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

Commit 40eecb3

Browse files
committed
Update jsdoc rules
1 parent b760b00 commit 40eecb3

File tree

4 files changed

+13
-38
lines changed

4 files changed

+13
-38
lines changed

src/rules/jsdoc/index.d.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ import type { InformativeDocsRule } from './informative-docs';
1515
import type { MatchDescriptionRule } from './match-description';
1616
import type { MatchNameRule } from './match-name';
1717
import type { MultilineBlocksRule } from './multiline-blocks';
18-
import type { NewlineAfterDescriptionRule } from './newline-after-description';
1918
import type { NoBadBlocksRule } from './no-bad-blocks';
2019
import type { NoBlankBlockDescriptionsRule } from './no-blank-block-descriptions';
2120
import type { NoDefaultsRule } from './no-defaults';
@@ -71,7 +70,6 @@ export type JSDocRules = CheckAccessRule &
7170
MatchDescriptionRule &
7271
MatchNameRule &
7372
MultilineBlocksRule &
74-
NewlineAfterDescriptionRule &
7573
NoBadBlocksRule &
7674
NoBlankBlockDescriptionsRule &
7775
NoDefaultsRule &

src/rules/jsdoc/newline-after-description.d.ts

Lines changed: 0 additions & 33 deletions
This file was deleted.

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

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,13 @@ import type { RuleConfig } from '../rule-config';
55
*/
66
export interface SortTagsOption {
77
alphabetizeExtras?: boolean;
8-
tagSequence?: string[];
8+
linesBetween?: number;
9+
reportIntraTagGroupSpacing?: boolean;
10+
reportTagGroupSpacing?: boolean;
11+
tagSequence?: {
12+
tags?: string[];
13+
[k: string]: any;
14+
}[];
915
}
1016

1117
/**
@@ -14,17 +20,20 @@ export interface SortTagsOption {
1420
export type SortTagsOptions = [SortTagsOption?];
1521

1622
/**
23+
* Sorts tags by a specified sequence according to tag name.
1724
*
1825
* @see [sort-tags](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-sort-tags)
1926
*/
2027
export type SortTagsRuleConfig = RuleConfig<SortTagsOptions>;
2128

2229
/**
30+
* Sorts tags by a specified sequence according to tag name.
2331
*
2432
* @see [sort-tags](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-sort-tags)
2533
*/
2634
export interface SortTagsRule {
2735
/**
36+
* Sorts tags by a specified sequence according to tag name.
2837
*
2938
* @see [sort-tags](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-sort-tags)
3039
*/

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@ import type { RuleConfig } from '../rule-config';
44
* Config.
55
*/
66
export interface TagLinesConfig {
7+
applyToEndTag?: boolean;
78
count?: number;
8-
dropEndLines?: boolean;
9-
noEndLines?: boolean;
9+
endLines?: number | null;
10+
startLines?: number | null;
1011
tags?: {
1112
/**
1213
*/

0 commit comments

Comments
 (0)