Examples

Basic usage

After you have installed DepsHub you can run it with the depshub lint . command:

> depshub lint .

Scanning 2 manifest files.
  - /Users/semanser/Programming/cli/docs/package.json
  - /Users/semanser/Programming/cli/go.mod
Found 1 error:

 - [allowed-licenses] - The license of the package is not allowed.
╭───────────────────────────────────────╮
│ /Users/semanser/Programming/cli/go.mod│
│                                       │
│ 13 | golang.org/x/mod v0.22.0         │
╰───────────────────────────────────────╯

This will run DepsHub on the current directory and all its subdirectories. It respects the .gitignore file and will not lint files that are ignored by Git.

Ignoring files

To further configure DepsHub, you can create a configuration file. This file should be named depshub.yml. DepsHub automatically reads this file when it is present in the current directory.

Now, let’s say you want to ignore some specific directory. You can do this by adding the following to your depshub.yml file:

version: 1
ignore:
  - "**/testdata/**"

Configuring specific rules

If you want to configure a specific rule for a specific manifest file, you can do this by adding the following to your depshub.yml file:

version: 1
ignore:
  - "**/testdata/**"
manifest_files:
  - filter: "**" # This rule applies to all manifest files
    rules:
      - name: "allowed-licenses"
        value: ["", "MIT", "Apache-2.0", "BSD-3-Clause"]
  - filter: "**/docs/package.json"
    packages: ["@astrojs/check", "@astrojs/starlight", "sharp"]
    rules:
      - name: "no-unstable"
        disabled: true

See all the available configuration options in the configuration reference.