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

$ 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

Related projects

• dotfile-regex: Regular expresson for matching dotfiles. | homepage
• has-glob: Returns true if an array has a glob pattern. | homepage
• is-dotdir: Returns true if a path is a dot-directory. | homepage
• is-glob: Returns true if the given string looks like a glob pattern or an extglob pattern.… more | homepage

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

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2015 Jon Schlinkert Released under the MIT license.

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