This repository was archived by the owner on Mar 7, 2025. It is now read-only.
File tree Expand file tree Collapse file tree 2 files changed +45
-1
lines changed Expand file tree Collapse file tree 2 files changed +45
-1
lines changed Original file line number Diff line number Diff line change 1
1
import type { MatchDescriptionRule } from './match-description' ;
2
+ import type { NoTypesRule } from './no-types' ;
2
3
3
4
/**
4
5
* All jsdoc rules.
5
6
*/
6
- export type JSDocRules = MatchDescriptionRule ;
7
+ export type JSDocRules = MatchDescriptionRule & NoTypesRule ;
Original file line number Diff line number Diff line change
1
+ import type { RuleConfig } from '../rule-config' ;
2
+
3
+ /**
4
+ * Option.
5
+ */
6
+ export type NoTypesOption = {
7
+ /**
8
+ * @see [contexts](https://github.com/gajus/eslint-plugin-jsdoc#contexts-3)
9
+ */
10
+ contexts ?: string [ ] ;
11
+ } ;
12
+
13
+ /**
14
+ * Options.
15
+ */
16
+ export type NoTypesOptions = [ NoTypesOption ?] ;
17
+
18
+ /**
19
+ * This rule reports types being used on `@param` or `@returns`.
20
+ *
21
+ * The rule is intended to prevent the indication of types on tags where the type information would be redundant with TypeScript.
22
+ *
23
+ * @see [no-types](https://github.com/gajus/eslint-plugin-jsdoc#no-types)
24
+ */
25
+ export type NoTypesRuleConfig = RuleConfig < NoTypesOptions > ;
26
+
27
+ /**
28
+ * This rule reports types being used on `@param` or `@returns`.
29
+ *
30
+ * The rule is intended to prevent the indication of types on tags where the type information would be redundant with TypeScript.
31
+ *
32
+ * @see [no-types](https://github.com/gajus/eslint-plugin-jsdoc#no-types)
33
+ */
34
+ export interface NoTypesRule {
35
+ /**
36
+ * This rule reports types being used on `@param` or `@returns`.
37
+ *
38
+ * The rule is intended to prevent the indication of types on tags where the type information would be redundant with TypeScript.
39
+ *
40
+ * @see [no-types](https://github.com/gajus/eslint-plugin-jsdoc#no-types)
41
+ */
42
+ 'jsdoc/no-types' : NoTypesRuleConfig ;
43
+ }
You can’t perform that action at this time.
0 commit comments