Return true if the file is (or the file path has) a dotfile.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
benchmark benchmarks Jan 24, 2015
.editorconfig run update May 30, 2017
.eslintrc.json run update May 30, 2017
.gitattributes first commit Jan 22, 2015
.gitignore run update May 30, 2017
.travis.yml
.verb.md update .verb.md, run verb to generate readme May 30, 2017
LICENSE
README.md update .verb.md, run verb to generate readme May 30, 2017
index.js use dotfile-regex May 30, 2017
package.json 2.0.0 May 30, 2017
test.js run update May 30, 2017

README.md

is-dotfile NPM version NPM monthly downloads NPM total downloads Linux Build Status

Return true if a file path is (or has) a dotfile. Returns false if the path is a dot directory.

Install

Install with npm:

$ 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, like .git/ and .github/.

var isDotfile = require('is-dotfile');

false

All of the following return false:

isDotfile('a/b/c.js');
isDotfile('/.git/foo');
isDotfile('a/b/c/.git/foo');
//=> false

true

All of the following return true:

isDotfile('a/b/.gitignore');
isDotfile('.gitignore');
isDotfile('/.gitignore');
//=> true

About

Related projects

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Contributors

Commits Contributor
13 jonschlinkert
1 Lykathia

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ 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:

$ npm install && npm test

Author

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.


This file was generated by verb-generate-readme, v0.6.0, on May 30, 2017.