eslint-plugin-jsdoc 46.4.5 → 46.4.6

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.
Files changed (136) hide show
  1. package/dist/WarnSettings.d.ts +17 -0
  2. package/dist/WarnSettings.d.ts.map +1 -0
  3. package/dist/alignTransform.d.ts +32 -0
  4. package/dist/alignTransform.d.ts.map +1 -0
  5. package/dist/alignTransform.js +5 -5
  6. package/dist/alignTransform.js.map +1 -1
  7. package/dist/defaultTagOrder.d.ts +5 -0
  8. package/dist/defaultTagOrder.d.ts.map +1 -0
  9. package/dist/exportParser.d.ts +41 -0
  10. package/dist/exportParser.d.ts.map +1 -0
  11. package/dist/getDefaultTagStructureForMode.d.ts +11 -0
  12. package/dist/getDefaultTagStructureForMode.d.ts.map +1 -0
  13. package/dist/index.d.ts +10 -0
  14. package/dist/index.d.ts.map +1 -0
  15. package/dist/iterateJsdoc.d.ts +460 -0
  16. package/dist/iterateJsdoc.d.ts.map +1 -0
  17. package/dist/iterateJsdoc.js +1 -1
  18. package/dist/iterateJsdoc.js.map +1 -1
  19. package/dist/jsdocUtils.d.ts +421 -0
  20. package/dist/jsdocUtils.d.ts.map +1 -0
  21. package/dist/rules/checkAccess.d.ts +3 -0
  22. package/dist/rules/checkAccess.d.ts.map +1 -0
  23. package/dist/rules/checkAlignment.d.ts +3 -0
  24. package/dist/rules/checkAlignment.d.ts.map +1 -0
  25. package/dist/rules/checkExamples.d.ts +4 -0
  26. package/dist/rules/checkExamples.d.ts.map +1 -0
  27. package/dist/rules/checkExamples.js +12 -6
  28. package/dist/rules/checkExamples.js.map +1 -1
  29. package/dist/rules/checkIndentation.d.ts +3 -0
  30. package/dist/rules/checkIndentation.d.ts.map +1 -0
  31. package/dist/rules/checkLineAlignment.d.ts +10 -0
  32. package/dist/rules/checkLineAlignment.d.ts.map +1 -0
  33. package/dist/rules/checkParamNames.d.ts +3 -0
  34. package/dist/rules/checkParamNames.d.ts.map +1 -0
  35. package/dist/rules/checkPropertyNames.d.ts +3 -0
  36. package/dist/rules/checkPropertyNames.d.ts.map +1 -0
  37. package/dist/rules/checkSyntax.d.ts +3 -0
  38. package/dist/rules/checkSyntax.d.ts.map +1 -0
  39. package/dist/rules/checkTagNames.d.ts +3 -0
  40. package/dist/rules/checkTagNames.d.ts.map +1 -0
  41. package/dist/rules/checkTypes.d.ts +3 -0
  42. package/dist/rules/checkTypes.d.ts.map +1 -0
  43. package/dist/rules/checkValues.d.ts +3 -0
  44. package/dist/rules/checkValues.d.ts.map +1 -0
  45. package/dist/rules/emptyTags.d.ts +3 -0
  46. package/dist/rules/emptyTags.d.ts.map +1 -0
  47. package/dist/rules/implementsOnClasses.d.ts +3 -0
  48. package/dist/rules/implementsOnClasses.d.ts.map +1 -0
  49. package/dist/rules/importsAsDependencies.d.ts +3 -0
  50. package/dist/rules/importsAsDependencies.d.ts.map +1 -0
  51. package/dist/rules/informativeDocs.d.ts +3 -0
  52. package/dist/rules/informativeDocs.d.ts.map +1 -0
  53. package/dist/rules/matchDescription.d.ts +3 -0
  54. package/dist/rules/matchDescription.d.ts.map +1 -0
  55. package/dist/rules/matchName.d.ts +3 -0
  56. package/dist/rules/matchName.d.ts.map +1 -0
  57. package/dist/rules/multilineBlocks.d.ts +3 -0
  58. package/dist/rules/multilineBlocks.d.ts.map +1 -0
  59. package/dist/rules/noBadBlocks.d.ts +3 -0
  60. package/dist/rules/noBadBlocks.d.ts.map +1 -0
  61. package/dist/rules/noBlankBlockDescriptions.d.ts +3 -0
  62. package/dist/rules/noBlankBlockDescriptions.d.ts.map +1 -0
  63. package/dist/rules/noBlankBlocks.d.ts +3 -0
  64. package/dist/rules/noBlankBlocks.d.ts.map +1 -0
  65. package/dist/rules/noDefaults.d.ts +3 -0
  66. package/dist/rules/noDefaults.d.ts.map +1 -0
  67. package/dist/rules/noMissingSyntax.d.ts +10 -0
  68. package/dist/rules/noMissingSyntax.d.ts.map +1 -0
  69. package/dist/rules/noMultiAsterisks.d.ts +3 -0
  70. package/dist/rules/noMultiAsterisks.d.ts.map +1 -0
  71. package/dist/rules/noRestrictedSyntax.d.ts +3 -0
  72. package/dist/rules/noRestrictedSyntax.d.ts.map +1 -0
  73. package/dist/rules/noTypes.d.ts +3 -0
  74. package/dist/rules/noTypes.d.ts.map +1 -0
  75. package/dist/rules/noUndefinedTypes.d.ts +3 -0
  76. package/dist/rules/noUndefinedTypes.d.ts.map +1 -0
  77. package/dist/rules/requireAsteriskPrefix.d.ts +3 -0
  78. package/dist/rules/requireAsteriskPrefix.d.ts.map +1 -0
  79. package/dist/rules/requireDescription.d.ts +3 -0
  80. package/dist/rules/requireDescription.d.ts.map +1 -0
  81. package/dist/rules/requireDescriptionCompleteSentence.d.ts +3 -0
  82. package/dist/rules/requireDescriptionCompleteSentence.d.ts.map +1 -0
  83. package/dist/rules/requireExample.d.ts +3 -0
  84. package/dist/rules/requireExample.d.ts.map +1 -0
  85. package/dist/rules/requireFileOverview.d.ts +3 -0
  86. package/dist/rules/requireFileOverview.d.ts.map +1 -0
  87. package/dist/rules/requireHyphenBeforeParamDescription.d.ts +3 -0
  88. package/dist/rules/requireHyphenBeforeParamDescription.d.ts.map +1 -0
  89. package/dist/rules/requireJsdoc.d.ts +9 -0
  90. package/dist/rules/requireJsdoc.d.ts.map +1 -0
  91. package/dist/rules/requireParam.d.ts +4 -0
  92. package/dist/rules/requireParam.d.ts.map +1 -0
  93. package/dist/rules/requireParamDescription.d.ts +3 -0
  94. package/dist/rules/requireParamDescription.d.ts.map +1 -0
  95. package/dist/rules/requireParamName.d.ts +3 -0
  96. package/dist/rules/requireParamName.d.ts.map +1 -0
  97. package/dist/rules/requireParamType.d.ts +3 -0
  98. package/dist/rules/requireParamType.d.ts.map +1 -0
  99. package/dist/rules/requireProperty.d.ts +3 -0
  100. package/dist/rules/requireProperty.d.ts.map +1 -0
  101. package/dist/rules/requirePropertyDescription.d.ts +3 -0
  102. package/dist/rules/requirePropertyDescription.d.ts.map +1 -0
  103. package/dist/rules/requirePropertyName.d.ts +3 -0
  104. package/dist/rules/requirePropertyName.d.ts.map +1 -0
  105. package/dist/rules/requirePropertyType.d.ts +3 -0
  106. package/dist/rules/requirePropertyType.d.ts.map +1 -0
  107. package/dist/rules/requireReturns.d.ts +3 -0
  108. package/dist/rules/requireReturns.d.ts.map +1 -0
  109. package/dist/rules/requireReturnsCheck.d.ts +3 -0
  110. package/dist/rules/requireReturnsCheck.d.ts.map +1 -0
  111. package/dist/rules/requireReturnsDescription.d.ts +3 -0
  112. package/dist/rules/requireReturnsDescription.d.ts.map +1 -0
  113. package/dist/rules/requireReturnsType.d.ts +3 -0
  114. package/dist/rules/requireReturnsType.d.ts.map +1 -0
  115. package/dist/rules/requireThrows.d.ts +3 -0
  116. package/dist/rules/requireThrows.d.ts.map +1 -0
  117. package/dist/rules/requireYields.d.ts +3 -0
  118. package/dist/rules/requireYields.d.ts.map +1 -0
  119. package/dist/rules/requireYieldsCheck.d.ts +3 -0
  120. package/dist/rules/requireYieldsCheck.d.ts.map +1 -0
  121. package/dist/rules/sortTags.d.ts +3 -0
  122. package/dist/rules/sortTags.d.ts.map +1 -0
  123. package/dist/rules/tagLines.d.ts +3 -0
  124. package/dist/rules/tagLines.d.ts.map +1 -0
  125. package/dist/rules/textEscaping.d.ts +3 -0
  126. package/dist/rules/textEscaping.d.ts.map +1 -0
  127. package/dist/rules/validTypes.d.ts +3 -0
  128. package/dist/rules/validTypes.d.ts.map +1 -0
  129. package/dist/tagNames.d.ts +16 -0
  130. package/dist/tagNames.d.ts.map +1 -0
  131. package/dist/utils/hasReturnValue.d.ts +20 -0
  132. package/dist/utils/hasReturnValue.d.ts.map +1 -0
  133. package/docs/rules/imports-as-dependencies.md +1 -1
  134. package/package.json +10 -8
  135. package/tsconfig-prod.json +20 -0
  136. package/tsconfig.json +0 -1
