Skip to content

Commit c03dd66

Browse files
authored
feat: add normalize-see-links rule (#1725)
* feat: add normalize-see-links rule * fix: autofix delimiter-colliding @see links via encodeURI and escaping
1 parent 786d12d commit c03dd66

9 files changed

Lines changed: 1805 additions & 0 deletions

File tree

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# `normalize-see-links`
2+
3+
Normalizes labeled links in `@see` tags to a canonical `{@link}` form.
4+
5+
## Options
6+
7+
{"gitdown": "options"}
8+
9+
|||
10+
|---|---|
11+
|Context|everywhere|
12+
|Tags|`see`|
13+
|Recommended|false|
14+
|Settings||
15+
|Options|`canonicalForm`, `enableFixer`|
16+
17+
## Failing examples
18+
19+
<!-- assertions-failing normalizeSeeLinks -->
20+
21+
## Passing examples
22+
23+
<!-- assertions-passing normalizeSeeLinks -->

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -491,6 +491,7 @@ non-default-recommended fixer).
491491
||| [no-restricted-syntax](./docs/rules/no-restricted-syntax.md#readme) | Reports when certain comment structures are present. |
492492
|On in TS; Off in TS flavor|:wrench:| [no-types](./docs/rules/no-types.md#readme) | This rule reports types being used on `@param` or `@returns` (redundant with TypeScript). |
493493
|:heavy_check_mark: (Off in TS; Off in TS flavor)|| [no-undefined-types](./docs/rules/no-undefined-types.md#readme) | Besides some expected built-in types, prohibits any types not specified as globals or within `@typedef`. |
494+
||:wrench:| [normalize-see-links](./docs/rules/normalize-see-links.md#readme) | Normalizes labeled links in `@see` tags to a canonical `{@link}` form. |
494495
||:wrench:| [prefer-import-tag](./docs/rules/prefer-import-tag.md#readme) | Prefer `@import` tags to inline `import()` statements. |
495496
|:heavy_check_mark:|| [reject-any-type](./docs/rules/reject-any-type.md#readme) | Reports use of `any` or `*` type |
496497
|:heavy_check_mark:|| [reject-function-type](./docs/rules/reject-function-type.md#readme) | Reports use of `Function` type |

0 commit comments

Comments
 (0)