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

@dotcom-tool-kit/lint-staged

v5.1.1

Published

A plugin to run the [lint-staged](https://github.com/okonet/lint-staged) tool to run linters on files staged via git.

Downloads

2,143

Readme

@dotcom-tool-kit/lint-staged

A plugin to run the lint-staged tool to run linters on files staged via git.

Installation

With Tool Kit already set up, install this plugin as a dev dependency:

npm install --save-dev @dotcom-tool-kit/lint-staged

And add it to your repo's .toolkitrc.yml:

plugins:
    - '@dotcom-tool-kit/lint-staged'

How LintStaged interacts with other hooks

The LintStaged is quite special as it's a task that will run other Tool Kit hooks. That means you can have a hook that will run this task that will in turn run other hooks that will run further tasks! The indirection can be hard to get your head around. Typically, you'll want to set up LintStaged to run on a Tool Kit hook hooked to a git hook via another plugin like husky-npm (LintStaged by default runs on the git:precommit hook). Then it will call the lint-staged executable that will read your lint-staged configuration to see what further programs need to be run: these programs should be other Tool Kit hooks that can be configured using a plugin like lint-staged-npm.

An example package.json config set up with lint-staged and Tool Kit could have these fields:

{
  "husky": {
    "hooks": {
      "pre-commit": "dotcom-tool-kit git:precommit"
    }
  },
  "lint-staged": {
    "**/*.js": "dotcom-tool-kit format:staged test:staged --"
  }
}

This will run the git:precommit hook when making a git commit, and the LintStaged task in git:precommit will run the lint-staged binary, which will pass all the staged JavaScript files to a Tool Kit invocation that will call the format:staged and test:staged hooks (see the lint-staged-npm README for further information on what we do with the passed files). This control flow is illustrated in the following diagram:

flowchart
    A[git commit] --> B[husky pre-commit hook] --> h1
    subgraph h1[git:precommit hook]
    C[dotcom-tool-kit git:precommit] --> D[LintStaged]
    end
    D --> E[lint-staged] --> h2
    subgraph h2[format:staged hook]
    F[dotcom-tool-kit format:staged -- index.js] --> G[Prettier]
    end
    G --> H[prettier index.js]

Tasks

LintStaged

Run lint-staged in your repo, for use with git hooks.