Package Exports
- github-short-url-regex
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (github-short-url-regex) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Regex for converting github shorthand url (user/repo#branch) to object
Install
$ npm install github-short-url-regex
$ npm test.githubShortUrlRegex
Convert github shorthand url (user/repo#branch) to object
[options]{Object}flags{String} every valid RegExp flag, defaultundefinedexact{Boolean}
return{RegExp}
Usage
For more use-cases see the tests
var regex = require('github-short-url-regex');
regex().test('gh tunnckoCore/npmls#master here');
//=> false
regex({flags: 'g'}).test('gh tunnckoCore/npmls#master here');
//=> false
regex({flags: 'g', exact: false}).test('gh tunnckoCore/npmls#master here');
//=> true
regex({flags: 'g', exact: true}).test('gh tunnckoCore/npmls#master here');
//=> false
'gh tunnckoCore/npmls#test here user/repo#branch yea'.match(regex({flags: 'g'}));
//=> null
'gh tunnckoCore/npmls#test here user/repo#branch yea'.match(regex({flags: 'g', exact: false}));
//=> ['tunnckoCore/npmls#test', 'user/repo#branch']
'gh tunnckoCore/npmls#test here user/repo#branch yea'.match(regex({exact: false}))[0];
//=> 'tunnckoCore/npmls#test'
'gh tunnckoCore/npmls#test here user/repo#branch yea'.match(regex({exact: true}));
//=> null
'tunnckoCore/npmls#test'.match(regex({exact: true}))[0];
//=> 'tunnckoCore/npmls#test'Author
Charlike Mike Reagent
License
Copyright (c) 2014 Charlike Mike Reagent, contributors.
Released under the MIT license.
Powered and automated by readdirp + hogan.js, December 20, 2014