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

Commit 47fcb2b

Browse files
committed
Update jsdoc rules
1 parent 59408fe commit 47fcb2b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+186
-153
lines changed

src/rules/jsdoc/check-access.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,20 @@ import type { RuleConfig } from '../rule-config';
33
/**
44
* Checks that `@access` tags have a valid value.
55
*
6-
* @see [check-access](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-access)
6+
* @see [check-access](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-access.md#repos-sticky-header)
77
*/
88
export type CheckAccessRuleConfig = RuleConfig<[]>;
99

1010
/**
1111
* Checks that `@access` tags have a valid value.
1212
*
13-
* @see [check-access](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-access)
13+
* @see [check-access](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-access.md#repos-sticky-header)
1414
*/
1515
export interface CheckAccessRule {
1616
/**
1717
* Checks that `@access` tags have a valid value.
1818
*
19-
* @see [check-access](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-access)
19+
* @see [check-access](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-access.md#repos-sticky-header)
2020
*/
2121
'jsdoc/check-access': CheckAccessRuleConfig;
2222
}

src/rules/jsdoc/check-alignment.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,20 @@ import type { RuleConfig } from '../rule-config';
33
/**
44
* Reports invalid alignment of JSDoc block asterisks.
55
*
6-
* @see [check-alignment](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-alignment)
6+
* @see [check-alignment](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-alignment.md#repos-sticky-header)
77
*/
88
export type CheckAlignmentRuleConfig = RuleConfig<[]>;
99

1010
/**
1111
* Reports invalid alignment of JSDoc block asterisks.
1212
*
13-
* @see [check-alignment](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-alignment)
13+
* @see [check-alignment](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-alignment.md#repos-sticky-header)
1414
*/
1515
export interface CheckAlignmentRule {
1616
/**
1717
* Reports invalid alignment of JSDoc block asterisks.
1818
*
19-
* @see [check-alignment](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-alignment)
19+
* @see [check-alignment](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-alignment.md#repos-sticky-header)
2020
*/
2121
'jsdoc/check-alignment': CheckAlignmentRuleConfig;
2222
}

src/rules/jsdoc/check-examples.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,20 +33,20 @@ export type CheckExamplesOptions = [CheckExamplesOption?];
3333
/**
3434
* Ensures that (JavaScript) examples within JSDoc adhere to ESLint rules.
3535
*
36-
* @see [check-examples](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-examples)
36+
* @see [check-examples](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-examples.md#repos-sticky-header)
3737
*/
3838
export type CheckExamplesRuleConfig = RuleConfig<CheckExamplesOptions>;
3939

4040
/**
4141
* Ensures that (JavaScript) examples within JSDoc adhere to ESLint rules.
4242
*
43-
* @see [check-examples](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-examples)
43+
* @see [check-examples](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-examples.md#repos-sticky-header)
4444
*/
4545
export interface CheckExamplesRule {
4646
/**
4747
* Ensures that (JavaScript) examples within JSDoc adhere to ESLint rules.
4848
*
49-
* @see [check-examples](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-examples)
49+
* @see [check-examples](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-examples.md#repos-sticky-header)
5050
*/
5151
'jsdoc/check-examples': CheckExamplesRuleConfig;
5252
}

src/rules/jsdoc/check-indentation.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,20 @@ export type CheckIndentationOptions = [CheckIndentationOption?];
1515
/**
1616
* Reports invalid padding inside JSDoc blocks.
1717
*
18-
* @see [check-indentation](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-indentation)
18+
* @see [check-indentation](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-indentation.md#repos-sticky-header)
1919
*/
2020
export type CheckIndentationRuleConfig = RuleConfig<CheckIndentationOptions>;
2121

2222
/**
2323
* Reports invalid padding inside JSDoc blocks.
2424
*
25-
* @see [check-indentation](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-indentation)
25+
* @see [check-indentation](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-indentation.md#repos-sticky-header)
2626
*/
2727
export interface CheckIndentationRule {
2828
/**
2929
* Reports invalid padding inside JSDoc blocks.
3030
*
31-
* @see [check-indentation](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-indentation)
31+
* @see [check-indentation](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-indentation.md#repos-sticky-header)
3232
*/
3333
'jsdoc/check-indentation': CheckIndentationRuleConfig;
3434
}

