.gitignore added
[dotfiles/.git] / .config / coc / extensions / node_modules / coc-prettier / node_modules / globjoin / README.md
1 # globjoin
2
3 Join paths and globs.
4
5 [![MIT](http://img.shields.io/badge/license-MIT-brightgreen.svg)](https://github.com/amobiz/globjoin/blob/master/LICENSE) [![npm version](https://badge.fury.io/js/globjoin.svg)](http://badge.fury.io/js/globjoin) [![David Dependency Badge](https://david-dm.org/amobiz/globjoin.svg)](https://david-dm.org/amobiz/globjoin)
6
7 [![NPM](https://nodei.co/npm/globjoin.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/globjoin.png?downloads=true&downloadRank=true&stars=true) [![NPM](https://nodei.co/npm-dl/globjoin.png?months=6&height=3)](https://nodei.co/npm/globjoin/)
8
9 ## Install
10 ``` bash
11 $ npm install globjoin
12 ```
13
14 ## API
15
16 ### `globjoin(globs...)`
17 Join paths and globs.
18
19 Like Node's [path.join()](https://nodejs.org/api/path.html#path_path_join_path1_path2) that join all arguments together and normalize the resulting path, `globjoin` takes arbitrary number of paths and/or arrays of paths, join them together and take care of negative globs.
20 #### Context
21 Don't care.
22 #### Parameters
23 ##### `paths/globs`
24 The paths/globs or arrays of paths/globs to join.
25 #### Returns
26 The result glob, or array of globs if any of paths/globs are array.
27 #### Example
28 ``` javascript
29 var join = require('globjoin');
30 var globs1 = join(__dirname, ['**/*.js', '!**/test*.js']);
31 var globs2 = join('test', 'fixture', 'app', ['views', '!services'], ['**/*', '!*.{js,json,coffee,ts}']);
32 ```
33
34 Check out test for more examples.
35
36 ## Issues
37
38 [Issues](https://github.com/amobiz/globjoin/issues)
39
40 ## Test
41
42 ``` bash
43 $ npm test
44 ```
45
46 ## Changelog
47
48 [Changelog](./CHANGELOG.md)
49
50 ## License
51 MIT
52
53 ## Author
54 [Amobiz](https://github.com/amobiz)