Skip to content

Commit

Permalink
Do not emit warnings on urls within @link tags
Browse files Browse the repository at this point in the history
Resolves #1980
  • Loading branch information
Gerrit0 committed Jul 17, 2022
1 parent 9ed9f01 commit f41f6c8
Show file tree
Hide file tree
Showing 4 changed files with 56 additions and 7 deletions.
5 changes: 3 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@

### Features

- Added defined in links for classes, enums, #180.
- Added support for `*.ghe.com` and `*.github.us` GitHub enterprise domains for source links, #2001.
- Expose `Converter.parseRawComment` for plugins to parse additional markdown files, #2004.
- Added defined in links for classes, enums #180.

### Bug Fixes

- Fixed missing `sources` property on signature reflections #1996.
- TypeDoc will no longer emit a warning for `{@link}` containing a URL, #1980.
- `excludeNotDocumented` will no longer remove functions/methods/accessors which are documented, #1994.
- Fixed missing `sources` property on signature reflections #1996.

### Thanks!

Expand Down
23 changes: 18 additions & 5 deletions src/lib/converter/plugins/LinkResolverPlugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -220,26 +220,37 @@ function resolveLinkTag(
) {
let pos = 0;
const end = part.text.length;
while (pos < end && ts.isWhiteSpaceLike(part.text.charCodeAt(pos))) {
pos++;
}
const origText = part.text;

// Try to parse one
const declRef = parseDeclarationReference(part.text, pos, end);

let target: Reflection | undefined;
let target: Reflection | string | undefined;
if (declRef) {
// Got one, great! Try to resolve the link
target = resolveDeclarationReference(reflection, declRef[0]);
pos = declRef[1];
}

if (!target) {
if (urlPrefix.test(part.text)) {
const wsIndex = part.text.search(/\s/);
target =
wsIndex === -1 ? part.text : part.text.substring(0, wsIndex);
pos = target.length;
}
}

// If resolution via a declaration reference failed, revert to the legacy "split and check"
// method... this should go away in 0.24, once people have had a chance to migrate any failing links.
if (!target) {
const resolved = legacyResolveLinkTag(reflection, part);
if (resolved) {
warn(
`Failed to resolve {@link ${
part.text
}} in ${reflection.getFriendlyFullName()} with declaration references. This link will break in v0.24.`
`Failed to resolve {@link ${origText}} in ${reflection.getFriendlyFullName()} with declaration references. This link will break in v0.24.`
);
}
return resolved;
Expand All @@ -255,7 +266,9 @@ function resolveLinkTag(
}

part.target = target;
part.text = part.text.substring(pos).trim() || target.name;
part.text =
part.text.substring(pos).trim() ||
(typeof target === "string" ? target : target.name);

return part;
}
Expand Down
6 changes: 6 additions & 0 deletions src/test/converter2/issues/gh1980.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
/**
* {@link http://example.com }
* {@link http://example.com | with text}
* {@link http://example.com jsdoc support}
*/
export const link = 123;
29 changes: 29 additions & 0 deletions src/test/issueTests.ts
Original file line number Diff line number Diff line change
Expand Up @@ -599,6 +599,35 @@ export const issueTests: {
equal(comments2, ["Comment for a", "Comment for b"]);
},

gh1980(project, logger) {
const link = query(project, "link");
equal(
link.comment?.summary.filter((t) => t.kind === "inline-tag"),
[
{
kind: "inline-tag",
tag: "@link",
target: "http://example.com",
text: "http://example.com",
},
{
kind: "inline-tag",
tag: "@link",
target: "http://example.com",
text: "with text",
},
{
kind: "inline-tag",
tag: "@link",
target: "http://example.com",
text: "jsdoc support",
},
]
);
logger.discardDebugMessages();
logger.expectNoOtherMessages();
},

gh1986(project, logger) {
const a = query(project, "a");
equal(
Expand Down

0 comments on commit f41f6c8

Please sign in to comment.