Skip to content
This repository was archived by the owner on Mar 7, 2025. It is now read-only.

Commit 553c73f

Browse files
committed
Remove non generated JSDoc to minimize diffs
1 parent 8357bf9 commit 553c73f

25 files changed

+25
-597
lines changed

src/rules/eslint/dot-notation.d.ts

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,7 @@ import type { RuleConfig } from '../rule-config';
44
* Option.
55
*/
66
export interface DotNotationOption {
7-
/**
8-
* Set to `false` to follow ECMAScript version 3 compatible style, avoiding dot notation for reserved word properties.
9-
*
10-
* @default true
11-
*
12-
* @see [allowKeywords](https://eslint.org/docs/rules/dot-notation#allowkeywords)
13-
*/
147
allowKeywords?: boolean;
15-
/**
16-
* Set to a regular expression string to allow bracket notation for property names that match a pattern.
17-
*
18-
* @default false
19-
*
20-
* @see [allowPattern](https://eslint.org/docs/rules/dot-notation#allowpattern)
21-
*/
228
allowPattern?: string;
239
}
2410

src/rules/eslint/id-blacklist.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ export type IdBlacklistOptions = IdBlacklistOption;
1313
/**
1414
* Disallow specified identifiers.
1515
*
16-
* @deprecated Use `id-denylist` instead.
16+
* @deprecated
1717
*
1818
* @see [id-blacklist](https://eslint.org/docs/rules/id-blacklist)
1919
*/
@@ -22,15 +22,15 @@ export type IdBlacklistRuleConfig = RuleConfig<IdBlacklistOptions>;
2222
/**
2323
* Disallow specified identifiers.
2424
*
25-
* @deprecated Use `id-denylist` instead.
25+
* @deprecated
2626
*
2727
* @see [id-blacklist](https://eslint.org/docs/rules/id-blacklist)
2828
*/
2929
export interface IdBlacklistRule {
3030
/**
3131
* Disallow specified identifiers.
3232
*
33-
* @deprecated Use `id-denylist` instead.
33+
* @deprecated
3434
*
3535
* @see [id-blacklist](https://eslint.org/docs/rules/id-blacklist)
3636
*/

src/rules/eslint/max-len.d.ts

Lines changed: 0 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -4,85 +4,15 @@ import type { RuleConfig } from '../rule-config';
44
* Setting.
55
*/
66
export interface MaxLenSetting {
7-
/**
8-
* Enforces a maximum line length.
9-
*
10-
* @default 80
11-
*
12-
* @see [code](https://eslint.org/docs/rules/max-len#code)
13-
*/
147
code?: number;
15-
/**
16-
* Enforces a maximum line length for comments.
17-
*
18-
* @default - to value of code.
19-
*
20-
* @see [comments](https://eslint.org/docs/rules/max-len#comments)
21-
*/
228
comments?: number;
23-
/**
24-
* Specifies the character width for tab characters.
25-
*
26-
* @default 4
27-
*
28-
* @see [tabWidth](https://eslint.org/docs/rules/max-len#tabwidth)
29-
*/
309
tabWidth?: number;
31-
/**
32-
* Ignores lines matching a regular expression
33-
*
34-
* Can only match a single line and need to be double escaped when written in YAML or JSON.
35-
*
36-
* @see [ignorePattern](https://eslint.org/docs/rules/max-len#ignorepattern)
37-
*/
3810
ignorePattern?: string;
39-
/**
40-
* Ignores all trailing comments and comments on their own line.
41-
*
42-
* @default true
43-
*
44-
* @see [ignoreComments](https://eslint.org/docs/rules/max-len#ignorecomments)
45-
*/
4611
ignoreComments?: boolean;
47-
/**
48-
* Ignores lines that contain a double-quoted or single-quoted string.
49-
*
50-
* @default true
51-
*
52-
* @see [ignoreStrings](https://eslint.org/docs/rules/max-len#ignorestrings)
53-
*/
5412
ignoreStrings?: boolean;
55-
/**
56-
* Ignores lines that contain a URL.
57-
*
58-
* @default true
59-
*
60-
* @see [ignoreUrls](https://eslint.org/docs/rules/max-len#ignoreurls)
61-
*/
6213
ignoreUrls?: boolean;
63-
/**
64-
* Ignores lines that contain a template literal.
65-
*
66-
* @default true
67-
*
68-
* @see [ignoreTemplateLiterals](https://eslint.org/docs/rules/max-len#ignoretemplateliterals)
69-
*/
7014
ignoreTemplateLiterals?: boolean;
71-
/**
72-
* Ignores lines that contain a RegExp literal.
73-
*
74-
* @default true
75-
*
76-
* @see [ignoreRegExpLiterals](https://eslint.org/docs/rules/max-len#ignoreregexpliterals)
77-
*/
7815
ignoreRegExpLiterals?: boolean;
79-
/**
80-
* Ignores only trailing comments.
81-
*
82-
* @default true
83-
*
84-
* @see [ignoreTrailingComments](https://eslint.org/docs/rules/max-len#ignoretrailingcomments)
85-
*/
8616
ignoreTrailingComments?: boolean;
8717
}
8818

src/rules/eslint/max-lines.d.ts

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,8 @@ import type { RuleConfig } from '../rule-config';
66
export type MaxLinesOption =
77
| number
88
| {
9-
/**
10-
* Enforces a maximum number of lines in a file.
11-
*
12-
* @default 300
13-
*
14-
* @see [max](https://eslint.org/docs/rules/max-lines#code)
15-
*/
169
max?: number;
17-
/**
18-
* Ignore lines containing just comments.
19-
*
20-
* @default true
21-
*
22-
* @see [skipComments](https://eslint.org/docs/rules/max-lines#skipcomments)
23-
*/
2410
skipComments?: boolean;
25-
/**
26-
* Ignore lines made up purely of whitespace.
27-
*
28-
* @default true
29-
*
30-
* @see [skipBlankLines](https://eslint.org/docs/rules/max-lines#skipblanklines)
31-
*/
3211
skipBlankLines?: boolean;
3312
};
3413

src/rules/eslint/no-constant-condition.d.ts

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,6 @@ import type { RuleConfig } from '../rule-config';
44
* Option.
55
*/
66
export interface NoConstantConditionOption {
7-
/**
8-
* Setting this option to `false` allows constant expressions in loops.
9-
*
10-
* @default true
11-
*
12-
* @see [checkLoops](https://eslint.org/docs/rules/no-constant-condition#checkloops)
13-
*/
147
checkLoops?: boolean;
158
}
169

src/rules/eslint/no-process-exit.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import type { RuleConfig } from '../rule-config';
33
/**
44
* Disallow the use of `process.exit()`.
55
*
6-
* @deprecated This rule was **deprecated** in ESLint `v7.0.0`. Please use the corresponding rule in [`eslint-plugin-node`](https://github.com/mysticatea/eslint-plugin-node).
6+
* @deprecated
77
*
88
* @see [no-process-exit](https://eslint.org/docs/rules/no-process-exit)
99
*/
@@ -12,15 +12,15 @@ export type NoProcessExitRuleConfig = RuleConfig<[]>;
1212
/**
1313
* Disallow the use of `process.exit()`.
1414
*
15-
* @deprecated This rule was **deprecated** in ESLint `v7.0.0`. Please use the corresponding rule in [`eslint-plugin-node`](https://github.com/mysticatea/eslint-plugin-node).
15+
* @deprecated
1616
*
1717
* @see [no-process-exit](https://eslint.org/docs/rules/no-process-exit)
1818
*/
1919
export interface NoProcessExitRule {
2020
/**
2121
* Disallow the use of `process.exit()`.
2222
*
23-
* @deprecated This rule was **deprecated** in ESLint `v7.0.0`. Please use the corresponding rule in [`eslint-plugin-node`](https://github.com/mysticatea/eslint-plugin-node).
23+
* @deprecated
2424
*
2525
* @see [no-process-exit](https://eslint.org/docs/rules/no-process-exit)
2626
*/

src/rules/eslint/no-unused-expressions.d.ts

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -4,37 +4,9 @@ import type { RuleConfig } from '../rule-config';
44
* Option.
55
*/
66
export interface NoUnusedExpressionsOption {
7-
/**
8-
* Set to `true` will allow you to use short circuit evaluations in your expressions.
9-
*
10-
* @default false
11-
*
12-
* @see [allowShortCircuit](https://eslint.org/docs/rules/no-unused-expressions#allowshortcircuit)
13-
*/
147
allowShortCircuit?: boolean;
15-
/**
16-
* Set to `true` will enable you to use ternary operators in your expressions similarly to short circuit evaluations.
17-
*
18-
* @default false
19-
*
20-
* @see [allowTernary](https://eslint.org/docs/rules/no-unused-expressions#allowternary)
21-
*/
228
allowTernary?: boolean;
23-
/**
24-
* Set to `true` will enable you to use tagged template literals in your expressions.
25-
*
26-
* @default false
27-
*
28-
* @see [allowTaggedTemplates](https://eslint.org/docs/rules/no-unused-expressions#allowtaggedtemplates)
29-
*/
309
allowTaggedTemplates?: boolean;
31-
/**
32-
* Set to `true` will flag unused JSX element expressions.
33-
*
34-
* @default false
35-
*
36-
* @see [enforceForJSX](https://eslint.org/docs/rules/no-unused-expressions#enforceforjsx)
37-
*/
3810
enforceForJSX?: boolean;
3911
}
4012

src/rules/eslint/prefer-const.d.ts

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,7 @@ import type { RuleConfig } from '../rule-config';
44
* Option.
55
*/
66
export interface PreferConstOption {
7-
/**
8-
* The kind of the way to address variables in destructuring.
9-
*
10-
* @default 'any'
11-
*
12-
* @see [destructuring](https://eslint.org/docs/rules/prefer-const#destructuring)
13-
*/
147
destructuring?: 'any' | 'all';
15-
/**
16-
* This is an option to avoid conflicting with `no-use-before-define` rule (without `"nofunc"` option).
17-
*
18-
* If `true` is specified, this rule will ignore variables that are read between the declaration and the first assignment.
19-
*
20-
* @default false
21-
*
22-
* @see [ignoreReadBeforeAssign](https://eslint.org/docs/rules/prefer-const#ignorereadbeforeassign)
23-
*/
248
ignoreReadBeforeAssign?: boolean;
259
}
2610

src/rules/eslint/quote-props.d.ts

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -11,29 +11,8 @@ export type QuotePropsOption =
1111
| [
1212
'always' | 'as-needed' | 'consistent' | 'consistent-as-needed',
1313
{
14-
/**
15-
* Requires quotes around language keywords used as object property names.
16-
*
17-
* @default true
18-
*
19-
* @see [keywords](https://eslint.org/docs/rules/quote-props#keywords)
20-
*/
2114
keywords?: boolean;
22-
/**
23-
* Dis-/allows quotes around object literal property names that are not strictly required.
24-
*
25-
* @default true
26-
*
27-
* @see [unnecessary](https://eslint.org/docs/rules/quote-props#unnecessary)
28-
*/
2915
unnecessary?: boolean;
30-
/**
31-
* Requires quotes around numbers used as object property names.
32-
*
33-
* @default true
34-
*
35-
* @see [numbers](https://eslint.org/docs/rules/quote-props#numbers)
36-
*/
3716
numbers?: boolean;
3817
}
3918
];

src/rules/eslint/quotes.d.ts

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,7 @@ import type { RuleConfig } from '../rule-config';
66
export type QuotesConfig =
77
| 'avoid-escape'
88
| {
9-
/**
10-
* Allows strings to use single-quotes or double-quotes so long as the string contains a quote that would have to be escaped otherwise.
11-
*/
129
avoidEscape?: boolean;
13-
/**
14-
* Allows strings to use backticks.
15-
*/
1610
allowTemplateLiterals?: boolean;
1711
};
1812

0 commit comments

Comments
 (0)