Enable a default delimiter for parsing behaviour (pillarjs#94)

Author: blakeembrey

Readme.md

@@ -31,6 +31,7 @@ var pathToRegexp = require('path-to-regexp')
  - **sensitive** When `true` the route will be case sensitive. (default: `false`)
  - **strict** When `false` the trailing slash is optional. (default: `false`)
  - **end** When `false` the path will match at the beginning. (default: `true`)
+ - **delimiter** Set the default delimiter for repeat parameters. (default: `'/'`)
 
 ```javascript
 var keys = []

index.d.ts

@@ -1,30 +1,43 @@
-declare function pathToRegexp (path: pathToRegexp.Path, options?: pathToRegexp.Options): pathToRegexp.PathRegExp;
-declare function pathToRegexp (path: pathToRegexp.Path, keys?: pathToRegexp.Key[], options?: pathToRegexp.Options): pathToRegexp.PathRegExp;
+declare function pathToRegexp (path: pathToRegexp.Path, options?: pathToRegexp.RegExpOptions & pathToRegexp.ParseOptions): pathToRegexp.PathRegExp;
+declare function pathToRegexp (path: pathToRegexp.Path, keys?: pathToRegexp.Key[], options?: pathToRegexp.RegExpOptions & pathToRegexp.ParseOptions): pathToRegexp.PathRegExp;
 
 declare namespace pathToRegexp {
  export interface PathRegExp extends RegExp {
  // An array to be populated with the keys found in the path.
  keys: Key[];
  }
 
- export interface Options {
- // When `true` the route will be case sensitive. (default: `false`)
+ export interface RegExpOptions {
+ /**
+ * When `true` the route will be case sensitive. (default: `false`)
+ */
  sensitive?: boolean;
- // When `false` the trailing slash is optional. (default: `false`)
+ /**
+ * When `false` the trailing slash is optional. (default: `false`)
+ */
  strict?: boolean;
- // When `false` the path will match at the beginning. (default: `true`)
+ /**
+ * When `false` the path will match at the beginning. (default: `true`)
+ */
  end?: boolean;
  }
 
+ export interface ParseOptions {
+ /**
+ * Set the default delimiter for repeat parameters. (default: `'/'`)
+ */
+ delimiter?: string;
+ }
+
  /**
  * Parse an Express-style path into an array of tokens.
  */
- export function parse (path: string): Token[];
+ export function parse (path: string, options?: ParseOptions): Token[];
 
  /**
  * Transforming an Express-style path into a valid path.
  */
- export function compile (path: string): PathFunction;
+ export function compile (path: string, options?: ParseOptions): PathFunction;
 
  /**
  * Transform an array of tokens into a path generator function.
@@ -34,8 +47,8 @@ declare namespace pathToRegexp {
  /**
  * Transform an array of tokens into a matching regular expression.
  */
- export function tokensToRegExp (tokens: Token[], options?: Options): PathRegExp;
- export function tokensToRegExp (tokens: Token[], keys?: Key[], options?: Options): PathRegExp;
+ export function tokensToRegExp (tokens: Token[], options?: RegExpOptions): PathRegExp;
+ export function tokensToRegExp (tokens: Token[], keys?: Key[], options?: RegExpOptions): PathRegExp;
 
  export interface Key {
  name: string | number;

index.js

@@ -30,14 +30,16 @@ var PATH_REGEXP = new RegExp([
 /**
  * Parse a string for the raw tokens.
  *
- * @param {string} str
+ * @param {string} str
+ * @param {Object=} options
  * @return {!Array}
  */
-function parse (str) {
+function parse (str, options) {
  var tokens = []
  var key = 0
  var index = 0
  var path = ''
+ var defaultDelimiter = options && options.delimiter || '/'
  var res
 
  while ((res = PATH_REGEXP.exec(str)) != null) {
@@ -70,8 +72,8 @@ function parse (str) {
  var partial = prefix != null && next != null && next !== prefix
  var repeat = modifier === '+' || modifier === '*'
  var optional = modifier === '?' || modifier === '*'
- var delimiter = res[2] || '/'
- var pattern = capture || group || (asterisk ? '.*' : '[^' + delimiter + ']+?')
+ var delimiter = res[2] || defaultDelimiter
+ var pattern = capture || group
 
  tokens.push({
  name: name || key++,
@@ -81,7 +83,7 @@ function parse (str) {
  repeat: repeat,
  partial: partial,
  asterisk: !!asterisk,
- pattern: escapeGroup(pattern)
+ pattern: pattern ? escapeGroup(pattern) : (asterisk ? '.*' : '[^' + escapeString(delimiter) + ']+?')
  })
  }
 
@@ -102,10 +104,11 @@ function parse (str) {
  * Compile a string to a template function for the path.
  *
  * @param {string} str
+ * @param {Object=} options
  * @return {!function(Object=, Object=)}
  */
-function compile (str) {
- return tokensToFunction(parse(str))
+function compile (str, options) {
+ return tokensToFunction(parse(str, options))
 }
 
 /**
@@ -316,7 +319,7 @@ function arrayToRegexp (path, keys, options) {
  * @return {!RegExp}
  */
 function stringToRegexp (path, keys, options) {
- return tokensToRegExp(parse(path), keys, options)
+ return tokensToRegExp(parse(path, options), keys, options)
 }
 
 /**

test.ts

@@ -10,7 +10,7 @@ const expect = chai.expect
 
 type Test = [
  pathToRegexp.Path,
- pathToRegexp.Options,
+ pathToRegexp.RegExpOptions & pathToRegexp.ParseOptions,
  pathToRegexp.Token[],
  Array<[string, string[]]>,
  Array<[any, string]>
@@ -1122,7 +1122,7 @@ var TESTS: Test[] = [
  repeat: false,
  partial: false,
  asterisk: false,
- pattern: '[^.]+?'
+ pattern: '[^\\.]+?'
  }
  ],
  [
@@ -1148,7 +1148,7 @@ var TESTS: Test[] = [
  repeat: false,
  partial: false,
  asterisk: false,
- pattern: '[^.]+?'
+ pattern: '[^\\.]+?'
  },
  {
  name: 'format',
@@ -1158,7 +1158,7 @@ var TESTS: Test[] = [
  repeat: false,
  partial: false,
  asterisk: false,
- pattern: '[^.]+?'
+ pattern: '[^\\.]+?'
  }
  ],
  [
@@ -1183,7 +1183,7 @@ var TESTS: Test[] = [
  repeat: true,
  partial: false,
  asterisk: false,
- pattern: '[^.]+?'
+ pattern: '[^\\.]+?'
  }
  ],
  [
@@ -1211,7 +1211,7 @@ var TESTS: Test[] = [
  repeat: false,
  partial: false,
  asterisk: false,
- pattern: '[^.]+?'
+ pattern: '[^\\.]+?'
  }
  ],
  [
@@ -1235,7 +1235,7 @@ var TESTS: Test[] = [
  repeat: false,
  partial: false,
  asterisk: false,
- pattern: '[^.]+?'
+ pattern: '[^\\.]+?'
  },
  '.'
  ],
@@ -1274,7 +1274,7 @@ var TESTS: Test[] = [
  repeat: false,
  partial: false,
  asterisk: false,
- pattern: '[^.]+?'
+ pattern: '[^\\.]+?'
  }
  ],
  [
@@ -1309,7 +1309,7 @@ var TESTS: Test[] = [
  repeat: false,
  partial: false,
  asterisk: false,
- pattern: '[^.]+?'
+ pattern: '[^\\.]+?'
  }
  ],
  [
@@ -1347,7 +1347,7 @@ var TESTS: Test[] = [
  repeat: false,
  partial: false,
  asterisk: false,
- pattern: '[^.]+?'
+ pattern: '[^\\.]+?'
  }
  ],
  [
@@ -2135,6 +2135,92 @@ var TESTS: Test[] = [
  [
  [{ foo: 'café' }, '/caf%C3%A9']
  ]
+ ],
+
+ /**
+ * Hostnames.
+ */
+ [
+ ':domain.com',
+ {
+ delimiter: '.'
+ },
+ [
+ {
+ name: 'domain',
+ prefix: '',
+ delimiter: '.',
+ optional: false,
+ repeat: false,
+ partial: false,
+ asterisk: false,
+ pattern: '[^\\.]+?'
+ },
+ '.com'
+ ],
+ [
+ ['example.com', ['example.com', 'example']],
+ ['github.com', ['github.com', 'github']],
+ ],
+ [
+ [{ domain: 'example' }, 'example.com'],
+ [{ domain: 'github' }, 'github.com']
+ ]
+ ],
+ [
+ 'mail.:domain.com',
+ {
+ delimiter: '.'
+ },
+ [
+ 'mail',
+ {
+ name: 'domain',
+ prefix: '.',
+ delimiter: '.',
+ optional: false,
+ repeat: false,
+ partial: false,
+ asterisk: false,
+ pattern: '[^\\.]+?'
+ },
+ '.com'
+ ],
+ [
+ ['mail.example.com', ['mail.example.com', 'example']],
+ ['mail.github.com', ['mail.github.com', 'github']]
+ ],
+ [
+ [{ domain: 'example' }, 'mail.example.com'],
+ [{ domain: 'github' }, 'mail.github.com']
+ ]
+ ],
+ [
+ 'example.:ext',
+ {
+ delimiter: '.'
+ },
+ [
+ 'example',
+ {
+ name: 'ext',
+ prefix: '.',
+ delimiter: '.',
+ optional: false,
+ repeat: false,
+ partial: false,
+ asterisk: false,
+ pattern: '[^\\.]+?'
+ }
+ ],
+ [
+ ['example.com', ['example.com', 'com']],
+ ['example.org', ['example.org', 'org']],
+ ],
+ [
+ [{ ext: 'com' }, 'example.com'],
+ [{ ext: 'org' }, 'example.org']
+ ]
  ]
 ]
 
@@ -2224,7 +2310,7 @@ describe('path-to-regexp', function () {
  // Parsing and compiling is only supported with string input.
  if (typeof path === 'string') {
  it('should parse', function () {
- expect(pathToRegexp.parse(path)).to.deep.equal(tokens)
+ expect(pathToRegexp.parse(path, opts)).to.deep.equal(tokens)
  })
 
  describe('compile', function () {