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 🙏

© 2024 – Pkg Stats / Ryan Hefner

ensure-gitignore

v1.2.0

Published

Ensure the presence of patterns within a project's gitignore

Downloads

24,111

Readme

ensure-gitignore

Ensure the presence of patterns within a project's gitignore.

Usage

const ensureGitignore = require('ensure-gitignore');

await ensureGitignore({
  patterns: ['node_modules', 'output']
});

Options

filepath (string, default: '/.gitignore')

Path to the .gitignore file to be used.

patterns (?Array<string>)

An array of patterns to ensure are present in the specified .gitignore file. Any pattern that already exists in the file will be appended with the comment. All new patterns will be appended to the bottom of the file.

comment (?string, default: 'managed by ensure-gitignore')

Allows you to document the list of patterns that are being controlled programmatically. This helps provide context as to what is controlling certain patterns within a .gitignore file. Anything inside the comment block will be re-written on each run, including the removal of old patterns that are no longer managed.

const ensureGitignore = require('ensure-gitignore');

await ensureGitignore({
  patterns: ['node_modules', 'output'],
  comment: 'managed by build script'
});

// =>
// # managed by build script
// node_modules
// output
// # end managed by build script
//

dryRun (?boolean, default: false)

The file at the input path will not be updated, instead the intended output will be returned.

const ensureGitignore = require('ensure-gitignore');

const result = await ensureGitignore({
  patterns: ['node_modules', 'output'],
  dryRun: true
});

// result:
// node_modules
// output
//

License

MIT.