Sha256: 3fb7c3dc5c32cc2e91e9fb26856f36181136d297a5d45115fc16c1165ea9da26
Contents?: true
Size: 1.02 KB
Versions: 10
Compression:
Stored size: 1.02 KB
Contents
# is-dotfile [](http://badge.fury.io/js/is-dotfile)
> Return true if a file path is (or has) a dotfile.
## Install with [npm](npmjs.org)
```bash
npm i is-dotfile --save
```
## Usage
```js
var isDotfile = require('is-dotfile');
isDotfile('a/b/c.js');
//=> false
isDotfile('a/b/.gitignore');
//=> true
isDotfile('.gitignore');
//=> true
isDotfile('/.gitignore');
//=> true
isDotfile('/.gitignore/foo');
//=> false
```
## Run tests
Install dev dependencies:
```bash
npm i -d && npm test
```
## Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/regexps/is-dotfile/issues)
## Author
**Jon Schlinkert**
+ [github/jonschlinkert](https://github.com/jonschlinkert)
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
## License
Copyright (c) 2015 Jon Schlinkert
Released under the MIT license
***
_This file was generated by [verb](https://github.com/assemble/verb) on January 23, 2015._
Version data entries
10 entries across 10 versions & 1 rubygems