forked from PirateCare/Syllabus
107 lines
3.4 KiB
Markdown
107 lines
3.4 KiB
Markdown
|
# is-extglob [](https://www.npmjs.com/package/is-extglob) [](https://npmjs.org/package/is-extglob) [](https://travis-ci.org/jonschlinkert/is-extglob)
|
||
|
|
|
||
|
|
> Returns true if a string has an extglob.
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
Install with [npm](https://www.npmjs.com/):
|
||
|
|
|
||
|
|
```sh
|
||
|
|
$ npm install --save is-extglob
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```js
|
||
|
|
var isExtglob = require('is-extglob');
|
||
|
|
```
|
||
|
|
|
||
|
|
**True**
|
||
|
|
|
||
|
|
```js
|
||
|
|
isExtglob('?(abc)');
|
||
|
|
isExtglob('@(abc)');
|
||
|
|
isExtglob('!(abc)');
|
||
|
|
isExtglob('*(abc)');
|
||
|
|
isExtglob('+(abc)');
|
||
|
|
```
|
||
|
|
|
||
|
|
**False**
|
||
|
|
|
||
|
|
Escaped extglobs:
|
||
|
|
|
||
|
|
```js
|
||
|
|
isExtglob('\\?(abc)');
|
||
|
|
isExtglob('\\@(abc)');
|
||
|
|
isExtglob('\\!(abc)');
|
||
|
|
isExtglob('\\*(abc)');
|
||
|
|
isExtglob('\\+(abc)');
|
||
|
|
```
|
||
|
|
|
||
|
|
Everything else...
|
||
|
|
|
||
|
|
```js
|
||
|
|
isExtglob('foo.js');
|
||
|
|
isExtglob('!foo.js');
|
||
|
|
isExtglob('*.js');
|
||
|
|
isExtglob('**/abc.js');
|
||
|
|
isExtglob('abc/*.js');
|
||
|
|
isExtglob('abc/(aaa|bbb).js');
|
||
|
|
isExtglob('abc/[a-z].js');
|
||
|
|
isExtglob('abc/{a,b}.js');
|
||
|
|
isExtglob('abc/?.js');
|
||
|
|
isExtglob('abc.js');
|
||
|
|
isExtglob('abc/def/ghi.js');
|
||
|
|
```
|
||
|
|
|
||
|
|
## History
|
||
|
|
|
||
|
|
**v2.0**
|
||
|
|
|
||
|
|
Adds support for escaping. Escaped exglobs no longer return true.
|
||
|
|
|
||
|
|
## About
|
||
|
|
|
||
|
|
### Related projects
|
||
|
|
|
||
|
|
* [has-glob](https://www.npmjs.com/package/has-glob): Returns `true` if an array has a glob pattern. | [homepage](https://github.com/jonschlinkert/has-glob "Returns `true` if an array has a glob pattern.")
|
||
|
|
* [is-glob](https://www.npmjs.com/package/is-glob): Returns `true` if the given string looks like a glob pattern or an extglob pattern… [more](https://github.com/jonschlinkert/is-glob) | [homepage](https://github.com/jonschlinkert/is-glob "Returns `true` if the given string looks like a glob pattern or an extglob pattern. This makes it easy to create code that only uses external modules like node-glob when necessary, resulting in much faster code execution and initialization time, and a bet")
|
||
|
|
* [micromatch](https://www.npmjs.com/package/micromatch): Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. | [homepage](https://github.com/jonschlinkert/micromatch "Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch.")
|
||
|
|
|
||
|
|
### Contributing
|
||
|
|
|
||
|
|
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
|
||
|
|
|
||
|
|
### Building docs
|
||
|
|
|
||
|
|
_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_
|
||
|
|
|
||
|
|
To generate the readme and API documentation with [verb](https://github.com/verbose/verb):
|
||
|
|
|
||
|
|
```sh
|
||
|
|
$ npm install -g verb verb-generate-readme && verb
|
||
|
|
```
|
||
|
|
|
||
|
|
### Running tests
|
||
|
|
|
||
|
|
Install dev dependencies:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
$ npm install -d && npm test
|
||
|
|
```
|
||
|
|
|
||
|
|
### Author
|
||
|
|
|
||
|
|
**Jon Schlinkert**
|
||
|
|
|
||
|
|
* [github/jonschlinkert](https://github.com/jonschlinkert)
|
||
|
|
* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
|
||
|
|
|
||
|
|
### License
|
||
|
|
|
||
|
|
Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
|
||
|
|
Released under the [MIT license](https://github.com/jonschlinkert/is-extglob/blob/master/LICENSE).
|
||
|
|
|
||
|
|
***
|
||
|
|
|
||
|
|
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.1.31, on October 12, 2016._
|