https://github.com/masawada/yarn-outdated-formatter

yarn outdated --json formatter
https://github.com/masawada/yarn-outdated-formatter

yarn

Last synced: 17 days ago
JSON representation

yarn outdated --json formatter

• Host: GitHub
• URL: https://github.com/masawada/yarn-outdated-formatter
• Owner: masawada
• License: mit
• Created: 2017-05-21T16:16:40.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2023-01-06T01:56:22.000Z (about 2 years ago)
• Last Synced: 2024-10-29T22:32:35.051Z (2 months ago)
• Topics: yarn
• Language: JavaScript
• Homepage:
• Size: 463 KB
• Stars: 31
• Watchers: 5
• Forks: 12
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
yarn-outdated-formatter

=======================

[![Build Status](https://img.shields.io/github/workflow/status/masawada/yarn-outdated-formatter/test/master?style=flat-square)](https://github.com/masawada/yarn-outdated-formatter/actions?query=workflow%3Atest+branch%3Amaster)

[![Coverage Status](https://img.shields.io/coveralls/masawada/yarn-outdated-formatter.svg?style=flat-square)](https://coveralls.io/github/masawada/yarn-outdated-formatter?branch=master)

[![NPM Version](https://img.shields.io/npm/v/yarn-outdated-formatter.svg?style=flat-square)](https://www.npmjs.com/package/yarn-outdated-formatter)

[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](https://masawada.mit-license.org/)

## Usage

`format-yarn-outdated --help` shows the help:

```

NAME

  format-yarn-outdated - yarn outdated --json formatter

SYNOPSIS

  format-yarn-outdated [-h help] [-v version] [-f format]

                       [-e excludes] [-c changelogs]

OPTIONS

  --help, -h       Prints the help.

  --version, -v    Prints the package version.

  --format, -f     Output format. One of either markdown, json, mackerel or csv can be used. Default: markdown

  --excludes, -e   Path to YAML file which specify package names to exclude

  --changelogs, -c Path to YAML file which specify changelog uris for the packages

EXAMPLES

  $ yarn outdated --json | $(yarn bin)/format-yarn-outdated

  $ yarn outdated --json | $(yarn bin)/format-yarn-outdated --excludes /path/to/excludes.yml --changelogs /path/to/changelogs.yml

  $ yarn outdated --json | $(yarn bin)/format-yarn-outdated --format json | jq '.minor[],.patch[] | .[0]' | xargs -I{} yarn upgrade {}

  $ yarn outdated --json | $(yarn bin)/format-yarn-outdated --format mackerel | mkr throw --service ServiceMetricName

NPM SUPPORT

  To detecting dependencies or devDependencies, --long option is required.

  $ npm outdated --json --long | $(npm bin)/format-yarn-outdated

  URL will not shown.

  CHANGELOG URL will not shown unless you set --changelogs option.

```

## Examples

- Markdown: [examples/formatted.md](examples/formatted.md)

- JSON: [examples/formatted.json](examples/formatted.json)

- Mackerel: [examples/formatted.mackerel](examples/formatted.mackerel)

- CSV: [examples/formatted.csv](examples/formatted.csv)

## License

MIT License