summaryrefslogtreecommitdiff
path: root/tools/node_modules/eslint/node_modules/eslint-plugin-jsdoc/dist/index.js
blob: 7f450e2cf47b09b84244f2c2744d51b9d0ccedd4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.default = void 0;
var _checkAccess = _interopRequireDefault(require("./rules/checkAccess"));
var _checkAlignment = _interopRequireDefault(require("./rules/checkAlignment"));
var _checkExamples = _interopRequireDefault(require("./rules/checkExamples"));
var _checkIndentation = _interopRequireDefault(require("./rules/checkIndentation"));
var _checkLineAlignment = _interopRequireDefault(require("./rules/checkLineAlignment"));
var _checkParamNames = _interopRequireDefault(require("./rules/checkParamNames"));
var _checkPropertyNames = _interopRequireDefault(require("./rules/checkPropertyNames"));
var _checkSyntax = _interopRequireDefault(require("./rules/checkSyntax"));
var _checkTagNames = _interopRequireDefault(require("./rules/checkTagNames"));
var _checkTypes = _interopRequireDefault(require("./rules/checkTypes"));
var _checkValues = _interopRequireDefault(require("./rules/checkValues"));
var _emptyTags = _interopRequireDefault(require("./rules/emptyTags"));
var _implementsOnClasses = _interopRequireDefault(require("./rules/implementsOnClasses"));
var _matchDescription = _interopRequireDefault(require("./rules/matchDescription"));
var _matchName = _interopRequireDefault(require("./rules/matchName"));
var _multilineBlocks = _interopRequireDefault(require("./rules/multilineBlocks"));
var _newlineAfterDescription = _interopRequireDefault(require("./rules/newlineAfterDescription"));
var _noBadBlocks = _interopRequireDefault(require("./rules/noBadBlocks"));
var _noDefaults = _interopRequireDefault(require("./rules/noDefaults"));
var _noMissingSyntax = _interopRequireDefault(require("./rules/noMissingSyntax"));
var _noMultiAsterisks = _interopRequireDefault(require("./rules/noMultiAsterisks"));
var _noRestrictedSyntax = _interopRequireDefault(require("./rules/noRestrictedSyntax"));
var _noTypes = _interopRequireDefault(require("./rules/noTypes"));
var _noUndefinedTypes = _interopRequireDefault(require("./rules/noUndefinedTypes"));
var _requireAsteriskPrefix = _interopRequireDefault(require("./rules/requireAsteriskPrefix"));
var _requireDescription = _interopRequireDefault(require("./rules/requireDescription"));
var _requireDescriptionCompleteSentence = _interopRequireDefault(require("./rules/requireDescriptionCompleteSentence"));
var _requireExample = _interopRequireDefault(require("./rules/requireExample"));
var _requireFileOverview = _interopRequireDefault(require("./rules/requireFileOverview"));
var _requireHyphenBeforeParamDescription = _interopRequireDefault(require("./rules/requireHyphenBeforeParamDescription"));
var _requireJsdoc = _interopRequireDefault(require("./rules/requireJsdoc"));
var _requireParam = _interopRequireDefault(require("./rules/requireParam"));
var _requireParamDescription = _interopRequireDefault(require("./rules/requireParamDescription"));
var _requireParamName = _interopRequireDefault(require("./rules/requireParamName"));
var _requireParamType = _interopRequireDefault(require("./rules/requireParamType"));
var _requireProperty = _interopRequireDefault(require("./rules/requireProperty"));
var _requirePropertyDescription = _interopRequireDefault(require("./rules/requirePropertyDescription"));
var _requirePropertyName = _interopRequireDefault(require("./rules/requirePropertyName"));
var _requirePropertyType = _interopRequireDefault(require("./rules/requirePropertyType"));
var _requireReturns = _interopRequireDefault(require("./rules/requireReturns"));
var _requireReturnsCheck = _interopRequireDefault(require("./rules/requireReturnsCheck"));
var _requireReturnsDescription = _interopRequireDefault(require("./rules/requireReturnsDescription"));
var _requireReturnsType = _interopRequireDefault(require("./rules/requireReturnsType"));
var _requireThrows = _interopRequireDefault(require("./rules/requireThrows"));
var _requireYields = _interopRequireDefault(require("./rules/requireYields"));
var _requireYieldsCheck = _interopRequireDefault(require("./rules/requireYieldsCheck"));
var _sortTags = _interopRequireDefault(require("./rules/sortTags"));
var _tagLines = _interopRequireDefault(require("./rules/tagLines"));
var _textEscaping = _interopRequireDefault(require("./rules/textEscaping"));
var _validTypes = _interopRequireDefault(require("./rules/validTypes"));
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
const index = {
  configs: {},
  rules: {
    'check-access': _checkAccess.default,
    'check-alignment': _checkAlignment.default,
    'check-examples': _checkExamples.default,
    'check-indentation': _checkIndentation.default,
    'check-line-alignment': _checkLineAlignment.default,
    'check-param-names': _checkParamNames.default,
    'check-property-names': _checkPropertyNames.default,
    'check-syntax': _checkSyntax.default,
    'check-tag-names': _checkTagNames.default,
    'check-types': _checkTypes.default,
    'check-values': _checkValues.default,
    'empty-tags': _emptyTags.default,
    'implements-on-classes': _implementsOnClasses.default,
    'match-description': _matchDescription.default,
    'match-name': _matchName.default,
    'multiline-blocks': _multilineBlocks.default,
    'newline-after-description': _newlineAfterDescription.default,
    'no-bad-blocks': _noBadBlocks.default,
    'no-defaults': _noDefaults.default,
    'no-missing-syntax': _noMissingSyntax.default,
    'no-multi-asterisks': _noMultiAsterisks.default,
    'no-restricted-syntax': _noRestrictedSyntax.default,
    'no-types': _noTypes.default,
    'no-undefined-types': _noUndefinedTypes.default,
    'require-asterisk-prefix': _requireAsteriskPrefix.default,
    'require-description': _requireDescription.default,
    'require-description-complete-sentence': _requireDescriptionCompleteSentence.default,
    'require-example': _requireExample.default,
    'require-file-overview': _requireFileOverview.default,
    'require-hyphen-before-param-description': _requireHyphenBeforeParamDescription.default,
    'require-jsdoc': _requireJsdoc.default,
    'require-param': _requireParam.default,
    'require-param-description': _requireParamDescription.default,
    'require-param-name': _requireParamName.default,
    'require-param-type': _requireParamType.default,
    'require-property': _requireProperty.default,
    'require-property-description': _requirePropertyDescription.default,
    'require-property-name': _requirePropertyName.default,
    'require-property-type': _requirePropertyType.default,
    'require-returns': _requireReturns.default,
    'require-returns-check': _requireReturnsCheck.default,
    'require-returns-description': _requireReturnsDescription.default,
    'require-returns-type': _requireReturnsType.default,
    'require-throws': _requireThrows.default,
    'require-yields': _requireYields.default,
    'require-yields-check': _requireYieldsCheck.default,
    'sort-tags': _sortTags.default,
    'tag-lines': _tagLines.default,
    'text-escaping': _textEscaping.default,
    'valid-types': _validTypes.default
  }
};
const createRecommendedRuleset = warnOrError => {
  return {
    plugins: ['jsdoc'],
    rules: {
      'jsdoc/check-access': warnOrError,
      'jsdoc/check-alignment': warnOrError,
      'jsdoc/check-examples': 'off',
      'jsdoc/check-indentation': 'off',
      'jsdoc/check-line-alignment': 'off',
      'jsdoc/check-param-names': warnOrError,
      'jsdoc/check-property-names': warnOrError,
      'jsdoc/check-syntax': 'off',
      'jsdoc/check-tag-names': warnOrError,
      'jsdoc/check-types': warnOrError,
      'jsdoc/check-values': warnOrError,
      'jsdoc/empty-tags': warnOrError,
      'jsdoc/implements-on-classes': warnOrError,
      'jsdoc/match-description': 'off',
      'jsdoc/match-name': 'off',
      'jsdoc/multiline-blocks': warnOrError,
      'jsdoc/newline-after-description': warnOrError,
      'jsdoc/no-bad-blocks': 'off',
      'jsdoc/no-defaults': 'off',
      'jsdoc/no-missing-syntax': 'off',
      'jsdoc/no-multi-asterisks': warnOrError,
      'jsdoc/no-restricted-syntax': 'off',
      'jsdoc/no-types': 'off',
      'jsdoc/no-undefined-types': warnOrError,
      'jsdoc/require-asterisk-prefix': 'off',
      'jsdoc/require-description': 'off',
      'jsdoc/require-description-complete-sentence': 'off',
      'jsdoc/require-example': 'off',
      'jsdoc/require-file-overview': 'off',
      'jsdoc/require-hyphen-before-param-description': 'off',
      'jsdoc/require-jsdoc': warnOrError,
      'jsdoc/require-param': warnOrError,
      'jsdoc/require-param-description': warnOrError,
      'jsdoc/require-param-name': warnOrError,
      'jsdoc/require-param-type': warnOrError,
      'jsdoc/require-property': warnOrError,
      'jsdoc/require-property-description': warnOrError,
      'jsdoc/require-property-name': warnOrError,
      'jsdoc/require-property-type': warnOrError,
      'jsdoc/require-returns': warnOrError,
      'jsdoc/require-returns-check': warnOrError,
      'jsdoc/require-returns-description': warnOrError,
      'jsdoc/require-returns-type': warnOrError,
      'jsdoc/require-throws': 'off',
      'jsdoc/require-yields': warnOrError,
      'jsdoc/require-yields-check': warnOrError,
      'jsdoc/sort-tags': 'off',
      'jsdoc/tag-lines': warnOrError,
      'jsdoc/text-escaping': 'off',
      'jsdoc/valid-types': warnOrError
    }
  };
};
const createRecommendedTypeScriptRuleset = warnOrError => {
  const ruleset = createRecommendedRuleset(warnOrError);
  return {
    ...ruleset,
    rules: {
      ...ruleset.rules,
      /* eslint-disable indent -- Extra indent to avoid use by auto-rule-editing */
      'jsdoc/no-types': warnOrError,
      'jsdoc/require-param-type': 'off',
      'jsdoc/require-property-type': 'off',
      'jsdoc/require-returns-type': 'off'
      /* eslint-enable indent */
    }
  };
};

index.configs.recommended = createRecommendedRuleset('warn');
index.configs['recommended-error'] = createRecommendedRuleset('error');
index.configs['recommended-typescript'] = createRecommendedTypeScriptRuleset('warn');
index.configs['recommended-typescript-error'] = createRecommendedTypeScriptRuleset('error');
var _default = index;
exports.default = _default;
module.exports = exports.default;
//# sourceMappingURL=index.js.map