<commit_before>yarn-outdated-formatter
=======================

[![Build Status](http://img.shields.io/travis/masawada/yarn-outdated-formatter.svg?style=flat-square)](https://travis-ci.org/masawada/yarn-outdated-formatter)
[![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

```
$ yarn add -D yarn-outdated-formatter
$ yarn outdated --json | $(yarn bin)/format-yarn-outdated
```

## Options

| name | description | example |
|---|---|---|
| format | output format [markdown&#124;json&#124;mackerel] \(default: markdown) | --format json |
| excludes | exclude packages (YAML) | --excludes ./excludes.yml |
| changelogs | changelog urls (YAML) | --changelogs ./changelogs.yml |

## License

MIT License<commit_msg>rewrite usage<commit_after>yarn-outdated-formatter
=======================

[![Build Status](http://img.shields.io/travis/masawada/yarn-outdated-formatter.svg?style=flat-square)](https://travis-ci.org/masawada/yarn-outdated-formatter)
[![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 formater

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 or mackerel 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
```

## License

MIT License
{'fraction_non_alphanumeric': 0.18498105408198415, 'fraction_numerical': 0.002411298656562177, 'mean_word_length': 4.270417422867514, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 14, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '274763', 'n_tokens_mistral': 1060, 'n_tokens_neox': 976, 'n_words': 173}