UNPKG

nyc/node_modules/is-dotfile/README.md

Version:

1.98 kBMarkdownView Raw

1# is-dotfile [![NPM version](https://badge.fury.io/js/is-dotfile.svg)](http://badge.fury.io/js/is-dotfile)
2
3> Return true if a file path is (or has) a dotfile. Returns false if the path is a dot directory.
4
5## Install
6
7Install with [npm](https://www.npmjs.com/)
8
9```sh
10$ npm i is-dotfile --save
11```
12
13## Usage
14
15```js
16var isDotfile = require('is-dotfile');
17```
18
19**false**
20
21All of the following return `false`:
22
23```js
24isDotfile('a/b/c.js');
25isDotfile('/.git/foo');
26isDotfile('a/b/c/.git/foo');
27//=> false
28```
29
30**true**
31
32All of the following return `true`:
33
34```js
35isDotfile('a/b/.gitignore');
36isDotfile('.gitignore');
37isDotfile('/.gitignore');
38//=> true
39```
40
41## Related projects
42
43* [dotfile-regex](https://www.npmjs.com/package/dotfile-regex): Regular expresson for matching dotfiles. | [homepage](https://github.com/regexps/dotfile-regex)
44* [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)
45* [is-dotdir](https://www.npmjs.com/package/is-dotdir): Returns true if a path is a dot-directory. | [homepage](https://github.com/jonschlinkert/is-dotdir)
46* [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://www.npmjs.com/package/is-glob) | [homepage](https://github.com/jonschlinkert/is-glob)
47
48## Running tests
49
50Install dev dependencies:
51
52```sh
53$ npm i -d && npm test
54```
55
56## Contributing
57
58Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/is-dotfile/issues/new).
59
60## Authors
61
62**Jon Schlinkert**
63
64+ [github/jonschlinkert](https://github.com/jonschlinkert)
65+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
66
67## License
68
69Copyright © 2015 Jon Schlinkert
70Released under the MIT license.
71
72***
73
74_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on October 20, 2015._
\No newline at end of file

1	`# is-dotfile [![NPM version](https://badge.fury.io/js/is-dotfile.svg)](http://badge.fury.io/js/is-dotfile)`
2
3	`> Return true if a file path is (or has) a dotfile. Returns false if the path is a dot directory.`
4
5	`## Install`
6
7	`Install with [npm](https://www.npmjs.com/)`
8
9	```sh
10	`$ npm i is-dotfile --save`
11	```
12
13	`## Usage`
14
15	```js
16	`var isDotfile = require('is-dotfile');`
17	```
18
19	`false`
20
21	All of the following return `false`:
22
23	```js
24	`isDotfile('a/b/c.js');`
25	`isDotfile('/.git/foo');`
26	`isDotfile('a/b/c/.git/foo');`
27	`//=> false`
28	```
29
30	`true`
31
32	All of the following return `true`:
33
34	```js
35	`isDotfile('a/b/.gitignore');`
36	`isDotfile('.gitignore');`
37	`isDotfile('/.gitignore');`
38	`//=> true`
39	```
40
41	`## Related projects`
42
43	`* [dotfile-regex](https://www.npmjs.com/package/dotfile-regex): Regular expresson for matching dotfiles. \| [homepage](https://github.com/regexps/dotfile-regex)`
44	* [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)
45	`* [is-dotdir](https://www.npmjs.com/package/is-dotdir): Returns true if a path is a dot-directory. \| [homepage](https://github.com/jonschlinkert/is-dotdir)`
46	* [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://www.npmjs.com/package/is-glob) \| [homepage](https://github.com/jonschlinkert/is-glob)
47
48	`## Running tests`
49
50	`Install dev dependencies:`
51
52	```sh
53	`$ npm i -d && npm test`
54	```
55
56	`## Contributing`
57
58	`Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/is-dotfile/issues/new).`
59
60	`## Authors`
61
62	`Jon Schlinkert`
63
64	`+ [github/jonschlinkert](https://github.com/jonschlinkert)`
65	`+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)`
66
67	`## License`
68
69	`Copyright © 2015 Jon Schlinkert`
70	`Released under the MIT license.`
71
72	`***`
73
74	`_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on October 20, 2015._`
\	No newline at end of file