Registry / devops / yarn-outdated-formatter

yarn-outdated-formatter

library4.0.0jsnpmunverified

A CLI tool that formats the JSON output from `yarn outdated --json` into human-readable or machine-parseable formats such as markdown, JSON, CSV, or Mackerel service metrics. v4.0.0 is the current stable release. Compared to manual parsing, it provides a structured, configurable output with support for excluding packages and linking changelog URLs. It also works with `npm outdated --json --long` with reduced functionality. Designed for CI/CD pipelines and dependency management automation.

devops

npm install yarn-outdated-formatter

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · YARN-OUTDATED-FORM

yarn-outdated-formatter

devopsjavascriptv4.0.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

formatYarnOutdated (CLI call)

✓ format-yarn-outdated --format markdown < yarn-outdated.json

✗ import { formatYarnOutdated } from 'yarn-outdated-formatter'

This is a CLI tool, not a library. Use via command line only.

N/A (direct usage)

✓ npx yarn-outdated-formatter ...

✗ require('yarn-outdated-formatter')

No programmatic API exported. Pipe yarn outdated --json to this command.

Pipe JSON from yarn outdated and format as markdown, or filter minor/patch upgrades using JSON output and jq.

yarn outdated --json | npx yarn-outdated-formatter --format markdown yarn outdated --json | npx yarn-outdated-formatter --format json | jq '.minor[],.patch[] | .[0]' | xargs -I{} yarn upgrade {}

Debug

Known issues

gotchaThis tool reads from stdin, not a file argument. You must pipe `yarn outdated --json` output.

fix

Use shell pipeline as shown in examples.

affects: >=1.0

gotchaThe CLI command is `format-yarn-outdated`, not `yarn-outdated-formatter`.

fix

Run `npx format-yarn-outdated` or add to scripts as `format-yarn-outdated`.

affects: >=1.0

gotchaSupports only `--long` flag with npm outdated. Without `--long`, dependencies/devDependencies are not distinguished.

fix

Use `npm outdated --json --long | format-yarn-outdated`.

affects: >=1.0

deprecatedDependency `node-fetch` is included but only used for custom changelog fetching; not used in core output.

fix

If not using custom changelogs, the fetch dependency is unnecessary bloat. Consider removing in future versions.

affects: >=4.0

gotchaThe `--excludes` and `--changelogs` options require YAML files, not inline content or JSON.

fix

Prepare .yml files with the required structure.

affects: >=1.0

Errors

Common errors & fixes

format-yarn-outdated: command not found

Installed package but using wrong command name or missing npm bin

fix

Use `npx format-yarn-outdated` or run `./node_modules/.bin/format-yarn-outdated`.

Unexpected token for JSON

Piped output is not valid JSON from yarn outdated --json

fix

Ensure you run `yarn outdated --json` and not `yarn outdated` without --json.

ENOENT: no such file or directory, open 'excludes.yml'

Provided relative path to --excludes file from wrong working directory

fix

Use absolute path or adjust cwd to where the excludes file is located.

Upgrade

Version history

4.0.0latest on npm

Audit

Dependencies

commanderrequiredCLI argument parsing

js-yamlrequiredparsing YAML exclude/changelog files

csv-stringifyrequiredCSV output formatting

markedrequiredMarkdown output rendering (actually used for markdown formatting)

node-fetchoptionalfetching changelog URLs (not used in core, possibly optional but listed as dependency)

Agent activity

8 hits · last 30 days

node

Amazon

Resources

githubhttps://github.com/masawada/yarn-outdated-formatter ↗

packageyarn-outdated-formatter ↗

homepagehttps://github.com/masawada/yarn-outdated-formatter#readme ↗