src/rules/jsdoc/check-line-alignment.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,21 +32,21 @@ export type CheckLineAlignmentOptions = [
3232
/**
3333
* Reports invalid alignment of JSDoc block lines.
3434
*
35-
* @see [check-line-alignment](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-line-alignment)
35+
* @see [check-line-alignment](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-line-alignment.md#repos-sticky-header)
3636
*/
3737
export type CheckLineAlignmentRuleConfig =
3838
RuleConfig<CheckLineAlignmentOptions>;
3939

4040
/**
4141
* Reports invalid alignment of JSDoc block lines.
4242
*
43-
* @see [check-line-alignment](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-line-alignment)
43+
* @see [check-line-alignment](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-line-alignment.md#repos-sticky-header)
4444
*/
4545
export interface CheckLineAlignmentRule {
4646
/**
4747
* Reports invalid alignment of JSDoc block lines.
4848
*
49-
* @see [check-line-alignment](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-line-alignment)
49+
* @see [check-line-alignment](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-line-alignment.md#repos-sticky-header)
5050
*/
5151
'jsdoc/check-line-alignment': CheckLineAlignmentRuleConfig;
5252
}

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,20 @@ export type CheckParamNamesOptions = [CheckParamNamesOption?];
2121
/**
2222
* Ensures that parameter names in JSDoc match those in the function declaration.
2323
*
24-
* @see [check-param-names](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-param-names)
24+
* @see [check-param-names](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-param-names.md#repos-sticky-header)
2525
*/
2626
export type CheckParamNamesRuleConfig = RuleConfig<CheckParamNamesOptions>;
2727

2828
/**
2929
* Ensures that parameter names in JSDoc match those in the function declaration.
3030
*
31-
* @see [check-param-names](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-param-names)
31+
* @see [check-param-names](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-param-names.md#repos-sticky-header)
3232
*/
3333
export interface CheckParamNamesRule {
3434
/**
3535
* Ensures that parameter names in JSDoc match those in the function declaration.
3636
*
37-
* @see [check-param-names](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-param-names)
37+
* @see [check-param-names](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-param-names.md#repos-sticky-header)
3838
*/
3939
'jsdoc/check-param-names': CheckParamNamesRuleConfig;
4040
}

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,21 @@ export type CheckPropertyNamesOptions = [CheckPropertyNamesOption?];
1515
/**
1616
* Ensures that property names in JSDoc are not duplicated on the same block and that nested properties have defined roots.
1717
*
18-
* @see [check-property-names](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-property-names)
18+
* @see [check-property-names](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-property-names.md#repos-sticky-header)
1919
*/
2020
export type CheckPropertyNamesRuleConfig =
2121
RuleConfig<CheckPropertyNamesOptions>;
2222

2323
/**
2424
* Ensures that property names in JSDoc are not duplicated on the same block and that nested properties have defined roots.
2525
*
26-
* @see [check-property-names](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-property-names)
26+
* @see [check-property-names](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-property-names.md#repos-sticky-header)
2727
*/
2828
export interface CheckPropertyNamesRule {
2929
/**
3030
* Ensures that property names in JSDoc are not duplicated on the same block and that nested properties have defined roots.
3131
*
32-
* @see [check-property-names](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-property-names)
32+
* @see [check-property-names](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-property-names.md#repos-sticky-header)
3333
*/
3434
'jsdoc/check-property-names': CheckPropertyNamesRuleConfig;
3535
}

src/rules/jsdoc/check-syntax.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,20 @@ import type { RuleConfig } from '../rule-config';
33
/**
44
* Reports against syntax not valid for the mode (e.g., Google Closure Compiler in non-Closure mode).
55
*
6-
* @see [check-syntax](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-syntax)
6+
* @see [check-syntax](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-syntax.md#repos-sticky-header)
77
*/
88
export type CheckSyntaxRuleConfig = RuleConfig<[]>;
99

1010
/**
1111
* Reports against syntax not valid for the mode (e.g., Google Closure Compiler in non-Closure mode).
1212
*
13-
* @see [check-syntax](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-syntax)
13+
* @see [check-syntax](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-syntax.md#repos-sticky-header)
1414
*/
1515
export interface CheckSyntaxRule {
1616
/**
1717
* Reports against syntax not valid for the mode (e.g., Google Closure Compiler in non-Closure mode).
1818
*
19-
* @see [check-syntax](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-syntax)
19+
* @see [check-syntax](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-syntax.md#repos-sticky-header)
2020
*/
2121
'jsdoc/check-syntax': CheckSyntaxRuleConfig;
2222
}

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,20 @@ export type CheckTagNamesOptions = [CheckTagNamesOption?];
1818
/**
1919
* Reports invalid block tag names.
2020
*
21-
* @see [check-tag-names](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-tag-names)
21+
* @see [check-tag-names](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-tag-names.md#repos-sticky-header)
2222
*/
2323
export type CheckTagNamesRuleConfig = RuleConfig<CheckTagNamesOptions>;
2424

2525
/**
2626
* Reports invalid block tag names.
2727
*
28-
* @see [check-tag-names](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-tag-names)
28+
* @see [check-tag-names](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-tag-names.md#repos-sticky-header)
2929
*/
3030
export interface CheckTagNamesRule {
3131
/**
3232
* Reports invalid block tag names.
3333
*
34-
* @see [check-tag-names](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-tag-names)
34+
* @see [check-tag-names](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-tag-names.md#repos-sticky-header)
3535
*/
3636
'jsdoc/check-tag-names': CheckTagNamesRuleConfig;
3737
}

src/rules/jsdoc/check-types.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,20 @@ export type CheckTypesOptions = [CheckTypesOption?];
2020
/**
2121
* Reports invalid types.
2222
*
23-
* @see [check-types](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-types)
23+
* @see [check-types](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-types.md#repos-sticky-header)
2424
*/
2525
export type CheckTypesRuleConfig = RuleConfig<CheckTypesOptions>;
2626

2727
/**
2828
* Reports invalid types.
2929
*
30-
* @see [check-types](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-types)
30+
* @see [check-types](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-types.md#repos-sticky-header)
3131
*/
3232
export interface CheckTypesRule {
3333
/**
3434
* Reports invalid types.
3535
*
36-
* @see [check-types](https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-types)
36+
* @see [check-types](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-types.md#repos-sticky-header)
3737
*/
3838
'jsdoc/check-types': CheckTypesRuleConfig;
3939
}

0 commit comments

Comments
 (0)