refactor: have ESLint manage our JSDocs #1746
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
michaelfig
force-pushed
the
mfig/eslint-jsdoc
branch
from
3b88292 to
f24fcaf
Compare
Chris-Hibbert
approved these changes
Sep 13, 2020
michaelfig
force-pushed
the
mfig/eslint-jsdoc
branch
2 times, most recently
from
d903d91 to
9e76a9f
Compare
michaelfig
added
hygiene
erights
approved these changes
Sep 14, 2020
| @@ -189,11 +191,13 @@ function fail(optDetails = details`Assert failed`) { | |||
| throw optDetails.complain(); | |||
| } | |||
|
|
|||
| /* eslint-disable jsdoc/require-returns-check,jsdoc/valid-types */ | |||
There was a problem hiding this comment.
The types below failed the linter, mostly due to the incomplete implementation of JSDoc Typescript linting described in #1751.
| // @ts-check | ||
|
|
||
| import makeStore from '@agoric/store'; | ||
|
|
||
| /** | ||
| * @template T | ||
| * @typedef {Object} Device | ||
| * @typedef {'Device' & { __deviceType__: T }} Device |
There was a problem hiding this comment.
Not strictly necessary, just to remind people not to try actually using d.__deviceType__. Do you have a better suggestion?
| @@ -6,10 +6,11 @@ | |||
| "scripts": { | |||
| "build": "exit 0", | |||
| "test": "ava", | |||
| "lint": "yarn lint:types && eslint '**/*.js'", | |||
| "lint": "yarn lint:types&&yarn lint:eslint", | |||
There was a problem hiding this comment.
Why remove the spaces around the double ampersand? To me, this is a serious legibility problem.
There was a problem hiding this comment.
Windows experience. Okay, I've reverted that.
michaelfig
force-pushed
the
mfig/eslint-jsdoc
branch
from
9e76a9f to
01048eb
Compare
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.
This is much stricter ESLint checking for everything that uses it (except for SwingSet, #1749), but still not as strict as we need: gajus/eslint-plugin-jsdoc#637