@depup/eslint-plugin-jsdoc 63.3.2-depup.1 → 64.0.0-depup.0
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/README.md +3 -11
- package/changes.json +3 -16
- package/dist/index.d.ts +7 -4
- package/package.json +29 -67
- package/src/index.js +7 -8
- package/dist/WarnSettings.cjs +0 -38
- package/dist/WarnSettings.cjs.map +0 -1
- package/dist/alignTransform.cjs +0 -402
- package/dist/alignTransform.cjs.map +0 -1
- package/dist/buildForbidRuleDefinition.cjs +0 -101
- package/dist/buildForbidRuleDefinition.cjs.map +0 -1
- package/dist/buildRejectOrPreferRuleDefinition.cjs +0 -352
- package/dist/buildRejectOrPreferRuleDefinition.cjs.map +0 -1
- package/dist/cjs/WarnSettings.d.ts +0 -16
- package/dist/cjs/alignTransform.d.ts +0 -33
- package/dist/cjs/buildForbidRuleDefinition.d.ts +0 -14
- package/dist/cjs/buildRejectOrPreferRuleDefinition.d.ts +0 -8
- package/dist/cjs/defaultTagOrder.d.ts +0 -4
- package/dist/cjs/exportParser.d.ts +0 -40
- package/dist/cjs/getDefaultTagStructureForMode.d.ts +0 -10
- package/dist/cjs/getJsdocProcessorPlugin.d.cts +0 -5
- package/dist/cjs/getJsdocProcessorPlugin.d.ts +0 -66
- package/dist/cjs/index-cjs.d.ts +0 -23
- package/dist/cjs/index.cjs.d.cts +0 -2
- package/dist/cjs/iterateJsdoc.d.cts +0 -7
- package/dist/cjs/iterateJsdoc.d.ts +0 -495
- package/dist/cjs/jsdocUtils.d.ts +0 -500
- package/dist/cjs/rules/checkAccess.d.ts +0 -2
- package/dist/cjs/rules/checkAlignment.d.ts +0 -2
- package/dist/cjs/rules/checkExamples.d.ts +0 -3
- package/dist/cjs/rules/checkIndentation.d.ts +0 -2
- package/dist/cjs/rules/checkLineAlignment.d.ts +0 -9
- package/dist/cjs/rules/checkParamNames.d.ts +0 -2
- package/dist/cjs/rules/checkPropertyNames.d.ts +0 -2
- package/dist/cjs/rules/checkSyntax.d.ts +0 -2
- package/dist/cjs/rules/checkTagNames.d.ts +0 -2
- package/dist/cjs/rules/checkTemplateNames.d.ts +0 -2
- package/dist/cjs/rules/checkTypes.d.ts +0 -7
- package/dist/cjs/rules/checkValues.d.ts +0 -2
- package/dist/cjs/rules/convertToJsdocComments.d.ts +0 -266
- package/dist/cjs/rules/emptyTags.d.ts +0 -2
- package/dist/cjs/rules/escapeInlineTags.d.ts +0 -2
- package/dist/cjs/rules/implementsOnClasses.d.ts +0 -2
- package/dist/cjs/rules/importsAsDependencies.d.ts +0 -2
- package/dist/cjs/rules/informativeDocs.d.ts +0 -2
- package/dist/cjs/rules/linesBeforeBlock.d.ts +0 -2
- package/dist/cjs/rules/matchDescription.d.ts +0 -2
- package/dist/cjs/rules/matchName.d.ts +0 -2
- package/dist/cjs/rules/multilineBlocks.d.ts +0 -2
- package/dist/cjs/rules/noBadBlocks.d.ts +0 -2
- package/dist/cjs/rules/noBlankBlockDescriptions.d.ts +0 -2
- package/dist/cjs/rules/noBlankBlocks.d.ts +0 -2
- package/dist/cjs/rules/noDefaults.d.ts +0 -2
- package/dist/cjs/rules/noMissingSyntax.d.ts +0 -9
- package/dist/cjs/rules/noMultiAsterisks.d.ts +0 -2
- package/dist/cjs/rules/noRestrictedSyntax.d.ts +0 -2
- package/dist/cjs/rules/noTypes.d.ts +0 -2
- package/dist/cjs/rules/noUndefinedTypes.d.ts +0 -2
- package/dist/cjs/rules/normalizeSeeLinks.d.ts +0 -2
- package/dist/cjs/rules/preferImportTag.d.ts +0 -2
- package/dist/cjs/rules/requireAsteriskPrefix.d.ts +0 -2
- package/dist/cjs/rules/requireDescription.d.ts +0 -2
- package/dist/cjs/rules/requireDescriptionCompleteSentence.d.ts +0 -2
- package/dist/cjs/rules/requireExample.d.ts +0 -2
- package/dist/cjs/rules/requireFileOverview.d.ts +0 -2
- package/dist/cjs/rules/requireHyphenBeforeParamDescription.d.ts +0 -2
- package/dist/cjs/rules/requireJsdoc.d.ts +0 -24
- package/dist/cjs/rules/requireParam.d.ts +0 -3
- package/dist/cjs/rules/requireParamDescription.d.ts +0 -2
- package/dist/cjs/rules/requireParamName.d.ts +0 -2
- package/dist/cjs/rules/requireParamType.d.ts +0 -2
- package/dist/cjs/rules/requireProperty.d.ts +0 -2
- package/dist/cjs/rules/requirePropertyDescription.d.ts +0 -2
- package/dist/cjs/rules/requirePropertyName.d.ts +0 -2
- package/dist/cjs/rules/requirePropertyType.d.ts +0 -2
- package/dist/cjs/rules/requireRejects.d.ts +0 -2
- package/dist/cjs/rules/requireReturns.d.ts +0 -2
- package/dist/cjs/rules/requireReturnsCheck.d.ts +0 -2
- package/dist/cjs/rules/requireReturnsDescription.d.ts +0 -2
- package/dist/cjs/rules/requireReturnsType.d.ts +0 -2
- package/dist/cjs/rules/requireTags.d.ts +0 -2
- package/dist/cjs/rules/requireTemplate.d.ts +0 -2
- package/dist/cjs/rules/requireThrows.d.ts +0 -2
- package/dist/cjs/rules/requireYields.d.ts +0 -2
- package/dist/cjs/rules/requireYieldsCheck.d.ts +0 -2
- package/dist/cjs/rules/sortTags.d.ts +0 -2
- package/dist/cjs/rules/tagLines.d.ts +0 -2
- package/dist/cjs/rules/textEscaping.d.ts +0 -2
- package/dist/cjs/rules/tsMethodSignatureStyle.d.ts +0 -2
- package/dist/cjs/rules/tsNoEmptyObjectType.d.ts +0 -2
- package/dist/cjs/rules/tsNoUnnecessaryTemplateExpression.d.ts +0 -2
- package/dist/cjs/rules/tsPreferFunctionType.d.ts +0 -2
- package/dist/cjs/rules/typeFormatting.d.ts +0 -2
- package/dist/cjs/rules/validTypes.d.ts +0 -2
- package/dist/cjs/tagNames.d.ts +0 -15
- package/dist/cjs/utils/hasReturnValue.d.ts +0 -19
- package/dist/defaultTagOrder.cjs +0 -46
- package/dist/defaultTagOrder.cjs.map +0 -1
- package/dist/exportParser.cjs +0 -732
- package/dist/exportParser.cjs.map +0 -1
- package/dist/generateDocs.cjs +0 -342
- package/dist/generateDocs.cjs.map +0 -1
- package/dist/generateOptions.cjs +0 -62
- package/dist/generateOptions.cjs.map +0 -1
- package/dist/generateRule.cjs +0 -248
- package/dist/generateRule.cjs.map +0 -1
- package/dist/generateRuleTypes.cjs +0 -24
- package/dist/generateRuleTypes.cjs.map +0 -1
- package/dist/getDefaultTagStructureForMode.cjs +0 -289
- package/dist/getDefaultTagStructureForMode.cjs.map +0 -1
- package/dist/getJsdocProcessorPlugin.cjs +0 -587
- package/dist/getJsdocProcessorPlugin.cjs.map +0 -1
- package/dist/getJsdocProcessorPlugin.cts +0 -5
- package/dist/index-cjs.cjs +0 -598
- package/dist/index-cjs.cjs.map +0 -1
- package/dist/index-cjs.d.ts +0 -24
- package/dist/index-esm.cjs +0 -162
- package/dist/index-esm.cjs.map +0 -1
- package/dist/index-esm.d.ts +0 -72
- package/dist/index.cjs +0 -746
- package/dist/index.cjs.cts +0 -3
- package/dist/index.cjs.map +0 -1
- package/dist/iterateJsdoc.cjs +0 -2150
- package/dist/iterateJsdoc.cjs.map +0 -1
- package/dist/iterateJsdoc.cts +0 -7
- package/dist/jsdocUtils.cjs +0 -1786
- package/dist/jsdocUtils.cjs.map +0 -1
- package/dist/rules/checkAccess.cjs +0 -40
- package/dist/rules/checkAccess.cjs.map +0 -1
- package/dist/rules/checkAlignment.cjs +0 -78
- package/dist/rules/checkAlignment.cjs.map +0 -1
- package/dist/rules/checkExamples.cjs +0 -521
- package/dist/rules/checkExamples.cjs.map +0 -1
- package/dist/rules/checkIndentation.cjs +0 -170
- package/dist/rules/checkIndentation.cjs.map +0 -1
- package/dist/rules/checkLineAlignment.cjs +0 -398
- package/dist/rules/checkLineAlignment.cjs.map +0 -1
- package/dist/rules/checkParamNames.cjs +0 -407
- package/dist/rules/checkParamNames.cjs.map +0 -1
- package/dist/rules/checkPropertyNames.cjs +0 -135
- package/dist/rules/checkPropertyNames.cjs.map +0 -1
- package/dist/rules/checkSyntax.cjs +0 -38
- package/dist/rules/checkSyntax.cjs.map +0 -1
- package/dist/rules/checkTagNames.cjs +0 -312
- package/dist/rules/checkTagNames.cjs.map +0 -1
- package/dist/rules/checkTemplateNames.cjs +0 -192
- package/dist/rules/checkTemplateNames.cjs.map +0 -1
- package/dist/rules/checkTypes.cjs +0 -111
- package/dist/rules/checkTypes.cjs.map +0 -1
- package/dist/rules/checkValues.cjs +0 -166
- package/dist/rules/checkValues.cjs.map +0 -1
- package/dist/rules/convertToJsdocComments.cjs +0 -356
- package/dist/rules/convertToJsdocComments.cjs.map +0 -1
- package/dist/rules/emptyTags.cjs +0 -98
- package/dist/rules/emptyTags.cjs.map +0 -1
- package/dist/rules/escapeInlineTags.cjs +0 -234
- package/dist/rules/escapeInlineTags.cjs.map +0 -1
- package/dist/rules/implementsOnClasses.cjs +0 -74
- package/dist/rules/implementsOnClasses.cjs.map +0 -1
- package/dist/rules/importsAsDependencies.cjs +0 -104
- package/dist/rules/importsAsDependencies.cjs.map +0 -1
- package/dist/rules/informativeDocs.cjs +0 -187
- package/dist/rules/informativeDocs.cjs.map +0 -1
- package/dist/rules/linesBeforeBlock.cjs +0 -120
- package/dist/rules/linesBeforeBlock.cjs.map +0 -1
- package/dist/rules/matchDescription.cjs +0 -356
- package/dist/rules/matchDescription.cjs.map +0 -1
- package/dist/rules/matchName.cjs +0 -160
- package/dist/rules/matchName.cjs.map +0 -1
- package/dist/rules/multilineBlocks.cjs +0 -431
- package/dist/rules/multilineBlocks.cjs.map +0 -1
- package/dist/rules/noBadBlocks.cjs +0 -100
- package/dist/rules/noBadBlocks.cjs.map +0 -1
- package/dist/rules/noBlankBlockDescriptions.cjs +0 -63
- package/dist/rules/noBlankBlockDescriptions.cjs.map +0 -1
- package/dist/rules/noBlankBlocks.cjs +0 -54
- package/dist/rules/noBlankBlocks.cjs.map +0 -1
- package/dist/rules/noDefaults.cjs +0 -102
- package/dist/rules/noDefaults.cjs.map +0 -1
- package/dist/rules/noMissingSyntax.cjs +0 -196
- package/dist/rules/noMissingSyntax.cjs.map +0 -1
- package/dist/rules/noMultiAsterisks.cjs +0 -126
- package/dist/rules/noMultiAsterisks.cjs.map +0 -1
- package/dist/rules/noRestrictedSyntax.cjs +0 -68
- package/dist/rules/noRestrictedSyntax.cjs.map +0 -1
- package/dist/rules/noTypes.cjs +0 -101
- package/dist/rules/noTypes.cjs.map +0 -1
- package/dist/rules/noUndefinedTypes.cjs +0 -616
- package/dist/rules/noUndefinedTypes.cjs.map +0 -1
- package/dist/rules/normalizeSeeLinks.cjs +0 -271
- package/dist/rules/normalizeSeeLinks.cjs.map +0 -1
- package/dist/rules/preferImportTag.cjs +0 -362
- package/dist/rules/preferImportTag.cjs.map +0 -1
- package/dist/rules/requireAsteriskPrefix.cjs +0 -190
- package/dist/rules/requireAsteriskPrefix.cjs.map +0 -1
- package/dist/rules/requireDescription.cjs +0 -164
- package/dist/rules/requireDescription.cjs.map +0 -1
- package/dist/rules/requireDescriptionCompleteSentence.cjs +0 -321
- package/dist/rules/requireDescriptionCompleteSentence.cjs.map +0 -1
- package/dist/rules/requireExample.cjs +0 -136
- package/dist/rules/requireExample.cjs.map +0 -1
- package/dist/rules/requireFileOverview.cjs +0 -194
- package/dist/rules/requireFileOverview.cjs.map +0 -1
- package/dist/rules/requireHyphenBeforeParamDescription.cjs +0 -166
- package/dist/rules/requireHyphenBeforeParamDescription.cjs.map +0 -1
- package/dist/rules/requireJsdoc.cjs +0 -721
- package/dist/rules/requireJsdoc.cjs.map +0 -1
- package/dist/rules/requireParam.cjs +0 -772
- package/dist/rules/requireParam.cjs.map +0 -1
- package/dist/rules/requireParamDescription.cjs +0 -105
- package/dist/rules/requireParamDescription.cjs.map +0 -1
- package/dist/rules/requireParamName.cjs +0 -68
- package/dist/rules/requireParamName.cjs.map +0 -1
- package/dist/rules/requireParamType.cjs +0 -104
- package/dist/rules/requireParamType.cjs.map +0 -1
- package/dist/rules/requireProperty.cjs +0 -63
- package/dist/rules/requireProperty.cjs.map +0 -1
- package/dist/rules/requirePropertyDescription.cjs +0 -29
- package/dist/rules/requirePropertyDescription.cjs.map +0 -1
- package/dist/rules/requirePropertyName.cjs +0 -29
- package/dist/rules/requirePropertyName.cjs.map +0 -1
- package/dist/rules/requirePropertyType.cjs +0 -29
- package/dist/rules/requirePropertyType.cjs.map +0 -1
- package/dist/rules/requireRejects.cjs +0 -226
- package/dist/rules/requireRejects.cjs.map +0 -1
- package/dist/rules/requireReturns.cjs +0 -262
- package/dist/rules/requireReturns.cjs.map +0 -1
- package/dist/rules/requireReturnsCheck.cjs +0 -225
- package/dist/rules/requireReturnsCheck.cjs.map +0 -1
- package/dist/rules/requireReturnsDescription.cjs +0 -72
- package/dist/rules/requireReturnsDescription.cjs.map +0 -1
- package/dist/rules/requireReturnsType.cjs +0 -68
- package/dist/rules/requireReturnsType.cjs.map +0 -1
- package/dist/rules/requireTags.cjs +0 -74
- package/dist/rules/requireTags.cjs.map +0 -1
- package/dist/rules/requireTemplate.cjs +0 -220
- package/dist/rules/requireTemplate.cjs.map +0 -1
- package/dist/rules/requireThrows.cjs +0 -118
- package/dist/rules/requireThrows.cjs.map +0 -1
- package/dist/rules/requireYields.cjs +0 -224
- package/dist/rules/requireYields.cjs.map +0 -1
- package/dist/rules/requireYieldsCheck.cjs +0 -179
- package/dist/rules/requireYieldsCheck.cjs.map +0 -1
- package/dist/rules/sortTags.cjs +0 -656
- package/dist/rules/sortTags.cjs.map +0 -1
- package/dist/rules/tagLines.cjs +0 -374
- package/dist/rules/tagLines.cjs.map +0 -1
- package/dist/rules/textEscaping.cjs +0 -141
- package/dist/rules/textEscaping.cjs.map +0 -1
- package/dist/rules/tsMethodSignatureStyle.cjs +0 -240
- package/dist/rules/tsMethodSignatureStyle.cjs.map +0 -1
- package/dist/rules/tsNoEmptyObjectType.cjs +0 -62
- package/dist/rules/tsNoEmptyObjectType.cjs.map +0 -1
- package/dist/rules/tsNoUnnecessaryTemplateExpression.cjs +0 -104
- package/dist/rules/tsNoUnnecessaryTemplateExpression.cjs.map +0 -1
- package/dist/rules/tsPreferFunctionType.cjs +0 -110
- package/dist/rules/tsPreferFunctionType.cjs.map +0 -1
- package/dist/rules/typeFormatting.cjs +0 -607
- package/dist/rules/typeFormatting.cjs.map +0 -1
- package/dist/rules/validTypes.cjs +0 -324
- package/dist/rules/validTypes.cjs.map +0 -1
- package/dist/tagNames.cjs +0 -244
- package/dist/tagNames.cjs.map +0 -1
- package/dist/to-valid-identifier.cjs +0 -263
- package/dist/utils/hasReturnValue.cjs +0 -495
- package/dist/utils/hasReturnValue.cjs.map +0 -1
- package/rollup.config.js +0 -16
- package/src/getJsdocProcessorPlugin.cts +0 -5
- package/src/index-cjs.js +0 -758
- package/src/index-esm.js +0 -196
- package/src/index.cjs.cts +0 -3
- package/src/iterateJsdoc.cts +0 -7
package/README.md
CHANGED
|
@@ -13,18 +13,10 @@ npm install @depup/eslint-plugin-jsdoc
|
|
|
13
13
|
|
|
14
14
|
| Field | Value |
|
|
15
15
|
|-------|-------|
|
|
16
|
-
| Original | [eslint-plugin-jsdoc](https://www.npmjs.com/package/eslint-plugin-jsdoc) @
|
|
17
|
-
| Processed | 2026-
|
|
16
|
+
| Original | [eslint-plugin-jsdoc](https://www.npmjs.com/package/eslint-plugin-jsdoc) @ 64.0.0 |
|
|
17
|
+
| Processed | 2026-08-08 |
|
|
18
18
|
| Smoke test | passed |
|
|
19
|
-
| Deps updated |
|
|
20
|
-
|
|
21
|
-
## Dependency Changes
|
|
22
|
-
|
|
23
|
-
| Dependency | From | To |
|
|
24
|
-
|------------|------|-----|
|
|
25
|
-
| @es-joy/jsdoccomment | ~0.91.0 | ^0.92.0 |
|
|
26
|
-
| are-docs-informative | ^0.0.2 | ^0.1.1 |
|
|
27
|
-
| escape-string-regexp | ^4.0.0 | ^5.0.0 |
|
|
19
|
+
| Deps updated | 0 |
|
|
28
20
|
|
|
29
21
|
---
|
|
30
22
|
|
package/changes.json
CHANGED
|
@@ -1,18 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"bumped": {
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
"to": "^0.92.0"
|
|
6
|
-
},
|
|
7
|
-
"are-docs-informative": {
|
|
8
|
-
"from": "^0.0.2",
|
|
9
|
-
"to": "^0.1.1"
|
|
10
|
-
},
|
|
11
|
-
"escape-string-regexp": {
|
|
12
|
-
"from": "^4.0.0",
|
|
13
|
-
"to": "^5.0.0"
|
|
14
|
-
}
|
|
15
|
-
},
|
|
16
|
-
"timestamp": "2026-07-31T00:40:46.977Z",
|
|
17
|
-
"totalUpdated": 3
|
|
2
|
+
"bumped": {},
|
|
3
|
+
"timestamp": "2026-08-08T00:23:04.685Z",
|
|
4
|
+
"totalUpdated": 0
|
|
18
5
|
}
|
package/dist/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@ export default index;
|
|
|
2
2
|
/**
|
|
3
3
|
* @type {((
|
|
4
4
|
* cfg?: import('eslint').Linter.Config & {
|
|
5
|
-
* config?:
|
|
5
|
+
* config?: FlatConfigNames,
|
|
6
6
|
* mergeSettings?: boolean,
|
|
7
7
|
* settings?: Partial<import('./iterateJsdoc.js').Settings>,
|
|
8
8
|
* rules?: {[key in keyof import('./rules.d.ts').Rules]?: import('eslint').Linter.RuleEntry<import('./rules.d.ts').Rules[key]>},
|
|
@@ -36,7 +36,7 @@ export default index;
|
|
|
36
36
|
* ) => import('eslint').Linter.Config)}
|
|
37
37
|
*/
|
|
38
38
|
export const jsdoc: ((cfg?: import("eslint").Linter.Config & {
|
|
39
|
-
config?:
|
|
39
|
+
config?: FlatConfigNames;
|
|
40
40
|
mergeSettings?: boolean;
|
|
41
41
|
settings?: Partial<import("./iterateJsdoc.js").Settings>;
|
|
42
42
|
rules?: { [key in keyof import("./rules.d.ts").Rules]?: import("eslint").Linter.RuleEntry<import("./rules.d.ts").Rules[key]>; };
|
|
@@ -71,13 +71,16 @@ export { getJsdocProcessorPlugin } from "./getJsdocProcessorPlugin.js";
|
|
|
71
71
|
export type ConfigGroups = "recommended" | "stylistic" | "contents" | "logical" | "requirements";
|
|
72
72
|
export type ConfigVariants = "" | "-typescript" | "-typescript-flavor";
|
|
73
73
|
export type ErrorLevelVariants = "" | "-error";
|
|
74
|
+
export type FlatConfigNames = `flat/${ConfigGroups}${ConfigVariants}${ErrorLevelVariants}` | "flat/recommended-tsdoc" | "flat/recommended-tsdoc-error";
|
|
74
75
|
/**
|
|
75
76
|
* @typedef {"recommended" | "stylistic" | "contents" | "logical" | "requirements"} ConfigGroups
|
|
76
77
|
* @typedef {"" | "-typescript" | "-typescript-flavor"} ConfigVariants
|
|
77
78
|
* @typedef {"" | "-error"} ErrorLevelVariants
|
|
79
|
+
* @typedef {`flat/${ConfigGroups}${ConfigVariants}${ErrorLevelVariants}` |
|
|
80
|
+
* "flat/recommended-tsdoc" | "flat/recommended-tsdoc-error"} FlatConfigNames
|
|
78
81
|
* @type {import('eslint').ESLint.Plugin & {
|
|
79
82
|
* configs: Record<
|
|
80
|
-
*
|
|
83
|
+
* FlatConfigNames,
|
|
81
84
|
* import('eslint').Linter.Config
|
|
82
85
|
* > &
|
|
83
86
|
* Record<
|
|
@@ -88,6 +91,6 @@ export type ErrorLevelVariants = "" | "-error";
|
|
|
88
91
|
* }}
|
|
89
92
|
*/
|
|
90
93
|
declare const index: import("eslint").ESLint.Plugin & {
|
|
91
|
-
configs: Record
|
|
94
|
+
configs: Record<FlatConfigNames, import("eslint").Linter.Config> & Record<"examples" | "default-expressions" | "examples-and-default-expressions", import("eslint").Linter.Config[]> & Record<"flat/recommended-mixed", import("eslint").Linter.Config[]>;
|
|
92
95
|
};
|
|
93
96
|
//# sourceMappingURL=index.d.ts.map
|
package/package.json
CHANGED
|
@@ -5,10 +5,10 @@
|
|
|
5
5
|
"url": "http://gajus.com"
|
|
6
6
|
},
|
|
7
7
|
"dependencies": {
|
|
8
|
-
"@es-joy/jsdoccomment": "
|
|
8
|
+
"@es-joy/jsdoccomment": "~0.93.1",
|
|
9
9
|
"@es-joy/resolve.exports": "1.2.0",
|
|
10
10
|
"are-docs-informative": "^0.1.1",
|
|
11
|
-
"comment-parser": "1.4.
|
|
11
|
+
"comment-parser": "1.4.8",
|
|
12
12
|
"debug": "^4.4.3",
|
|
13
13
|
"escape-string-regexp": "^5.0.0",
|
|
14
14
|
"espree": "^11.2.0",
|
|
@@ -23,16 +23,14 @@
|
|
|
23
23
|
"description": "JSDoc linting rules for ESLint. (with updated dependencies)",
|
|
24
24
|
"devDependencies": {
|
|
25
25
|
"@arethetypeswrong/cli": "^0.18.5",
|
|
26
|
-
"@babel/cli": "8.0.4",
|
|
27
26
|
"@babel/core": "8.0.1",
|
|
28
27
|
"@babel/eslint-parser": "8.0.1",
|
|
29
28
|
"@babel/plugin-transform-flow-strip-types": "8.0.1",
|
|
30
29
|
"@babel/preset-env": "8.0.2",
|
|
31
30
|
"@es-joy/escodegen": "^4.2.0",
|
|
32
|
-
"@es-joy/jsdoc-eslint-parser": "^0.
|
|
31
|
+
"@es-joy/jsdoc-eslint-parser": "^0.28.0",
|
|
33
32
|
"@eslint/core": "^1.2.1",
|
|
34
33
|
"@hkdobrev/run-if-changed": "^0.9.0",
|
|
35
|
-
"@rollup/plugin-node-resolve": "^16.0.3",
|
|
36
34
|
"@semantic-release/commit-analyzer": "^13.0.1",
|
|
37
35
|
"@semantic-release/github": "^12.0.9",
|
|
38
36
|
"@semantic-release/npm": "^13.1.5",
|
|
@@ -42,41 +40,39 @@
|
|
|
42
40
|
"@types/estree": "^1.0.9",
|
|
43
41
|
"@types/json-schema": "^7.0.15",
|
|
44
42
|
"@types/mocha": "^10.0.10",
|
|
45
|
-
"@types/node": "^26.
|
|
46
|
-
"@types/semver": "^7.
|
|
43
|
+
"@types/node": "^26.2.0",
|
|
44
|
+
"@types/semver": "^7.8.0",
|
|
47
45
|
"@types/spdx-expression-parse": "^4.0.0",
|
|
48
|
-
"@typescript-eslint/types": "8.
|
|
46
|
+
"@typescript-eslint/types": "8.66.0",
|
|
49
47
|
"babel-plugin-add-module-exports": "^1.0.4",
|
|
50
|
-
"babel-plugin-istanbul": "^8.0.0",
|
|
51
48
|
"babel-plugin-transform-import-meta": "^3.0.0",
|
|
52
49
|
"c8": "^12.0.0",
|
|
53
50
|
"camelcase": "^9.0.0",
|
|
54
51
|
"chai": "^6.2.2",
|
|
55
52
|
"decamelize": "^6.0.1",
|
|
56
|
-
"eslint": "10.8.
|
|
53
|
+
"eslint": "10.8.1",
|
|
57
54
|
"eslint-config-canonical": "^47.4.2",
|
|
58
55
|
"gitdown": "^4.1.1",
|
|
59
56
|
"glob": "^13.0.6",
|
|
60
|
-
"globals": "^17.
|
|
57
|
+
"globals": "^17.9.0",
|
|
61
58
|
"husky": "^9.1.7",
|
|
62
|
-
"jsdoc-type-pratt-parser": "^
|
|
59
|
+
"jsdoc-type-pratt-parser": "^9.0.0",
|
|
63
60
|
"json-schema": "^0.4.0",
|
|
64
61
|
"json-schema-to-typescript": "^15.0.4",
|
|
65
|
-
"lint-staged": "^17.
|
|
66
|
-
"mocha": "^11.
|
|
62
|
+
"lint-staged": "^17.3.0",
|
|
63
|
+
"mocha": "^11.8.0",
|
|
67
64
|
"open-editor": "^6.0.0",
|
|
68
|
-
"playwright": "^1.62.
|
|
65
|
+
"playwright": "^1.62.1",
|
|
69
66
|
"replace": "^1.2.2",
|
|
70
67
|
"rimraf": "^6.1.3",
|
|
71
|
-
"
|
|
72
|
-
"semantic-release": "^25.0.8",
|
|
68
|
+
"semantic-release": "^25.0.9",
|
|
73
69
|
"sinon": "^22.1.0",
|
|
74
70
|
"ts-api-utils": "^2.5.0",
|
|
75
71
|
"typescript": "5.9.3",
|
|
76
|
-
"typescript-eslint": "8.
|
|
72
|
+
"typescript-eslint": "8.66.0"
|
|
77
73
|
},
|
|
78
74
|
"engines": {
|
|
79
|
-
"node": "^22.
|
|
75
|
+
"node": "^22.22.2 || >=24.15.0"
|
|
80
76
|
},
|
|
81
77
|
"keywords": [
|
|
82
78
|
"eslint-plugin-jsdoc",
|
|
@@ -94,38 +90,19 @@
|
|
|
94
90
|
"*.js": "eslint --fix"
|
|
95
91
|
},
|
|
96
92
|
"type": "module",
|
|
97
|
-
"main": "./dist/index.cjs",
|
|
98
93
|
"types": "./dist/index.d.ts",
|
|
99
94
|
"exports": {
|
|
100
95
|
".": {
|
|
101
|
-
"
|
|
102
|
-
|
|
103
|
-
"default": "./src/index.js"
|
|
104
|
-
},
|
|
105
|
-
"require": {
|
|
106
|
-
"types": "./dist/cjs/index.cjs.d.cts",
|
|
107
|
-
"default": "./dist/index-cjs.cjs"
|
|
108
|
-
}
|
|
96
|
+
"types": "./dist/index.d.ts",
|
|
97
|
+
"default": "./src/index.js"
|
|
109
98
|
},
|
|
110
99
|
"./getJsdocProcessorPlugin.js": {
|
|
111
|
-
"
|
|
112
|
-
|
|
113
|
-
"default": "./src/getJsdocProcessorPlugin.js"
|
|
114
|
-
},
|
|
115
|
-
"require": {
|
|
116
|
-
"types": "./dist/cjs/getJsdocProcessorPlugin.d.cts",
|
|
117
|
-
"default": "./dist/getJsdocProcessorPlugin.cjs"
|
|
118
|
-
}
|
|
100
|
+
"types": "./dist/getJsdocProcessorPlugin.d.ts",
|
|
101
|
+
"default": "./src/getJsdocProcessorPlugin.js"
|
|
119
102
|
},
|
|
120
103
|
"./iterateJsdoc.js": {
|
|
121
|
-
"
|
|
122
|
-
|
|
123
|
-
"default": "./src/iterateJsdoc.js"
|
|
124
|
-
},
|
|
125
|
-
"require": {
|
|
126
|
-
"types": "./dist/cjs/iterateJsdoc.d.cts",
|
|
127
|
-
"default": "./dist/iterateJsdoc.cjs"
|
|
128
|
-
}
|
|
104
|
+
"types": "./dist/iterateJsdoc.d.ts",
|
|
105
|
+
"default": "./src/iterateJsdoc.js"
|
|
129
106
|
}
|
|
130
107
|
},
|
|
131
108
|
"name": "@depup/eslint-plugin-jsdoc",
|
|
@@ -168,10 +145,8 @@
|
|
|
168
145
|
"ruleTypes": "node ./src/bin/generateRuleTypes.js",
|
|
169
146
|
"tsc": "tsc",
|
|
170
147
|
"tsc-build": "tsc -p tsconfig-prod.json",
|
|
171
|
-
"
|
|
172
|
-
"
|
|
173
|
-
"build": "node ./src/bin/buildEntryFileForTS.js && rimraf ./dist && mkdir dist && pnpm rollup && NODE_ENV=production babel ./src --out-file-extension .cjs --out-dir ./dist --copy-files --source-maps --ignore ./src/bin/*.js --no-copy-ignored && replace 'to-valid-identifier' '../to-valid-identifier.cjs' 'dist' -r --include=\"*.cjs\" && replace 'require\\(\"\\.(.*?)\\.[^.]*?\"\\)' 'require(\".$1.cjs\")' 'dist' -r --include=\"*.cjs\" && pnpm tsc-build && pnpm tsc-cjs",
|
|
174
|
-
"attw": "attw --pack .",
|
|
148
|
+
"build": "rimraf ./dist && mkdir dist && pnpm tsc-build && cp src/rules.d.ts dist/rules.d.ts",
|
|
149
|
+
"attw": "attw --profile esm-only --pack .",
|
|
175
150
|
"check-docs": "node ./src/bin/generateDocs.js --check",
|
|
176
151
|
"create-docs": "pnpm run create-options && node ./src/bin/generateDocs.js && pnpm ruleTypes",
|
|
177
152
|
"create-rule": "node ./src/bin/generateRule.js",
|
|
@@ -180,31 +155,18 @@
|
|
|
180
155
|
"inspect-config": "eslint --inspect-config",
|
|
181
156
|
"lint": "eslint",
|
|
182
157
|
"lint-fix": "eslint --fix",
|
|
183
|
-
"test-no-cov": "
|
|
158
|
+
"test-no-cov": "mocha",
|
|
184
159
|
"test": "c8 pnpm run test-no-cov",
|
|
185
160
|
"test-cov": "TIMING=1 c8 --reporter text pnpm run test-no-cov",
|
|
186
161
|
"test-index": "pnpm run test-no-cov test/rules/index.js"
|
|
187
162
|
},
|
|
188
|
-
"version": "
|
|
163
|
+
"version": "64.0.0-depup.0",
|
|
189
164
|
"depup": {
|
|
190
|
-
"changes": {
|
|
191
|
-
|
|
192
|
-
"from": "~0.91.0",
|
|
193
|
-
"to": "^0.92.0"
|
|
194
|
-
},
|
|
195
|
-
"are-docs-informative": {
|
|
196
|
-
"from": "^0.0.2",
|
|
197
|
-
"to": "^0.1.1"
|
|
198
|
-
},
|
|
199
|
-
"escape-string-regexp": {
|
|
200
|
-
"from": "^4.0.0",
|
|
201
|
-
"to": "^5.0.0"
|
|
202
|
-
}
|
|
203
|
-
},
|
|
204
|
-
"depsUpdated": 3,
|
|
165
|
+
"changes": {},
|
|
166
|
+
"depsUpdated": 0,
|
|
205
167
|
"originalPackage": "eslint-plugin-jsdoc",
|
|
206
|
-
"originalVersion": "
|
|
207
|
-
"processedAt": "2026-
|
|
168
|
+
"originalVersion": "64.0.0",
|
|
169
|
+
"processedAt": "2026-08-08T00:23:21.527Z",
|
|
208
170
|
"smokeTest": "passed"
|
|
209
171
|
}
|
|
210
172
|
}
|
package/src/index.js
CHANGED
|
@@ -1,9 +1,3 @@
|
|
|
1
|
-
/* AUTO-GENERATED BY build SCRIPT */
|
|
2
|
-
/* eslint-disable perfectionist/sort-imports -- For auto-generate; Do not remove */
|
|
3
|
-
import {
|
|
4
|
-
merge,
|
|
5
|
-
} from 'object-deep-merge';
|
|
6
|
-
|
|
7
1
|
import {
|
|
8
2
|
buildForbidRuleDefinition,
|
|
9
3
|
} from './buildForbidRuleDefinition.js';
|
|
@@ -83,15 +77,20 @@ import validTypes from './rules/validTypes.js';
|
|
|
83
77
|
import {
|
|
84
78
|
ESLint,
|
|
85
79
|
} from 'eslint';
|
|
80
|
+
import {
|
|
81
|
+
merge,
|
|
82
|
+
} from 'object-deep-merge';
|
|
86
83
|
import semver from 'semver';
|
|
87
84
|
|
|
88
85
|
/**
|
|
89
86
|
* @typedef {"recommended" | "stylistic" | "contents" | "logical" | "requirements"} ConfigGroups
|
|
90
87
|
* @typedef {"" | "-typescript" | "-typescript-flavor"} ConfigVariants
|
|
91
88
|
* @typedef {"" | "-error"} ErrorLevelVariants
|
|
89
|
+
* @typedef {`flat/${ConfigGroups}${ConfigVariants}${ErrorLevelVariants}` |
|
|
90
|
+
* "flat/recommended-tsdoc" | "flat/recommended-tsdoc-error"} FlatConfigNames
|
|
92
91
|
* @type {import('eslint').ESLint.Plugin & {
|
|
93
92
|
* configs: Record<
|
|
94
|
-
*
|
|
93
|
+
* FlatConfigNames,
|
|
95
94
|
* import('eslint').Linter.Config
|
|
96
95
|
* > &
|
|
97
96
|
* Record<
|
|
@@ -766,7 +765,7 @@ export default index;
|
|
|
766
765
|
/**
|
|
767
766
|
* @type {((
|
|
768
767
|
* cfg?: import('eslint').Linter.Config & {
|
|
769
|
-
* config?:
|
|
768
|
+
* config?: FlatConfigNames,
|
|
770
769
|
* mergeSettings?: boolean,
|
|
771
770
|
* settings?: Partial<import('./iterateJsdoc.js').Settings>,
|
|
772
771
|
* rules?: {[key in keyof import('./rules.d.ts').Rules]?: import('eslint').Linter.RuleEntry<import('./rules.d.ts').Rules[key]>},
|
package/dist/WarnSettings.cjs
DELETED
|
@@ -1,38 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
|
|
3
|
-
Object.defineProperty(exports, "__esModule", {
|
|
4
|
-
value: true
|
|
5
|
-
});
|
|
6
|
-
exports.default = void 0;
|
|
7
|
-
const WarnSettings = function () {
|
|
8
|
-
/** @type {WeakMap<object, Set<string>>} */
|
|
9
|
-
const warnedSettings = new WeakMap();
|
|
10
|
-
return {
|
|
11
|
-
/**
|
|
12
|
-
* Warn only once for each context and setting
|
|
13
|
-
* @param {import('eslint').Rule.RuleContext} context
|
|
14
|
-
* @param {string} setting
|
|
15
|
-
* @returns {boolean}
|
|
16
|
-
*/
|
|
17
|
-
hasBeenWarned(context, setting) {
|
|
18
|
-
return warnedSettings.has(context) && /** @type {Set<string>} */warnedSettings.get(context).has(setting);
|
|
19
|
-
},
|
|
20
|
-
/**
|
|
21
|
-
* @param {import('eslint').Rule.RuleContext} context
|
|
22
|
-
* @param {string} setting
|
|
23
|
-
* @returns {void}
|
|
24
|
-
*/
|
|
25
|
-
markSettingAsWarned(context, setting) {
|
|
26
|
-
// c8 ignore else
|
|
27
|
-
if (!warnedSettings.has(context)) {
|
|
28
|
-
warnedSettings.set(context, new Set());
|
|
29
|
-
}
|
|
30
|
-
|
|
31
|
-
/** @type {Set<string>} */
|
|
32
|
-
warnedSettings.get(context).add(setting);
|
|
33
|
-
}
|
|
34
|
-
};
|
|
35
|
-
};
|
|
36
|
-
var _default = exports.default = WarnSettings;
|
|
37
|
-
module.exports = exports.default;
|
|
38
|
-
//# sourceMappingURL=WarnSettings.cjs.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"WarnSettings.cjs","names":[],"sources":["../src/WarnSettings.js"],"sourcesContent":["const WarnSettings = function () {\n /** @type {WeakMap<object, Set<string>>} */\n const warnedSettings = new WeakMap();\n\n return {\n /**\n * Warn only once for each context and setting\n * @param {import('eslint').Rule.RuleContext} context\n * @param {string} setting\n * @returns {boolean}\n */\n hasBeenWarned (context, setting) {\n return warnedSettings.has(context) && /** @type {Set<string>} */ (\n warnedSettings.get(context)\n ).has(setting);\n },\n\n /**\n * @param {import('eslint').Rule.RuleContext} context\n * @param {string} setting\n * @returns {void}\n */\n markSettingAsWarned (context, setting) {\n // c8 ignore else\n if (!warnedSettings.has(context)) {\n warnedSettings.set(context, new Set());\n }\n\n /** @type {Set<string>} */ (warnedSettings.get(context)).add(setting);\n },\n };\n};\n\nexport default WarnSettings;\n"],"mappings":";;;;;;AAAA,MAAM,YAAY,GAAG,YAAY;EAC/B;EACA,MAAM,cAAc,GAAG,IAAI,OAAO,CAAC,CAAC;EAEpC,OAAO;IACL;AACJ;AACA;AACA;AACA;AACA;IACI,aAAa,CAAE,OAAO,EAAE,OAAO,EAAE;MAC/B,OAAO,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,0BACpC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,CAC3B,GAAG,CAAC,OAAO,CAAC;IAChB,CAAC;IAED;AACJ;AACA;AACA;AACA;IACI,mBAAmB,CAAE,OAAO,EAAE,OAAO,EAAE;MACrC;MACA,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;QAChC,cAAc,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC;MACxC;;MAEA;MAA4B,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,CAAE,GAAG,CAAC,OAAO,CAAC;IACvE;EACF,CAAC;AACH,CAAC;AAAC,iCAEa,YAAY;AAAA","ignoreList":[]}
|