Skip to content

Commit

Permalink
docs: misc update (#1475)
Browse files Browse the repository at this point in the history
  • Loading branch information
unional authored Jun 11, 2022
1 parent 8e389d9 commit d954b03
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Contributer's Guide
# Contributor's Guide

We welcome contributions from the community and have gathered guidelines
We welcome contributions from the community and have gathered guidelines
here to help you get started.

## Discussion

While not absolutely required, it is encouraged that you first open an issue
While not absolutely required, it is encouraged that you first open an issue
for any bug or feature request. This allows discussion on the proper course of
action to take before coding begins.

Expand Down Expand Up @@ -69,7 +69,7 @@ To investigate slowdowns in build times, it's often helpful to profile webpack &
1. Start webpack with a debugger attached (see debugging steps above)
2. Identify the reproducible user scenario that is experiencing slowdowns
3. In Chrome, open `chrome://inspect` and inspect the running webpack instance
Note: Utilizing Chromium instead of Chrome sometimes yeilds better results. If any of the following steps fail or cause a crash, try switching from Chrome to Chromium.
Note: Utilizing Chromium instead of Chrome sometimes yields better results. If any of the following steps fail or cause a crash, try switching from Chrome to Chromium.
4. Switch to the Profiling Tab
5. Start Recording
6. Kick off the scenario that's known to be slow
Expand Down
4 changes: 2 additions & 2 deletions REFERENCES.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ There are a few points to note:
1. You need to use <code>tsc --build</code> to compile the project.
1. When you compile the project <code>tsc --build</code> will create a file called tsconfig.tsbuildinfo that contains the signatures and timestamps of all files required to build the project. On subsequent builds TypeScript will use that information to detect the least costly way to type-check and emit changes to your project.
1. There is no need to use the incremental compiler option. <code>tsc --build</code> will generate and use tsconfig.tsbuildinfo anyway.
1. If you delete your compiled code and re-run <code>tsc --build</code> the code will **not **be rebuilt unless you also delete the <code>tsconfig.tsbuildinfo</code> file. Use the <code>tsc --build --clean</code> command to do this for you.
1. If you delete your compiled code and re-run <code>tsc --build</code> the code will **not** be rebuilt unless you also delete the <code>tsconfig.tsbuildinfo</code> file. Use the <code>tsc --build --clean</code> command to do this for you.

1. If you set the <code>declaration</code> and <code>declarationMap</code> settings in <code>tsconfig.json</code> the <code>outDir</code> folder will contain <code>.d.ts</code> and <code>.d.ts.map</code> files alongside the transpiled JavaScript. When you consume the compiled project you should consume the <code>outDir</code> folder, not the <code>src</code>. Even though your root project is in TypeScript it can use full syntax checking without the subproject’s TypeScript source because the <code>outDir</code> folder contains the definitions in the <code>.d.ts</code> file. Vscode (and many other code editors and IDEs) will be able to find the definitions and perform syntax checking in the editor just as if you were not using project references and importing the TypeScript source directly.

Expand Down Expand Up @@ -154,7 +154,7 @@ Now TypeScript understands that when it sees <code>packages/reference1</code> in
Unless you are using tsconfig-paths-webpack-plugin you may need to include a corresponding resolve-alias setting in your <code>webpack.config.js</code>:
```
const path = require('path');
module.exports = {
modules: [
"node_modules",
Expand Down

0 comments on commit d954b03

Please sign in to comment.