Support {} for capturing prefix and suffix chars (#207)

Author: blakeembrey

Readme.md

@@ -33,10 +33,10 @@ const { pathToRegexp, match, parse, compile } = require("path-to-regexp");
   - **strict** When `true` the regexp allows an optional trailing delimiter to match. (default: `false`)
   - **end** When `true` the regexp will match to the end of the string. (default: `true`)
   - **start** When `true` the regexp will match from the beginning of the string. (default: `true`)
-  - **delimiter** The default delimiter for segments. (default: `'/'`)
+  - **delimiter** The default delimiter for segments, e.g. `[^/]` for `:named` patterns. (default: `'/'`)
   - **endsWith** Optional character, or list of characters, to treat as "end" characters.
-  - **whitelist** List of characters to consider delimiters when parsing. (default: `undefined`, any character)
   - **encode** A function to encode strings before inserting into `RegExp`. (default: `x => x`)
+  - **prefixes** List of characters to automatically consider prefixes when parsing. (default: `./`)
 
 ```javascript
 const keys = [];
@@ -49,11 +49,11 @@ const regexp = pathToRegexp("/foo/:bar", keys);
 
 ### Parameters
 
-The path argument is used to define parameters and populate the list of keys.
+The path argument is used to define parameters and populate keys.
 
 #### Named Parameters
 
-Named parameters are defined by prefixing a colon to the parameter name (`:foo`). By default, the parameter will match until the next prefix (e.g. `[^/]+`).
+Named parameters are defined by prefixing a colon to the parameter name (`:foo`).
 
 ```js
 const regexp = pathToRegexp("/:foo/:bar");
@@ -65,7 +65,61 @@ regexp.exec("/test/route");
 
 **Please note:** Parameter names must use "word characters" (`[A-Za-z0-9_]`).
 
-#### Parameter Modifiers
+##### Custom Matching Parameters
+
+Parameters can have a custom regexp, which overrides the default match (`[^/]+`). For example, you can match digits or names in a path:
+
+```js
+const regexpNumbers = pathToRegexp("/icon-:foo(\\d+).png");
+// keys = [{ name: 'foo', ... }]
+
+regexpNumbers.exec("/icon-123.png");
+//=> ['/icon-123.png', '123']
+
+regexpNumbers.exec("/icon-abc.png");
+//=> null
+
+const regexpWord = pathToRegexp("/(user|u)");
+// keys = [{ name: 0, ... }]
+
+regexpWord.exec("/u");
+//=> ['/u', 'u']
+
+regexpWord.exec("/users");
+//=> null
+```
+
+**Tip:** Backslashes need to be escaped with another backslash in JavaScript strings.
+
+##### Custom Prefix and Suffix
+
+Parameters can be wrapped in `{}` to create custom prefixes or suffixes for your segment:
+
+```js
+const regexp = pathToRegexp("/:attr1?{-:attr2}?{-:attr3}?");
+
+regexp.exec("/test");
+// => ['/test', 'test', undefined, undefined]
+
+regexp.exec("/test-test");
+// => ['/test', 'test', 'test', undefined]
+```
+
+#### Unnamed Parameters
+
+It is possible to write an unnamed parameter that only consists of a regexp. It works the same the named parameter, except it will be numerically indexed:
+
+```js
+const regexp = pathToRegexp("/:foo/(.*)");
+// keys = [{ name: 'foo', ... }, { name: 0, ... }]
+
+regexp.exec("/test/route");
+//=> [ '/test/route', 'test', 'route', index: 0, input: '/test/route', groups: undefined ]
+```
+
+#### Modifiers
+
+Modifiers must be placed after the parameter (e.g. `/:foo?`, `/(test)?`, or `/:foo(test)?`).
 
 ##### Optional
 
@@ -86,7 +140,7 @@ regexp.exec("/test/route");
 
 ##### Zero or more
 
-Parameters can be suffixed with an asterisk (`*`) to denote a zero or more parameter matches. The prefix is used for each match.
+Parameters can be suffixed with an asterisk (`*`) to denote a zero or more parameter matches.
 
 ```js
 const regexp = pathToRegexp("/:foo*");
@@ -101,7 +155,7 @@ regexp.exec("/bar/baz");
 
 ##### One or more
 
-Parameters can be suffixed with a plus sign (`+`) to denote a one or more parameter matches. The prefix is used for each match.
+Parameters can be suffixed with a plus sign (`+`) to denote a one or more parameter matches.
 
 ```js
 const regexp = pathToRegexp("/:foo+");
@@ -114,44 +168,6 @@ regexp.exec("/bar/baz");
 //=> [ '/bar/baz','bar/baz', index: 0, input: '/bar/baz', groups: undefined ]
 ```
 
-#### Unnamed Parameters
-
-It is possible to write an unnamed parameter that only consists of a matching group. It works the same as a named parameter, except it will be numerically indexed.
-
-```js
-const regexp = pathToRegexp("/:foo/(.*)");
-// keys = [{ name: 'foo', ... }, { name: 0, ... }]
-
-regexp.exec("/test/route");
-//=> [ '/test/route', 'test', 'route', index: 0, input: '/test/route', groups: undefined ]
-```
-
-#### Custom Matching Parameters
-
-All parameters can have a custom regexp, which overrides the default match (`[^/]+`). For example, you can match digits or names in a path:
-
-```js
-const regexpNumbers = pathToRegexp("/icon-:foo(\\d+).png");
-// keys = [{ name: 'foo', ... }]
-
-regexpNumbers.exec("/icon-123.png");
-//=> ['/icon-123.png', '123']
-
-regexpNumbers.exec("/icon-abc.png");
-//=> null
-
-const regexpWord = pathToRegexp("/(user|u)");
-// keys = [{ name: 0, ... }]
-
-regexpWord.exec("/u");
-//=> ['/u', 'u']
-
-regexpWord.exec("/users");
-//=> null
-```
-
-**Tip:** Backslashes need to be escaped with another backslash in JavaScript strings.
-
 ### Match
 
 The `match` function will return a function for transforming paths into parameters:

package.json

@@ -34,7 +34,7 @@
   "size-limit": [
     {
       "path": "dist/index.js",
-      "limit": "1.75 kB"
+      "limit": "2 kB"
     }
   ],
   "jest": {