eslint-plugin-jsdoc 55.4.0 → 56.0.1

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 (79) hide show
  1. package/dist/cjs/WarnSettings.d.ts +16 -0
  2. package/dist/cjs/alignTransform.d.ts +33 -0
  3. package/dist/cjs/defaultTagOrder.d.ts +4 -0
  4. package/dist/cjs/exportParser.d.ts +40 -0
  5. package/dist/cjs/getDefaultTagStructureForMode.d.ts +10 -0
  6. package/dist/cjs/getJsdocProcessorPlugin.d.cts +1 -0
  7. package/dist/cjs/getJsdocProcessorPlugin.d.ts +66 -0
  8. package/dist/cjs/index-cjs.d.ts +16 -0
  9. package/dist/cjs/index.cjs.d.cts +2 -0
  10. package/dist/cjs/iterateJsdoc.d.cts +2 -0
  11. package/dist/cjs/iterateJsdoc.d.ts +462 -0
  12. package/dist/cjs/jsdocUtils.d.ts +454 -0
  13. package/dist/cjs/rules/checkAccess.d.ts +2 -0
  14. package/dist/cjs/rules/checkAlignment.d.ts +2 -0
  15. package/dist/cjs/rules/checkExamples.d.ts +3 -0
  16. package/dist/cjs/rules/checkIndentation.d.ts +2 -0
  17. package/dist/cjs/rules/checkLineAlignment.d.ts +9 -0
  18. package/dist/cjs/rules/checkParamNames.d.ts +2 -0
  19. package/dist/cjs/rules/checkPropertyNames.d.ts +2 -0
  20. package/dist/cjs/rules/checkSyntax.d.ts +2 -0
  21. package/dist/cjs/rules/checkTagNames.d.ts +2 -0
  22. package/dist/cjs/rules/checkTemplateNames.d.ts +2 -0
  23. package/dist/cjs/rules/checkTypes.d.ts +2 -0
  24. package/dist/cjs/rules/checkValues.d.ts +2 -0
  25. package/dist/cjs/rules/convertToJsdocComments.d.ts +251 -0
  26. package/dist/cjs/rules/emptyTags.d.ts +2 -0
  27. package/dist/cjs/rules/implementsOnClasses.d.ts +2 -0
  28. package/dist/cjs/rules/importsAsDependencies.d.ts +2 -0
  29. package/dist/cjs/rules/informativeDocs.d.ts +2 -0
  30. package/dist/cjs/rules/linesBeforeBlock.d.ts +2 -0
  31. package/dist/cjs/rules/matchDescription.d.ts +2 -0
  32. package/dist/cjs/rules/matchName.d.ts +2 -0
  33. package/dist/cjs/rules/multilineBlocks.d.ts +2 -0
  34. package/dist/cjs/rules/noBadBlocks.d.ts +2 -0
  35. package/dist/cjs/rules/noBlankBlockDescriptions.d.ts +2 -0
  36. package/dist/cjs/rules/noBlankBlocks.d.ts +2 -0
  37. package/dist/cjs/rules/noDefaults.d.ts +2 -0
  38. package/dist/cjs/rules/noMissingSyntax.d.ts +9 -0
  39. package/dist/cjs/rules/noMultiAsterisks.d.ts +2 -0
  40. package/dist/cjs/rules/noRestrictedSyntax.d.ts +2 -0
  41. package/dist/cjs/rules/noTypes.d.ts +2 -0
  42. package/dist/cjs/rules/noUndefinedTypes.d.ts +2 -0
  43. package/dist/cjs/rules/requireAsteriskPrefix.d.ts +2 -0
  44. package/dist/cjs/rules/requireDescription.d.ts +2 -0
  45. package/dist/cjs/rules/requireDescriptionCompleteSentence.d.ts +2 -0
  46. package/dist/cjs/rules/requireExample.d.ts +2 -0
  47. package/dist/cjs/rules/requireFileOverview.d.ts +2 -0
  48. package/dist/cjs/rules/requireHyphenBeforeParamDescription.d.ts +2 -0
  49. package/dist/cjs/rules/requireJsdoc.d.ts +25 -0
  50. package/dist/cjs/rules/requireParam.d.ts +3 -0
  51. package/dist/cjs/rules/requireParamDescription.d.ts +2 -0
  52. package/dist/cjs/rules/requireParamName.d.ts +2 -0
  53. package/dist/cjs/rules/requireParamType.d.ts +2 -0
  54. package/dist/cjs/rules/requireProperty.d.ts +2 -0
  55. package/dist/cjs/rules/requirePropertyDescription.d.ts +2 -0
  56. package/dist/cjs/rules/requirePropertyName.d.ts +2 -0
  57. package/dist/cjs/rules/requirePropertyType.d.ts +2 -0
  58. package/dist/cjs/rules/requireReturns.d.ts +2 -0
  59. package/dist/cjs/rules/requireReturnsCheck.d.ts +2 -0
  60. package/dist/cjs/rules/requireReturnsDescription.d.ts +2 -0
  61. package/dist/cjs/rules/requireReturnsType.d.ts +2 -0
  62. package/dist/cjs/rules/requireTemplate.d.ts +2 -0
  63. package/dist/cjs/rules/requireThrows.d.ts +2 -0
  64. package/dist/cjs/rules/requireYields.d.ts +2 -0
  65. package/dist/cjs/rules/requireYieldsCheck.d.ts +2 -0
  66. package/dist/cjs/rules/sortTags.d.ts +2 -0
  67. package/dist/cjs/rules/tagLines.d.ts +2 -0
  68. package/dist/cjs/rules/textEscaping.d.ts +2 -0
  69. package/dist/cjs/rules/typeFormatting.d.ts +2 -0
  70. package/dist/cjs/rules/validTypes.d.ts +2 -0
  71. package/dist/cjs/tagNames.d.ts +15 -0
  72. package/dist/cjs/utils/hasReturnValue.d.ts +19 -0
  73. package/dist/getJsdocProcessorPlugin.cts +3 -0
  74. package/dist/index.cjs.cts +3 -0
  75. package/dist/iterateJsdoc.cts +6 -0
  76. package/package.json +20 -9
  77. package/src/getJsdocProcessorPlugin.cts +3 -0
  78. package/src/index.cjs.cts +3 -0
  79. package/src/iterateJsdoc.cts +6 -0
