is-dotdir

is-dotdir

Returns true if a path is a dot-directory.

Install

Install with npm:

$ npm install --save is-dotdir

Usage

To be considered a dot directory:

• the path must contain a dot that is at the beginning of the string or following a slash
• the next character after the dot must not be another dot
• one or more non-slash characters must follow the dot
• a slash must follow after at least one non-dot, non-slash character

To check for dot files, use is-dotfile instead.

var isDotdir = require('is-dotdir');

isDotdir('a/b/c/.gitignore');
//=> false

isDotdir('a/.git/a/b/');
//=> true

About

Related projects

• dotdir-regex: Regex for matching dot-directories, like .git/ | homepage
• dotfile-regex: Regular expresson for matching dotfiles. | homepage
• is-dotfile: Return true if a file path is (or has) a dotfile. Returns false if the… more | homepage

Contributing

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

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

• github/jonschlinkert
• twitter/jonschlinkert

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.