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

@trussle/qc

v1.0.5

Published

Quality control tool for Trussle

Downloads

47

Readme

Trussle QC

QC is a tool that performs quality control checks on a Javascript repository. It makes sure that:

If any of these checks don't pass, QC won't let you push your changes. Mean, I know - but it's the only way you'll learn.

Installation

QC should be installed as a dependency in your project:

npm install --save-dev @trussle/qc

If you're using mocha, you'll need to change from using mocha to using _mocha; this avoids forking the process, which causes some issues with code coverage.

Usage

On installation, QC will do a few things:

  • If there is no .eslintrc.js file, one is added to the root of the project.
  • If there is no .istanbul.yml file, one is added to the root of your project.
  • It will set up a Git pre-push hook that runs itself when pushing code, to make sure you're behaving 😘

If you want to run QC yourself, just run ./node_modules/.bin/qc or set up the following script in your package.json:

{
    "scripts": {
        "qc": "qc"
    }
}

Assumptions

Please read this section very carefully: if any of these assumptions are not true about your project, QC will fail.

QC assumes the following about your package:

  • There is a test script in your package.json which points to an executable in the ./node_modules/.bin directory (not global; usually _mocha).