@@ -0,0 +1 @@
1
+ {"version":3,"file":"requireYieldsCheck.d.ts","sourceRoot":"","sources":["../../src/rules/requireYieldsCheck.js"],"names":[],"mappings":""}
@@ -0,0 +1,3 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
3
+ //# sourceMappingURL=sortTags.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"sortTags.d.ts","sourceRoot":"","sources":["../../src/rules/sortTags.js"],"names":[],"mappings":""}
@@ -0,0 +1,3 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
3
+ //# sourceMappingURL=tagLines.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"tagLines.d.ts","sourceRoot":"","sources":["../../src/rules/tagLines.js"],"names":[],"mappings":""}
@@ -0,0 +1,3 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
3
+ //# sourceMappingURL=textEscaping.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"textEscaping.d.ts","sourceRoot":"","sources":["../../src/rules/textEscaping.js"],"names":[],"mappings":""}
@@ -0,0 +1,3 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
3
+ //# sourceMappingURL=validTypes.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"validTypes.d.ts","sourceRoot":"","sources":["../../src/rules/validTypes.js"],"names":[],"mappings":""}
@@ -0,0 +1,16 @@
1
+ export type AliasedTags = {
2
+ [key: string]: string[];
3
+ };
4
+ /**
5
+ * @type {AliasedTags}
6
+ */
7
+ export const closureTags: AliasedTags;
8
+ /**
9
+ * @type {AliasedTags}
10
+ */
11
+ export const jsdocTags: AliasedTags;
12
+ /**
13
+ * @type {AliasedTags}
14
+ */
15
+ export const typeScriptTags: AliasedTags;
16
+ //# sourceMappingURL=tagNames.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"tagNames.d.ts","sourceRoot":"","sources":["../src/tagNames.js"],"names":[],"mappings":";;;AAyLA;;GAEG;AACH,0BAFU,WAAW,CAyCnB;AAnNF;;GAEG;AACH,wBAFU,WAAW,CAiHnB;AAEF;;GAEG;AACH,6BAFU,WAAW,CAiBnB"}
@@ -0,0 +1,20 @@
1
+ export type ESTreeOrTypeScriptNode = import('estree').Node | any;
2
+ export type PromiseFilter = (node: ESTreeOrTypeScriptNode | undefined) => boolean;
3
+ /**
4
+ * Checks if a node has a return statement. Void return does not count.
5
+ * @param {ESTreeOrTypeScriptNode|undefined|null} node
6
+ * @param {boolean} [throwOnNullReturn]
7
+ * @param {PromiseFilter} [promFilter]
8
+ * @returns {boolean|undefined}
9
+ */
10
+ export function hasReturnValue(node: ESTreeOrTypeScriptNode | undefined | null, throwOnNullReturn?: boolean | undefined, promFilter?: PromiseFilter | undefined): boolean | undefined;
11
+ /**
12
+ * Checks if a Promise executor has no resolve value or an empty value.
13
+ * An `undefined` resolve does not count.
14
+ * @param {ESTreeOrTypeScriptNode} node
15
+ * @param {boolean} anyPromiseAsReturn
16
+ * @param {boolean} [allBranches]
17
+ * @returns {boolean}
18
+ */
19
+ export function hasValueOrExecutorHasNonEmptyResolveValue(node: ESTreeOrTypeScriptNode, anyPromiseAsReturn: boolean, allBranches?: boolean | undefined): boolean;
20
+ //# sourceMappingURL=hasReturnValue.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"hasReturnValue.d.ts","sourceRoot":"","sources":["../../src/utils/hasReturnValue.js"],"names":[],"mappings":"qCACa,OAAO,QAAQ,EAAE,IAAI,MACmB;mCA0P1C,sBAAsB,GAAC,SAAS,KAC9B,OAAO;AA/NpB;;;;;;GAMG;AAEH,qCANW,sBAAsB,GAAC,SAAS,GAAC,IAAI,oFAGnC,OAAO,GAAC,SAAS,CAuF7B;AA4VD;;;;;;;GAOG;AACH,gEALW,sBAAsB,sBACtB,OAAO,sCAEL,OAAO,CAsEnB"}
@@ -8,7 +8,7 @@ which is not listed in `dependencies` or `devDependencies`.
8
8
  |||
