@W-7802169@ Add eslint out of memory troubleshooter #134
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds an entry for an out of memory error that can occur when scanning large projects.
jbartolotta-sfdc
commented
Jul 9, 2020
|
|
||
| ### The `scanner:run` command output contains the message `'<file_name>' does not reside in a location that is included by your tsconfig.json 'include' attribute`. | ||
|
|
||
| The ESLint engine requires that any typescript files that are scanned must be included by the tsconfig. [More Information](https://github.com/typescript-eslint/typescript-eslint/releases/tag/v2.0.0) |
Contributor
Author
There was a problem hiding this comment.
The red highlighting is a github.com oddity because of the json comments above. You can view the end result here.
|
|
||
| The scanner's node process runs with a default limit of 2GB of memory. This limit can be changed by configuring the `max-old-space-size` node option. The required memory will depend on the files included in the `--target` parameter. The following example increases the memory value to 4GB for a single invocation of the scanner. | ||
|
|
||
| ```bash |
Contributor
Author
There was a problem hiding this comment.
This is a unix example. I don't know the exact Windows syntax. I can add it if anyone knows what it would be.
rmohan20
approved these changes
Jul 9, 2020
jfeingold35
approved these changes
Jul 9, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds an entry for an out of memory error that can occur when scanning
large projects.