forked from public/fvtt-cthulhu-eternal
59 lines
2.0 KiB
Markdown
59 lines
2.0 KiB
Markdown
|
<p align="center">
|
||
|
|
<a href="http://gulpjs.com">
|
||
|
|
<img height="257" width="114" src="https://raw.githubusercontent.com/gulpjs/artwork/master/gulp-2x.png">
|
||
|
|
</a>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
# @gulpjs/to-absolute-glob
|
||
|
|
|
||
|
|
[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][ci-image]][ci-url] [![Coveralls Status][coveralls-image]][coveralls-url]
|
||
|
|
|
||
|
|
Make a glob pattern absolute, ensuring that negative globs and patterns with trailing slashes are correctly handled.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```js
|
||
|
|
var toAbsoluteGlob = require('@gulpjs/to-absolute-glob');
|
||
|
|
|
||
|
|
// All these assume your cwd is `/dev/foo/`
|
||
|
|
|
||
|
|
toAbsoluteGlob('a/*.js') === '/dev/foo/a/*.js';
|
||
|
|
|
||
|
|
// Makes a path absolute
|
||
|
|
toAbsoluteGlob('a') === '/dev/foo/a';
|
||
|
|
|
||
|
|
// Retains trailing slashes
|
||
|
|
toAbsoluteGlob('a/*/') === '/dev/foo/a/*/';
|
||
|
|
|
||
|
|
// Makes a negative glob absolute
|
||
|
|
toAbsoluteGlob('!a/*.js') === '!/dev/foo/a/*.js';
|
||
|
|
|
||
|
|
// Accepts a cwd
|
||
|
|
toAbsoluteGlob('a/*.js', { cwd: 'foo' }) === '/dev/foo/foo/a/*.js';
|
||
|
|
|
||
|
|
// Accepts a root path
|
||
|
|
toAbsoluteGlob('/a/*.js', { root: 'baz' }) === '/dev/foo/baz/a/*.js';
|
||
|
|
```
|
||
|
|
|
||
|
|
## API
|
||
|
|
|
||
|
|
### `toAbsoluteGlob(glob, [options])`
|
||
|
|
|
||
|
|
Takes a `glob` string and an optional `options` object and produces an absolute glob. If the glob is relative, the `root` or `cwd` option (or `process.cwd()` if neither specified) will be used as the base of the glob.
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
MIT
|
||
|
|
|
||
|
|
<!-- prettier-ignore-start -->
|
||
|
|
[downloads-image]: https://img.shields.io/npm/dm/@gulpjs/to-absolute-glob.svg?style=flat-square
|
||
|
|
[npm-url]: https://www.npmjs.com/package/@gulpjs/to-absolute-glob
|
||
|
|
[npm-image]: https://img.shields.io/npm/v/@gulpjs/to-absolute-glob.svg?style=flat-square
|
||
|
|
|
||
|
|
[ci-url]: https://github.com/gulpjs/to-absolute-glob/actions?query=workflow:dev
|
||
|
|
[ci-image]: https://img.shields.io/github/actions/workflow/status/gulpjs/to-absolute-glob/dev.yml?branch=master&style=flat-square
|
||
|
|
|
||
|
|
[coveralls-url]: https://coveralls.io/r/gulpjs/to-absolute-glob
|
||
|
|
[coveralls-image]: https://img.shields.io/coveralls/gulpjs/to-absolute-glob/master.svg?style=flat-square
|
||
|
|
<!-- prettier-ignore-end -->
|