9
9
  |---|---|
10
10
  |Context|everywhere|
11
- |Tags|``|
11
+ |Tags|(Any)|
12
12
  |Recommended|false|
13
13
  |Settings||
14
14
  |Options||
package/package.json CHANGED
@@ -5,9 +5,9 @@
5
5
  "url": "http://gajus.com"
6
6
  },
7
7
  "dependencies": {
8
- "@es-joy/jsdoccomment": "~0.39.4",
8
+ "@es-joy/jsdoccomment": "~0.40.1",
9
9
  "are-docs-informative": "^0.0.2",
10
- "comment-parser": "1.3.1",
10
+ "comment-parser": "1.4.0",
11
11
  "debug": "^4.3.4",
12
12
  "escape-string-regexp": "^4.0.0",
13
13
  "esquery": "^1.5.0",
@@ -38,18 +38,18 @@
38
38
  "@types/estree": "^1.0.1",
39
39
  "@types/lodash.defaultsdeep": "^4.6.7",
40
40
  "@types/mocha": "^10.0.1",
41
- "@types/node": "^20.4.5",
41
+ "@types/node": "^20.4.7",
42
42
  "@types/semver": "^7.5.0",
43
43
  "@types/spdx-expression-parse": "^3.0.2",
44
- "@typescript-eslint/parser": "^6.2.0",
44
+ "@typescript-eslint/parser": "^6.2.1",
45
45
  "babel-plugin-add-module-exports": "^1.0.4",
46
46
  "babel-plugin-istanbul": "^6.1.1",
47
47
  "camelcase": "^6.3.0",
48
48
  "chai": "^4.3.7",
49
49
  "cross-env": "^7.0.3",
50
50
  "decamelize": "^5.0.1",
51
- "eslint": "8.45.0",
52
- "eslint-config-canonical": "~41.1.5",
51
+ "eslint": "8.46.0",
52
+ "eslint-config-canonical": "~41.1.7",
53
53
  "espree": "^9.6.1",
54
54
  "gitdown": "^3.1.5",
55
55
  "glob": "^10.3.3",
@@ -81,6 +81,7 @@
81
81
  "*.js": "npm run lint-arg -- --fix"
82
82
  },
