🚀 Feature: Add configurable link URL prefixes to parser configuration - #467
Closed
- nyankoiscat - (Hikkywannafly) wants to merge 3 commits into
Closed
🚀 Feature: Add configurable link URL prefixes to parser configuration#467- nyankoiscat - (Hikkywannafly) wants to merge 3 commits into
- nyankoiscat - (Hikkywannafly) wants to merge 3 commits into
Conversation
Extend `TSDocConfiguration` with a new public setting for URI-style prefixes (e.g. `xref`, `mailto`) that should be recognized as URL destinations in `{@link ...}` tags, even when they do not use `://`. This must preserve existing behavior for `scheme://` while allowing explicit opt-in for additional protocols.
Affected files: TSDocConfiguration.ts, NodeParser.ts, NodeParserLinkTag.test.ts
Signed-off-by: - nyankoiscat - <76279331+Hikkywannafly@users.noreply.github.com>
Extend `TSDocConfiguration` with a new public setting for URI-style prefixes (e.g. `xref`, `mailto`) that should be recognized as URL destinations in `{@link ...}` tags, even when they do not use `://`. This must preserve existing behavior for `scheme://` while allowing explicit opt-in for additional protocols.
Affected files: TSDocConfiguration.ts, NodeParser.ts, NodeParserLinkTag.test.ts
Signed-off-by: - nyankoiscat - <76279331+Hikkywannafly@users.noreply.github.com>
Extend `TSDocConfiguration` with a new public setting for URI-style prefixes (e.g. `xref`, `mailto`) that should be recognized as URL destinations in `{@link ...}` tags, even when they do not use `://`. This must preserve existing behavior for `scheme://` while allowing explicit opt-in for additional protocols.
Affected files: TSDocConfiguration.ts, NodeParser.ts, NodeParserLinkTag.test.ts
Signed-off-by: - nyankoiscat - <76279331+Hikkywannafly@users.noreply.github.com>
Contributor
|
- nyankoiscat - (@Hikkywannafly) please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
Extend
TSDocConfigurationwith a new public setting for URI-style prefixes (e.g.xref,mailto) that should be recognized as URL destinations in{@link ...}tags, even when they do not use://. This must preserve existing behavior forscheme://while allowing explicit opt-in for additional protocols.Severity:
highFile:
tsdoc/src/configuration/TSDocConfiguration.tsSolution
Add a private normalized set (e.g.
_linkUrlPrefixes: Set<string>) and public APIs to manage it (getter + mutator methods such asaddLinkUrlPrefix(),clearLinkUrlPrefixes(), possiblyisLinkUrlPrefixAllowed()). Validate prefixes using a strict scheme-like grammar (^[A-Za-z][A-Za-z0-9+.-]*$) and normalize case (lowercase) for matching. Keep default empty so current behavior is unchanged unless configured.Changes
tsdoc/src/configuration/TSDocConfiguration.ts(modified)tsdoc/src/parser/NodeParser.ts(modified)tsdoc/src/parser/__tests__/NodeParserLinkTag.test.ts(modified)Testing
Closes #227