//renovate-config-npmxbyorbisk

renovate-config-npmx

1
0
1
1
TypeScript

renovate-config-npmx

Renovate preset that adds npmx.dev badges to dependency update PR bodies. Only applies to npm dependencies.

Usage

Add to your renovate.json:

{
  "extends": [
    "config:best-practices",
    "github>OrbisK/renovate-config-npmx#0.0.6"
  ]
}

This adds a single npmx column containing badges for downloads, license, types, size, vulnerabilities, and deprecated status.

The default prBodyColumns are: Package, Change, Age, Confidence, npmx.

Minimal preset

A lighter-weight alternative showing downloads, vulnerabilities, and deprecated as individual columns:

{
  "extends": [
    "config:best-practices",
    "github>OrbisK/renovate-config-npmx:minimal#0.0.6"
  ]
}

Individual presets

Each badge type is available as a standalone preset with its own column:

Preset Column Badge
github>OrbisK/renovate-config-npmx:version npmx version version
github>OrbisK/renovate-config-npmx:license npmx license license
github>OrbisK/renovate-config-npmx:size npmx size size
github>OrbisK/renovate-config-npmx:downloads npmx downloads downloads
github>OrbisK/renovate-config-npmx:downloads-day npmx downloads-day downloads-day
github>OrbisK/renovate-config-npmx:downloads-week npmx downloads-week downloads-week
github>OrbisK/renovate-config-npmx:downloads-month npmx downloads-month downloads-month
github>OrbisK/renovate-config-npmx:downloads-year npmx downloads-year downloads-year
github>OrbisK/renovate-config-npmx:vulnerabilities npmx vulnerabilities vulnerabilities
github>OrbisK/renovate-config-npmx:dependencies npmx dependencies dependencies
github>OrbisK/renovate-config-npmx:created npmx created created
github>OrbisK/renovate-config-npmx:updated npmx updated updated
github>OrbisK/renovate-config-npmx:engines npmx engines engines
github>OrbisK/renovate-config-npmx:types npmx types types
github>OrbisK/renovate-config-npmx:maintainers npmx maintainers maintainers
github>OrbisK/renovate-config-npmx:deprecated npmx deprecated deprecated
github>OrbisK/renovate-config-npmx:name npmx name name
github>OrbisK/renovate-config-npmx:likes npmx likes likes

Combining individual badge columns

To show multiple badge columns, use the columns preset and set prBodyColumns to include the columns you want:

{
  "extends": [
    "config:best-practices",
    "github>OrbisK/renovate-config-npmx:columns#0.0.6"
  ],
  "packageRules": [
    {
      "matchDatasources": ["npm"],
      "prBodyColumns": ["Package", "Change", "Age", "Confidence", "npmx downloads", "npmx types", "npmx vulnerabilities"]
    }
  ]
}

[!NOTE]
Individual presets (e.g. :downloads, :types) each set their own prBodyColumns. Since Renovate does not merge prBodyColumns across presets, extending multiple individual presets will only keep the columns from the last one. Use the :columns preset instead and list the columns explicitly.

Columns preset

The columns preset defines all badge column definitions without setting prBodyColumns. Use it when you want full control over which columns appear:

{
  "extends": [
    "config:best-practices",
    "github>OrbisK/renovate-config-npmx:columns#0.0.6"
  ],
  "packageRules": [
    {
      "matchDatasources": ["npm"],
      "prBodyColumns": ["Package", "Change", "npmx downloads", "npmx types"]
    }
  ]
}

Available column names: npmx (all badges combined), npmx version, npmx license, npmx size, npmx downloads, npmx downloads-day, npmx downloads-week, npmx downloads-month, npmx downloads-year, npmx vulnerabilities, npmx dependencies, npmx created, npmx updated, npmx engines, npmx types, npmx maintainers, npmx deprecated, npmx name, npmx likes.

Customizing prBodyColumns

Each preset sets prBodyColumns to include its badge column(s). Since prBodyColumns is not merged across presets — the last preset in the extends array wins — you may need to override it in your config if you combine this preset with others that also define prBodyColumns.

To override, define prBodyColumns directly in your renovate.json:

{
  "extends": [
    "config:best-practices",
    "github>OrbisK/renovate-config-npmx#0.0.6"
  ],
  "prBodyColumns": ["Package", "Type", "Update", "Change", "npmx"]
}

Usage with Merge Confidence

The default and minimal presets already include Age and Confidence in their prBodyColumns, so they work alongside Merge Confidence out of the box.

If you use mergeConfidence:all-badges (which adds Adoption and Passing columns), place this preset after the merge confidence preset so the npmx columns are included:

{
  "extends": [
    "config:best-practices",
    "mergeConfidence:all-badges",
    "github>OrbisK/renovate-config-npmx#0.0.6"
  ]
}

If you want all Merge Confidence columns (Adoption, Passing) alongside the npmx badges, override prBodyColumns explicitly:

{
  "extends": [
    "config:best-practices",
    "mergeConfidence:all-badges",
    "github>OrbisK/renovate-config-npmx#0.0.6"
  ],
  "prBodyColumns": ["Package", "Change", "Age", "Adoption", "Passing", "Confidence", "npmx"]
}

Badges by npmx.dev

Badge data is provided by npmx.dev. Each badge links to the package page on npmx.dev.

[beta]v0.20.0