feat: add createUrlTransform factory for custom safe protocols#943
Open
Aimee1608 wants to merge 1 commit into
Open
feat: add createUrlTransform factory for custom safe protocols#943Aimee1608 wants to merge 1 commit into
Aimee1608 wants to merge 1 commit into
Conversation
Introduce `createUrlTransform(safeProtocol?)` which returns a URL transform function identical to `defaultUrlTransform` but with a user-supplied protocol allowlist. This lets callers extend the default set (e.g. add `tel:`) without reimplementing the full sanitization logic. `defaultUrlTransform` is now defined as `createUrlTransform()`, keeping all existing behaviour unchanged. Closes remarkjs#941
This comment has been minimized.
This comment has been minimized.
Member
|
kind of duplicate of #942 |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #943 +/- ##
==========================================
Coverage 100.00% 100.00%
==========================================
Files 3 3
Lines 1743 1862 +119
Branches 123 129 +6
==========================================
+ Hits 1743 1862 +119 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
Initial checklist
Description of changes
Summary
Adds a
createUrlTransform(safeProtocol?)factory function that returns a URL transform function with a custom set of allowed protocols, without requiring callers to reimplement the full sanitization logic.Motivation
Currently, extending the list of safe protocols (e.g. adding
tel:) requires fully reimplementingdefaultUrlTransform, which means callers lose the benefit of any future improvements to that function (see #941).Changes
lib/index.js: Extract the URL sanitization logic intocreateUrlTransform(safeProtocol?)and redefinedefaultUrlTransformascreateUrlTransform()— fully backward-compatible.index.js: ExportcreateUrlTransformfrom the package entry point.test.jsx: Add acreateUrlTransformtest suite covering default behaviour, custom protocols, blocked protocols, component integration, and parity withdefaultUrlTransform.readme.md: DocumentcreateUrlTransformwith a usage example.Usage example
Backward compatibility
defaultUrlTransformbehaviour is unchanged — it is now defined ascreateUrlTransform()with the same default regex.Closes #941