# github-short-url-regex

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

Latest version **3.0.0** (published 2015-03-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install github-short-url-regex
pnpm add github-short-url-regex
yarn add github-short-url-regex
bun add github-short-url-regex
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2015-03-26 |
| First published | 2014-12-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 10 |
| Author | Charlike Mike Reagent |
| Maintainers | tunnckocore |
| Keywords | github, regex, regexps, short, shorthand, url |

## Links

- npm: https://www.npmjs.com/package/github-short-url-regex
- Repository: https://github.com/regexps/github-short-url-regex
- Issues: https://github.com/regexps/github-short-url-regex/issues
- npm.io page: https://npm.io/package/github-short-url-regex

## Dependencies (1)

- [regex-cache](https://npm.io/package/regex-cache.md) ~0.4.2

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 3.0.0 (latest) — 2015-03-26
- 2.0.0 — 2015-03-26
- 1.0.0 — 2014-12-20

## README

## [![npm version][npmjs-img]][npmjs-url] [![mit license][license-img]][license-url] [![build status][travis-img]][travis-url] [![coverage status][coveralls-img]][coveralls-url]

> 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](./index.js#L19)
> 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](./test.js)

```js
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](https://github.com/jonschlinkert/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](https://github.com/jonschlinkert/utils): Fast, generic JavaScript/node.js utility functions.
- [helper-related](https://github.com/helpers/helper-related): Template helper for generating a list of links to the homepages of related GitHub/npm projects.


## Author
**Charlike Mike Reagent**
+ [gratipay/tunnckoCore][author-gratipay]
+ [twitter/tunnckoCore][author-twitter]
+ [github/tunnckoCore][author-github]
+ [npmjs/tunnckoCore][author-npmjs]
+ [more ...][contrib-more]


## License [![MIT license][license-img]][license-url]
Copyright (c) 2014-2015 [Charlike Mike Reagent][contrib-more], [contributors][contrib-graf].  
Released under the [`MIT`][license-url] license.


[npmjs-url]: http://npm.im/github-short-url-regex
[npmjs-img]: https://img.shields.io/npm/v/github-short-url-regex.svg?style=flat&label=github-short-url-regex

[coveralls-url]: https://coveralls.io/r/regexps/github-short-url-regex?branch=master
[coveralls-img]: https://img.shields.io/coveralls/regexps/github-short-url-regex.svg?style=flat

[license-url]: https://github.com/regexps/github-short-url-regex/blob/master/license.md
[license-img]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat

[travis-url]: https://travis-ci.org/regexps/github-short-url-regex
[travis-img]: https://img.shields.io/travis/regexps/github-short-url-regex.svg?style=flat

[daviddm-url]: https://david-dm.org/regexps/github-short-url-regex
[daviddm-img]: https://img.shields.io/david/regexps/github-short-url-regex.svg?style=flat

[author-gratipay]: https://gratipay.com/tunnckoCore
[author-twitter]: https://twitter.com/tunnckoCore
[author-github]: https://github.com/tunnckoCore
[author-npmjs]: https://npmjs.org/~tunnckocore

[contrib-more]: http://j.mp/1stW47C
[contrib-graf]: https://github.com/regexps/github-short-url-regex/graphs/contributors

***

_Powered and automated by [docks](https://github.com/tunnckoCore), March 26, 2015_

---
_Source: https://npm.io/package/github-short-url-regex · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._