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

Commit a2424bf

Browse files
committed
Update jsdoc rules
1 parent f4670dc commit a2424bf

File tree

2 files changed

+38
-0
lines changed

2 files changed

+38
-0
lines changed

src/rules/jsdoc/index.d.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ import type { RequireReturnsTypeRule } from './require-returns-type';
4444
import type { RequireThrowsRule } from './require-throws';
4545
import type { RequireYieldsRule } from './require-yields';
4646
import type { RequireYieldsCheckRule } from './require-yields-check';
47+
import type { SortTagsRule } from './sort-tags';
4748
import type { TagLinesRule } from './tag-lines';
4849
import type { ValidTypesRule } from './valid-types';
4950

@@ -96,5 +97,6 @@ export type JSDocRules = CheckAccessRule &
9697
RequireThrowsRule &
9798
RequireYieldsRule &
9899
RequireYieldsCheckRule &
100+
SortTagsRule &
99101
TagLinesRule &
100102
ValidTypesRule;

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

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
import type { RuleConfig } from '../rule-config';
2+
3+
/**
4+
* Option.
5+
*/
6+
export interface SortTagsOption {
7+
alphabetizeExtras?: boolean;
8+
tagSequence?: string[];
9+
[k: string]: any;
10+
}
11+
12+
/**
13+
* Options.
14+
*/
15+
export type SortTagsOptions = [SortTagsOption?];
16+
17+
/**
18+
*
19+
*
20+
* @see [sort-tags](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-sort-tags)
21+
*/
22+
export type SortTagsRuleConfig = RuleConfig<SortTagsOptions>;
23+
24+
/**
25+
*
26+
*
27+
* @see [sort-tags](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-sort-tags)
28+
*/
29+
export interface SortTagsRule {
30+
/**
31+
*
32+
*
33+
* @see [sort-tags](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-sort-tags)
34+
*/
35+
'jsdoc/sort-tags': SortTagsRuleConfig;
36+
}

0 commit comments

Comments
 (0)