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

dependencies-checker

v1.1.0

Published

JS dependencies checker

Downloads

208

Readme

:white_check_mark: Dependencies Checker

badge

Easily control the versions of dependencies your project accepts. Why?

  • :handshake: Consistency: Guarantees to use the exact same versions everywhere.
  • :bug: Avoid bugs: Make sure there are no duplicate entries in your dependencies.
  • :gear: Automation: Automatically rejects PRs when conditions are not met.

Usage

The lib only takes the path to the package.json as a param. It will default to the current directory when not provided.

GitHub actions

Create a file .github/workflows/dependencies-checker.yml with:

name: Check for dependencies without specific version

on: [ push ]

jobs:
  dependency_check_job:
    runs-on: ubuntu-latest
    name: Check for dependencies without specific version
    steps:
      - uses: actions/checkout@v3
      - uses: matheusjardimb/dependencies-checker@latest

Add the following to specify a custom package.json path:

      - uses: matheusjardimb/dependencies-checker@latest
        with:
          packageJsonPath: 'app/package.json'
          quite: true

Gitlab

Add the following block to your .gitlab-ci.yml file:

validate_dependencies:
  image: node:20.5.0
  script:
    - export INPUT_PACKAGEJSONPATH='package.json' # This line is optional
    - export INPUT_QUIET='true' # This line is optional
    - npx dependencies-checker@latest

NPX

Dependencies checker is also published into npm, so you can run with:

export INPUT_PACKAGEJSONPATH='package.json' # This line is optional
export INPUT_QUIET='true' # This line is optional
npx dependencies-checker@latest

Custom rules

Add a dependencies-checker block to your package.json file, if you need customize the default rules:

{
  "dependencies": {
    "react": "^18.2.0",
    "axios": "1.3.5 | 1.3.6",
    "react-native": "0.71.2"
  },
  "devDependencies": {
    "prettier": "^2.8.8"
  },
  // ...
  "dependencies-checker": {
    "blocks-to-check": [
      // Ignores "devDependencies"
      "dependencies"
    ],
    "ignored-dependencies": [
      // Ignores the '^' at "react"
      "react"
    ],
    // These version descriptors are not allowed by default:
    //     'latest', '^', '~', 'x', '*', '>', '<', '|', '-'
    "valid-descriptors": [
      // Allows the '|' at "axios"
      '|'
    ]
  }
}

License

See more about the MIT licensing at LICENSE.md. This project was originally created as a fork of github-developer/javascript-action.

Contributing

Pull requests are welcome! See CONTRIBUTING.md for more. Please consider activating pre-commit before committing (npm run pre-commit.install).