83
83
  "main": "./dist/index.js",
84
+ "types": "./dist/index.d.ts",
84
85
  "name": "eslint-plugin-jsdoc",
85
86
  "mocha": {
86
87
  "require": [
@@ -121,7 +122,8 @@
121
122
  },
122
123
  "scripts": {
123
124
  "tsc": "tsc",
124
- "build": "rimraf ./dist && cross-env NODE_ENV=production babel ./src --out-dir ./dist --copy-files --source-maps --ignore ./src/bin/*.js --no-copy-ignored",
125
+ "tsc-build": "tsc -p tsconfig-prod.json",
126
+ "build": "rimraf ./dist && cross-env NODE_ENV=production babel ./src --out-dir ./dist --copy-files --source-maps --ignore ./src/bin/*.js --no-copy-ignored && pnpm tsc-build || true",
125
127
  "check-docs": "babel-node ./src/bin/generateDocs.js --check",
126
128
  "create-docs": "npm run create-options && babel-node ./src/bin/generateDocs.js",
127
129
  "create-rule": "babel-node ./src/bin/generateRule.js",
@@ -136,5 +138,5 @@
136
138
  "test-cov": "cross-env TIMING=1 nyc --reporter text npm run test-no-cov",
137
139
  "test-index": "npm run test-no-cov -- test/rules/index.js"
138
140
  },
139
- "version": "46.4.5"
141
+ "version": "46.4.6"
140
142
  }
@@ -0,0 +1,20 @@
1
+ {
2
+ "compilerOptions": {
3
+ "lib": ["es2022"],
4
+ "moduleResolution": "node",
5
+ "module": "NodeNext",
6
+ "allowJs": true,
7
+ "checkJs": true,
8
+ "noEmit": false,
9
+ "emitDeclarationOnly": true,
10
+ "declaration": true,
11
+ "declarationMap": true,
12
+ "strict": true,
13
+ "target": "es2017",
14
+ "outDir": "dist"
15
+ },
16
+ "include": [
17
+ "src/**/*.js"
18
+ ],
19
+ "exclude": ["node_modules", "src/bin/*.js"]
20
+ }
package/tsconfig.json CHANGED
@@ -8,7 +8,6 @@
8
8
  "noEmit": true,
9
9
  "declaration": true,
10
10
  "declarationMap": true,
11
- "allowSyntheticDefaultImports": true,
12
11
  "strict": true,
13
12
  "target": "es2017",
14
13
  "outDir": "dist"