https://github.com/emsk/bundle-outdated-formatter
Formatter for `bundle outdated` command
https://github.com/emsk/bundle-outdated-formatter
bundler cli formatter javascript nodejs
Last synced: about 1 month ago
JSON representation
Formatter for `bundle outdated` command
- Host: GitHub
- URL: https://github.com/emsk/bundle-outdated-formatter
- Owner: emsk
- License: mit
- Created: 2018-05-13T13:04:38.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2022-12-03T17:41:04.000Z (over 3 years ago)
- Last Synced: 2025-02-28T21:58:34.672Z (over 1 year ago)
- Topics: bundler, cli, formatter, javascript, nodejs
- Language: TypeScript
- Size: 376 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# bundle-outdated-formatter
[](https://npmjs.org/package/bundle-outdated-formatter)
[](https://circleci.com/gh/emsk/bundle-outdated-formatter/tree/main)
[](https://ci.appveyor.com/project/emsk/bundle-outdated-formatter-lsmuc/branch/main)
[](https://codecov.io/gh/emsk/bundle-outdated-formatter)
[](https://npmjs.org/package/bundle-outdated-formatter)
[](https://github.com/emsk/bundle-outdated-formatter/blob/main/package.json)
bundle-outdated-formatter is a command-line tool to format output of `bundle outdated`.
## Installation
```sh
$ npm install --global bundle-outdated-formatter
```
## Usage
```sh
$ bundle outdated | bundle-outdated-formatter
```
## Command Options
| Option | Alias | Description | Default |
| :----- | :---- | :---------- | :------ |
| `--format` | `-f` | Format. `terminal`, `markdown`, `json`, `yaml`, `csv`, `tsv`, `xml`, or `html`. | `terminal` |
| `--pretty` | `-p` | `true` if pretty output.
This option is available in `json`, `xml`, or `html` formats. | `false` |
| `--style` | `-s` | Terminal table style. `unicode` or `ascii`.
This option is available in `terminal` format. | `unicode` |
## Examples
Output of `bundle outdated`:
```
Fetching gem metadata from https://rubygems.org/..........
Fetching version metadata from https://rubygems.org/...
Fetching dependency metadata from https://rubygems.org/..
Resolving dependencies...
Outdated gems included in the bundle:
* faker (newest 1.6.6, installed 1.6.5, requested ~> 1.4) in groups "development, test"
* hashie (newest 3.4.6, installed 1.2.0, requested = 1.2.0) in groups "default"
* headless (newest 2.3.1, installed 2.2.3)
```
### Convert to Terminal
Unicode style:
```
┌──────────┬────────┬───────────┬───────────┬───────────────────┐
│ gem │ newest │ installed │ requested │ groups │
├──────────┼────────┼───────────┼───────────┼───────────────────┤
│ faker │ 1.6.6 │ 1.6.5 │ ~> 1.4 │ development, test │
│ hashie │ 3.4.6 │ 1.2.0 │ = 1.2.0 │ default │
│ headless │ 2.3.1 │ 2.2.3 │ │ │
└──────────┴────────┴───────────┴───────────┴───────────────────┘
```
ASCII style:
```
+----------+--------+-----------+-----------+-------------------+
| gem | newest | installed | requested | groups |
+----------+--------+-----------+-----------+-------------------+
| faker | 1.6.6 | 1.6.5 | ~> 1.4 | development, test |
| hashie | 3.4.6 | 1.2.0 | = 1.2.0 | default |
| headless | 2.3.1 | 2.2.3 | | |
+----------+--------+-----------+-----------+-------------------+
```
### Convert to Markdown
```
| gem | newest | installed | requested | groups |
| --- | --- | --- | --- | --- |
| faker | 1.6.6 | 1.6.5 | ~> 1.4 | development, test |
| hashie | 3.4.6 | 1.2.0 | = 1.2.0 | default |
| headless | 2.3.1 | 2.2.3 | | |
```
### Convert to JSON
Normal output:
```
[{"gem":"faker","newest":"1.6.6","installed":"1.6.5","requested":"~> 1.4","groups":"development, test"},{"gem":"hashie","newest":"3.4.6","installed":"1.2.0","requested":"= 1.2.0","groups":"default"},{"gem":"headless","newest":"2.3.1","installed":"2.2.3","requested":"","groups":""}]
```
Pretty output:
```
[
{
"gem": "faker",
"newest": "1.6.6",
"installed": "1.6.5",
"requested": "~> 1.4",
"groups": "development, test"
},
{
"gem": "hashie",
"newest": "3.4.6",
"installed": "1.2.0",
"requested": "= 1.2.0",
"groups": "default"
},
{
"gem": "headless",
"newest": "2.3.1",
"installed": "2.2.3",
"requested": "",
"groups": ""
}
]
```
### Convert to YAML
```
---
- gem: faker
newest: 1.6.6
installed: 1.6.5
requested: ~> 1.4
groups: 'development, test'
- gem: hashie
newest: 3.4.6
installed: 1.2.0
requested: = 1.2.0
groups: default
- gem: headless
newest: 2.3.1
installed: 2.2.3
requested: ''
groups: ''
```
### Convert to CSV
```
"gem","newest","installed","requested","groups"
"faker","1.6.6","1.6.5","~> 1.4","development, test"
"hashie","3.4.6","1.2.0","= 1.2.0","default"
"headless","2.3.1","2.2.3","",""
```
### Convert to TSV
```
"gem" "newest" "installed" "requested" "groups"
"faker" "1.6.6" "1.6.5" "~> 1.4" "development, test"
"hashie" "3.4.6" "1.2.0" "= 1.2.0" "default"
"headless" "2.3.1" "2.2.3" "" ""
```
### Convert to XML
Normal output:
```
faker1.6.61.6.5~> 1.4development, testhashie3.4.61.2.0= 1.2.0defaultheadless2.3.12.2.3
```
Pretty output:
```
faker
1.6.6
1.6.5
~> 1.4
development, test
hashie
3.4.6
1.2.0
= 1.2.0
default
headless
2.3.1
2.2.3
```
### Convert to HTML
Normal output:
```
gemnewestinstalledrequestedgroupsfaker1.6.61.6.5~> 1.4development, testhashie3.4.61.2.0= 1.2.0defaultheadless2.3.12.2.3
```
Pretty output:
```
gem
newest
installed
requested
groups
faker
1.6.6
1.6.5
~> 1.4
development, test
hashie
3.4.6
1.2.0
= 1.2.0
default
headless
2.3.1
2.2.3
```
## Related
* [bundle_outdated_formatter](https://github.com/emsk/bundle_outdated_formatter) - A Ruby implementation of the bundle-outdated-formatter
## License
[MIT](LICENSE)