npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2021 – Pkg Stats / Ryan Hefner

gitignore-fs

v2.1.0

Published

determine if any file is gitignored (complete implementation of gitignore rules)

Downloads

17

Readme

gitignore-fs

CircleCI Coverage Status semantic-release Commitizen friendly npm version

Determine if any file is gitignored. This is intended to be a complete implementation of the gitignore spec, including $GIT_DIR, $GIT_DIR/info/excludes, and the core.excludesFile configuration variable.

Requires Node >= 8.

Getting started

npm install --save gitignore-fs
const Gitignore = require('gitignore-fs')

const gitignore = new Gitignore()

console.log(gitignore.ignores('node_modules')) // true or false depending on your config

API

class Gitignore

Each instance of this class keeps a separate cache of gitignore rules.

new Gitignore([options])

Creates a new Gitignore instance.

options.initialRules (string[], optional)

These rules will be applied at lowest precedence (lower than rules from core.excludesFile). Paths with a slash in the beginning or middle are relative to the closest enclosing git directory.

options.finalRules (string[], optional)

These rules will be applied at highest precedence (higher than .gitignore files). Paths with a slash in the beginning or middle are relative to the closest enclosing git directory.

.ignores(path)

Determines if the given path is gitignored asynchronously.

path (string, required)

The path to test. Must end with / if it is a directory!

Returns (Promise<boolean>)

A promise that will resolve to true if path is gitignored, false otherwise

.ignoresSync(path)

Determines if the given path is gitignored synchronously.

path (string, required)

The path to test. Must end with / if it is a directory!

Returns (boolean)

true if path is gitignored, false otherwise

.clearCache()

Clears the entire gitignore rule cache.