Reduce duplication in badge regex/url patterns

[chris48s]

Can we use something like url-pattern or path-to-regexp to define routes in a nicer way so we don't have to define this twice?

relevant discussions:
#2042 (comment)
#1582 (comment)

[RedSparr0w]

👍 Sounds like a good idea, would definitely help keep everything consistent.

Edit: I like the look of path-to-regexp

[paulmelnikow]

I played with path-to-regexp a bit back in March. This is based on what I did then:

const pathToRegexp = require('path-to-regexp')

const keys = []
const re = pathToRegexp('/appveyor/ci/:user/:repo/:branch?.:ext(png|gif)', keys, {
  delimiter: '.',
  strict: true,
  sensitive: true,
})

console.log(re)

const result = {}
re.exec('/appveyor/ci/foo/bar/baz.png').slice(1).forEach((match, i) => {
  result[keys[i].name] = match
})
console.log(result)

Output:

/^\/appveyor\/ci\/([^\/]+?)\/([^\/]+?)\/([^\/]+?)?\.(png|gif)$/
{ user: 'foo', repo: 'bar', branch: 'baz', ext: 'png' }

Cool stuff!

The compile() method would be useful in the frontend to build a badge URL from user input. I ran into some issues with that, IIRC. It'd be good to make sure that works before we settle on this library.

[paulmelnikow]

compile() seems to be working now!

const toPath = pathToRegexp.compile('/appveyor/ci/:user/:repo/:branch?.:ext(png|gif)', {
  delimiter: '.',
  strict: true,
  sensitive: true,
})

console.log(toPath({ user: 'foo', repo: 'bar', branch: 'baz', ext: 'png' }))

What do you think? Should we move forward with this approach?

[paulmelnikow]

#2279 is about ready for merge!

The next step would be to reduce duplication in defining examples, and maybe do this with an eye toward #701 and #776.