github-short-url-regex

3.0.0 • Public • Published

npm version mit license build status coverage status

Regular expression (Regex) for matching github shorthand (user/repo#branch).

Install

npm i --save github-short-url-regex
npm test

Support

  • github shorthands mochajs/mocha#master
    • where thing after hash (#) represent release, tag or branch
  • npm shorthands gulpjs/gulp@v3.8.10

githubShortUrlRegex

Find github shorthand url (user/repo#branch)

  • [options] {Object}
    • flags {String} every valid RegExp flag, default undefined
    • exact {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'

Related

  • regex-cache: Memoize the results of a call to the RegExp constructor, avoiding repetitious runtime compilation of the same string and options, resulting in dramatic speed improvements.
  • utils: Fast, generic JavaScript/node.js utility functions.
  • helper-related: Template helper for generating a list of links to the homepages of related GitHub/npm projects.

Author

Charlike Mike Reagent

License MIT license

Copyright (c) 2014-2015 Charlike Mike Reagent, contributors.
Released under the MIT license.


Powered and automated by docks, March 26, 2015

Package Sidebar

Install

npm i github-short-url-regex

Weekly Downloads

69

Version

3.0.0

License

MIT

Last publish

Collaborators

  • vanchoy
  • tunnckocore