Releases: pillarjs/path-to-regexp
Releases · pillarjs/path-to-regexp
Simpler API
Heads up! This is a fairly large change (again) and I need to apologize in advance. If I foresaw what this version would have ended up being I would not have released version 7. A longer blog post and explanation will be incoming this week, but the pivot has been due to work on Express.js v5 and this will the finalized syntax used in Express moving forward.
Added
- Adds key names to wildcards using
*name
syntax, aligns with:
behavior but using an asterisk instead
Changed
- Removes group suffixes of
?
,*
- only optional exists moving forward (use wildcards for{*foo}
for*
) - Parameter names follow JS identifier rules and allow unicode characters
Added
- Parameter names can now be quoted, e.g.
:"foo-bar"
Removed
- Removes
loose
mode - Removes regular expression overrides of parameters
Backtrack protection
Fixed
- Add backtrack protection to parameters 29b96b4
- This will break some edge cases but should improve performance
Support non-lookahead regex output
Strict mode
Added
- Adds a
strict
option to detect potential ReDOS issues
Fixed
- Fixes separator to default to
suffix prefix
when not specified - Allows separator to be undefined in
TokenData
- This is only relevant if you are building
TokenData
manually, previouslyparse
filled it in automatically
- This is only relevant if you are building
Comments
- I highly recommend enabling
strict: true
and I'm probably releasing a V8 with it enabled by default ASAP as a necessary security mitigation
Wildcard, unicode, and modifier changes
Hi all! There's a few major breaking changes in this release so read carefully.
Breaking changes:
- The function returned by
compile
only accepts strings as values (i.e. no numbers, useString(value)
before compiling a path)- For repeated values, when
encode !== false
, it must be an array of strings
- For repeated values, when
- Parameter names can contain all unicode identifier characters (defined as regex
\p{XID_Continue}
). - Modifiers (
?
,*
,{}
- No more implied prefix of
/
or.
- No more implied prefix of
- No support for arrays or regexes as inputs
- The wildcard (standalone
*
) has been added back and matches Express.js expected behavior - Removed
endsWith
option - Renamed
strict: true
totrailing: false
- Reserved
;
,,
,!
, and@
for future use-cases - Removed
tokensToRegexp
,tokensToFunction
andregexpToFunction
in favor of simplifying exports - Enable a "loose" mode by default, so
/
can be repeated multiple times in a matched path (i.e./foo
works like//foo
, etc) encode
anddecode
no longer receive the token as the second parameter- Removed the ESM CommonJS dual package in favor of only one CommonJS supported export
- Minimum JS support for ES2020 (previous ES2015)
- Encode defaults to
encodeURIComponent
and decode defaults todecodeURIComponent
Added:
- Adds
encodePath
to fix an issue aroundencode
being used for both path and parameters (the path and parameter should be encoded slightly differently) - Adds
loose
as an option to support arbitrarily matching the delimiter in paths, e.g.foo/bar
andfoo///bar
should work the same - Allow
encode
anddecode
to be set tofalse
which skips all processing of the parameters input/output - All remaining methods support
TokenData
(exported, returned byparse
) as input- This should be useful if you are programmatically building paths to match or want to avoid parsing multiple times
Requests for feedback:
- Requiring
{}
is an obvious drawback but I'm seeking feedback on whether it helps make path behavior clearer- Related: Removing
/
and.
as implicit prefixes
- Related: Removing
- Removing array and regex support is to reduce the overall package size for things many users don't need
- Unicode IDs are added to align more closely with browser URLPattern behavior, which uses JS identifiers
Updated README
No API changes. Documentation only release.
Changed
Support named matching groups in `RegExp`
Fix matching `:name*` parameter
Named Capturing Groups
Use `/#?` as Default Delimiter
Fixed
- Use
/#?
as default delimiter to avoid matching on query or fragment parameters- If you are matching non-paths (e.g. hostnames), you can adjust
delimiter: '.'
- If you are matching non-paths (e.g. hostnames), you can adjust