Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yowainwright/install-perfection
Install dependencies with control 💖
https://github.com/yowainwright/install-perfection
dependency-management folder-size install package-management
Last synced: 3 months ago
JSON representation
Install dependencies with control 💖
- Host: GitHub
- URL: https://github.com/yowainwright/install-perfection
- Owner: yowainwright
- License: mit
- Created: 2023-03-21T03:16:41.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-30T05:02:29.000Z (9 months ago)
- Last Synced: 2024-05-02T00:01:19.568Z (9 months ago)
- Topics: dependency-management, folder-size, install, package-management
- Language: TypeScript
- Homepage:
- Size: 644 KB
- Stars: 3
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Install Perfection
[](https://badge.fury.io/js/install-perfection)
[](https://github.com/yowainwright/install-perfection)
_**Install dependencies with control 💪**_
Sometimes, you need nuance and control over your npm dependencies.
> You might want to minimize your `node_module` folder size when shipping to production. Or, you might want to switch dependencies on the fly. For this, **Install Perfection** might be the tool you need.
---
## How easy is Install Perfection to set up?
#### Very easy!
_If not, [submit an issue](https://github.com/yowainwright/install-perfection/issues)!_
You can use Install Perfection as a CLI only.
```bash
npx install-perfection --include {"playwright-core": "latest"} --ignore {"playwright": "latest"}
```
If you'd like to use it a bit more explicitly, you can configure it in your `package.json`.
```ts
// package.json
{
...
"install": {
// include this dependency
"include": {
"playwright-core": "latest"
},
// but don't include this one!
"ignore": {
"playwright": "latest"
}
}
...
}
```
Or, if you like to keep your `package.json` pure, you can create a `.installrc` file with the same configuration.
```ts
// .installrc
{
"include": {
"playwright-core": "latest"
},
"ignore": {
"playwright": "latest"
}
}
```
If you'd like to build something custom, you can copy it's functionality into your own project or you can use the exported functions directly—as they're typed and tested.
```ts
import { install } from 'install-perfection'
install({
include: {
'playwright-core': 'latest'
},
ignore: {
'playwright': 'latest'
},
})
```
---
## How do I use Install Perfection?
Install Perfection is built to be used as a CLI _**first and foremost**_. It also exports node functions which can be used to preform the same install operation.
---
Install or reference Install Perfection in your project.
```bash
npm install install-perfection --save-dev
```
---
## CLI API
Listed below are the CLI options and arguments to execute install-perfection. To *view all cli options, run `install-perfection --help`!
```bash
Usage: install-perfection [options]
Install dependencies with control, perfectly 💪
Options:
-V, --version output the version number
-c, --config config path
--debug enables debug mode
-d, --dest dest path
-f, --file path to package.json file
--has-lockfile use lock file
-p, --path path to package.json file
-r, --runner npm, pnpm, or yarn (bun support coming; use npm for bun now)
-i, --include [include...] include dependencies, include an array of json parseable string
wrapped objects, e.g. `--include '{"foo": "bar"}' '{"biz": "baz"}'
`
--ignore [exclude...] exclude dependencies, e.g. `--exclude foo bar`
-h, --help display help for command
```
---
### Recipes
Install an additional list of dependencies.
```sh
install-perfection --include {"playwright-core": "latest"}' '{"react": "latest"}
```
Ignore an array of dependencies.
```sh
install-perfection --ignore playwright react
```
Ignore and install dependencies for Install Perfection.
```sh
install-perfection --ignore playwright react --include {"playwright-core": "latest"} {"react": "latest"}
```
Install while including a lock file.
```sh
install-perfection --has-lockfile --ignore playwright
```
Add a custom path to the package.json file you're installing perfection for.
```sh
install-perfection --path ./path/to/package.json --ignore playwright
```
Add a custom path to install your `node_modules`.
```sh
install-perfection --dest ./path/to/node_modules_dest --ignore playwright
```
Use a custom runner (dependence manager)
```sh
install-perfection --runner pnpm --ignore playwright
```
Make it fast by inputting your config to your command.
```sh
install-perfection --config ./path/to/.installrc --ignore playwright
```
Get debugging information.
```sh
install-perfection --debug --ignore playwright
```
---
## Node API
The node API works exactly the same as the CLI API.
```ts
import { install } from 'install-perfection'
install({
include: {
'playwright-core': 'latest'
},
ignore: {
'playwright': 'latest'
},
})
```
---
## Is the name, "Install Perfection", a bit much?
Yes. _Just like your `node_module` folder_. 😜 Use Install Perfection to make your node_modules _a bit less_.
---
Made by [@yowainwright](https://github.com/yowainwright), MIT 2023