Skip to content

Commit a32ab26

Browse files
RunDevelopmentRunDevelopment
authored
Disable require-jsdoc rule (#601)
1 parent d0b90a9 commit a32ab26

File tree

85 files changed

+2
-388
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

85 files changed

+2
-388
lines changed

‎.eslintrc.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ module.exports = {
1717
"plugin:regexp/recommended",
1818
],
1919
rules: {
20-
"require-jsdoc": "error",
20+
"require-jsdoc": "off",
2121
"no-warning-comments": "warn",
2222
"no-lonely-if": "off",
2323
complexity: "off",

‎lib/rules/confusing-quantifier.ts

-3
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,6 @@ export default createRule("confusing-quantifier", {
2424
type: "problem",
2525
},
2626
create(context) {
27-
/**
28-
* Create visitor
29-
*/
3027
function createVisitor({
3128
node,
3229
flags,

‎lib/rules/control-character-escape.ts

-3
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,6 @@ export default createRule("control-character-escape", {
5858
type: "suggestion", // "problem",
5959
},
6060
create(context) {
61-
/**
62-
* Create visitor
63-
*/
6461
function createVisitor(
6562
regexpContext: RegExpContext,
6663
): RegExpVisitor.Handlers {

‎lib/rules/hexadecimal-escape.ts

-9
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,6 @@ export default createRule("hexadecimal-escape", {
3232
create(context) {
3333
const always = context.options[0] !== "never"
3434

35-
/**
36-
* Verify for always
37-
*/
3835
function verifyForAlways(
3936
{ node, getRegexpLocation, fixReplaceNode }: RegExpContext,
4037
kind: EscapeSequenceKind,
@@ -62,9 +59,6 @@ export default createRule("hexadecimal-escape", {
6259
})
6360
}
6461

65-
/**
66-
* Verify for never
67-
*/
6862
function verifyForNever(
6963
{ node, getRegexpLocation, fixReplaceNode }: RegExpContext,
7064
kind: EscapeSequenceKind,
@@ -86,9 +80,6 @@ export default createRule("hexadecimal-escape", {
8680

8781
const verify = always ? verifyForAlways : verifyForNever
8882

89-
/**
90-
* Create visitor
91-
*/
9283
function createVisitor(
9384
regexpContext: RegExpContext,
9485
): RegExpVisitor.Handlers {

‎lib/rules/letter-case.ts

-12
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ const DEFAULTS = {
2424
controlEscape: "uppercase" as const,
2525
}
2626

27-
/** Parse option */
2827
function parseOptions(option?: {
2928
caseInsensitive?: Case
3029
unicodeEscape?: Case
@@ -89,9 +88,6 @@ export default createRule("letter-case", {
8988
create(context) {
9089
const options = parseOptions(context.options[0])
9190

92-
/**
93-
* Report
94-
*/
9591
function report(
9692
{ node, getRegexpLocation, fixReplaceNode }: RegExpContext,
9793
reportNode: CharacterClassRange | Character,
@@ -112,7 +108,6 @@ export default createRule("letter-case", {
112108
})
113109
}
114110

115-
/** Verify for Character in case insensitive */
116111
function verifyCharacterInCaseInsensitive(
117112
regexpContext: RegExpContext,
118113
cNode: Character,
@@ -135,7 +130,6 @@ export default createRule("letter-case", {
135130
)
136131
}
137132

138-
/** Verify for CharacterClassRange in case insensitive */
139133
function verifyCharacterClassRangeInCaseInsensitive(
140134
regexpContext: RegExpContext,
141135
ccrNode: CharacterClassRange,
@@ -166,7 +160,6 @@ export default createRule("letter-case", {
166160
)
167161
}
168162

169-
/** Verify for Character in unicode escape */
170163
function verifyCharacterInUnicodeEscape(
171164
regexpContext: RegExpContext,
172165
cNode: Character,
@@ -193,7 +186,6 @@ export default createRule("letter-case", {
193186
)
194187
}
195188

196-
/** Verify for Character in hexadecimal escape */
197189
function verifyCharacterInHexadecimalEscape(
198190
regexpContext: RegExpContext,
199191
cNode: Character,
@@ -217,7 +209,6 @@ export default createRule("letter-case", {
217209
)
218210
}
219211

220-
/** Verify for Character in control escape */
221212
function verifyCharacterInControl(
222213
regexpContext: RegExpContext,
223214
cNode: Character,
@@ -239,9 +230,6 @@ export default createRule("letter-case", {
239230
)
240231
}
241232

242-
/**
243-
* Create visitor
244-
*/
245233
function createVisitor(
246234
regexpContext: RegExpContext,
247235
): RegExpVisitor.Handlers {

‎lib/rules/match-any.ts

-3
Original file line numberDiff line numberDiff line change
@@ -129,9 +129,6 @@ export default createRule("match-any", {
129129
return range?.replace(fixer, preference) ?? null
130130
}
131131

132-
/**
133-
* Create visitor
134-
*/
135132
function createVisitor(
136133
regexpContext: RegExpContext,
137134
): RegExpVisitor.Handlers {

‎lib/rules/negation.ts

-3
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,6 @@ export default createRule("negation", {
2323
type: "suggestion", // "problem",
2424
},
2525
create(context) {
26-
/**
27-
* Create visitor
28-
*/
2926
function createVisitor({
3027
node,
3128
getRegexpLocation,

‎lib/rules/no-contradiction-with-assertion.ts

-1
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,6 @@ export default createRule("no-contradiction-with-assertion", {
249249
type: "problem",
250250
},
251251
create(context) {
252-
/** Create visitor */
253252
function createVisitor(
254253
regexpContext: RegExpContext,
255254
): RegExpVisitor.Handlers {

‎lib/rules/no-control-character.ts

-5
Original file line numberDiff line numberDiff line change
@@ -36,16 +36,12 @@ export default createRule("no-control-character", {
3636
hasSuggestions: true,
3737
},
3838
create(context) {
39-
/**
40-
* Create visitor
41-
*/
4239
function createVisitor(
4340
regexpContext: RegExpContext,
4441
): RegExpVisitor.Handlers {
4542
const { node, patternSource, getRegexpLocation, fixReplaceNode } =
4643
regexpContext
4744

48-
/** */
4945
function isBadEscapeRaw(raw: string, cp: number): boolean {
5046
return (
5147
raw.codePointAt(0)! === cp ||
@@ -54,7 +50,6 @@ export default createRule("no-control-character", {
5450
)
5551
}
5652

57-
/** */
5853
function isAllowedEscapeRaw(raw: string): boolean {
5954
return (
6055
ALLOWED_CONTROL_CHARS.test(raw) ||

‎lib/rules/no-dupe-characters-character-class.ts

-6
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,6 @@ function groupElements(
9191
characterSets: [...characterSets.values()],
9292
}
9393

94-
/**
95-
* Build key of range
96-
*/
9794
function buildRangeKey(rangeCharSet: CharSet) {
9895
return rangeCharSet.ranges
9996
.map((r) => String.fromCodePoint(r.min, r.max))
@@ -246,9 +243,6 @@ export default createRule("no-dupe-characters-character-class", {
246243
})
247244
}
248245

249-
/**
250-
* Create visitor
251-
*/
252246
function createVisitor(
253247
regexpContext: RegExpContext,
254248
): RegExpVisitor.Handlers {

‎lib/rules/no-dupe-disjunctions.ts

-19
Original file line numberDiff line numberDiff line change
@@ -281,9 +281,6 @@ function* iteratePartialAlternatives(
281281
}
282282
}
283283

284-
/**
285-
* Unions all given NFAs
286-
*/
287284
function unionAll(nfas: readonly ReadonlyNFA[]): ReadonlyNFA {
288285
if (nfas.length === 0) {
289286
throw new Error("Cannot union 0 NFAs.")
@@ -300,9 +297,6 @@ function unionAll(nfas: readonly ReadonlyNFA[]): ReadonlyNFA {
300297

301298
const MAX_DFA_NODES = 100_000
302299

303-
/**
304-
* Returns whether one NFA is a subset of another.
305-
*/
306300
function isSubsetOf(
307301
superset: ReadonlyNFA,
308302
subset: ReadonlyNFA,
@@ -330,9 +324,6 @@ const enum SubsetRelation {
330324
unknown,
331325
}
332326

333-
/**
334-
* Returns the subset relation
335-
*/
336327
function getSubsetRelation(
337328
left: ReadonlyNFA,
338329
right: ReadonlyNFA,
@@ -832,14 +823,10 @@ function deduplicateResults(
832823
})
833824
}
834825

835-
/**
836-
* Throws if called.
837-
*/
838826
function assertNever(value: never): never {
839827
throw new Error(`Invalid value: ${value}`)
840828
}
841829

842-
/** Mentions the given nested alternative. */
843830
function mentionNested(nested: NestedAlternative): string {
844831
if (nested.type === "Alternative") {
845832
return mention(nested)
@@ -963,9 +950,6 @@ export default createRule("no-dupe-disjunctions", {
963950

964951
const allowedRanges = getAllowedCharRanges(undefined, context)
965952

966-
/**
967-
* Create visitor
968-
*/
969953
function createVisitor(
970954
regexpContext: RegExpContext,
971955
): RegExpVisitor.Handlers {
@@ -1135,7 +1119,6 @@ export default createRule("no-dupe-disjunctions", {
11351119
}
11361120
}
11371121

1138-
/** Prints the given character. */
11391122
function printChar(char: number): string {
11401123
if (inRange(allowedRanges, char)) {
11411124
return String.fromCodePoint(char)
@@ -1150,7 +1133,6 @@ export default createRule("no-dupe-disjunctions", {
11501133
return `\\u{${char.toString(16)}}`
11511134
}
11521135

1153-
/** Returns suggestions for fixing the given report */
11541136
function getSuggestions(
11551137
result: Result,
11561138
): Rule.SuggestionReportDescriptor[] {
@@ -1232,7 +1214,6 @@ export default createRule("no-dupe-disjunctions", {
12321214
]
12331215
}
12341216

1235-
/** Report the given result. */
12361217
function reportResult(result: Result, { stared }: FilterInfo) {
12371218
let exp
12381219
if (stared === MaybeBool.true) {

‎lib/rules/no-empty-alternative.ts

-6
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,10 @@ export default createRule("no-empty-alternative", {
2222
type: "problem",
2323
},
2424
create(context) {
25-
/**
26-
* Create visitor
27-
*/
2825
function createVisitor({
2926
node,
3027
getRegexpLocation,
3128
}: RegExpContext): RegExpVisitor.Handlers {
32-
/**
33-
* Verify alternatives
34-
*/
3529
function verifyAlternatives(
3630
regexpNode: CapturingGroup | Group | Pattern,
3731
) {

‎lib/rules/no-empty-capturing-group.ts

-3
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,6 @@ export default createRule("no-empty-capturing-group", {
1717
type: "suggestion",
1818
},
1919
create(context) {
20-
/**
21-
* Create visitor
22-
*/
2320
function createVisitor({
2421
node,
2522
flags,

‎lib/rules/no-empty-character-class.ts

-3
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,6 @@ export default createRule("no-empty-character-class", {
1818
type: "suggestion", // "problem",
1919
},
2020
create(context) {
21-
/**
22-
* Create visitor
23-
*/
2421
function createVisitor(
2522
regexpContext: RegExpContext,
2623
): RegExpVisitor.Handlers {

‎lib/rules/no-empty-group.ts

-6
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,6 @@ export default createRule("no-empty-group", {
1717
type: "suggestion",
1818
},
1919
create(context) {
20-
/**
21-
* verify group node
22-
*/
2320
function verifyGroup(
2421
{ node, getRegexpLocation }: RegExpContext,
2522
gNode: Group | CapturingGroup,
@@ -33,9 +30,6 @@ export default createRule("no-empty-group", {
3330
}
3431
}
3532

36-
/**
37-
* Create visitor
38-
*/
3933
function createVisitor(
4034
regexpContext: RegExpContext,
4135
): RegExpVisitor.Handlers {

‎lib/rules/no-empty-lookarounds-assertion.ts

-3
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,6 @@ export default createRule("no-empty-lookarounds-assertion", {
1919
type: "suggestion",
2020
},
2121
create(context) {
22-
/**
23-
* Create visitor
24-
*/
2522
function createVisitor({
2623
node,
2724
flags,

‎lib/rules/no-escape-backspace.ts

-3
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,6 @@ export default createRule("no-escape-backspace", {
1616
type: "suggestion", // "problem",
1717
},
1818
create(context) {
19-
/**
20-
* Create visitor
21-
*/
2219
function createVisitor({
2320
node,
2421
getRegexpLocation,

‎lib/rules/no-extra-lookaround-assertions.ts

-5
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,6 @@ export default createRule("no-extra-lookaround-assertions", {
2121
type: "suggestion",
2222
},
2323
create(context) {
24-
/**
25-
* Create visitor
26-
*/
2724
function createVisitor(
2825
regexpContext: RegExpContext,
2926
): RegExpVisitor.Handlers {
@@ -39,7 +36,6 @@ export default createRule("no-extra-lookaround-assertions", {
3936
}
4037
}
4138

42-
/** Verify for lookaround assertion */
4339
function verify(
4440
regexpContext: RegExpContext,
4541
assertion: LookaroundAssertion,
@@ -64,7 +60,6 @@ export default createRule("no-extra-lookaround-assertions", {
6460
}
6561
}
6662

67-
/** Report */
6863
function reportLookaroundAssertion(
6964
{ node, getRegexpLocation, fixReplaceNode }: RegExpContext,
7065
assertion: LookaroundAssertion,

‎lib/rules/no-invalid-regexp.ts

-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ export default createRule("no-invalid-regexp", {
2828
type: "problem",
2929
},
3030
create(context) {
31-
/** Visit invalid regexes */
3231
function visitInvalid(regexpContext: RegExpContextForInvalid): void {
3332
const { node, error, patternSource } = regexpContext
3433

‎lib/rules/no-invisible-character.ts

-3
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,6 @@ export default createRule("no-invisible-character", {
2626
create(context) {
2727
const sourceCode = context.getSourceCode()
2828

29-
/**
30-
* Create visitor
31-
*/
3229
function createLiteralVisitor({
3330
node,
3431
flags,

0 commit comments

Comments
 (0)