Return true if a file path is (or has) a dotfile. Returns false if the path is a dot directory.
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.
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')); // falseThe 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.
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).
Return true if a file path is (or has) a dotfile. Returns false if the path is a dot directory.
Install with npm:
$ npm install --save is-dotfile
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
.git/ | homepagetrue if the given string looks like a glob pattern or an extglob pattern… more | homepagePull requests and stars are always welcome. For bugs and feature requests, please create an issue.
| Commits | Contributor |
|---|---|
| 13 | jonschlinkert |
| 1 | Lykathia |
(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 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
Jon Schlinkert
Copyright © 2017, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on May 30, 2017.
FAQs
Return true if a file path is (or has) a dotfile. Returns false if the path is a dot directory.
The npm package is-dotfile receives a total of 1,590,467 weekly downloads. As such, is-dotfile popularity was classified as popular.
We found that is-dotfile demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.