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

npm-lint

v0.3.4

Published

A configurable package.json linter with a focus on security

Downloads

40

Readme

npm-linter

A opinionated, but configurable linter for npm & node package.json files with a focus on security.

Github | Issues | NPM

Install

npm i -g npm-lint

npm-lint is build using Typescript on top of node 8 as it uses async/await - however the distribution is compiled and confirmed to work with node >= 6.5.0.

Please note the APIs and commands are likely to change quite a bit

What is npm-lint?

A tool that reads a .npmlint.json file in a directory and from this can parse a package.json file and enforce these rules.

It's designed to enforce rules across many repositories within your organisation. By putting a .npmlint.json file in your root directory and running npm-lint the tool will check the file to ensure it meets your configuration.

The focus is on security and being able to lock down where dependencies are resolved from, and where packages are published too and being able to implement this in pre-commit/pre-push hooks or CI environments

The currently implemented options are:

properties

An array of properties a package must include.

The name and version are hard coded these are always required, so do not need to be added to your list If your package.json does not have these fields then it will cause a failure on exit

Example

{
    "properties": {
    "private": true,
    "required": ["description", "main", "author", "license"]
  }

}

scripts

An object of properties that will handle checking the scripts property in your package.json

scripts.allow

An array of names of executables allowed to be in scripts. If a script it found to be using an application not in this list it will cause a failure on exit

Example

{
   "scripts": {
        "allow": ["node", "npm", "git"]
    }
}

dependencies

An object of properties that will handle checking the dependencies and devDependencies in your package.json

dependencies.checkLatest

A boolean value to determine if a scan of all dependencies should be done and to advise of the latest version

dependencies.sources

An array of strings that are whitelisted to be in dependencies as non-npm sources. For example if you point to a git dependency, or a private repository then these should be included. You can reference the entire source or a domain. By default this will accept any valid semver as a valid NPM source. If you use non-semver values such as release tags you also need to include them in this file

Example

{
  "dependencies": {
       "sources": [
           "release",
           "https://github.com",
           "https://git.myrepo.com/myrepo.git"
       ]
   }
}