Set up ESLint for JSDoc comments #1605
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
43081j
reviewed
Feb 19, 2024
| import jsdoc from "eslint-plugin-jsdoc"; | ||
|
|
||
| export default [ | ||
| jsdoc.configs["flat/recommended"], |
There was a problem hiding this comment.
while you're in there, can you maybe also enable eslint's recommended rule set? im surprised we didn't already have eslint
if it ends up with too big of a change, you could do a PR to add eslint + recommended, then a separate one for jsdoc on top or vice versa
43081j
reviewed
Feb 19, 2024
| @@ -2116,6 +2110,13 @@ function assertOwnPropertyDescriptor (name, descriptor, msg) { | |||
| Assertion.addMethod('ownPropertyDescriptor', assertOwnPropertyDescriptor); | |||
| Assertion.addMethod('haveOwnPropertyDescriptor', assertOwnPropertyDescriptor); | |||
|
|
|||
| /** | |||
| * | |||
There was a problem hiding this comment.
maybe add a description? "Flags that the length property should be asserted in this chain"
43081j
approved these changes
Feb 19, 2024
|
lol, maybe I shouldn't have had it on auto-merge :D I'll make a follow up PR to apply some of your suggestions @43081j |
renovate bot
referenced
this pull request
in runtime-env/import-meta-env
Jul 7, 2024
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [chai](http://chaijs.com) ([source](https://togithub.com/chaijs/chai)) | [`4.4.1` -> `5.1.1`](https://renovatebot.com/diffs/npm/chai/4.4.1/5.1.1) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>chaijs/chai (chai)</summary> ### [`v5.1.1`](https://togithub.com/chaijs/chai/releases/tag/v5.1.1) [Compare Source](https://togithub.com/chaijs/chai/compare/v5.1.0...v5.1.1) #### What's Changed - Set up ESLint for JSDoc comments by [@​koddsson](https://togithub.com/koddsson) in [https://github.com/chaijs/chai/pull/1605](https://togithub.com/chaijs/chai/pull/1605) - build(deps-dev): bump ip from 1.1.8 to 1.1.9 by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/chaijs/chai/pull/1608](https://togithub.com/chaijs/chai/pull/1608) - Correct Mocha import instructions by [@​MattiSG](https://togithub.com/MattiSG) in [https://github.com/chaijs/chai/pull/1611](https://togithub.com/chaijs/chai/pull/1611) - fix: support some virtual contexts in `toThrow` by [@​43081j](https://togithub.com/43081j) in [https://github.com/chaijs/chai/pull/1609](https://togithub.com/chaijs/chai/pull/1609) #### New Contributors - [@​MattiSG](https://togithub.com/MattiSG) made their first contribution in [https://github.com/chaijs/chai/pull/1611](https://togithub.com/chaijs/chai/pull/1611) **Full Changelog**: chaijs/chai@v5.1.0...v5.1.1 ### [`v5.1.0`](https://togithub.com/chaijs/chai/releases/tag/v5.1.0) [Compare Source](https://togithub.com/chaijs/chai/compare/v5.0.3...v5.1.0) #### What's Changed - Remove useless guards and add parentheses to constuctors by [@​koddsson](https://togithub.com/koddsson) in [https://github.com/chaijs/chai/pull/1593](https://togithub.com/chaijs/chai/pull/1593) - Cleanup jsdoc comments by [@​koddsson](https://togithub.com/koddsson) in [https://github.com/chaijs/chai/pull/1596](https://togithub.com/chaijs/chai/pull/1596) - Convert comments in "legal comments" format to jsdoc or normal comments by [@​koddsson](https://togithub.com/koddsson) in [https://github.com/chaijs/chai/pull/1598](https://togithub.com/chaijs/chai/pull/1598) - Implement `iterable` assertion by [@​koddsson](https://togithub.com/koddsson) in [https://github.com/chaijs/chai/pull/1592](https://togithub.com/chaijs/chai/pull/1592) - Assert interface fix by [@​developer-bandi](https://togithub.com/developer-bandi) in [https://github.com/chaijs/chai/pull/1601](https://togithub.com/chaijs/chai/pull/1601) - Set support in same members by [@​koddsson](https://togithub.com/koddsson) in [https://github.com/chaijs/chai/pull/1583](https://togithub.com/chaijs/chai/pull/1583) - Fix publish script by [@​koddsson](https://togithub.com/koddsson) in [https://github.com/chaijs/chai/pull/1602](https://togithub.com/chaijs/chai/pull/1602) #### New Contributors - [@​developer-bandi](https://togithub.com/developer-bandi) made their first contribution in [https://github.com/chaijs/chai/pull/1601](https://togithub.com/chaijs/chai/pull/1601) **Full Changelog**: chaijs/chai@v5.0.3...v5.1.0 ### [`v5.0.3`](https://togithub.com/chaijs/chai/releases/tag/v5.0.3) [Compare Source](https://togithub.com/chaijs/chai/compare/v5.0.2...v5.0.3) Fix bad v5.0.2 publish. **Full Changelog**: chaijs/chai@v5.0.2...v5.0.3 ### [`v5.0.2`](https://togithub.com/chaijs/chai/releases/tag/v5.0.2) [Compare Source](https://togithub.com/chaijs/chai/compare/v5.0.0...v5.0.2) #### What's Changed - build(deps): bump nanoid and mocha by [@​dependabot](https://togithub.com/dependabot) in [https://github.com/chaijs/chai/pull/1558](https://togithub.com/chaijs/chai/pull/1558) - remove `bump-cli` by [@​koddsson](https://togithub.com/koddsson) in [https://github.com/chaijs/chai/pull/1559](https://togithub.com/chaijs/chai/pull/1559) - Update developer dependencies by [@​koddsson](https://togithub.com/koddsson) in [https://github.com/chaijs/chai/pull/1560](https://togithub.com/chaijs/chai/pull/1560) - fix: removes `??` for node compat (5.x) by [@​43081j](https://togithub.com/43081j) in [https://github.com/chaijs/chai/pull/1576](https://togithub.com/chaijs/chai/pull/1576) - Update `loupe` to latest version by [@​koddsson](https://togithub.com/koddsson) in [https://github.com/chaijs/chai/pull/1579](https://togithub.com/chaijs/chai/pull/1579) - Re-enable some webkit tests by [@​koddsson](https://togithub.com/koddsson) in [https://github.com/chaijs/chai/pull/1580](https://togithub.com/chaijs/chai/pull/1580) - Remove a bunch of if statements in test/should.js by [@​koddsson](https://togithub.com/koddsson) in [https://github.com/chaijs/chai/pull/1581](https://togithub.com/chaijs/chai/pull/1581) - Remove a bunch of unused files by [@​koddsson](https://togithub.com/koddsson) in [https://github.com/chaijs/chai/pull/1582](https://togithub.com/chaijs/chai/pull/1582) - Fix 1564 by [@​koddsson](https://togithub.com/koddsson) in [https://github.com/chaijs/chai/pull/1566](https://togithub.com/chaijs/chai/pull/1566) **Full Changelog**: chaijs/chai@v5.0.1...v5.0.2 ### [`v5.0.0`](https://togithub.com/chaijs/chai/releases/tag/v5.0.0) [Compare Source](https://togithub.com/chaijs/chai/compare/v4.4.1...v5.0.0) #### BREAKING CHANGES - Chai now only supports EcmaScript Modules (ESM). This means your tests will need to either have `import {...} from 'chai'` or `import('chai')`. `require('chai')` will cause failures in nodejs. If you're using ESM and seeing failures, it may be due to a bundler or transpiler which is incorrectly converting import statements into require calls. - Dropped support for Internet Explorer. - Dropped support for NodeJS < 18. - Minimum supported browsers are now Firefox 100, Safari 14.1, Chrome 100, Edge 100. Support for browsers prior to these versions is "best effort" (bug reports on older browsers will be assessed individually and may be marked as wontfix). #### What's Changed - feat: use chaijs/loupe for inspection by [@​pcorpet](https://togithub.com/pcorpet) in [https://github.com/chaijs/chai/pull/1401](https://togithub.com/chaijs/chai/pull/1401) - docs: fix URL in README by [@​Izzur](https://togithub.com/Izzur) in [https://github.com/chaijs/chai/pull/1413](https://togithub.com/chaijs/chai/pull/1413) - Remove `get-func-name` dependency by [@​koddsson](https://togithub.com/koddsson) in [https://github.com/chaijs/chai/pull/1416](https://togithub.com/chaijs/chai/pull/1416) - Convert Makefile script to npm scripts by [@​koddsson](https://togithub.com/koddsson) in [https://github.com/chaijs/chai/pull/1424](https://togithub.com/chaijs/chai/pull/1424) - Clean up README badges by [@​koddsson](https://togithub.com/koddsson) in [https://github.com/chaijs/chai/pull/1422](https://togithub.com/chaijs/chai/pull/1422) - fix: package.json - deprecation warning on exports field by [@​stevenjoezhang](https://togithub.com/stevenjoezhang) in [https://github.com/chaijs/chai/pull/1400](https://togithub.com/chaijs/chai/pull/1400) - fix: deep-eql bump package to support symbols by [@​snewcomer](https://togithub.com/snewcomer) in [https://github.com/chaijs/chai/pull/1458](https://togithub.com/chaijs/chai/pull/1458) - ES module conversion PoC by [@​43081j](https://togithub.com/43081j) in [https://github.com/chaijs/chai/pull/1498](https://togithub.com/chaijs/chai/pull/1498) - chore: drop commonjs support by [@​43081j](https://togithub.com/43081j) in [https://github.com/chaijs/chai/pull/1503](https://togithub.com/chaijs/chai/pull/1503) - Update pathval by [@​koddsson](https://togithub.com/koddsson) in [https://github.com/chaijs/chai/pull/1527](https://togithub.com/chaijs/chai/pull/1527) - Update check-error by [@​koddsson](https://togithub.com/koddsson) in [https://github.com/chaijs/chai/pull/1528](https://togithub.com/chaijs/chai/pull/1528) - update `deep-eql` to latest version by [@​koddsson](https://togithub.com/koddsson) in [https://github.com/chaijs/chai/pull/1542](https://togithub.com/chaijs/chai/pull/1542) - Inline `type-detect` as a simple function by [@​koddsson](https://togithub.com/koddsson) in [https://github.com/chaijs/chai/pull/1544](https://togithub.com/chaijs/chai/pull/1544) - Update loupe by [@​koddsson](https://togithub.com/koddsson) in [https://github.com/chaijs/chai/pull/1545](https://togithub.com/chaijs/chai/pull/1545) - Typo 'Test an object' not 'Test and object' by [@​mavaddat](https://togithub.com/mavaddat) in [https://github.com/chaijs/chai/pull/1460](https://togithub.com/chaijs/chai/pull/1460) - Update `assertion-error` to it's latest major version! by [@​koddsson](https://togithub.com/koddsson) in [https://github.com/chaijs/chai/pull/1543](https://togithub.com/chaijs/chai/pull/1543) - Replacing Karma with Web Test Runner by [@​koddsson](https://togithub.com/koddsson) in [https://github.com/chaijs/chai/pull/1546](https://togithub.com/chaijs/chai/pull/1546) #### New Contributors - [@​Izzur](https://togithub.com/Izzur) made their first contribution in [https://github.com/chaijs/chai/pull/1413](https://togithub.com/chaijs/chai/pull/1413) - [@​stevenjoezhang](https://togithub.com/stevenjoezhang) made their first contribution in [https://github.com/chaijs/chai/pull/1400](https://togithub.com/chaijs/chai/pull/1400) - [@​43081j](https://togithub.com/43081j) made their first contribution in [https://github.com/chaijs/chai/pull/1498](https://togithub.com/chaijs/chai/pull/1498) **Full Changelog**: chaijs/chai@4.3.1...v5.0.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/runtime-env/import-meta-env). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MjEuOSIsInVwZGF0ZWRJblZlciI6IjM3LjQyMS45IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
](https://renovatebot.com){kind=link}
This was referenced Jul 16, 2024
This was referenced Sep 17, 2024
This was referenced Sep 23, 2024
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.
I really want to explore both better typing and possible automatic generation of API docs since the JSDoc comments that exist in the codebase are of such high quality.
This PR introduces ESLint and
eslint-plugin-jsdocto start linting JSDoc comment in effort to make sure that all of the comments stay high quality as we refactor the codeThis PR can be followed up by more changes to the rules we apply as well as some explorations into API documentation and stricter type-checking.