@@ -9,6 +9,21 @@ only a lowercase `http:` or `https:` URL in a plain, no-label `{@link}` tag.
99This option defaults to ` false ` , and its output is independent of
1010` canonicalForm ` because there is no label to position.
1111
12+ Labels that contain the destination form's closing delimiter are fixable. For
13+ pipe form, the fixer escapes ` } ` in the label:
14+
15+ ``` js
16+ /** @see [See {options}](https://example.com/api) */
17+ /** @see {@link https://example.com/api |See {options\} } */
18+ ```
19+
20+ For prefix form, the fixer escapes ` ] ` in the label:
21+
22+ ``` js
23+ /** @see {@link https://example.com |A]B} */
24+ /** @see [A\]B]{ @link https://example.com} */
25+ ```
26+
1227<a name =" user-content-normalize-see-links-options " ></a >
1328<a name =" normalize-see-links-options " ></a >
1429## Options
@@ -57,12 +72,23 @@ The following patterns are considered problems:
5772/**
5873 * @see [See {options}](https://example.com/api)
5974 */
60- // Message: @see link cannot be safely normalized .
75+ // Message: Expected @see link to use the pipe form .
6176
6277/**
6378 * @see [a}b](https: //example.com)
6479 */
65- // Message: @see link cannot be safely normalized.
80+ // Message: Expected @see link to use the pipe form.
81+
82+ /**
83+ * @see [a\}b](https: //example.com)
84+ */
85+ // Message: Expected @see link to use the pipe form.
86+
87+ /**
88+ * @see [A\]B](https: //example.com)
89+ */
90+ // "jsdoc/normalize-see-links": ["error"|"warn", {"canonicalForm":"prefix"}]
91+ // Message: Expected @see link to use the prefix form.
6692
6793/**
6894 * @see [Foo](https: //example.com/a|b)
@@ -79,7 +105,7 @@ The following patterns are considered problems:
79105 * @see {@link https://example.com |A]B}
80106 */
81107// "jsdoc/normalize-see-links": ["error"|"warn", {"canonicalForm":"prefix"}]
82- // Message: @see link cannot be safely normalized .
108+ // Message: Expected @see link to use the prefix form .
83109
84110/**
85111 * @see [ ]{@link https://example.com }
@@ -137,19 +163,41 @@ The following patterns are considered problems:
137163// Message: Expected @see link to use the prefix form.
138164
139165/**
140- * @see [a\}b]( https: //example.com)
166+ * @see { @link https://example.com |a\} b}
141167 */
142- // Message: @see link cannot be safely normalized.
168+ // "jsdoc/normalize-see-links": ["error"|"warn", {"canonicalForm":"prefix"}]
169+ // Message: Expected @see link to use the prefix form.
170+
171+ /**
172+ * @see [A\]B]{ @link https://example.com}
173+ */
174+ // Message: Expected @see link to use the pipe form.
175+
176+ /**
177+ * @see {@link https://example.com |A]B\} C}
178+ */
179+ // "jsdoc/normalize-see-links": ["error"|"warn", {"canonicalForm":"prefix"}]
180+ // Message: Expected @see link to use the prefix form.
181+
182+ /**
183+ * @see [A}B\]C]{ @link https://example.com}
184+ */
185+ // Message: Expected @see link to use the pipe form.
186+
187+ /**
188+ * @see [Trailing\\](https: //example.com)
189+ */
190+ // Message: Expected @see link to use the pipe form.
143191
144192/**
145193 * @see [See {{one} and {two}}](https://example.com)
146194 */
147- // Message: @see link cannot be safely normalized .
195+ // Message: Expected @see link to use the pipe form .
148196
149197/**
150198 * @see [A}B|C](https: //example.com)
151199 */
152- // Message: @see link cannot be safely normalized .
200+ // Message: Expected @see link to use the pipe form .
153201
154202/**
155203 * @see [Read the guide](https://example.com/read)
@@ -321,7 +369,7 @@ const value: string = 'value';
321369 * @see [See {options}](https://example.com/labeled)
322370 */
323371// "jsdoc/normalize-see-links": ["error"|"warn", {"wrapBareUrls":true}]
324- // Message: @see link cannot be safely normalized .
372+ // Message: Expected @see link to use the pipe form .
325373
326374/**
327375 * @see [No fix](https://example.com/labeled)
@@ -360,6 +408,32 @@ const value: string = 'value';
360408The following patterns are not considered problems:
361409
362410```` ts
411+ /**
412+ * @see {@link https://example.com/api |See {options\} }
413+ */
414+
415+ /**
416+ * @see [A\]B]{ @link https://example.com}
417+ */
418+ // "jsdoc/normalize-see-links": ["error"|"warn", {"canonicalForm":"prefix"}]
419+
420+ /**
421+ * @see [A\]B}C]{ @link https://example.com}
422+ */
423+ // "jsdoc/normalize-see-links": ["error"|"warn", {"canonicalForm":"prefix"}]
424+
425+ /**
426+ * @see {@link https://example.com |A\} B]C}
427+ */
428+
429+ /**
430+ * @see {@link https://example.com |Trailing\\}
431+ */
432+
433+ /**
434+ * @see {@link https://example.com |See {{one\} and {two\}\}}
435+ */
436+
363437/**
364438 * @see {@link https://api.example.com/v1?ids=1%7C2%7C3 |Docs}
365439 */
0 commit comments