eslint-plugin-jsdoc 63.0.10 → 63.0.11
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.cjs +1 -8
- package/dist/WarnSettings.cjs.map +1 -1
- package/dist/alignTransform.cjs +6 -10
- package/dist/alignTransform.cjs.map +1 -1
- package/dist/buildForbidRuleDefinition.cjs +3 -10
- package/dist/buildForbidRuleDefinition.cjs.map +1 -1
- package/dist/buildRejectOrPreferRuleDefinition.cjs +7 -14
- package/dist/buildRejectOrPreferRuleDefinition.cjs.map +1 -1
- package/dist/defaultTagOrder.cjs +1 -8
- package/dist/defaultTagOrder.cjs.map +1 -1
- package/dist/exportParser.cjs +6 -14
- package/dist/exportParser.cjs.map +1 -1
- package/dist/generateDocs.cjs +36 -44
- package/dist/generateDocs.cjs.map +1 -1
- package/dist/generateOptions.cjs +15 -18
- package/dist/generateOptions.cjs.map +1 -1
- package/dist/generateRule.cjs +24 -24
- package/dist/generateRule.cjs.map +1 -1
- package/dist/generateRuleTypes.cjs +6 -9
- package/dist/generateRuleTypes.cjs.map +1 -1
- package/dist/getDefaultTagStructureForMode.cjs +1 -8
- package/dist/getDefaultTagStructureForMode.cjs.map +1 -1
- package/dist/getJsdocProcessorPlugin.cjs +20 -28
- package/dist/getJsdocProcessorPlugin.cjs.map +1 -1
- package/dist/index-cjs.cjs +152 -159
- package/dist/index-cjs.cjs.map +1 -1
- package/dist/index-esm.cjs +16 -27
- package/dist/index-esm.cjs.map +1 -1
- package/dist/index.cjs +159 -172
- package/dist/index.cjs.map +1 -1
- package/dist/iterateJsdoc.cjs +22 -32
- package/dist/iterateJsdoc.cjs.map +1 -1
- package/dist/jsdocUtils.cjs +18 -86
- package/dist/jsdocUtils.cjs.map +1 -1
- package/dist/rules/checkAccess.cjs +2 -10
- package/dist/rules/checkAccess.cjs.map +1 -1
- package/dist/rules/checkAlignment.cjs +2 -10
- package/dist/rules/checkAlignment.cjs.map +1 -1
- package/dist/rules/checkExamples.cjs +6 -15
- package/dist/rules/checkExamples.cjs.map +1 -1
- package/dist/rules/checkIndentation.cjs +2 -9
- package/dist/rules/checkIndentation.cjs.map +1 -1
- package/dist/rules/checkLineAlignment.cjs +6 -14
- package/dist/rules/checkLineAlignment.cjs.map +1 -1
- package/dist/rules/checkParamNames.cjs +2 -9
- package/dist/rules/checkParamNames.cjs.map +1 -1
- package/dist/rules/checkPropertyNames.cjs +2 -9
- package/dist/rules/checkPropertyNames.cjs.map +1 -1
- package/dist/rules/checkSyntax.cjs +2 -10
- package/dist/rules/checkSyntax.cjs.map +1 -1
- package/dist/rules/checkTagNames.cjs +4 -11
- package/dist/rules/checkTagNames.cjs.map +1 -1
- package/dist/rules/checkTemplateNames.cjs +12 -21
- package/dist/rules/checkTemplateNames.cjs.map +1 -1
- package/dist/rules/checkTypes.cjs +4 -10
- package/dist/rules/checkTypes.cjs.map +1 -1
- package/dist/rules/checkValues.cjs +9 -17
- package/dist/rules/checkValues.cjs.map +1 -1
- package/dist/rules/convertToJsdocComments.cjs +13 -19
- package/dist/rules/convertToJsdocComments.cjs.map +1 -1
- package/dist/rules/emptyTags.cjs +2 -10
- package/dist/rules/emptyTags.cjs.map +1 -1
- package/dist/rules/escapeInlineTags.cjs +2 -10
- package/dist/rules/escapeInlineTags.cjs.map +1 -1
- package/dist/rules/implementsOnClasses.cjs +2 -10
- package/dist/rules/implementsOnClasses.cjs.map +1 -1
- package/dist/rules/importsAsDependencies.cjs +12 -20
- package/dist/rules/importsAsDependencies.cjs.map +1 -1
- package/dist/rules/informativeDocs.cjs +4 -12
- package/dist/rules/informativeDocs.cjs.map +1 -1
- package/dist/rules/linesBeforeBlock.cjs +2 -9
- package/dist/rules/linesBeforeBlock.cjs.map +1 -1
- package/dist/rules/matchDescription.cjs +2 -9
- package/dist/rules/matchDescription.cjs.map +1 -1
- package/dist/rules/matchName.cjs +2 -10
- package/dist/rules/matchName.cjs.map +1 -1
- package/dist/rules/multilineBlocks.cjs +2 -9
- package/dist/rules/multilineBlocks.cjs.map +1 -1
- package/dist/rules/noBadBlocks.cjs +4 -11
- package/dist/rules/noBadBlocks.cjs.map +1 -1
- package/dist/rules/noBlankBlockDescriptions.cjs +2 -10
- package/dist/rules/noBlankBlockDescriptions.cjs.map +1 -1
- package/dist/rules/noBlankBlocks.cjs +2 -10
- package/dist/rules/noBlankBlocks.cjs.map +1 -1
- package/dist/rules/noDefaults.cjs +2 -10
- package/dist/rules/noDefaults.cjs.map +1 -1
- package/dist/rules/noMissingSyntax.cjs +2 -9
- package/dist/rules/noMissingSyntax.cjs.map +1 -1
- package/dist/rules/noMultiAsterisks.cjs +2 -10
- package/dist/rules/noMultiAsterisks.cjs.map +1 -1
- package/dist/rules/noRestrictedSyntax.cjs +2 -9
- package/dist/rules/noRestrictedSyntax.cjs.map +1 -1
- package/dist/rules/noTypes.cjs +2 -9
- package/dist/rules/noTypes.cjs.map +1 -1
- package/dist/rules/noUndefinedTypes.cjs +13 -21
- package/dist/rules/noUndefinedTypes.cjs.map +1 -1
- package/dist/rules/preferImportTag.cjs +21 -28
- package/dist/rules/preferImportTag.cjs.map +1 -1
- package/dist/rules/requireAsteriskPrefix.cjs +2 -10
- package/dist/rules/requireAsteriskPrefix.cjs.map +1 -1
- package/dist/rules/requireDescription.cjs +2 -9
- package/dist/rules/requireDescription.cjs.map +1 -1
- package/dist/rules/requireDescriptionCompleteSentence.cjs +7 -15
- package/dist/rules/requireDescriptionCompleteSentence.cjs.map +1 -1
- package/dist/rules/requireExample.cjs +2 -10
- package/dist/rules/requireExample.cjs.map +1 -1
- package/dist/rules/requireFileOverview.cjs +2 -10
- package/dist/rules/requireFileOverview.cjs.map +1 -1
- package/dist/rules/requireHyphenBeforeParamDescription.cjs +2 -10
- package/dist/rules/requireHyphenBeforeParamDescription.cjs.map +1 -1
- package/dist/rules/requireJsdoc.cjs +17 -25
- package/dist/rules/requireJsdoc.cjs.map +1 -1
- package/dist/rules/requireParam.cjs +2 -9
- package/dist/rules/requireParam.cjs.map +1 -1
- package/dist/rules/requireParamDescription.cjs +2 -10
- package/dist/rules/requireParamDescription.cjs.map +1 -1
- package/dist/rules/requireParamName.cjs +2 -10
- package/dist/rules/requireParamName.cjs.map +1 -1
- package/dist/rules/requireParamType.cjs +2 -10
- package/dist/rules/requireParamType.cjs.map +1 -1
- package/dist/rules/requireProperty.cjs +2 -10
- package/dist/rules/requireProperty.cjs.map +1 -1
- package/dist/rules/requirePropertyDescription.cjs +2 -10
- package/dist/rules/requirePropertyDescription.cjs.map +1 -1
- package/dist/rules/requirePropertyName.cjs +2 -10
- package/dist/rules/requirePropertyName.cjs.map +1 -1
- package/dist/rules/requirePropertyType.cjs +2 -10
- package/dist/rules/requirePropertyType.cjs.map +1 -1
- package/dist/rules/requireRejects.cjs +2 -9
- package/dist/rules/requireRejects.cjs.map +1 -1
- package/dist/rules/requireReturns.cjs +4 -11
- package/dist/rules/requireReturns.cjs.map +1 -1
- package/dist/rules/requireReturnsCheck.cjs +8 -15
- package/dist/rules/requireReturnsCheck.cjs.map +1 -1
- package/dist/rules/requireReturnsDescription.cjs +2 -10
- package/dist/rules/requireReturnsDescription.cjs.map +1 -1
- package/dist/rules/requireReturnsType.cjs +2 -10
- package/dist/rules/requireReturnsType.cjs.map +1 -1
- package/dist/rules/requireTags.cjs +2 -9
- package/dist/rules/requireTags.cjs.map +1 -1
- package/dist/rules/requireTemplate.cjs +5 -13
- package/dist/rules/requireTemplate.cjs.map +1 -1
- package/dist/rules/requireThrows.cjs +2 -9
- package/dist/rules/requireThrows.cjs.map +1 -1
- package/dist/rules/requireYields.cjs +2 -9
- package/dist/rules/requireYields.cjs.map +1 -1
- package/dist/rules/requireYieldsCheck.cjs +2 -9
- package/dist/rules/requireYieldsCheck.cjs.map +1 -1
- package/dist/rules/sortTags.cjs +4 -12
- package/dist/rules/sortTags.cjs.map +1 -1
- package/dist/rules/tagLines.cjs +2 -9
- package/dist/rules/tagLines.cjs.map +1 -1
- package/dist/rules/textEscaping.cjs +2 -9
- package/dist/rules/textEscaping.cjs.map +1 -1
- package/dist/rules/tsMethodSignatureStyle.cjs +10 -18
- package/dist/rules/tsMethodSignatureStyle.cjs.map +1 -1
- package/dist/rules/tsNoEmptyObjectType.cjs +5 -13
- package/dist/rules/tsNoEmptyObjectType.cjs.map +1 -1
- package/dist/rules/tsNoUnnecessaryTemplateExpression.cjs +8 -16
- package/dist/rules/tsNoUnnecessaryTemplateExpression.cjs.map +1 -1
- package/dist/rules/tsPreferFunctionType.cjs +8 -16
- package/dist/rules/tsPreferFunctionType.cjs.map +1 -1
- package/dist/rules/typeFormatting.cjs +9 -17
- package/dist/rules/typeFormatting.cjs.map +1 -1
- package/dist/rules/validTypes.cjs +10 -18
- package/dist/rules/validTypes.cjs.map +1 -1
- package/dist/tagNames.cjs +4 -9
- package/dist/tagNames.cjs.map +1 -1
- package/dist/utils/hasReturnValue.cjs +1 -8
- package/dist/utils/hasReturnValue.cjs.map +1 -1
- package/package.json +21 -21
- package/src/rules/checkTemplateNames.js +0 -1
- package/src/rules/requireJsdoc.js +0 -1
package/dist/index.cjs
CHANGED
|
@@ -1,91 +1,77 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
|
|
3
|
-
Object.defineProperty(exports, "__esModule", {
|
|
4
|
-
value: true
|
|
5
|
-
});
|
|
6
|
-
exports.default = void 0;
|
|
7
|
-
Object.defineProperty(exports, "getJsdocProcessorPlugin", {
|
|
8
|
-
enumerable: true,
|
|
9
|
-
get: function () {
|
|
10
|
-
return _getJsdocProcessorPlugin.getJsdocProcessorPlugin;
|
|
11
|
-
}
|
|
12
|
-
});
|
|
13
|
-
exports.jsdoc = void 0;
|
|
14
|
-
var _objectDeepMerge = require("object-deep-merge");
|
|
15
|
-
var _buildForbidRuleDefinition = require("./buildForbidRuleDefinition.cjs");
|
|
16
|
-
var _buildRejectOrPreferRuleDefinition = require("./buildRejectOrPreferRuleDefinition.cjs");
|
|
17
|
-
var _getJsdocProcessorPlugin = require("./getJsdocProcessorPlugin.cjs");
|
|
18
|
-
var _checkAccess = _interopRequireDefault(require("./rules/checkAccess.cjs"));
|
|
19
|
-
var _checkAlignment = _interopRequireDefault(require("./rules/checkAlignment.cjs"));
|
|
20
|
-
var _checkExamples = _interopRequireDefault(require("./rules/checkExamples.cjs"));
|
|
21
|
-
var _checkIndentation = _interopRequireDefault(require("./rules/checkIndentation.cjs"));
|
|
22
|
-
var _checkLineAlignment = _interopRequireDefault(require("./rules/checkLineAlignment.cjs"));
|
|
23
|
-
var _checkParamNames = _interopRequireDefault(require("./rules/checkParamNames.cjs"));
|
|
24
|
-
var _checkPropertyNames = _interopRequireDefault(require("./rules/checkPropertyNames.cjs"));
|
|
25
|
-
var _checkSyntax = _interopRequireDefault(require("./rules/checkSyntax.cjs"));
|
|
26
|
-
var _checkTagNames = _interopRequireDefault(require("./rules/checkTagNames.cjs"));
|
|
27
|
-
var _checkTemplateNames = _interopRequireDefault(require("./rules/checkTemplateNames.cjs"));
|
|
28
|
-
var _checkTypes = _interopRequireDefault(require("./rules/checkTypes.cjs"));
|
|
29
|
-
var _checkValues = _interopRequireDefault(require("./rules/checkValues.cjs"));
|
|
30
|
-
var _convertToJsdocComments = _interopRequireDefault(require("./rules/convertToJsdocComments.cjs"));
|
|
31
|
-
var _emptyTags = _interopRequireDefault(require("./rules/emptyTags.cjs"));
|
|
32
|
-
var _escapeInlineTags = _interopRequireDefault(require("./rules/escapeInlineTags.cjs"));
|
|
33
|
-
var _implementsOnClasses = _interopRequireDefault(require("./rules/implementsOnClasses.cjs"));
|
|
34
|
-
var _importsAsDependencies = _interopRequireDefault(require("./rules/importsAsDependencies.cjs"));
|
|
35
|
-
var _informativeDocs = _interopRequireDefault(require("./rules/informativeDocs.cjs"));
|
|
36
|
-
var _linesBeforeBlock = _interopRequireDefault(require("./rules/linesBeforeBlock.cjs"));
|
|
37
|
-
var _matchDescription = _interopRequireDefault(require("./rules/matchDescription.cjs"));
|
|
38
|
-
var _matchName = _interopRequireDefault(require("./rules/matchName.cjs"));
|
|
39
|
-
var _multilineBlocks = _interopRequireDefault(require("./rules/multilineBlocks.cjs"));
|
|
40
|
-
var _noBadBlocks = _interopRequireDefault(require("./rules/noBadBlocks.cjs"));
|
|
41
|
-
var _noBlankBlockDescriptions = _interopRequireDefault(require("./rules/noBlankBlockDescriptions.cjs"));
|
|
42
|
-
var _noBlankBlocks = _interopRequireDefault(require("./rules/noBlankBlocks.cjs"));
|
|
43
|
-
var _noDefaults = _interopRequireDefault(require("./rules/noDefaults.cjs"));
|
|
44
|
-
var _noMissingSyntax = _interopRequireDefault(require("./rules/noMissingSyntax.cjs"));
|
|
45
|
-
var _noMultiAsterisks = _interopRequireDefault(require("./rules/noMultiAsterisks.cjs"));
|
|
46
|
-
var _noRestrictedSyntax = _interopRequireDefault(require("./rules/noRestrictedSyntax.cjs"));
|
|
47
|
-
var _noTypes = _interopRequireDefault(require("./rules/noTypes.cjs"));
|
|
48
|
-
var _noUndefinedTypes = _interopRequireDefault(require("./rules/noUndefinedTypes.cjs"));
|
|
49
|
-
var _preferImportTag = _interopRequireDefault(require("./rules/preferImportTag.cjs"));
|
|
50
|
-
var _requireAsteriskPrefix = _interopRequireDefault(require("./rules/requireAsteriskPrefix.cjs"));
|
|
51
|
-
var _requireDescription = _interopRequireDefault(require("./rules/requireDescription.cjs"));
|
|
52
|
-
var _requireDescriptionCompleteSentence = _interopRequireDefault(require("./rules/requireDescriptionCompleteSentence.cjs"));
|
|
53
|
-
var _requireExample = _interopRequireDefault(require("./rules/requireExample.cjs"));
|
|
54
|
-
var _requireFileOverview = _interopRequireDefault(require("./rules/requireFileOverview.cjs"));
|
|
55
|
-
var _requireHyphenBeforeParamDescription = _interopRequireDefault(require("./rules/requireHyphenBeforeParamDescription.cjs"));
|
|
56
|
-
var _requireJsdoc = _interopRequireDefault(require("./rules/requireJsdoc.cjs"));
|
|
57
|
-
var _requireParam = _interopRequireDefault(require("./rules/requireParam.cjs"));
|
|
58
|
-
var _requireParamDescription = _interopRequireDefault(require("./rules/requireParamDescription.cjs"));
|
|
59
|
-
var _requireParamName = _interopRequireDefault(require("./rules/requireParamName.cjs"));
|
|
60
|
-
var _requireParamType = _interopRequireDefault(require("./rules/requireParamType.cjs"));
|
|
61
|
-
var _requireProperty = _interopRequireDefault(require("./rules/requireProperty.cjs"));
|
|
62
|
-
var _requirePropertyDescription = _interopRequireDefault(require("./rules/requirePropertyDescription.cjs"));
|
|
63
|
-
var _requirePropertyName = _interopRequireDefault(require("./rules/requirePropertyName.cjs"));
|
|
64
|
-
var _requirePropertyType = _interopRequireDefault(require("./rules/requirePropertyType.cjs"));
|
|
65
|
-
var _requireRejects = _interopRequireDefault(require("./rules/requireRejects.cjs"));
|
|
66
|
-
var _requireReturns = _interopRequireDefault(require("./rules/requireReturns.cjs"));
|
|
67
|
-
var _requireReturnsCheck = _interopRequireDefault(require("./rules/requireReturnsCheck.cjs"));
|
|
68
|
-
var _requireReturnsDescription = _interopRequireDefault(require("./rules/requireReturnsDescription.cjs"));
|
|
69
|
-
var _requireReturnsType = _interopRequireDefault(require("./rules/requireReturnsType.cjs"));
|
|
70
|
-
var _requireTags = _interopRequireDefault(require("./rules/requireTags.cjs"));
|
|
71
|
-
var _requireTemplate = _interopRequireDefault(require("./rules/requireTemplate.cjs"));
|
|
72
|
-
var _requireThrows = _interopRequireDefault(require("./rules/requireThrows.cjs"));
|
|
73
|
-
var _requireYields = _interopRequireDefault(require("./rules/requireYields.cjs"));
|
|
74
|
-
var _requireYieldsCheck = _interopRequireDefault(require("./rules/requireYieldsCheck.cjs"));
|
|
75
|
-
var _sortTags = _interopRequireDefault(require("./rules/sortTags.cjs"));
|
|
76
|
-
var _tagLines = _interopRequireDefault(require("./rules/tagLines.cjs"));
|
|
77
|
-
var _textEscaping = _interopRequireDefault(require("./rules/textEscaping.cjs"));
|
|
78
|
-
var _tsMethodSignatureStyle = _interopRequireDefault(require("./rules/tsMethodSignatureStyle.cjs"));
|
|
79
|
-
var _tsNoEmptyObjectType = _interopRequireDefault(require("./rules/tsNoEmptyObjectType.cjs"));
|
|
80
|
-
var _tsNoUnnecessaryTemplateExpression = _interopRequireDefault(require("./rules/tsNoUnnecessaryTemplateExpression.cjs"));
|
|
81
|
-
var _tsPreferFunctionType = _interopRequireDefault(require("./rules/tsPreferFunctionType.cjs"));
|
|
82
|
-
var _typeFormatting = _interopRequireDefault(require("./rules/typeFormatting.cjs"));
|
|
83
|
-
var _validTypes = _interopRequireDefault(require("./rules/validTypes.cjs"));
|
|
84
|
-
var _eslint = require("eslint");
|
|
85
|
-
var _semver = _interopRequireDefault(require("semver"));
|
|
86
|
-
function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
|
|
87
1
|
/* AUTO-GENERATED BY build SCRIPT */
|
|
88
2
|
/* eslint-disable perfectionist/sort-imports -- For auto-generate; Do not remove */
|
|
3
|
+
import { merge } from 'object-deep-merge';
|
|
4
|
+
import { buildForbidRuleDefinition } from './buildForbidRuleDefinition.js';
|
|
5
|
+
import { buildRejectOrPreferRuleDefinition } from './buildRejectOrPreferRuleDefinition.js';
|
|
6
|
+
import { getJsdocProcessorPlugin } from './getJsdocProcessorPlugin.js';
|
|
7
|
+
import checkAccess from './rules/checkAccess.js';
|
|
8
|
+
import checkAlignment from './rules/checkAlignment.js';
|
|
9
|
+
import checkExamples from './rules/checkExamples.js';
|
|
10
|
+
import checkIndentation from './rules/checkIndentation.js';
|
|
11
|
+
import checkLineAlignment from './rules/checkLineAlignment.js';
|
|
12
|
+
import checkParamNames from './rules/checkParamNames.js';
|
|
13
|
+
import checkPropertyNames from './rules/checkPropertyNames.js';
|
|
14
|
+
import checkSyntax from './rules/checkSyntax.js';
|
|
15
|
+
import checkTagNames from './rules/checkTagNames.js';
|
|
16
|
+
import checkTemplateNames from './rules/checkTemplateNames.js';
|
|
17
|
+
import checkTypes from './rules/checkTypes.js';
|
|
18
|
+
import checkValues from './rules/checkValues.js';
|
|
19
|
+
import convertToJsdocComments from './rules/convertToJsdocComments.js';
|
|
20
|
+
import emptyTags from './rules/emptyTags.js';
|
|
21
|
+
import escapeInlineTags from './rules/escapeInlineTags.js';
|
|
22
|
+
import implementsOnClasses from './rules/implementsOnClasses.js';
|
|
23
|
+
import importsAsDependencies from './rules/importsAsDependencies.js';
|
|
24
|
+
import informativeDocs from './rules/informativeDocs.js';
|
|
25
|
+
import linesBeforeBlock from './rules/linesBeforeBlock.js';
|
|
26
|
+
import matchDescription from './rules/matchDescription.js';
|
|
27
|
+
import matchName from './rules/matchName.js';
|
|
28
|
+
import multilineBlocks from './rules/multilineBlocks.js';
|
|
29
|
+
import noBadBlocks from './rules/noBadBlocks.js';
|
|
30
|
+
import noBlankBlockDescriptions from './rules/noBlankBlockDescriptions.js';
|
|
31
|
+
import noBlankBlocks from './rules/noBlankBlocks.js';
|
|
32
|
+
import noDefaults from './rules/noDefaults.js';
|
|
33
|
+
import noMissingSyntax from './rules/noMissingSyntax.js';
|
|
34
|
+
import noMultiAsterisks from './rules/noMultiAsterisks.js';
|
|
35
|
+
import noRestrictedSyntax from './rules/noRestrictedSyntax.js';
|
|
36
|
+
import noTypes from './rules/noTypes.js';
|
|
37
|
+
import noUndefinedTypes from './rules/noUndefinedTypes.js';
|
|
38
|
+
import preferImportTag from './rules/preferImportTag.js';
|
|
39
|
+
import requireAsteriskPrefix from './rules/requireAsteriskPrefix.js';
|
|
40
|
+
import requireDescription from './rules/requireDescription.js';
|
|
41
|
+
import requireDescriptionCompleteSentence from './rules/requireDescriptionCompleteSentence.js';
|
|
42
|
+
import requireExample from './rules/requireExample.js';
|
|
43
|
+
import requireFileOverview from './rules/requireFileOverview.js';
|
|
44
|
+
import requireHyphenBeforeParamDescription from './rules/requireHyphenBeforeParamDescription.js';
|
|
45
|
+
import requireJsdoc from './rules/requireJsdoc.js';
|
|
46
|
+
import requireParam from './rules/requireParam.js';
|
|
47
|
+
import requireParamDescription from './rules/requireParamDescription.js';
|
|
48
|
+
import requireParamName from './rules/requireParamName.js';
|
|
49
|
+
import requireParamType from './rules/requireParamType.js';
|
|
50
|
+
import requireProperty from './rules/requireProperty.js';
|
|
51
|
+
import requirePropertyDescription from './rules/requirePropertyDescription.js';
|
|
52
|
+
import requirePropertyName from './rules/requirePropertyName.js';
|
|
53
|
+
import requirePropertyType from './rules/requirePropertyType.js';
|
|
54
|
+
import requireRejects from './rules/requireRejects.js';
|
|
55
|
+
import requireReturns from './rules/requireReturns.js';
|
|
56
|
+
import requireReturnsCheck from './rules/requireReturnsCheck.js';
|
|
57
|
+
import requireReturnsDescription from './rules/requireReturnsDescription.js';
|
|
58
|
+
import requireReturnsType from './rules/requireReturnsType.js';
|
|
59
|
+
import requireTags from './rules/requireTags.js';
|
|
60
|
+
import requireTemplate from './rules/requireTemplate.js';
|
|
61
|
+
import requireThrows from './rules/requireThrows.js';
|
|
62
|
+
import requireYields from './rules/requireYields.js';
|
|
63
|
+
import requireYieldsCheck from './rules/requireYieldsCheck.js';
|
|
64
|
+
import sortTags from './rules/sortTags.js';
|
|
65
|
+
import tagLines from './rules/tagLines.js';
|
|
66
|
+
import textEscaping from './rules/textEscaping.js';
|
|
67
|
+
import tsMethodSignatureStyle from './rules/tsMethodSignatureStyle.js';
|
|
68
|
+
import tsNoEmptyObjectType from './rules/tsNoEmptyObjectType.js';
|
|
69
|
+
import tsNoUnnecessaryTemplateExpression from './rules/tsNoUnnecessaryTemplateExpression.js';
|
|
70
|
+
import tsPreferFunctionType from './rules/tsPreferFunctionType.js';
|
|
71
|
+
import typeFormatting from './rules/typeFormatting.js';
|
|
72
|
+
import validTypes from './rules/validTypes.js';
|
|
73
|
+
import { ESLint } from 'eslint';
|
|
74
|
+
import semver from 'semver';
|
|
89
75
|
|
|
90
76
|
/**
|
|
91
77
|
* @typedef {"recommended" | "stylistic" | "contents" | "logical" | "requirements"} ConfigGroups
|
|
@@ -106,39 +92,39 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
|
|
|
106
92
|
const index = {};
|
|
107
93
|
index.configs = {};
|
|
108
94
|
index.rules = {
|
|
109
|
-
'check-access':
|
|
110
|
-
'check-alignment':
|
|
111
|
-
'check-examples':
|
|
112
|
-
'check-indentation':
|
|
113
|
-
'check-line-alignment':
|
|
114
|
-
'check-param-names':
|
|
115
|
-
'check-property-names':
|
|
116
|
-
'check-syntax':
|
|
117
|
-
'check-tag-names':
|
|
118
|
-
'check-template-names':
|
|
119
|
-
'check-types':
|
|
120
|
-
'check-values':
|
|
121
|
-
'convert-to-jsdoc-comments':
|
|
122
|
-
'empty-tags':
|
|
123
|
-
'escape-inline-tags':
|
|
124
|
-
'implements-on-classes':
|
|
125
|
-
'imports-as-dependencies':
|
|
126
|
-
'informative-docs':
|
|
127
|
-
'lines-before-block':
|
|
128
|
-
'match-description':
|
|
129
|
-
'match-name':
|
|
130
|
-
'multiline-blocks':
|
|
131
|
-
'no-bad-blocks':
|
|
132
|
-
'no-blank-block-descriptions':
|
|
133
|
-
'no-blank-blocks':
|
|
134
|
-
'no-defaults':
|
|
135
|
-
'no-missing-syntax':
|
|
136
|
-
'no-multi-asterisks':
|
|
137
|
-
'no-restricted-syntax':
|
|
138
|
-
'no-types':
|
|
139
|
-
'no-undefined-types':
|
|
140
|
-
'prefer-import-tag':
|
|
141
|
-
'reject-any-type':
|
|
95
|
+
'check-access': checkAccess,
|
|
96
|
+
'check-alignment': checkAlignment,
|
|
97
|
+
'check-examples': checkExamples,
|
|
98
|
+
'check-indentation': checkIndentation,
|
|
99
|
+
'check-line-alignment': checkLineAlignment,
|
|
100
|
+
'check-param-names': checkParamNames,
|
|
101
|
+
'check-property-names': checkPropertyNames,
|
|
102
|
+
'check-syntax': checkSyntax,
|
|
103
|
+
'check-tag-names': checkTagNames,
|
|
104
|
+
'check-template-names': checkTemplateNames,
|
|
105
|
+
'check-types': checkTypes,
|
|
106
|
+
'check-values': checkValues,
|
|
107
|
+
'convert-to-jsdoc-comments': convertToJsdocComments,
|
|
108
|
+
'empty-tags': emptyTags,
|
|
109
|
+
'escape-inline-tags': escapeInlineTags,
|
|
110
|
+
'implements-on-classes': implementsOnClasses,
|
|
111
|
+
'imports-as-dependencies': importsAsDependencies,
|
|
112
|
+
'informative-docs': informativeDocs,
|
|
113
|
+
'lines-before-block': linesBeforeBlock,
|
|
114
|
+
'match-description': matchDescription,
|
|
115
|
+
'match-name': matchName,
|
|
116
|
+
'multiline-blocks': multilineBlocks,
|
|
117
|
+
'no-bad-blocks': noBadBlocks,
|
|
118
|
+
'no-blank-block-descriptions': noBlankBlockDescriptions,
|
|
119
|
+
'no-blank-blocks': noBlankBlocks,
|
|
120
|
+
'no-defaults': noDefaults,
|
|
121
|
+
'no-missing-syntax': noMissingSyntax,
|
|
122
|
+
'no-multi-asterisks': noMultiAsterisks,
|
|
123
|
+
'no-restricted-syntax': noRestrictedSyntax,
|
|
124
|
+
'no-types': noTypes,
|
|
125
|
+
'no-undefined-types': noUndefinedTypes,
|
|
126
|
+
'prefer-import-tag': preferImportTag,
|
|
127
|
+
'reject-any-type': buildRejectOrPreferRuleDefinition({
|
|
142
128
|
description: 'Reports use of `any` or `*` type',
|
|
143
129
|
overrideSettings: {
|
|
144
130
|
'*': {
|
|
@@ -154,7 +140,7 @@ index.rules = {
|
|
|
154
140
|
},
|
|
155
141
|
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/reject-any-type.md#repos-sticky-header'
|
|
156
142
|
}),
|
|
157
|
-
'reject-function-type':
|
|
143
|
+
'reject-function-type': buildRejectOrPreferRuleDefinition({
|
|
158
144
|
description: 'Reports use of `Function` type',
|
|
159
145
|
overrideSettings: {
|
|
160
146
|
Function: {
|
|
@@ -165,14 +151,14 @@ index.rules = {
|
|
|
165
151
|
},
|
|
166
152
|
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/reject-function-type.md#repos-sticky-header'
|
|
167
153
|
}),
|
|
168
|
-
'require-asterisk-prefix':
|
|
169
|
-
'require-description':
|
|
170
|
-
'require-description-complete-sentence':
|
|
171
|
-
'require-example':
|
|
172
|
-
'require-file-overview':
|
|
173
|
-
'require-hyphen-before-param-description':
|
|
174
|
-
'require-jsdoc':
|
|
175
|
-
'require-next-description':
|
|
154
|
+
'require-asterisk-prefix': requireAsteriskPrefix,
|
|
155
|
+
'require-description': requireDescription,
|
|
156
|
+
'require-description-complete-sentence': requireDescriptionCompleteSentence,
|
|
157
|
+
'require-example': requireExample,
|
|
158
|
+
'require-file-overview': requireFileOverview,
|
|
159
|
+
'require-hyphen-before-param-description': requireHyphenBeforeParamDescription,
|
|
160
|
+
'require-jsdoc': requireJsdoc,
|
|
161
|
+
'require-next-description': buildForbidRuleDefinition({
|
|
176
162
|
contexts: [{
|
|
177
163
|
comment: 'JsdocBlock:has(JsdocTag[tag=next]:not([name!=""]):not([description!=""]))',
|
|
178
164
|
context: 'any',
|
|
@@ -181,7 +167,7 @@ index.rules = {
|
|
|
181
167
|
description: 'Requires a description for `@next` tags',
|
|
182
168
|
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-next-description.md#repos-sticky-header'
|
|
183
169
|
}),
|
|
184
|
-
'require-next-type':
|
|
170
|
+
'require-next-type': buildForbidRuleDefinition({
|
|
185
171
|
contexts: [{
|
|
186
172
|
comment: 'JsdocBlock:has(JsdocTag[tag=next]:not([parsedType.type]))',
|
|
187
173
|
context: 'any',
|
|
@@ -190,22 +176,22 @@ index.rules = {
|
|
|
190
176
|
description: 'Requires a type for `@next` tags',
|
|
191
177
|
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-next-type.md#repos-sticky-header'
|
|
192
178
|
}),
|
|
193
|
-
'require-param':
|
|
194
|
-
'require-param-description':
|
|
195
|
-
'require-param-name':
|
|
196
|
-
'require-param-type':
|
|
197
|
-
'require-property':
|
|
198
|
-
'require-property-description':
|
|
199
|
-
'require-property-name':
|
|
200
|
-
'require-property-type':
|
|
201
|
-
'require-rejects':
|
|
202
|
-
'require-returns':
|
|
203
|
-
'require-returns-check':
|
|
204
|
-
'require-returns-description':
|
|
205
|
-
'require-returns-type':
|
|
206
|
-
'require-tags':
|
|
207
|
-
'require-template':
|
|
208
|
-
'require-template-description':
|
|
179
|
+
'require-param': requireParam,
|
|
180
|
+
'require-param-description': requireParamDescription,
|
|
181
|
+
'require-param-name': requireParamName,
|
|
182
|
+
'require-param-type': requireParamType,
|
|
183
|
+
'require-property': requireProperty,
|
|
184
|
+
'require-property-description': requirePropertyDescription,
|
|
185
|
+
'require-property-name': requirePropertyName,
|
|
186
|
+
'require-property-type': requirePropertyType,
|
|
187
|
+
'require-rejects': requireRejects,
|
|
188
|
+
'require-returns': requireReturns,
|
|
189
|
+
'require-returns-check': requireReturnsCheck,
|
|
190
|
+
'require-returns-description': requireReturnsDescription,
|
|
191
|
+
'require-returns-type': requireReturnsType,
|
|
192
|
+
'require-tags': requireTags,
|
|
193
|
+
'require-template': requireTemplate,
|
|
194
|
+
'require-template-description': buildForbidRuleDefinition({
|
|
209
195
|
contexts: [{
|
|
210
196
|
comment: 'JsdocBlock:has(JsdocTag[tag=template]:not([description!=""]))',
|
|
211
197
|
context: 'any',
|
|
@@ -214,8 +200,8 @@ index.rules = {
|
|
|
214
200
|
description: 'Requires a description for `@template` tags',
|
|
215
201
|
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-template-description.md#repos-sticky-header'
|
|
216
202
|
}),
|
|
217
|
-
'require-throws':
|
|
218
|
-
'require-throws-description':
|
|
203
|
+
'require-throws': requireThrows,
|
|
204
|
+
'require-throws-description': buildForbidRuleDefinition({
|
|
219
205
|
contexts: [{
|
|
220
206
|
comment: 'JsdocBlock:has(JsdocTag[tag=/^(?:throws|exception)$/]:not([description!=""]))',
|
|
221
207
|
context: 'any',
|
|
@@ -224,7 +210,7 @@ index.rules = {
|
|
|
224
210
|
description: 'Requires a description for `@throws` tags',
|
|
225
211
|
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-throws-description.md#repos-sticky-header'
|
|
226
212
|
}),
|
|
227
|
-
'require-throws-type':
|
|
213
|
+
'require-throws-type': buildForbidRuleDefinition({
|
|
228
214
|
contexts: [{
|
|
229
215
|
comment: 'JsdocBlock:has(JsdocTag[tag=/^(?:throws|exception)$/]:not([parsedType.type]))',
|
|
230
216
|
context: 'any',
|
|
@@ -233,9 +219,9 @@ index.rules = {
|
|
|
233
219
|
description: 'Requires a type for `@throws` tags',
|
|
234
220
|
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-throws-type.md#repos-sticky-header'
|
|
235
221
|
}),
|
|
236
|
-
'require-yields':
|
|
237
|
-
'require-yields-check':
|
|
238
|
-
'require-yields-description':
|
|
222
|
+
'require-yields': requireYields,
|
|
223
|
+
'require-yields-check': requireYieldsCheck,
|
|
224
|
+
'require-yields-description': buildForbidRuleDefinition({
|
|
239
225
|
contexts: [{
|
|
240
226
|
comment: 'JsdocBlock:has(JsdocTag[tag=/^yields?$/]:not([name!=""]):not([description!=""]))',
|
|
241
227
|
context: 'any',
|
|
@@ -244,7 +230,7 @@ index.rules = {
|
|
|
244
230
|
description: 'Requires a description for `@yields` tags',
|
|
245
231
|
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields-description.md#repos-sticky-header'
|
|
246
232
|
}),
|
|
247
|
-
'require-yields-type':
|
|
233
|
+
'require-yields-type': buildForbidRuleDefinition({
|
|
248
234
|
contexts: [{
|
|
249
235
|
comment: 'JsdocBlock:has(JsdocTag[tag=/^yields?$/]:not([parsedType.type]))',
|
|
250
236
|
context: 'any',
|
|
@@ -253,15 +239,15 @@ index.rules = {
|
|
|
253
239
|
description: 'Requires a type for `@yields` tags',
|
|
254
240
|
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-yields-type.md#repos-sticky-header'
|
|
255
241
|
}),
|
|
256
|
-
'sort-tags':
|
|
257
|
-
'tag-lines':
|
|
258
|
-
'text-escaping':
|
|
259
|
-
'ts-method-signature-style':
|
|
260
|
-
'ts-no-empty-object-type':
|
|
261
|
-
'ts-no-unnecessary-template-expression':
|
|
262
|
-
'ts-prefer-function-type':
|
|
263
|
-
'type-formatting':
|
|
264
|
-
'valid-types':
|
|
242
|
+
'sort-tags': sortTags,
|
|
243
|
+
'tag-lines': tagLines,
|
|
244
|
+
'text-escaping': textEscaping,
|
|
245
|
+
'ts-method-signature-style': tsMethodSignatureStyle,
|
|
246
|
+
'ts-no-empty-object-type': tsNoEmptyObjectType,
|
|
247
|
+
'ts-no-unnecessary-template-expression': tsNoUnnecessaryTemplateExpression,
|
|
248
|
+
'ts-prefer-function-type': tsPreferFunctionType,
|
|
249
|
+
'type-formatting': typeFormatting,
|
|
250
|
+
'valid-types': validTypes
|
|
265
251
|
};
|
|
266
252
|
|
|
267
253
|
/**
|
|
@@ -497,7 +483,7 @@ index.configs.examples = /** @type {import('eslint').Linter.Config[]} */[{
|
|
|
497
483
|
files: ['**/*.js'],
|
|
498
484
|
name: 'jsdoc/examples/processor',
|
|
499
485
|
plugins: {
|
|
500
|
-
examples:
|
|
486
|
+
examples: getJsdocProcessorPlugin()
|
|
501
487
|
},
|
|
502
488
|
processor: 'examples/examples'
|
|
503
489
|
}, {
|
|
@@ -525,7 +511,7 @@ index.configs.examples = /** @type {import('eslint').Linter.Config[]} */[{
|
|
|
525
511
|
// Unlikely to have inadvertent debugging within examples
|
|
526
512
|
'no-console': 0,
|
|
527
513
|
/* c8 ignore next 11 -- Coercion should work */
|
|
528
|
-
...(
|
|
514
|
+
...(semver.gte(semver.coerce(ESLint.version) ?? '9.0.0', '9.0.0') ? {} : {
|
|
529
515
|
// "always" newline rule at end unlikely in sample code
|
|
530
516
|
'eol-last': 0,
|
|
531
517
|
// Often wish to start `@example` code after newline; also may use
|
|
@@ -547,7 +533,7 @@ index.configs['default-expressions'] = /** @type {import('eslint').Linter.Config
|
|
|
547
533
|
files: ['**/*.js'],
|
|
548
534
|
name: 'jsdoc/default-expressions/processor',
|
|
549
535
|
plugins: {
|
|
550
|
-
examples:
|
|
536
|
+
examples: getJsdocProcessorPlugin({
|
|
551
537
|
checkDefaults: true,
|
|
552
538
|
checkParams: true,
|
|
553
539
|
checkProperties: true
|
|
@@ -567,7 +553,7 @@ index.configs['default-expressions'] = /** @type {import('eslint').Linter.Config
|
|
|
567
553
|
'no-new': 0,
|
|
568
554
|
'no-unused-expressions': 0,
|
|
569
555
|
/* c8 ignore next 8 -- Coercion should work */
|
|
570
|
-
...(
|
|
556
|
+
...(semver.gte(semver.coerce(ESLint.version) ?? '9.0.0', '9.0.0') ? {} : {
|
|
571
557
|
quotes: ['error', 'double'],
|
|
572
558
|
semi: ['error', 'never']
|
|
573
559
|
}),
|
|
@@ -577,7 +563,7 @@ index.configs['default-expressions'] = /** @type {import('eslint').Linter.Config
|
|
|
577
563
|
index.configs['examples-and-default-expressions'] = /** @type {import('eslint').Linter.Config[]} */[{
|
|
578
564
|
name: 'jsdoc/examples-and-default-expressions',
|
|
579
565
|
plugins: {
|
|
580
|
-
examples:
|
|
566
|
+
examples: getJsdocProcessorPlugin({
|
|
581
567
|
checkDefaults: true,
|
|
582
568
|
checkParams: true,
|
|
583
569
|
checkProperties: true
|
|
@@ -601,7 +587,8 @@ index.configs['flat/recommended-mixed'] = [{
|
|
|
601
587
|
...index.configs['flat/recommended-typescript'],
|
|
602
588
|
files: ['**/*.{ts,tsx,cts,mts}']
|
|
603
589
|
}];
|
|
604
|
-
|
|
590
|
+
export default index;
|
|
591
|
+
|
|
605
592
|
/**
|
|
606
593
|
* @type {((
|
|
607
594
|
* cfg?: import('eslint').Linter.Config & {
|
|
@@ -638,7 +625,7 @@ var _default = exports.default = index;
|
|
|
638
625
|
* }
|
|
639
626
|
* ) => import('eslint').Linter.Config)}
|
|
640
627
|
*/
|
|
641
|
-
const jsdoc = function (cfg) {
|
|
628
|
+
export const jsdoc = function (cfg) {
|
|
642
629
|
/** @type {import('eslint').Linter.Config} */
|
|
643
630
|
let outputConfig = {
|
|
644
631
|
plugins: {
|
|
@@ -699,7 +686,7 @@ const jsdoc = function (cfg) {
|
|
|
699
686
|
description,
|
|
700
687
|
url
|
|
701
688
|
}] of Object.entries(cfg.extraRuleDefinitions.forbid)) {
|
|
702
|
-
outputConfig.plugins.jsdoc.rules[`forbid-${contextName}`] =
|
|
689
|
+
outputConfig.plugins.jsdoc.rules[`forbid-${contextName}`] = buildForbidRuleDefinition({
|
|
703
690
|
contextName,
|
|
704
691
|
contexts,
|
|
705
692
|
description,
|
|
@@ -713,7 +700,7 @@ const jsdoc = function (cfg) {
|
|
|
713
700
|
overrideSettings,
|
|
714
701
|
url
|
|
715
702
|
}] of Object.entries(cfg.extraRuleDefinitions.preferTypes)) {
|
|
716
|
-
outputConfig.plugins.jsdoc.rules[`prefer-type-${typeName}`] =
|
|
703
|
+
outputConfig.plugins.jsdoc.rules[`prefer-type-${typeName}`] = buildRejectOrPreferRuleDefinition({
|
|
717
704
|
description,
|
|
718
705
|
overrideSettings,
|
|
719
706
|
typeName,
|
|
@@ -724,7 +711,7 @@ const jsdoc = function (cfg) {
|
|
|
724
711
|
}
|
|
725
712
|
}
|
|
726
713
|
outputConfig.settings = {
|
|
727
|
-
jsdoc: cfg?.mergeSettings === false ? cfg.settings :
|
|
714
|
+
jsdoc: cfg?.mergeSettings === false ? cfg.settings : merge({}, cfg?.settings ?? {}, cfg?.config?.includes('recommended') ? {
|
|
728
715
|
// We may need to drop these for "typescript" (non-"flavor") configs,
|
|
729
716
|
// if support is later added: https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html
|
|
730
717
|
structuredTags: {
|
|
@@ -739,5 +726,5 @@ const jsdoc = function (cfg) {
|
|
|
739
726
|
};
|
|
740
727
|
return outputConfig;
|
|
741
728
|
};
|
|
742
|
-
|
|
729
|
+
export { getJsdocProcessorPlugin } from './getJsdocProcessorPlugin.js';
|
|
743
730
|
//# sourceMappingURL=index.cjs.map
|