feat: speed up eslint parser timing #3250
Merged
Conversation
This file contains 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
p-fernandez
reviewed
Apr 20, 2023
| @@ -7,7 +7,6 @@ module.exports = { | |||
| 'prettier', | |||
| 'plugin:prettier/recommended', | |||
| 'plugin:promise/recommended', | |||
| 'plugin:@cspell/recommended', | |||
There was a problem hiding this comment.
You should remove .cspell.json file too. Or are we keeping it in the CI?
There was a problem hiding this comment.
@p-fernandez keeping it in CI, just making sure locally our linter will run faster
| @@ -37,7 +37,6 @@ export class InviteMember { | |||
| if (process.env.NOVU_API_KEY && (process.env.NODE_ENV === 'dev' || process.env.NODE_ENV === 'production')) { | |||
| const novu = new Novu(process.env.NOVU_API_KEY); | |||
|
|
|||
| // eslint-disable-next-line @cspell/spellchecker | |||
| // cspell:disable-next | |||
There was a problem hiding this comment.
You should remove all the ocurrences of cspell anotations.
There was a problem hiding this comment.
The second annotation helps the CI skip this one. I only removed the eslint one here
github-actions
bot
added
@novu/api
documentation
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.
What change does this PR introduce?
This PR introduces a performance improvement to eslint by localizing the ts parser options to the scanned object rather than the whole repo from the root. This change resulted in a significant reduction in test case running time, from 20s to 5s. Additionally, cspell has been removed from eslint, as it caused more than 70% of the time spent when linting.
Why was this change needed?
This change was needed to improve the performance of eslint, which was previously slow due to the ts parser options being applied to the entire repo from the root. This caused husky pre commit take a forever amount of time to complete
Before:
After:
Cspell took almost all the time, now we will only run it in CI.
