Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mskelton/yarn-plugin-outdated
Yarn plugin to show outdated dependencies.
https://github.com/mskelton/yarn-plugin-outdated
plugin yarn yarn-outdated yarn-plugin yarn2
Last synced: 6 days ago
JSON representation
Yarn plugin to show outdated dependencies.
- Host: GitHub
- URL: https://github.com/mskelton/yarn-plugin-outdated
- Owner: mskelton
- License: isc
- Created: 2020-12-08T05:34:09.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-26T14:01:11.000Z (26 days ago)
- Last Synced: 2025-01-09T00:23:20.477Z (13 days ago)
- Topics: plugin, yarn, yarn-outdated, yarn-plugin, yarn2
- Language: TypeScript
- Homepage:
- Size: 104 MB
- Stars: 128
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-list - yarn-plugin-outdated
README
# Yarn Plugin Outdated
Yarn plugin to show outdated dependencies.
## Installation
### Yarn 4
```bash
yarn plugin import https://go.mskelton.dev/yarn-outdated/v4
```
### Yarn 3
```bash
yarn plugin import https://go.mskelton.dev/yarn-outdated/v3
```
### Yarn 2
```bash
yarn plugin import https://go.mskelton.dev/yarn-outdated/v1.2.0
```
## Usage
When run without arguments, this plugin will find outdated plugins in all
workspaces of your project.
```bash
yarn outdated
```
### Filter by dependency
You can easily filter dependencies using any valid
[micromatch](https://github.com/micromatch/micromatch) glob pattern. This is
especially useful when you want to check a set of related dependencies such as a
component library or tools such as Babel or ESLint.
```bash
yarn outdated '@babel/*'
```
And, in case you were wondering, you can add multiple glob patterns!
```bash
yarn outdated '@babel/*' '@types/*'
```
### Filter by workspace (`--workspace`, `-w`)
In addition to filtering dependencies, larger projects will find it very helpful
to filter workspaces so only outdated dependencies in a set of workspaces will
be included.
The simplest way to filter a workspace is by it's name. And just like dependency
filtering, this flag supports glob patterns!
```bash
yarn outdated --workspace frontend
```
You can also filter workspaces by directory using either an absolute or relative
path.
```bash
yarn outdated --workspace packages/a
yarn outdated --workspace /Users/mark/project/packages/a
```
The `--workspace` flag can be added multiple times to specify multiple glob
patterns to match with. You can even mix and match directories and workspace
names!
```bash
yarn outdated --workspace packages/a --workspace frontend
```
_Tip: Specifying `--workspace .` will use the current working directory._
### Filter by severity (`--severity`, `-s`)
It's not always possible to update to the latest major version, and likewise you
may not care about every single patch release to packages. Don't worry, we've
got your back! With the `--severity` option, you can specify which severity
levels to include. By default, we show all but if you only want to display minor
versions updates, you could use this command.
```bash
yarn outdated --severity minor
```
Also, this flag can be specified multiple times if you would like to include
multiple severities, such as minor and patch versions, as shown in the following
example.
```bash
yarn outdated --severity minor --severity patch
```
### Filter by type (`--type`, `-t`)
The final means of filtering outdated dependencies is by dependency type. For
example, to only display outdated `devDependencies`, use the following command.
```bash
yarn outdated --type devDependencies
```
### Include the wanted range
By default, only the latest version of dependencies are displayed. However, in
some cases you may wish to know both the latest version and the version that
satisfies the range specified in your manifest.
```bash
yarn outdated --range
```
For example if you have `"glob": "^7.2.0"` in your manifest, the output with
this flag might look something like this.
```bash
➤ YN0000: Package Current Range Latest Package Type
➤ YN0000: glob 7.2.0 7.2.3 8.0.3 devDependencies
```
### Check mode (`--check`, `-c`)
By default, this plugin will always return an exit code 0 even if there are
outdated dependencies. While this is perfect for normal use, if you want to use
this plugin with scripts and fail if there are outdated dependencies, you can
add the `--check` flag.
```bash
yarn outdated --check
```
### Display homepage URLs (`--url`)
It is possible to display dependency homepage URLs in the output. To do so,
simply add the `--url` flag to the command!
```bash
yarn outdated --url
```
### Format (`--format`)
In addition to the standard terminal text format, this plugin supports JSON and
markdown formatting.
#### JSON (`--format=json`)
If you are writing a script that depends on information from this plugin, you
may find the `--format=json` option helpful to get raw JSON data that you can
then parse and use as your needs require.
#### Markdown (`--format=markdown`)
If you are using this plugin in a GitHub action or other CI provider that
displays markdown content, use `--format=markdown` to display a formatted
markdown table.
## Configuration
### Include homepage URLs by default (`outdatedIncludeUrl`)
By default, homepage URLs are not included in the output. In addition to the
`--url` flag, you can configure URLs to show by default.
```yaml
outdatedIncludeUrl: true
```
When this setting is enabled, you can use the `--no-url` flag to disable it on a
per-command basis.
```bash
yarn outdated --no-url
```