is-dotfile

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).

README

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.