is-dotfile
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/is-dotfile package

2.0.0 • Public • Published

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.

Package Sidebar

Install

npm i is-dotfile

Weekly Downloads

1,824,966

Version

2.0.0

License

MIT

Last publish

Collaborators

  • doowb
  • jonschlinkert