Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/angelogiuseppe/force-resolutions
This packages modifies package-lock.json to force the installation of specific version of a transitive dependency
https://github.com/angelogiuseppe/force-resolutions
Last synced: about 5 hours ago
JSON representation
This packages modifies package-lock.json to force the installation of specific version of a transitive dependency
- Host: GitHub
- URL: https://github.com/angelogiuseppe/force-resolutions
- Owner: angelogiuseppe
- License: mit
- Created: 2021-07-23T00:47:54.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-12-02T09:11:10.000Z (12 months ago)
- Last Synced: 2024-03-15T00:04:18.618Z (8 months ago)
- Language: TypeScript
- Size: 381 KB
- Stars: 23
- Watchers: 1
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
---
This package modifies package-lock.json to force the installation of specified versions of a set of transitive dependencies (dependencies of dependencies).
---
### Getting started
1. Add a field `resolutions` with the dependency version you want to fix at the main level of your `package.json`.
Example:
```json
"resolutions": {
"ssri": "8.0.5"
}
```
2. Add force-resolutions to the preinstall script so that it patches the `package-lock.json` file before every `npm install`:
```json
"scripts": {
"preinstall": "npx force-resolutions"
}
```
3. Install dependencies
```shell
npm install
```
Remember that whenever you run `npm install`, the `preinstall` command will run automatically.
If a `package.lock.json` is not detected the script will not run, and any other command after it will be executed as normal.
4. To confirm that the right version of the package you are trying to override was installed, use:
```shell
npm ls ssri
```
---
### Running this repository locally
**NodeJS and NPM versions**
NodeJS version:
```shell
v16.13.1
```
NPM version:
```shell
8.1.2
```
**Instructions**
1. Install the dependencies of the project:
```shell
npm install
```
2. Build the project:
```shell
npm run build
```
3. Go to the dist folder
```shell
cd dist
```
3. Copy a package.json and a package-lock.json file into the dist folder
4. Add a resolutions field in the package.json and inside of it a package to override
5. Run the compiled file
```shell
node index.js
```
5. Search in the package-lock.json to see that the versions of the packages are updated
---
### Why this project was created
This project was created because **npm-force-resolutions** became not suitable for the necesities the team I was working in had. We needed to avoid triggering the execution of the script when there was no `package-lock.json`, descriptive error logs, descriptive logs during the execution, faster download times, compatibility with multiple npm versions and faster execution times.
---
### Overrides, the new way of doing resolutions
NPM released a new way to handle resolutions, now there is a property on package.json to do them, is called overrides. If you are using recent versions of node and npm you probably don't need this package. You can read more about overrides here:
[NPM overrides documentation](https://docs.npmjs.com/cli/v10/configuring-npm/package-json#overrides)
---
### Discord community
To simplify communication I have created a discord community, if you detect an issue with this package or want to improve it in some way, you can contact me here. Normally I am busy with work, but if you contact me here I'll reply faster.
[Join discord community](https://discord.gg/fNEEthRGJu)
---
### NPM
[Find the package on NPM](https://www.npmjs.com/package/force-resolutions)
[See other versions of the package on NPM](https://www.npmjs.com/package/force-resolutions?activeTab=versions)
---
### Acknowledgments
This project was inspired by the next package: [npm-force-resolutions](https://www.npmjs.com/package/npm-force-resolutions).
Special thanks to Denis Gulin for contributing to fix issues that were happening with the package and improving the code.