chore: make our jsdoc eslint rules a bit less obnoxious #577
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
erunion
requested review from
kanadgupta,
a team,
Dashron and
julshotal
and removed request for
a team
Dashron
approved these changes
Jan 7, 2022
| @@ -31,12 +30,20 @@ | |||
| }, | |||
| "overrides": [ | |||
| { | |||
| "files": ["__tests__/__fixtures__/*.js", "src/cli/*.js", "src/cli/commands/*.js", "src/cli/lib/*.js"], | |||
| "files": ["*.js"], | |||
There was a problem hiding this comment.
will this lead to node_modules being linted? Is there a way to do a verbose run and output all the files we're checking to make sure nothing obvious wrong is now included?
There was a problem hiding this comment.
ESLint ignores node_modules/ by default, but running it with --debug it doesn't look in there still.
| // | ||
| // const variable = variables?.[value] | ||
| const variable = (variables[value] || {}) as RMOAS.ServerVariableObject; | ||
| const variable = variables?.[value]; |
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.
🧰 Changes
The ESLint rules that we put in place for JSDoc blocks has been a bit obnoxious with TypeScript so I'm slightly tweaking it to:
@returnstag. All of our existing@returnstags have essentially summarized what's already been said in the docblock summary so they've been a bit unnecessary and just add clutter.