@@ -0,0 +1,251 @@
1
+ declare const _default: {
2
+ create(context: import("eslint").Rule.RuleContext): {
3
+ [x: string]: ((...args: any[]) => void) | ((codePath: import("eslint").Rule.CodePath, node: import("eslint").Rule.Node) => void) | ((segment: import("eslint").Rule.CodePathSegment, node: import("eslint").Rule.Node) => void) | ((fromSegment: import("eslint").Rule.CodePathSegment, toSegment: import("eslint").Rule.CodePathSegment, node: import("eslint").Rule.Node) => void) | ((node: import("eslint").Rule.Node) => void) | undefined;
4
+ onCodePathStart?: ((codePath: import("eslint").Rule.CodePath, node: import("eslint").Rule.Node) => void) | undefined;
5
+ onCodePathEnd?: ((codePath: import("eslint").Rule.CodePath, node: import("eslint").Rule.Node) => void) | undefined;
6
+ onCodePathSegmentStart?: ((segment: import("eslint").Rule.CodePathSegment, node: import("eslint").Rule.Node) => void) | undefined;
7
+ onCodePathSegmentEnd?: ((segment: import("eslint").Rule.CodePathSegment, node: import("eslint").Rule.Node) => void) | undefined;
8
+ onCodePathSegmentLoop?: ((fromSegment: import("eslint").Rule.CodePathSegment, toSegment: import("eslint").Rule.CodePathSegment, node: import("eslint").Rule.Node) => void) | undefined;
9
+ ArrayExpression?: ((node: import("estree").ArrayExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
10
+ "ArrayExpression:exit"?: ((node: import("estree").ArrayExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
11
+ ArrayPattern?: ((node: import("estree").ArrayPattern & import("eslint").Rule.NodeParentExtension) => void) | undefined;
12
+ "ArrayPattern:exit"?: ((node: import("estree").ArrayPattern & import("eslint").Rule.NodeParentExtension) => void) | undefined;
13
+ ArrowFunctionExpression?: ((node: import("estree").ArrowFunctionExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
14
+ "ArrowFunctionExpression:exit"?: ((node: import("estree").ArrowFunctionExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
15
+ AssignmentExpression?: ((node: import("estree").AssignmentExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
16
+ "AssignmentExpression:exit"?: ((node: import("estree").AssignmentExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
17
+ AssignmentPattern?: ((node: import("estree").AssignmentPattern & import("eslint").Rule.NodeParentExtension) => void) | undefined;
18
+ "AssignmentPattern:exit"?: ((node: import("estree").AssignmentPattern & import("eslint").Rule.NodeParentExtension) => void) | undefined;
19
+ AwaitExpression?: ((node: import("estree").AwaitExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
20
+ "AwaitExpression:exit"?: ((node: import("estree").AwaitExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
21
+ BinaryExpression?: ((node: import("estree").BinaryExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
22
+ "BinaryExpression:exit"?: ((node: import("estree").BinaryExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
23
+ BlockStatement?: ((node: import("estree").BlockStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
24
+ "BlockStatement:exit"?: ((node: import("estree").BlockStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
25
+ BreakStatement?: ((node: import("estree").BreakStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
26
+ "BreakStatement:exit"?: ((node: import("estree").BreakStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
27
+ CallExpression?: ((node: import("estree").CallExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
28
+ "CallExpression:exit"?: ((node: import("estree").CallExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
29
+ CatchClause?: ((node: import("estree").CatchClause & import("eslint").Rule.NodeParentExtension) => void) | undefined;
30
+ "CatchClause:exit"?: ((node: import("estree").CatchClause & import("eslint").Rule.NodeParentExtension) => void) | undefined;
31
+ ChainExpression?: ((node: import("estree").ChainExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
32
+ "ChainExpression:exit"?: ((node: import("estree").ChainExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
33
+ ClassBody?: ((node: import("estree").ClassBody & import("eslint").Rule.NodeParentExtension) => void) | undefined;
34
+ "ClassBody:exit"?: ((node: import("estree").ClassBody & import("eslint").Rule.NodeParentExtension) => void) | undefined;
35
+ ClassDeclaration?: ((node: import("estree").ClassDeclaration & import("eslint").Rule.NodeParentExtension) => void) | undefined;
36
+ "ClassDeclaration:exit"?: ((node: import("estree").ClassDeclaration & import("eslint").Rule.NodeParentExtension) => void) | undefined;
37
+ ClassExpression?: ((node: import("estree").ClassExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
38
+ "ClassExpression:exit"?: ((node: import("estree").ClassExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
39
+ ConditionalExpression?: ((node: import("estree").ConditionalExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
40
+ "ConditionalExpression:exit"?: ((node: import("estree").ConditionalExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
41
+ ContinueStatement?: ((node: import("estree").ContinueStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
42
+ "ContinueStatement:exit"?: ((node: import("estree").ContinueStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
43
+ DebuggerStatement?: ((node: import("estree").DebuggerStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
44
+ "DebuggerStatement:exit"?: ((node: import("estree").DebuggerStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
45
+ DoWhileStatement?: ((node: import("estree").DoWhileStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
46
+ "DoWhileStatement:exit"?: ((node: import("estree").DoWhileStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
47
+ EmptyStatement?: ((node: import("estree").EmptyStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
48
+ "EmptyStatement:exit"?: ((node: import("estree").EmptyStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
49
+ ExportAllDeclaration?: ((node: import("estree").ExportAllDeclaration & import("eslint").Rule.NodeParentExtension) => void) | undefined;
50
+ "ExportAllDeclaration:exit"?: ((node: import("estree").ExportAllDeclaration & import("eslint").Rule.NodeParentExtension) => void) | undefined;
51
+ ExportDefaultDeclaration?: ((node: import("estree").ExportDefaultDeclaration & import("eslint").Rule.NodeParentExtension) => void) | undefined;
52
+ "ExportDefaultDeclaration:exit"?: ((node: import("estree").ExportDefaultDeclaration & import("eslint").Rule.NodeParentExtension) => void) | undefined;
53
+ ExportNamedDeclaration?: ((node: import("estree").ExportNamedDeclaration & import("eslint").Rule.NodeParentExtension) => void) | undefined;
54
+ "ExportNamedDeclaration:exit"?: ((node: import("estree").ExportNamedDeclaration & import("eslint").Rule.NodeParentExtension) => void) | undefined;
55
+ ExportSpecifier?: ((node: import("estree").ExportSpecifier & import("eslint").Rule.NodeParentExtension) => void) | undefined;
56
+ "ExportSpecifier:exit"?: ((node: import("estree").ExportSpecifier & import("eslint").Rule.NodeParentExtension) => void) | undefined;
57
+ ExpressionStatement?: ((node: import("estree").ExpressionStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
58
+ "ExpressionStatement:exit"?: ((node: import("estree").ExpressionStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
59
+ ForInStatement?: ((node: import("estree").ForInStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
60
+ "ForInStatement:exit"?: ((node: import("estree").ForInStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
61
+ ForOfStatement?: ((node: import("estree").ForOfStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
62
+ "ForOfStatement:exit"?: ((node: import("estree").ForOfStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
63
+ ForStatement?: ((node: import("estree").ForStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
64
+ "ForStatement:exit"?: ((node: import("estree").ForStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
65
+ FunctionDeclaration?: ((node: import("estree").FunctionDeclaration & import("eslint").Rule.NodeParentExtension) => void) | undefined;
66
+ "FunctionDeclaration:exit"?: ((node: import("estree").FunctionDeclaration & import("eslint").Rule.NodeParentExtension) => void) | undefined;
67
+ FunctionExpression?: ((node: import("estree").FunctionExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
68
+ "FunctionExpression:exit"?: ((node: import("estree").FunctionExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
69
+ Identifier?: ((node: import("estree").Identifier & import("eslint").Rule.NodeParentExtension) => void) | undefined;
70
+ "Identifier:exit"?: ((node: import("estree").Identifier & import("eslint").Rule.NodeParentExtension) => void) | undefined;
71
+ IfStatement?: ((node: import("estree").IfStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
72
+ "IfStatement:exit"?: ((node: import("estree").IfStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
73
+ ImportDeclaration?: ((node: import("estree").ImportDeclaration & import("eslint").Rule.NodeParentExtension) => void) | undefined;
74
+ "ImportDeclaration:exit"?: ((node: import("estree").ImportDeclaration & import("eslint").Rule.NodeParentExtension) => void) | undefined;
75
+ ImportDefaultSpecifier?: ((node: import("estree").ImportDefaultSpecifier & import("eslint").Rule.NodeParentExtension) => void) | undefined;
76
+ "ImportDefaultSpecifier:exit"?: ((node: import("estree").ImportDefaultSpecifier & import("eslint").Rule.NodeParentExtension) => void) | undefined;
77
+ ImportExpression?: ((node: import("estree").ImportExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
78
+ "ImportExpression:exit"?: ((node: import("estree").ImportExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
79
+ ImportNamespaceSpecifier?: ((node: import("estree").ImportNamespaceSpecifier & import("eslint").Rule.NodeParentExtension) => void) | undefined;
80
+ "ImportNamespaceSpecifier:exit"?: ((node: import("estree").ImportNamespaceSpecifier & import("eslint").Rule.NodeParentExtension) => void) | undefined;
81
+ ImportSpecifier?: ((node: import("estree").ImportSpecifier & import("eslint").Rule.NodeParentExtension) => void) | undefined;
82
+ "ImportSpecifier:exit"?: ((node: import("estree").ImportSpecifier & import("eslint").Rule.NodeParentExtension) => void) | undefined;
83
+ LabeledStatement?: ((node: import("estree").LabeledStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
84
+ "LabeledStatement:exit"?: ((node: import("estree").LabeledStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
85
+ Literal?: ((node: import("estree").Literal & import("eslint").Rule.NodeParentExtension) => void) | undefined;
86
+ "Literal:exit"?: ((node: import("estree").Literal & import("eslint").Rule.NodeParentExtension) => void) | undefined;
87
+ LogicalExpression?: ((node: import("estree").LogicalExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
88
+ "LogicalExpression:exit"?: ((node: import("estree").LogicalExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
89
+ MemberExpression?: ((node: import("estree").MemberExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
90
+ "MemberExpression:exit"?: ((node: import("estree").MemberExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
91
+ MetaProperty?: ((node: import("estree").MetaProperty & import("eslint").Rule.NodeParentExtension) => void) | undefined;
92
+ "MetaProperty:exit"?: ((node: import("estree").MetaProperty & import("eslint").Rule.NodeParentExtension) => void) | undefined;
93
+ MethodDefinition?: ((node: import("estree").MethodDefinition & import("eslint").Rule.NodeParentExtension) => void) | undefined;
94
+ "MethodDefinition:exit"?: ((node: import("estree").MethodDefinition & import("eslint").Rule.NodeParentExtension) => void) | undefined;
95
+ NewExpression?: ((node: import("estree").NewExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
96
+ "NewExpression:exit"?: ((node: import("estree").NewExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
97
+ ObjectExpression?: ((node: import("estree").ObjectExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
98
+ "ObjectExpression:exit"?: ((node: import("estree").ObjectExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
99
+ ObjectPattern?: ((node: import("estree").ObjectPattern & import("eslint").Rule.NodeParentExtension) => void) | undefined;
100
+ "ObjectPattern:exit"?: ((node: import("estree").ObjectPattern & import("eslint").Rule.NodeParentExtension) => void) | undefined;
101
+ PrivateIdentifier?: ((node: import("estree").PrivateIdentifier & import("eslint").Rule.NodeParentExtension) => void) | undefined;
102
+ "PrivateIdentifier:exit"?: ((node: import("estree").PrivateIdentifier & import("eslint").Rule.NodeParentExtension) => void) | undefined;
103
+ Program?: ((node: import("estree").Program) => void) | undefined;
104
+ "Program:exit"?: ((node: import("estree").Program) => void) | undefined;
105
+ Property?: ((node: import("estree").Property & import("eslint").Rule.NodeParentExtension) => void) | undefined;
106
+ "Property:exit"?: ((node: import("estree").Property & import("eslint").Rule.NodeParentExtension) => void) | undefined;
107
+ PropertyDefinition?: ((node: import("estree").PropertyDefinition & import("eslint").Rule.NodeParentExtension) => void) | undefined;
108
+ "PropertyDefinition:exit"?: ((node: import("estree").PropertyDefinition & import("eslint").Rule.NodeParentExtension) => void) | undefined;
109
+ RestElement?: ((node: import("estree").RestElement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
110
+ "RestElement:exit"?: ((node: import("estree").RestElement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
111
+ ReturnStatement?: ((node: import("estree").ReturnStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
112
+ "ReturnStatement:exit"?: ((node: import("estree").ReturnStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
113
+ SequenceExpression?: ((node: import("estree").SequenceExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
114
+ "SequenceExpression:exit"?: ((node: import("estree").SequenceExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
115
+ SpreadElement?: ((node: import("estree").SpreadElement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
116
+ "SpreadElement:exit"?: ((node: import("estree").SpreadElement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
117
+ StaticBlock?: ((node: import("estree").StaticBlock & import("eslint").Rule.NodeParentExtension) => void) | undefined;
118
+ "StaticBlock:exit"?: ((node: import("estree").StaticBlock & import("eslint").Rule.NodeParentExtension) => void) | undefined;
119
+ Super?: ((node: import("estree").Super & import("eslint").Rule.NodeParentExtension) => void) | undefined;
120
+ "Super:exit"?: ((node: import("estree").Super & import("eslint").Rule.NodeParentExtension) => void) | undefined;
121
+ SwitchCase?: ((node: import("estree").SwitchCase & import("eslint").Rule.NodeParentExtension) => void) | undefined;
122
+ "SwitchCase:exit"?: ((node: import("estree").SwitchCase & import("eslint").Rule.NodeParentExtension) => void) | undefined;
123
+ SwitchStatement?: ((node: import("estree").SwitchStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
124
+ "SwitchStatement:exit"?: ((node: import("estree").SwitchStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
125
+ TaggedTemplateExpression?: ((node: import("estree").TaggedTemplateExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
126
+ "TaggedTemplateExpression:exit"?: ((node: import("estree").TaggedTemplateExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
127
+ TemplateElement?: ((node: import("estree").TemplateElement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
128
+ "TemplateElement:exit"?: ((node: import("estree").TemplateElement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
129
+ TemplateLiteral?: ((node: import("estree").TemplateLiteral & import("eslint").Rule.NodeParentExtension) => void) | undefined;
130
+ "TemplateLiteral:exit"?: ((node: import("estree").TemplateLiteral & import("eslint").Rule.NodeParentExtension) => void) | undefined;
131
+ ThisExpression?: ((node: import("estree").ThisExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
132
+ "ThisExpression:exit"?: ((node: import("estree").ThisExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
133
+ ThrowStatement?: ((node: import("estree").ThrowStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
134
+ "ThrowStatement:exit"?: ((node: import("estree").ThrowStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
135
+ TryStatement?: ((node: import("estree").TryStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
136
+ "TryStatement:exit"?: ((node: import("estree").TryStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
137
+ UnaryExpression?: ((node: import("estree").UnaryExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
138
+ "UnaryExpression:exit"?: ((node: import("estree").UnaryExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
139
+ UpdateExpression?: ((node: import("estree").UpdateExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
140
+ "UpdateExpression:exit"?: ((node: import("estree").UpdateExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
141
+ VariableDeclaration?: ((node: import("estree").VariableDeclaration & import("eslint").Rule.NodeParentExtension) => void) | undefined;
142
+ "VariableDeclaration:exit"?: ((node: import("estree").VariableDeclaration & import("eslint").Rule.NodeParentExtension) => void) | undefined;
143
+ VariableDeclarator?: ((node: import("estree").VariableDeclarator & import("eslint").Rule.NodeParentExtension) => void) | undefined;
144
+ "VariableDeclarator:exit"?: ((node: import("estree").VariableDeclarator & import("eslint").Rule.NodeParentExtension) => void) | undefined;
145
+ WhileStatement?: ((node: import("estree").WhileStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
146
+ "WhileStatement:exit"?: ((node: import("estree").WhileStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
147
+ WithStatement?: ((node: import("estree").WithStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
148
+ "WithStatement:exit"?: ((node: import("estree").WithStatement & import("eslint").Rule.NodeParentExtension) => void) | undefined;
149
+ YieldExpression?: ((node: import("estree").YieldExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
150
+ "YieldExpression:exit"?: ((node: import("estree").YieldExpression & import("eslint").Rule.NodeParentExtension) => void) | undefined;
151
+ };
152
+ meta: {
153
+ docs: {
154
+ description: string;
155
+ url: string;
156
+ };
157
+ fixable: "code";
158
+ messages: {
159
+ blockCommentsJsdocStyle: string;
160
+ lineCommentsJsdocStyle: string;
161
+ };
162
+ schema: {
163
+ additionalProperties: false;
164
+ properties: {
165
+ allowedPrefixes: {
166
+ items: {
167
+ type: "string";
168
+ };
169
+ type: "array";
170
+ };
171
+ contexts: {
172
+ items: {
173
+ anyOf: ({
174
+ type: "string";
175
+ additionalProperties?: undefined;
176
+ properties?: undefined;
177
+ } | {
178
+ additionalProperties: false;
179
+ properties: {
180
+ context: {
181
+ type: "string";
182
+ };
183
+ inlineCommentBlock: {
184
+ type: "boolean";
185
+ };
186
+ };
187
+ type: "object";
188
+ })[];
189
+ };
190
+ type: "array";
191
+ };
192
+ contextsAfter: {
193
+ items: {
194
+ anyOf: ({
195
+ type: "string";
196
+ additionalProperties?: undefined;
197
+ properties?: undefined;
198
+ } | {
199
+ additionalProperties: false;
200
+ properties: {
201
+ context: {
202
+ type: "string";
203
+ };
204
+ inlineCommentBlock: {
205
+ type: "boolean";
206
+ };
207
+ };
208
+ type: "object";
209
+ })[];
210
+ };
211
+ type: "array";
212
+ };
213
+ contextsBeforeAndAfter: {
214
+ items: {
215
+ anyOf: ({
216
+ type: "string";
217
+ additionalProperties?: undefined;
218
+ properties?: undefined;
219
+ } | {
220
+ additionalProperties: false;
221
+ properties: {
222
+ context: {
223
+ type: "string";
224
+ };
225
+ inlineCommentBlock: {
226
+ type: "boolean";
227
+ };
228
+ };
229
+ type: "object";
230
+ })[];
231
+ };
232
+ type: "array";
233
+ };
234
+ enableFixer: {
235
+ type: "boolean";
236
+ };
237
+ enforceJsdocLineStyle: {
238
+ enum: string[];
239
+ type: "string";
240
+ };
241
+ lineOrBlockStyle: {
242
+ enum: string[];
243
+ type: "string";
244
+ };
245
+ };
246
+ type: "object";
247
+ }[];
248
+ type: "suggestion";
249
+ };
250
+ };
251
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,9 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
3
+ export type ContextObject = {
4
+ comment: string;
5
+ context: string;
6
+ message: string;
7
+ minimum: import("../iterateJsdoc.js").Integer;
8
+ };
9
+ export type Context = string | ContextObject;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,25 @@
1
+ declare const _default: {
2
+ create(context: import("eslint").Rule.RuleContext): {};
3
+ meta: {
4
+ docs: {
5
+ category: string;
6
+ description: string;
7
+ recommended: boolean;
8
+ url: string;
9
+ };
10
+ fixable: "code";
11
+ messages: {
12
+ missingJsDoc: string;
13
+ };
14
+ schema: import("json-schema").JSONSchema4[];
15
+ type: "suggestion";
16
+ };
17
+ };
18
+ export default _default;
19
+ export type RequireJsdocOpts = {
20
+ ancestorsOnly: boolean;
21
+ esm: boolean;
22
+ initModuleExports: boolean;
23
+ initWindow: boolean;
24
+ };
25
+ export type ESLintOrTSNode = import("eslint").Rule.Node | import("@typescript-eslint/types").TSESTree.Node;
@@ -0,0 +1,3 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
3
+ export type RootNamerReturn = [string, boolean, () => RootNamerReturn];
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: import("eslint").Rule.RuleModule;
2
+ export default _default;
@@ -0,0 +1,15 @@
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;
@@ -0,0 +1,19 @@
1
+ export type ESTreeOrTypeScriptNode = import("estree").Node | import("@typescript-eslint/types").TSESTree.Node;
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, promFilter?: PromiseFilter): 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): boolean;
@@ -0,0 +1,3 @@
1
+ import {getJsdocProcessorPlugin} from './getJsdocProcessorPlugin.js';
2
+
3
+ exports.getJsdocProcessorPlugin = getJsdocProcessorPlugin;
@@ -0,0 +1,3 @@
1
+ import items from './index-cjs.js';
2
+
3
+ export = items;
@@ -0,0 +1,6 @@
1
+ import iterateJsdoc, {getSettings, parseComment} from './iterateJsdoc.js';
2
+
3
+ export = iterateJsdoc;
4
+
5
+ exports.getSettings = getSettings;
6
+ exports.parseComment = parseComment;
package/package.json CHANGED
@@ -90,19 +90,29 @@
90
90
  "default": "./src/index.js"
91
91
  },
92
92
  "require": {
93
- "types": "./dist/index-cjs.d.ts",
93
+ "types": "./dist/cjs/index.cjs.d.cts",
94
94
  "default": "./dist/index-cjs.cjs"
95
95
  }
96
96
  },
97
97
  "./getJsdocProcessorPlugin.js": {
98
- "types": "./dist/getJsdocProcessorPlugin.d.ts",
99
- "import": "./src/getJsdocProcessorPlugin.js",
100
- "require": "./dist/getJsdocProcessorPlugin.cjs"
98
+ "import": {
99
+ "types": "./dist/getJsdocProcessorPlugin.d.ts",
100
+ "default": "./src/getJsdocProcessorPlugin.js"
101
+ },
102
+ "require": {
103
+ "types": "./dist/cjs/getJsdocProcessorPlugin.d.cts",
104
+ "default": "./dist/getJsdocProcessorPlugin.cjs"
105
+ }
101
106
  },
102
107
  "./iterateJsdoc.js": {
103
- "types": "./dist/iterateJsdoc.d.ts",
104
- "import": "./src/iterateJsdoc.js",
105
- "require": "./dist/iterateJsdoc.cjs"
108
+ "import": {
109
+ "types": "./dist/iterateJsdoc.d.ts",
110
+ "default": "./src/iterateJsdoc.js"
111
+ },
112
+ "require": {
113
+ "types": "./dist/cjs/iterateJsdoc.d.cts",
114
+ "default": "./dist/iterateJsdoc.cjs"
115
+ }
106
116
  }
107
117
  },
108
118
  "name": "eslint-plugin-jsdoc",
@@ -145,7 +155,8 @@
145
155
  "ruleTypes": "node ./src/bin/generateRuleTypes.js",
146
156
  "tsc": "tsc",
147
157
  "tsc-build": "tsc -p tsconfig-prod.json",
148
- "build": "node ./src/bin/buildEntryFileForTS.js && rimraf ./dist && NODE_ENV=production babel ./src --out-file-extension .cjs --out-dir ./dist --copy-files --source-maps --ignore ./src/bin/*.js --no-copy-ignored && replace 'require\\(\"\\.(.*?)\\.[^.]*?\"\\)' 'require(\".$1.cjs\")' 'dist' -r --include=\"*.cjs\" && pnpm tsc-build",
158
+ "tsc-cjs": "tsc -p tsconfig-cjs.json",
159
+ "build": "node ./src/bin/buildEntryFileForTS.js && rimraf ./dist && NODE_ENV=production babel ./src --out-file-extension .cjs --out-dir ./dist --copy-files --source-maps --ignore ./src/bin/*.js --no-copy-ignored && replace 'require\\(\"\\.(.*?)\\.[^.]*?\"\\)' 'require(\".$1.cjs\")' 'dist' -r --include=\"*.cjs\" && pnpm tsc-build && pnpm tsc-cjs",
149
160
  "attw": "attw --pack .",
150
161
  "check-docs": "node ./src/bin/generateDocs.js --check",
151
162
  "create-docs": "pnpm run create-options && node ./src/bin/generateDocs.js",
@@ -160,5 +171,5 @@
160
171
  "test-cov": "TIMING=1 c8 --reporter text pnpm run test-no-cov",
161
172
  "test-index": "pnpm run test-no-cov test/rules/index.js"
162
173
  },
163
- "version": "55.4.0"
174
+ "version": "56.0.1"
164
175
  }
@@ -0,0 +1,3 @@
1
+ import {getJsdocProcessorPlugin} from './getJsdocProcessorPlugin.js';
2
+
3
+ exports.getJsdocProcessorPlugin = getJsdocProcessorPlugin;
@@ -0,0 +1,3 @@
1
+ import items from './index-cjs.js';
2
+
3
+ export = items;