is-dotfile NPM version

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 i is-dotfile --save

Usage

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

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

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

Authors

Jon Schlinkert

License

Copyright © 2015 Jon Schlinkert Released under the MIT license.


This file was generated by verb-cli on October 20, 2015.