test: check code with ESLint #243
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
EvanHahn
referenced
this pull request
Sep 3, 2024
This change should have no user impact. There's almost always something better than `// @ts-ignore` and `// @ts-expect-error`. They can be problematic because they're very broad, and typically broader than we want. For details, see ["At least 7 reasons to avoid @ts-expect-error and @ts-ignore"][0]. This removes all of them in favor of more targeted solutions. (Or, in one case, just removes it and everything was fine!) I think this is a useful change on its own, but it should make [an upcoming change][1] easier too. [0]: https://shane-o.dev/articles/any-or-expect [1]: https://github.com/digidem/mapeo-schema/pull/243
EvanHahn
referenced
this pull request
Sep 3, 2024
This change should have no user impact. This removes a few unused imports from a few files. I think this is a useful change on its own, but it should make [an upcoming change][1] easier too. [1]: https://github.com/digidem/mapeo-schema/pull/243
EvanHahn
referenced
this pull request
Sep 3, 2024
This change should have no user impact. This removes a few unused imports from a few files. I think this is a useful change on its own, but it should make [an upcoming change][1] easier too. [1]: https://github.com/digidem/mapeo-schema/pull/243
`npm run lint:eslint` (run as part of `npm lint` and `npm test`) now checks our code with ESLint. This also fixes or disables all lint failures.
EvanHahn
force-pushed
the
add-eslint
branch
2 times, most recently
from
d39d786 to
859a695
Compare
`npm run lint:eslint` (run as part of `npm lint` and `npm test`) now checks our code with ESLint. This also fixes or disables all lint failures.
EvanHahn
commented
Sep 5, 2024
| '@typescript-eslint/ban-ts-comment': [ | ||
| 'error', | ||
| { | ||
| 'ts-expect-error': false, |
There was a problem hiding this comment.
The default still allows this, but makes us leave a comment.
| 'ts-expect-error': false, | ||
| }, | ||
| ], | ||
| '@typescript-eslint/no-explicit-any': 'off', |
There was a problem hiding this comment.
We use a lot of anys so I don't think we should disable this right now.
eslint.config.js
Outdated
Comment on lines
22
to
29
| '@typescript-eslint/no-unused-vars': [ | ||
| 'error', | ||
| { | ||
| varsIgnorePattern: '^_', | ||
| argsIgnorePattern: '^_', | ||
| }, | ||
| ], | ||
| }, |
There was a problem hiding this comment.
Matches rules we have elsewhere.
gmaclennan
reviewed
Sep 9, 2024
gmaclennan
reviewed
Sep 9, 2024
Because we genuinely expect an error! See [this comment][0]. [0]: #243 (comment)
gmaclennan
approved these changes
Oct 2, 2024
There was a problem hiding this comment.
Looks good. Small niggle, can be ignored: we use filter-obj in a couple of other modules, and I would lean towards using a well-maintained and tested module like that rather than our own implementation, which is doesn't have tests for edge-cases, e.g. symbol properties.
|
I'll plan to do that in a followup. |
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.
npm run lint:eslint(run as part ofnpm lintandnpm test) now checks our code with ESLint.This also fixes or disables all lint failures.