This repository was archived by the owner on Mar 7, 2025. It is now read-only.
File tree Expand file tree Collapse file tree 11 files changed +63
-7
lines changed Expand file tree Collapse file tree 11 files changed +63
-7
lines changed Original file line number Diff line number Diff line change @@ -5,7 +5,9 @@ import type { RuleConfig } from '../rule-config';
5
5
*/
6
6
export interface CheckTagNamesOption {
7
7
definedTags ?: string [ ] ;
8
+ enableFixer ?: boolean ;
8
9
jsxTags ?: boolean ;
10
+ typed ?: boolean ;
9
11
}
10
12
11
13
/**
Original file line number Diff line number Diff line change @@ -11,11 +11,13 @@ import type { CheckTypesRule } from './check-types';
11
11
import type { CheckValuesRule } from './check-values' ;
12
12
import type { EmptyTagsRule } from './empty-tags' ;
13
13
import type { ImplementsOnClassesRule } from './implements-on-classes' ;
14
+ import type { InformativeDocsRule } from './informative-docs' ;
14
15
import type { MatchDescriptionRule } from './match-description' ;
15
16
import type { MatchNameRule } from './match-name' ;
16
17
import type { MultilineBlocksRule } from './multiline-blocks' ;
17
18
import type { NewlineAfterDescriptionRule } from './newline-after-description' ;
18
19
import type { NoBadBlocksRule } from './no-bad-blocks' ;
20
+ import type { NoBlankBlockDescriptionsRule } from './no-blank-block-descriptions' ;
19
21
import type { NoDefaultsRule } from './no-defaults' ;
20
22
import type { NoMissingSyntaxRule } from './no-missing-syntax' ;
21
23
import type { NoMultiAsterisksRule } from './no-multi-asterisks' ;
@@ -65,11 +67,13 @@ export type JSDocRules = CheckAccessRule &
65
67
CheckValuesRule &
66
68
EmptyTagsRule &
67
69
ImplementsOnClassesRule &
70
+ InformativeDocsRule &
68
71
MatchDescriptionRule &
69
72
MatchNameRule &
70
73
MultilineBlocksRule &
71
74
NewlineAfterDescriptionRule &
72
75
NoBadBlocksRule &
76
+ NoBlankBlockDescriptionsRule &
73
77
NoDefaultsRule &
74
78
NoMissingSyntaxRule &
75
79
NoMultiAsterisksRule &
Original file line number Diff line number Diff line change
1
+ import type { RuleConfig } from '../rule-config' ;
2
+
3
+ /**
4
+ * Option.
5
+ */
6
+ export interface InformativeDocsOption {
7
+ aliases ?: string [ ] ;
8
+ uselessWords ?: string [ ] ;
9
+ }
10
+
11
+ /**
12
+ * Options.
13
+ */
14
+ export type InformativeDocsOptions = [ InformativeDocsOption ?] ;
15
+
16
+ /**
17
+ * This rule reports doc comments that only restate their attached name.
18
+ *
19
+ * @see [informative-docs](https://github.com/gajus/eslint-plugin-jsdoc#informative-docs)
20
+ */
21
+ export type InformativeDocsRuleConfig = RuleConfig < InformativeDocsOptions > ;
22
+
23
+ /**
24
+ * This rule reports doc comments that only restate their attached name.
25
+ *
26
+ * @see [informative-docs](https://github.com/gajus/eslint-plugin-jsdoc#informative-docs)
27
+ */
28
+ export interface InformativeDocsRule {
29
+ /**
30
+ * This rule reports doc comments that only restate their attached name.
31
+ *
32
+ * @see [informative-docs](https://github.com/gajus/eslint-plugin-jsdoc#informative-docs)
33
+ */
34
+ 'jsdoc/informative-docs' : InformativeDocsRuleConfig ;
35
+ }
Original file line number Diff line number Diff line change @@ -13,7 +13,6 @@ export interface MatchNameOption {
13
13
tags ?: string [ ] ;
14
14
[ k : string ] : any ;
15
15
} [ ] ;
16
- [ k : string ] : any ;
17
16
}
18
17
19
18
/**
Original file line number Diff line number Diff line change @@ -12,7 +12,6 @@ export interface MultilineBlocksOption {
12
12
noSingleLineBlocks ?: boolean ;
13
13
noZeroLineText ?: boolean ;
14
14
singleLineTags ?: string [ ] ;
15
- [ k : string ] : any ;
16
15
}
17
16
18
17
/**
Original file line number Diff line number Diff line change
1
+ import type { RuleConfig } from '../rule-config' ;
2
+
3
+ /**
4
+ * Detects and removes extra lines of a blank block description.
5
+ *
6
+ * @see [no-blank-block-descriptions](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-blank-block-descriptions)
7
+ */
8
+ export type NoBlankBlockDescriptionsRuleConfig = RuleConfig < [ ] > ;
9
+
10
+ /**
11
+ * Detects and removes extra lines of a blank block description.
12
+ *
13
+ * @see [no-blank-block-descriptions](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-blank-block-descriptions)
14
+ */
15
+ export interface NoBlankBlockDescriptionsRule {
16
+ /**
17
+ * Detects and removes extra lines of a blank block description.
18
+ *
19
+ * @see [no-blank-block-descriptions](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-blank-block-descriptions)
20
+ */
21
+ 'jsdoc/no-blank-block-descriptions' : NoBlankBlockDescriptionsRuleConfig ;
22
+ }
Original file line number Diff line number Diff line change @@ -7,7 +7,6 @@ export interface NoMultiAsterisksOption {
7
7
allowWhitespace ?: boolean ;
8
8
preventAtEnd ?: boolean ;
9
9
preventAtMiddleLines ?: boolean ;
10
- [ k : string ] : any ;
11
10
}
12
11
13
12
/**
Original file line number Diff line number Diff line change @@ -6,7 +6,6 @@ import type { RuleConfig } from '../rule-config';
6
6
export interface SortTagsOption {
7
7
alphabetizeExtras ?: boolean ;
8
8
tagSequence ?: string [ ] ;
9
- [ k : string ] : any ;
10
9
}
11
10
12
11
/**
Original file line number Diff line number Diff line change @@ -15,7 +15,6 @@ export interface TagLinesConfig {
15
15
lines ?: 'always' | 'never' | 'any' ;
16
16
} ;
17
17
} ;
18
- [ k : string ] : any ;
19
18
}
20
19
21
20
/**
Original file line number Diff line number Diff line change @@ -6,7 +6,6 @@ import type { RuleConfig } from '../rule-config';
6
6
export interface TextEscapingOption {
7
7
escapeHTML ?: boolean ;
8
8
escapeMarkdown ?: boolean ;
9
- [ k : string ] : any ;
10
9
}
11
10
12
11
/**
You can’t perform that action at this time.
0 commit comments