Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kristian/yarn-plugin-optional-resolution
Yarn 2+ / Berry plugin adding support for resolving non-existing optional package dependencies / version ranges
https://github.com/kristian/yarn-plugin-optional-resolution
yarn yarn-berry yarn-plugin
Last synced: 4 days ago
JSON representation
Yarn 2+ / Berry plugin adding support for resolving non-existing optional package dependencies / version ranges
- Host: GitHub
- URL: https://github.com/kristian/yarn-plugin-optional-resolution
- Owner: kristian
- License: mit
- Created: 2022-04-02T16:53:52.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-13T17:50:43.000Z (about 1 year ago)
- Last Synced: 2023-11-13T18:45:40.177Z (about 1 year ago)
- Topics: yarn, yarn-berry, yarn-plugin
- Language: TypeScript
- Homepage:
- Size: 1.41 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `@yarnpkg/plugin-optional-resolution`
Yarn Berry plugin that adds support for non-existing optional package dependencies. Without this plugin Yarn 2+ ("Berry") installing or adding an optional package which does not exist in the package repository will result in an error:
```
➤ YN0027: @unknown can't be resolved to a satisfying range
➤ YN0035: The remote server failed to provide the requested resource
➤ YN0035: Response Code: 404 (Not Found)
➤ YN0035: Request Method: GET
➤ YN0035: Request URL: https://registry.yarnpkg.com/
```
This plugin changes this behavior in two ways:
1. If an optional package requested from any defined NPM package registry (see [`npmRegistryServer`](https://yarnpkg.com/configuration/yarnrc#npmRegistryServer) and [`npmScopes`](https://yarnpkg.com/configuration/yarnrc#npmScopes)), would lead to a 404 (Not Found) error, this package instead, serves Yarn a "fake" / dummy package metadata file, leading to an [`optional-pkg`](https://www.npmjs.com/package/optional-pkg) instead, which satisfies the requested version range.
2. Before packing, this plugin will "realize" all those optional, but non-existent, packages, by removing them from the `"optionalDependencies"` section before publishing. This allows others to consume the package, without requiring the optional resolution plugin, or even with other package managers like NPM.
This makes `"optionalDependencies"` truly optional, in a sense that they do not even need to exist, which behaves according to the [NPM package specification](https://docs.npmjs.com/cli/v8/configuring-npm/package-json#optionaldependencies). Sometimes you favour a behavior like this, especially if you are working e.g. with multiple private package registries, that may, or may not contain certain package artifacts.
> ⚠️ There is a limitation for projects with *multiple workspaces* at the moment: As this plugin hooks into the network requests towards the NPM package registry and the hooking mechanism doesn't provide information for which workspace the request was made, this plugin assumes a package is optional, if it is mentioned in any `"optionalDependencies"` section of any of the workspace packages. Meaning that even if the package does not exist, installation would not fail for some workspaces, even if they declare the package as a hard dependency in their `"dependencies"` or `"devDependencies"` section.
## Installation
You can add this plugin to your Yarn 2+ ("Berry") project running the following command:
```bash
yarn plugin import https://raw.githubusercontent.com/kristian/yarn-plugin-optional-resolution/v1.2.0/bundles/%40yarnpkg/plugin-optional-resolution.js
```
## Author
Written by [Kristian Kraljić](https://kra.lc/).
## Found a Bug?
Please file any issues [on Github](https://github.com/kristian/yarn-plugin-optional-resolution).
## License
This package is licensed under the [MIT](LICENSE) license.