UNPKG

2.07 kBMarkdownView Raw
1# filename-regex [![NPM version](https://img.shields.io/npm/v/filename-regex.svg?style=flat)](https://www.npmjs.com/package/filename-regex) [![NPM monthly downloads](https://img.shields.io/npm/dm/filename-regex.svg?style=flat)](https://npmjs.org/package/filename-regex) [![NPM total downloads](https://img.shields.io/npm/dt/filename-regex.svg?style=flat)](https://npmjs.org/package/filename-regex) [![Linux Build Status](https://img.shields.io/travis/regexhq/filename-regex.svg?style=flat&label=Travis)](https://travis-ci.org/regexhq/filename-regex)
2
3> Regular expression for matching file names, with or without extension.
4
5## Install
6
7Install with [npm](https://www.npmjs.com/):
8
9```sh
10$ npm install --save filename-regex
11```
12
13## Usage
14
15```js
16var regex = require('filename-regex');
17
18'a/b/c/d.min.js'.match(regex());
19//=> match[0] = 'd.min.js'
20
21'a/b/c/.dotfile'.match(regex());
22//=> match[0] = '.dotfile'
23```
24
25## About
26
27### Contributing
28
29Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
30
31### Building docs
32
33_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
34
35To generate the readme, run the following command:
36
37```sh
38$ npm install -g verbose/verb#dev verb-generate-readme && verb
39```
40
41### Running tests
42
43Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
44
45```sh
46$ npm install && npm test
47```
48
49### Author
50
51**Jon Schlinkert**
52
53* [github/jonschlinkert](https://github.com/jonschlinkert)
54* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
55
56### License
57
58Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
59Released under the [MIT License](LICENSE).
60
61***
62
63_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.3, on April 28, 2017._
\No newline at end of file