source: trip-planner-front/node_modules/glob-parent/README.md@ 188ee53

Last change on this file since 188ee53 was 6a3a178, checked in by Ema <ema_spirova@…>, 3 years ago

initial commit

  • Property mode set to 100644
File size: 4.5 KB
Line 
1<p align="center">
2 <a href="https://gulpjs.com">
3 <img height="257" width="114" src="https://raw.githubusercontent.com/gulpjs/artwork/master/gulp-2x.png">
4 </a>
5</p>
6
7# glob-parent
8
9[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Azure Pipelines Build Status][azure-pipelines-image]][azure-pipelines-url] [![Travis Build Status][travis-image]][travis-url] [![AppVeyor Build Status][appveyor-image]][appveyor-url] [![Coveralls Status][coveralls-image]][coveralls-url] [![Gitter chat][gitter-image]][gitter-url]
10
11Extract the non-magic parent path from a glob string.
12
13## Usage
14
15```js
16var globParent = require('glob-parent');
17
18globParent('path/to/*.js'); // 'path/to'
19globParent('/root/path/to/*.js'); // '/root/path/to'
20globParent('/*.js'); // '/'
21globParent('*.js'); // '.'
22globParent('**/*.js'); // '.'
23globParent('path/{to,from}'); // 'path'
24globParent('path/!(to|from)'); // 'path'
25globParent('path/?(to|from)'); // 'path'
26globParent('path/+(to|from)'); // 'path'
27globParent('path/*(to|from)'); // 'path'
28globParent('path/@(to|from)'); // 'path'
29globParent('path/**/*'); // 'path'
30
31// if provided a non-glob path, returns the nearest dir
32globParent('path/foo/bar.js'); // 'path/foo'
33globParent('path/foo/'); // 'path/foo'
34globParent('path/foo'); // 'path' (see issue #3 for details)
35```
36
37## API
38
39### `globParent(maybeGlobString, [options])`
40
41Takes a string and returns the part of the path before the glob begins. Be aware of Escaping rules and Limitations below.
42
43#### options
44
45```js
46{
47 // Disables the automatic conversion of slashes for Windows
48 flipBackslashes: true
49}
50```
51
52## Escaping
53
54The following characters have special significance in glob patterns and must be escaped if you want them to be treated as regular path characters:
55
56- `?` (question mark) unless used as a path segment alone
57- `*` (asterisk)
58- `|` (pipe)
59- `(` (opening parenthesis)
60- `)` (closing parenthesis)
61- `{` (opening curly brace)
62- `}` (closing curly brace)
63- `[` (opening bracket)
64- `]` (closing bracket)
65
66**Example**
67
68```js
69globParent('foo/[bar]/') // 'foo'
70globParent('foo/\\[bar]/') // 'foo/[bar]'
71```
72
73## Limitations
74
75### Braces & Brackets
76This library attempts a quick and imperfect method of determining which path
77parts have glob magic without fully parsing/lexing the pattern. There are some
78advanced use cases that can trip it up, such as nested braces where the outer
79pair is escaped and the inner one contains a path separator. If you find
80yourself in the unlikely circumstance of being affected by this or need to
81ensure higher-fidelity glob handling in your library, it is recommended that you
82pre-process your input with [expand-braces] and/or [expand-brackets].
83
84### Windows
85Backslashes are not valid path separators for globs. If a path with backslashes
86is provided anyway, for simple cases, glob-parent will replace the path
87separator for you and return the non-glob parent path (now with
88forward-slashes, which are still valid as Windows path separators).
89
90This cannot be used in conjunction with escape characters.
91
92```js
93// BAD
94globParent('C:\\Program Files \\(x86\\)\\*.ext') // 'C:/Program Files /(x86/)'
95
96// GOOD
97globParent('C:/Program Files\\(x86\\)/*.ext') // 'C:/Program Files (x86)'
98```
99
100If you are using escape characters for a pattern without path parts (i.e.
101relative to `cwd`), prefix with `./` to avoid confusing glob-parent.
102
103```js
104// BAD
105globParent('foo \\[bar]') // 'foo '
106globParent('foo \\[bar]*') // 'foo '
107
108// GOOD
109globParent('./foo \\[bar]') // 'foo [bar]'
110globParent('./foo \\[bar]*') // '.'
111```
112
113## License
114
115ISC
116
117[expand-braces]: https://github.com/jonschlinkert/expand-braces
118[expand-brackets]: https://github.com/jonschlinkert/expand-brackets
119
120[downloads-image]: https://img.shields.io/npm/dm/glob-parent.svg
121[npm-url]: https://www.npmjs.com/package/glob-parent
122[npm-image]: https://img.shields.io/npm/v/glob-parent.svg
123
124[azure-pipelines-url]: https://dev.azure.com/gulpjs/gulp/_build/latest?definitionId=2&branchName=master
125[azure-pipelines-image]: https://dev.azure.com/gulpjs/gulp/_apis/build/status/glob-parent?branchName=master
126
127[travis-url]: https://travis-ci.org/gulpjs/glob-parent
128[travis-image]: https://img.shields.io/travis/gulpjs/glob-parent.svg?label=travis-ci
129
130[appveyor-url]: https://ci.appveyor.com/project/gulpjs/glob-parent
131[appveyor-image]: https://img.shields.io/appveyor/ci/gulpjs/glob-parent.svg?label=appveyor
132
133[coveralls-url]: https://coveralls.io/r/gulpjs/glob-parent
134[coveralls-image]: https://img.shields.io/coveralls/gulpjs/glob-parent/master.svg
135
136[gitter-url]: https://gitter.im/gulpjs/gulp
137[gitter-image]: https://badges.gitter.im/gulpjs/gulp.svg
Note: See TracBrowser for help on using the repository browser.