What is is-dotfile?
The is-dotfile npm package is a utility that helps determine if a given filename is a dotfile. Dotfiles are typically hidden files in Unix-like operating systems, often used for configuration purposes.
What are is-dotfile's main functionalities?
Check if a filename is a dotfile
This feature allows you to check if a given filename is a dotfile. A dotfile is a file whose name begins with a dot ('.'). The code sample demonstrates checking two filenames: '.gitignore' (which is a dotfile) and 'index.js' (which is not).
const isDotfile = require('is-dotfile');
console.log(isDotfile('.gitignore')); // true
console.log(isDotfile('index.js')); // false
Other packages similar to is-dotfile
dotfile-regex
The dotfile-regex package provides a regular expression for matching dotfiles. It is similar to is-dotfile in that it helps identify dotfiles, but it does so by providing a regex pattern that you can use in your own code.
is-hidden
The is-hidden package determines if a file or directory is hidden. While is-dotfile specifically checks for dotfiles, is-hidden can check for any hidden file or directory, including those that are hidden by other means (e.g., starting with a dot or having a hidden attribute).
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 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');
true
All of the following return true
:
isDotfile('a/b/.gitignore');
isDotfile('.gitignore');
isDotfile('/.gitignore');
About
Related projects
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Contributors
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
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.