8000 docs(eslint-plugin): ROADMAP note some jsdoc rules (#1319) Β· lipis/typescript-eslint@324f155 Β· GitHub
[go: up one dir, main page]

Skip to content

Commit 324f155

Browse files
mc-sucheckibradzacher
authored andcommitted
docs(eslint-plugin): ROADMAP note some jsdoc rules (typescript-eslint#1319)
1 parent 3ddf1a2 commit 324f155

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

β€Žpackages/eslint-plugin/ROADMAP.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@
142142
| [`class-name`] | βœ… | [`@typescript-eslint/class-name-casing`] |
143143
| [`comment-format`] | 🌟 | [`capitalized-comments`][capitalized-comments] & [`spaced-comment`][spaced-comment] |
144144
| [`comment-type`] | πŸ›‘ | N/A |
145-
| [`completed-docs`] | πŸ”Œ | [`eslint-plugin-jsdoc`][plugin:jsdoc] |
145+
| [`completed-docs`] | πŸ”Œ | [`jsdoc/require-jsdoc`] |
146146
| [`encoding`] | πŸ›‘ | N/A |
147147
| [`file-header`] | πŸ”Œ | [`eslint-plugin-header`][plugin:header] or [`-file-header`][plugin:file-header] |
148148
| [`file-name-casing`] | πŸ”Œ | [`unicorn/filename-case`] |
@@ -160,7 +160,7 @@
160160
| [`no-consecutive-blank-lines`] | 🌟 | [`no-multiple-empty-lines`][no-multiple-empty-lines] |
161161
| [`no-irregular-whitespace`] | 🌟 | [`no-irregular-whitespace`][no-irregular-whitespace] with `skipStrings: false` |
162162
| [`no-parameter-properties`] | βœ… | [`@typescript-eslint/no-parameter-properties`] |
163-
| [`no-redundant-jsdoc`] | πŸ›‘ | N/A ([open issue](https://github.com/gajus/eslint-plugin-jsdoc/issues/134)) |
163+
| [`no-redundant-jsdoc`] | πŸ”Œ | [`jsdoc/no-types`] |
164164
| [`no-reference-import`] | πŸ›‘ | N/A |
165165
| [`no-trailing-whitespace`] | 🌟 | [`no-trailing-spaces`][no-trailing-spaces] |
166166
| [`no-unnecessary-callback-wrapper`] | πŸ›‘ | N/A and this might be unsafe (i.e. with `forEach`) |
@@ -664,11 +664,16 @@ Relevant plugins: [`chai-expect-keywords`](https://github.com/gavinaiken/eslint-
664664
[`security/detect-non-literal-require`]: https://github.com/nodesecurity/eslint-plugin-security#detect-non-literal-require
665665
[`security/detect-possible-timing-attacks`]: https://github.com/nodesecurity/eslint-plugin-security#detect-possible-timing-attacks
666666

667+
<!-- eslint-plugin-jsdoc -->
668+
669+
[plugin:jsdoc]: https://github.com/gajus/eslint-plugin-jsdoc
670+
[`jsdoc/require-jsdoc`]: https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-jsdoc
671+
[`jsdoc/no-types`]: https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-types
672+
667673
<!-- Miscellaneous plugins -->
668674

669675
[`prefer-arrow/prefer-arrow-functions`]: https://github.com/TristonJ/eslint-plugin-prefer-arrow
670676
[plugin:promise]: https://github.com/xjamundx/eslint-plugin-promise
671-
[plugin:jsdoc]: https://github.com/gajus/eslint-plugin-jsdoc
672677
[plugin:header]: https://github.com/Stuk/eslint-plugin-header
673678
[plugin:file-header]: https://github.com/Sekhmet/eslint-plugin-file-header
674679
[plugin:compat]: https://github.com/amilajack/eslint-plugin-compat

0 commit comments

Comments
Β (0)
0