https://github.com/euberdeveloper/svecchiator
An npm module to brutally update a Node.js project's dependencies
https://github.com/euberdeveloper/svecchiator
cli nodejs npm
Last synced: 4 months ago
JSON representation
An npm module to brutally update a Node.js project's dependencies
- Host: GitHub
- URL: https://github.com/euberdeveloper/svecchiator
- Owner: euberdeveloper
- License: mit
- Created: 2022-04-21T13:06:20.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-25T17:53:53.000Z (10 months ago)
- Last Synced: 2025-02-25T00:38:46.529Z (4 months ago)
- Topics: cli, nodejs, npm
- Language: TypeScript
- Homepage: svecchiator.vercel.app
- Size: 916 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://coveralls.io/github/euberdeveloper/svecchiator?branch=main)
[](https://codecov.io/gh/euberdeveloper/svecchiator)
[](https://snyk.io/test/github/euberdeveloper/svecchiator?targetFile=package.json)
[](http://commitizen.github.io/cz-cli/)
[](https://github.com/euberdeveloper/svecchiator/blob/main/LICENSE)
[](https://github.com/euberdeveloper/svecchiator/issues)
# svecchiator
An npm module to brutally update a Node.js project's dependencies
## The name
A little explaination of the name **svecchiator**:
In Italian "svecchiare" means to remove the old parts from something or to renew something. This module will remove the old dependencies, replacing them with the ones with the latest versions.
## How does it work
Under the hood, svecchiator reads the package.json file and manually calls the `npm install` and `npm uninstall` commands to update the dependencies. It alwo works with `pnpm` and `yarn`.
## Install
To install svecchiator as a local module:
```bash
$ npm install svecchiator
```
To install svecchiator as a global module:
```bash
$ npm install -g svecchiator
```
## Usage (local module)
### Upgrade everything
Simple:
```js
import { svecchia } from 'svecchiator';
async function main() {
await svecchia();
}
main();
```
With custom configuration:
```js
import { svecchia } from 'svecchiator';
async function main() {
await svecchia({
path: '../my-project',
onlyDevDeps: true,
cleanCache: true,
exclude: ['dree', 'eslint'],
packageManager: 'pnpm'
});
}
main();
```
## Usage (global module)
### Simple
```bash
$ svecchia
```
This will uninstall and install again all the deps and dev deps of the current dir project.
### Only dev deps and with another project dir
```bash
$ svecchia --dev --source ./my-project
```
This will uninstall and install again only the dev deps of the project in `./my-project`.
### Exclude packages
```bash
$ svecchia -e eslint -e dree
```
This will exclude the packages `dree` and `eslint`
### Other package managers
```bash
$ svecchia --package-manager pnpm
```
This will use `pnpm` instead of `npm` to uninstall and install the packages.
### More help
```bash
$ svecchiator --help
```
This will show the help of the command.
### Code completion
In case you wanted to add the code completion for cli commands, you can use the following command:
```bash
$ svecchia completion
```
It will output the code completion for your shell. You can then add it to your `.bashrc` or `.zshrc` file.
For instance, if you want to add it to your `.bashrc` file, you can do it like this:
```bash
$ svecchia completion >> ~/.bashrc
```
## API
### Online documentation
The documentation generated with **TypeDoc** is available in this **[site](https://svecchiator.euber.dev/)**.
There is also a more specific version for development in this **[site](https://svecchiator-dev.euber.dev/)**.
### scan
**Syntax:**
`svecchiator.svecchia(options)`
**Description:**
A function that given some options, upgrades the dependencies of the package.json file. It works by running the command to uninstall and install them again. Note: the function is **async**.
**Options parameters:**
* __path__: Default value: `.`. The path of the folder containing the package.json file.
* __onlyDevDeps__: Default value: `false`. If true, only the devDependencies will be updated.
* __onlyProdDeps__: Default value: `false`. If true, only the dependencies will be updated.
* __onlyOptionalDeps__: Default value: `false`. If true, only the optional dependencies will be updated.
* __onlyPeerDeps__: Default value: `false`. If true, only the peer dependencies will be updated.
* __cleanCache__: Default value: `false`. If true, the npm cache will be cleaned before updating the dependencies.
* __exclude__: Default value: `[]`. The list of dependencies to exclude from the update.
* __only__: Default value: `[]`. The list of dependencies to update. If specified and not empty, only the dependencies in this list will be updated.
* __packageManager__: Default value: `npm`. The package manager to use. It can be `npm`, `pnpm` or `yarn`.
## Project structure
[//]: # (dree - BEGIN)
Made with [dree](https://github.com/marketplace/actions/ga-dree)
```
svecchiator
├── .env.example
├── .eslintignore
├── .eslintrc.cjs
├─> .github
│ └─> workflows
│ ├── build.yml
│ ├── dree.yml
│ ├── lint.yml
│ └── test.yml
├── .gitignore
├── .prettierrc.cjs
├── .release-it.json
├── CHANGELOG.md
├── LICENSE
├── README.md
├── babel.config.cjs
├── build.mjs
├─> docs
│ ├── .gitignore
│ └─> tree
│ └── dree.config.json
├── jest.config.ts
├── package.json
├── pnpm-lock.yaml
├─> source
│ ├── index.bin.ts
│ ├── index.ts
│ ├── shims.d.ts
│ └── tsconfig.json
├─> test
│ ├── .eslintrc.cjs
│ ├─> assets
│ │ ├─> withAllDeps
│ │ │ └── package.json
│ │ ├─> withNpmLock
│ │ │ ├── package-lock.json
│ │ │ └── package.json
│ │ ├─> withPnpmLock
│ │ │ ├── package.json
│ │ │ └── pnpm-lock.yaml
│ │ ├─> withProdAndDevDeps
│ │ │ └── package.json
│ │ ├─> withYarnLock
│ │ │ ├── package.json
│ │ │ └── yarn.lock
│ │ ├─> withoutDeps
│ │ │ └── package.json
│ │ ├─> withoutDevDeps
│ │ │ └── package.json
│ │ └─> withoutProdDeps
│ │ └── package.json
│ ├─> suites
│ │ └─> integration
│ │ ├── auto.test.ts
│ │ ├── npm.test.ts
│ │ ├── pnpm.test.ts
│ │ └── yarn.test.ts
│ └─> utils
│ ├── mockExecuteCommand.ts
│ └── paths.ts
├── tsconfig.json
├── typedoc.cjs
└── typedoc.dev.cjs
```
[//]: # (dree - END)
## Development
Make sure that you have all the dependencies installed
### Transpile
To transpile the typescript code
```bash
$ pnpm transpile
```
The transpiled code will be in the `dist` folder.
### Bundle
To bundle the library with esbuild:
```bash
$ pnpm bundle
```
The bundled code will be in the `bundled` folder.