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

Commit ebbf475

Browse files
committed
Update jsdoc rules
1 parent c8262ea commit ebbf475

11 files changed

+63
-7
lines changed

src/rules/jsdoc/check-tag-names.d.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ import type { RuleConfig } from '../rule-config';
55
*/
66
export interface CheckTagNamesOption {
77
definedTags?: string[];
8+
enableFixer?: boolean;
89
jsxTags?: boolean;
10+
typed?: boolean;
911
}
1012

1113
/**

src/rules/jsdoc/index.d.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,13 @@ import type { CheckTypesRule } from './check-types';
1111
import type { CheckValuesRule } from './check-values';
1212
import type { EmptyTagsRule } from './empty-tags';
1313
import type { ImplementsOnClassesRule } from './implements-on-classes';
14+
import type { InformativeDocsRule } from './informative-docs';
1415
import type { MatchDescriptionRule } from './match-description';
1516
import type { MatchNameRule } from './match-name';
1617
import type { MultilineBlocksRule } from './multiline-blocks';
1718
import type { NewlineAfterDescriptionRule } from './newline-after-description';
1819
import type { NoBadBlocksRule } from './no-bad-blocks';
20+
import type { NoBlankBlockDescriptionsRule } from './no-blank-block-descriptions';
1921
import type { NoDefaultsRule } from './no-defaults';
2022
import type { NoMissingSyntaxRule } from './no-missing-syntax';
2123
import type { NoMultiAsterisksRule } from './no-multi-asterisks';
@@ -65,11 +67,13 @@ export type JSDocRules = CheckAccessRule &
6567
CheckValuesRule &
6668
EmptyTagsRule &
6769
ImplementsOnClassesRule &
70+
InformativeDocsRule &
6871
MatchDescriptionRule &
6972
MatchNameRule &
7073
MultilineBlocksRule &
7174
NewlineAfterDescriptionRule &
7275
NoBadBlocksRule &
76+
NoBlankBlockDescriptionsRule &
7377
NoDefaultsRule &
7478
NoMissingSyntaxRule &
7579
NoMultiAsterisksRule &

src/rules/jsdoc/informative-docs.d.ts

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
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+
}

src/rules/jsdoc/match-name.d.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ export interface MatchNameOption {
1313
tags?: string[];
1414
[k: string]: any;
1515
}[];
16-
[k: string]: any;
1716
}
1817

1918
/**

src/rules/jsdoc/multiline-blocks.d.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ export interface MultilineBlocksOption {
1212
noSingleLineBlocks?: boolean;
1313
noZeroLineText?: boolean;
1414
singleLineTags?: string[];
15-
[k: string]: any;
1615
}
1716

1817
/**
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
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+
}

src/rules/jsdoc/no-multi-asterisks.d.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ export interface NoMultiAsterisksOption {
77
allowWhitespace?: boolean;
88
preventAtEnd?: boolean;
99
preventAtMiddleLines?: boolean;
10-
[k: string]: any;
1110
}
1211

1312
/**

src/rules/jsdoc/sort-tags.d.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ import type { RuleConfig } from '../rule-config';
66
export interface SortTagsOption {
77
alphabetizeExtras?: boolean;
88
tagSequence?: string[];
9-
[k: string]: any;
109
}
1110

1211
/**

src/rules/jsdoc/tag-lines.d.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ export interface TagLinesConfig {
1515
lines?: 'always' | 'never' | 'any';
1616
};
1717
};
18-
[k: string]: any;
1918
}
2019

2120
/**

src/rules/jsdoc/text-escaping.d.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ import type { RuleConfig } from '../rule-config';
66
export interface TextEscapingOption {
77
escapeHTML?: boolean;
88
escapeMarkdown?: boolean;
9-
[k: string]: any;
109
}
1110

1211
/**

0 commit comments

Comments
 (0)