diff options
Diffstat (limited to 'node_modules/is-dotfile/README.md')
| -rw-r--r-- | node_modules/is-dotfile/README.md | 95 |
1 files changed, 0 insertions, 95 deletions
diff --git a/node_modules/is-dotfile/README.md b/node_modules/is-dotfile/README.md deleted file mode 100644 index d69912bb1..000000000 --- a/node_modules/is-dotfile/README.md +++ /dev/null @@ -1,95 +0,0 @@ -# is-dotfile [](https://www.npmjs.com/package/is-dotfile) [](https://npmjs.org/package/is-dotfile) [](https://npmjs.org/package/is-dotfile) [](https://travis-ci.org/jonschlinkert/is-dotfile) - -> Return true if a file path is (or has) a dotfile. Returns false if the path is a dot directory. - -## Install - -Install with [npm](https://www.npmjs.com/): - -```sh -$ npm install --save is-dotfile -``` - -## Usage - -To be considered a dotfile, it must be the last filename in the path, like `.gitignore`. Otherwise it's a [dot directory](https://github.com/jonschlinkert/is-dotdir), like `.git/` and `.github/`. - -```js -var isDotfile = require('is-dotfile'); -``` - -**false** - -All of the following return `false`: - -```js -isDotfile('a/b/c.js'); -isDotfile('/.git/foo'); -isDotfile('a/b/c/.git/foo'); -//=> false -``` - -**true** - -All of the following return `true`: - -```js -isDotfile('a/b/.gitignore'); -isDotfile('.gitignore'); -isDotfile('/.gitignore'); -//=> true -``` - -## About - -### Related projects - -* [dotdir-regex](https://www.npmjs.com/package/dotdir-regex): Regex for matching dot-directories, like `.git/` | [homepage](https://github.com/regexps/dotdir-regex "Regex for matching dot-directories, like `.git/`") -* [dotfile-regex](https://www.npmjs.com/package/dotfile-regex): Regular expresson for matching dotfiles. | [homepage](https://github.com/regexps/dotfile-regex "Regular expresson for matching dotfiles.") -* [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 "Returns true if a path is a dot-directory.") -* [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") - -### Contributing - -Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). - -### Contributors - -| **Commits** | **Contributor** | -| --- | --- | -| 13 | [jonschlinkert](https://github.com/jonschlinkert) | -| 1 | [Lykathia](https://github.com/Lykathia) | - -### Building docs - -_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_ - -To generate the readme, run the following command: - -```sh -$ npm install -g verbose/verb#dev verb-generate-readme && verb -``` - -### Running tests - -Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command: - -```sh -$ npm install && npm test -``` - -### Author - -**Jon Schlinkert** - -* [github/jonschlinkert](https://github.com/jonschlinkert) -* [twitter/jonschlinkert](https://twitter.com/jonschlinkert) - -### License - -Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert). -Released under the [MIT License](LICENSE). - -*** - -_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on May 30, 2017._
\ No newline at end of file |