eslint-plugin-jsdoc 44.2.3 → 44.2.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/WarnSettings.js +0 -1
- package/dist/WarnSettings.js.map +1 -1
- package/dist/alignTransform.js +87 -5
- package/dist/alignTransform.js.map +1 -1
- package/dist/bin/generateRule.js +4 -3
- package/dist/bin/generateRule.js.map +1 -1
- package/dist/exportParser.js +272 -71
- package/dist/exportParser.js.map +1 -1
- package/dist/generateRule.js +4 -3
- package/dist/generateRule.js.map +1 -1
- package/dist/iterateJsdoc.js +921 -357
- package/dist/iterateJsdoc.js.map +1 -1
- package/dist/jsdocUtils.js +270 -168
- package/dist/jsdocUtils.js.map +1 -1
- package/dist/rules/checkAlignment.js +6 -0
- package/dist/rules/checkAlignment.js.map +1 -1
- package/dist/rules/checkExamples.js +73 -9
- package/dist/rules/checkExamples.js.map +1 -1
- package/dist/rules/checkIndentation.js +12 -2
- package/dist/rules/checkIndentation.js.map +1 -1
- package/dist/rules/checkLineAlignment.js +71 -7
- package/dist/rules/checkLineAlignment.js.map +1 -1
- package/dist/rules/checkParamNames.js +29 -11
- package/dist/rules/checkParamNames.js.map +1 -1
- package/dist/rules/checkPropertyNames.js +13 -7
- package/dist/rules/checkPropertyNames.js.map +1 -1
- package/dist/rules/checkTagNames.js +45 -9
- package/dist/rules/checkTagNames.js.map +1 -1
- package/dist/rules/checkTypes.js +98 -41
- package/dist/rules/checkTypes.js.map +1 -1
- package/dist/rules/checkValues.js +7 -7
- package/dist/rules/checkValues.js.map +1 -1
- package/dist/rules/emptyTags.js +8 -1
- package/dist/rules/emptyTags.js.map +1 -1
- package/dist/rules/informativeDocs.js +27 -8
- package/dist/rules/informativeDocs.js.map +1 -1
- package/dist/rules/matchDescription.js +18 -1
- package/dist/rules/matchDescription.js.map +1 -1
- package/dist/rules/matchName.js +2 -2
- package/dist/rules/matchName.js.map +1 -1
- package/dist/rules/multilineBlocks.js +12 -1
- package/dist/rules/multilineBlocks.js.map +1 -1
- package/dist/rules/noBadBlocks.js +4 -6
- package/dist/rules/noBadBlocks.js.map +1 -1
- package/dist/rules/noBlankBlockDescriptions.js +2 -0
- package/dist/rules/noBlankBlockDescriptions.js.map +1 -1
- package/dist/rules/noMissingSyntax.js +53 -16
- package/dist/rules/noMissingSyntax.js.map +1 -1
- package/dist/rules/noMultiAsterisks.js +1 -6
- package/dist/rules/noMultiAsterisks.js.map +1 -1
- package/dist/rules/noRestrictedSyntax.js +12 -5
- package/dist/rules/noRestrictedSyntax.js.map +1 -1
- package/dist/rules/noTypes.js +3 -0
- package/dist/rules/noTypes.js.map +1 -1
- package/dist/rules/noUndefinedTypes.js +65 -27
- package/dist/rules/noUndefinedTypes.js.map +1 -1
- package/dist/rules/requireAsteriskPrefix.js +20 -0
- package/dist/rules/requireAsteriskPrefix.js.map +1 -1
- package/dist/rules/requireDescription.js +6 -2
- package/dist/rules/requireDescription.js.map +1 -1
- package/dist/rules/requireDescriptionCompleteSentence.js +75 -12
- package/dist/rules/requireDescriptionCompleteSentence.js.map +1 -1
- package/dist/rules/requireFileOverview.js +9 -4
- package/dist/rules/requireFileOverview.js.map +1 -1
- package/dist/rules/requireHyphenBeforeParamDescription.js +21 -7
- package/dist/rules/requireHyphenBeforeParamDescription.js.map +1 -1
- package/dist/rules/requireJsdoc.js +150 -29
- package/dist/rules/requireJsdoc.js.map +1 -1
- package/dist/rules/requireParam.js +116 -10
- package/dist/rules/requireParam.js.map +1 -1
- package/dist/rules/requireProperty.js +1 -1
- package/dist/rules/requireProperty.js.map +1 -1
- package/dist/rules/requireReturns.js +2 -3
- package/dist/rules/requireReturns.js.map +1 -1
- package/dist/rules/requireReturnsCheck.js +9 -2
- package/dist/rules/requireReturnsCheck.js.map +1 -1
- package/dist/rules/requireThrows.js +2 -3
- package/dist/rules/requireThrows.js.map +1 -1
- package/dist/rules/requireYields.js +9 -3
- package/dist/rules/requireYields.js.map +1 -1
- package/dist/rules/requireYieldsCheck.js +19 -5
- package/dist/rules/requireYieldsCheck.js.map +1 -1
- package/dist/rules/sortTags.js +67 -9
- package/dist/rules/sortTags.js.map +1 -1
- package/dist/rules/tagLines.js +22 -3
- package/dist/rules/tagLines.js.map +1 -1
- package/dist/rules/textEscaping.js +18 -4
- package/dist/rules/textEscaping.js.map +1 -1
- package/dist/rules/validTypes.js +26 -9
- package/dist/rules/validTypes.js.map +1 -1
- package/dist/tagNames.js +0 -2
- package/dist/tagNames.js.map +1 -1
- package/dist/utils/hasReturnValue.js +77 -48
- package/dist/utils/hasReturnValue.js.map +1 -1
- package/docs/rules/check-line-alignment.md +7 -0
- package/docs/rules/check-tag-names.md +15 -0
- package/docs/rules/no-missing-syntax.md +6 -0
- package/docs/rules/no-undefined-types.md +6 -0
- package/docs/rules/require-description-complete-sentence.md +525 -289
- package/docs/rules/require-description.md +289 -525
- package/docs/rules/require-file-overview.md +7 -0
- package/docs/rules/require-jsdoc.md +1 -1
- package/docs/rules/require-param-description.md +116 -1694
- package/docs/rules/require-param-name.md +58 -133
- package/docs/rules/require-param-type.md +119 -55
- package/docs/rules/require-param.md +1704 -111
- package/docs/rules/require-property-description.md +39 -79
- package/docs/rules/require-property-name.md +21 -30
- package/docs/rules/require-property-type.md +21 -21
- package/docs/rules/require-property.md +82 -33
- package/docs/rules/require-returns-check.md +636 -747
- package/docs/rules/require-returns-description.md +61 -933
- package/docs/rules/require-returns-type.md +42 -79
- package/docs/rules/require-returns.md +1081 -61
- package/docs/rules/require-yields-check.md +238 -517
- package/docs/rules/require-yields.md +517 -238
- package/docs/rules/valid-types.md +1 -1
- package/docs/settings.md +3 -1
- package/package.json +10 -9
- package/tsconfig.json +2 -3
package/docs/settings.md
CHANGED
|
@@ -327,6 +327,8 @@ values are objects with the following optional properties:
|
|
|
327
327
|
checked to ensure it is a valid namepath. You might use this to ensure
|
|
328
328
|
that tags which normally allow free text, e.g., `@see` will instead
|
|
329
329
|
require a namepath.
|
|
330
|
+
- `"namepath-or-url-referencing"` - For inline tags which may point to
|
|
331
|
+
a namepath or URL.
|
|
330
332
|
- `false` - This will disallow any text in the name position.
|
|
331
333
|
- `type`:
|
|
332
334
|
- `true` - Allows valid types within brackets. This is the default.
|
|
@@ -347,7 +349,7 @@ values are objects with the following optional properties:
|
|
|
347
349
|
is required (not just that if present, it is a valid type). You
|
|
348
350
|
might use this with `@throws` or `@typedef` which might otherwise
|
|
349
351
|
normally have their types optional. See the type groups 3-5 above.
|
|
350
|
-
- `"
|
|
352
|
+
- `"typeOrNameRequired"` - Must have either type (e.g., `@throws {aType}`) or
|
|
351
353
|
name (`@throws Some text`); does not require that both exist but
|
|
352
354
|
disallows just an empty tag.
|
|
353
355
|
|
package/package.json
CHANGED
|
@@ -5,13 +5,13 @@
|
|
|
5
5
|
"url": "http://gajus.com"
|
|
6
6
|
},
|
|
7
7
|
"dependencies": {
|
|
8
|
-
"@es-joy/jsdoccomment": "~0.39.
|
|
8
|
+
"@es-joy/jsdoccomment": "~0.39.4",
|
|
9
9
|
"are-docs-informative": "^0.0.2",
|
|
10
10
|
"comment-parser": "1.3.1",
|
|
11
11
|
"debug": "^4.3.4",
|
|
12
12
|
"escape-string-regexp": "^4.0.0",
|
|
13
13
|
"esquery": "^1.5.0",
|
|
14
|
-
"semver": "^7.5.
|
|
14
|
+
"semver": "^7.5.1",
|
|
15
15
|
"spdx-expression-parse": "^3.0.1"
|
|
16
16
|
},
|
|
17
17
|
"description": "JSDoc linting rules for ESLint.",
|
|
@@ -32,23 +32,24 @@
|
|
|
32
32
|
"@types/chai": "^4.3.5",
|
|
33
33
|
"@types/debug": "^4.1.7",
|
|
34
34
|
"@types/eslint": "^8.37.0",
|
|
35
|
+
"@types/esquery": "^1.5.0",
|
|
35
36
|
"@types/estree": "^1.0.1",
|
|
36
37
|
"@types/lodash.defaultsdeep": "^4.6.7",
|
|
37
38
|
"@types/mocha": "^10.0.1",
|
|
38
|
-
"@types/node": "^20.
|
|
39
|
+
"@types/node": "^20.2.3",
|
|
39
40
|
"@types/semver": "^7.5.0",
|
|
40
41
|
"@types/spdx-expression-parse": "^3.0.2",
|
|
41
|
-
"@typescript-eslint/parser": "^5.59.
|
|
42
|
+
"@typescript-eslint/parser": "^5.59.6",
|
|
42
43
|
"babel-plugin-add-module-exports": "^1.0.4",
|
|
43
44
|
"babel-plugin-istanbul": "^6.1.1",
|
|
44
45
|
"camelcase": "^6.3.0",
|
|
45
46
|
"chai": "^4.3.7",
|
|
46
47
|
"cross-env": "^7.0.3",
|
|
47
48
|
"decamelize": "^5.0.1",
|
|
48
|
-
"eslint": "8.
|
|
49
|
-
"eslint-config-canonical": "~
|
|
49
|
+
"eslint": "8.41.0",
|
|
50
|
+
"eslint-config-canonical": "~41.0.4",
|
|
50
51
|
"gitdown": "^3.1.5",
|
|
51
|
-
"glob": "^10.2.
|
|
52
|
+
"glob": "^10.2.6",
|
|
52
53
|
"husky": "^8.0.3",
|
|
53
54
|
"jsdoc-type-pratt-parser": "^4.0.0",
|
|
54
55
|
"lint-staged": "^13.2.2",
|
|
@@ -56,7 +57,7 @@
|
|
|
56
57
|
"mocha": "^10.2.0",
|
|
57
58
|
"nyc": "^15.1.0",
|
|
58
59
|
"open-editor": "^3.0.0",
|
|
59
|
-
"rimraf": "^5.0.
|
|
60
|
+
"rimraf": "^5.0.1",
|
|
60
61
|
"semantic-release": "^21.0.2",
|
|
61
62
|
"typescript": "^5.0.4"
|
|
62
63
|
},
|
|
@@ -131,5 +132,5 @@
|
|
|
131
132
|
"test-cov": "cross-env TIMING=1 nyc --reporter text npm run test-no-cov",
|
|
132
133
|
"test-index": "npm run test-no-cov -- test/rules/index.js"
|
|
133
134
|
},
|
|
134
|
-
"version": "44.2.
|
|
135
|
+
"version": "44.2.5"
|
|
135
136
|
}
|
package/tsconfig.json
CHANGED