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

Commit 35bd43a

Browse files
committed
Update jsdoc rules
1 parent 5679f06 commit 35bd43a

File tree

4 files changed

+39
-0
lines changed

4 files changed

+39
-0
lines changed

src/rules/jsdoc/index.d.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ import type { RequireYieldsRule } from './require-yields';
4646
import type { RequireYieldsCheckRule } from './require-yields-check';
4747
import type { SortTagsRule } from './sort-tags';
4848
import type { TagLinesRule } from './tag-lines';
49+
import type { TextEscapingRule } from './text-escaping';
4950
import type { ValidTypesRule } from './valid-types';
5051

5152
/**
@@ -99,4 +100,5 @@ export type JSDocRules = CheckAccessRule &
99100
RequireYieldsCheckRule &
100101
SortTagsRule &
101102
TagLinesRule &
103+
TextEscapingRule &
102104
ValidTypesRule;

src/rules/jsdoc/require-param-description.d.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ export interface RequireParamDescriptionOption {
1111
context?: string;
1212
}
1313
)[];
14+
defaultDestructuredRootDescription?: string;
15+
setDefaultDestructuredRootDescription?: boolean;
1416
}
1517

1618
/**

src/rules/jsdoc/require-param-type.d.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ export interface RequireParamTypeOption {
1111
context?: string;
1212
}
1313
)[];
14+
defaultDestructuredRootType?: string;
15+
setDefaultDestructuredRootType?: boolean;
1416
}
1517

1618
/**

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

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

0 commit comments

Comments
 (0)