-
Notifications
You must be signed in to change notification settings - Fork 189
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fixes #2970 add eslint configurations to Docusaurus and play together with turborepo's linting #2971
Merged
Merged
Fixes #2970 add eslint configurations to Docusaurus and play together with turborepo's linting #2971
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
f26676b
add eslint to Docusaurus and play together with turborepo's linting
cindyorangis dcc19c8
extend correct eslint-config-telescope package and add eslint-plugin-…
cindyorangis 102758e
rename telescope-docs to @senecacdot/telescope-docs in package.json
cindyorangis File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| module.exports = { | ||
| extends: '@senecacdot/eslint-config-telescope', | ||
| overrides: [ | ||
| { | ||
| files: ['./**/*.js'], | ||
| extends: [ | ||
| 'plugin:import/typescript', | ||
| 'plugin:node/recommended', | ||
| 'plugin:react/recommended', | ||
| 'plugin:react-hooks/recommended', | ||
| ], | ||
| plugins: ['react', 'react-hooks'], | ||
| rules: { | ||
| '@typescript-eslint/no-shadow': 'off', | ||
| // https://github.com/facebook/docusaurus/blob/main/.eslintrc.js#L122 | ||
| // Ignore certain webpack aliases because they can't be resolved | ||
| 'import/no-unresolved': [ | ||
| 'off', | ||
| { | ||
| ignore: ['^@theme', '^@docusaurus', '^@generated', '^@site'], | ||
| }, | ||
| ], | ||
| 'global-require': 'off', | ||
| 'no-use-before-define': 'off', | ||
| 'node/no-missing-import': 'off', | ||
| 'node/no-unsupported-features/es-syntax': 'off', | ||
| 'react/jsx-filename-extension': ['error', { extensions: ['.js', '.jsx'] }], | ||
| // https://github.com/facebook/docusaurus/blob/main/.eslintrc.js#L154 | ||
| // We build a static site, and nearly all components don't change. | ||
| 'react/no-array-index-key': 'off', | ||
| 'react/prop-types': 'off', | ||
| }, | ||
| settings: { | ||
| 'import/resolver': { | ||
| node: { | ||
| extensions: ['.js', '.jsx'], | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| ], | ||
| }; |
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Where do we use this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In PR #2853, we added a number of eslint overrides, and they addressed all the eslint errors we were getting for the Docusaurus app. Hence, the overrides in this PR are identical to what we had previously (just located in
src/docsas opposed to/).For some reason, I am no longer getting any eslint errors for the Docusaurus app on master right now. I don't know if this PR is even needed...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What if you introduce an eslint error, does it catch that?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@menghif we use
eslint-plugin-nodeheretelescope/src/docs/.eslintrc.js
Lines 25 to 26 in 36f2307
or else we get errors like these
