https://github.com/uzitech/nstl

Install package with npm, yarn, or pnpm
https://github.com/uzitech/nstl

Last synced: 19 days ago
JSON representation

Install package with npm, yarn, or pnpm

• Host: GitHub
• URL: https://github.com/uzitech/nstl
• Owner: UziTech
• License: mit
• Created: 2021-01-29T19:47:36.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-09T11:11:37.000Z (about 1 month ago)
• Last Synced: 2024-10-15T12:18:40.674Z (about 1 month ago)
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/nstl
• Size: 2 MB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
[![Actions Status](https://github.com/UziTech/nstl/workflows/tests/badge.svg)](https://github.com/UziTech/nstl/actions)

# INSTALL

Install packages with `npm`, `yarn`, or `pnpm` based on the lock file present in the repo.

## Why?

Maintaining multiple repos with different packages managers has become very difficult. Not only do you have to remember which package manager to use, you have to remember which commands and options to use.

NPM uses `install` to install all packages and new packages, while Yarn uses `install` for all packages and `add` for new packages. If you want to install dev packages NPM uses `--save-dev`, but Yarn uses `--dev`, but PNPM uses `--save-dev` for new packages and `--dev` for all packages (WTF!!!)

[![XKCD Standards](https://imgs.xkcd.com/comics/standards.png)](https://xkcd.com/927/)

Unfortunately someone has to do it.

## Installation

```sh

npm i -g nstl [yarn] [pnpm]

```

## Usage

### Install All Dependencies

Install all dependencies by running `nstl` without any other arguments:

```sh

nstl

```

### Add New Dependencies

Add dependencies by including the name of the dependency as an argument:

```sh

nstl package-to-add

```

To install multiple packages add each dependency as an argument:

```sh

nstl package-1 package-2

```

`add`, `install`, and `i` can be used to be more explicit:

```sh

nstl install package-1 package-2

```

### Add Dev Dependencies

Add dev dependencies with `--save-dev`, `--dev`, or `-D`:

```sh

nstl --dev package-1 package-2

```

### Remove Dependencies

Remove dependencies with `remove`, `uninstall`, or `un`:

```sh

nstl uninstall package-1 package-2

```

## Options

| Option | Aliases | Description |

|--------|---------|-------------|

| `--dev`  | `--save-dev`, `-D` | Save as `devDependecies`, or only install `devDepedencies` when installing all dependecies. |

| `--no-dev` | `--ignore-dev` | Ignore `devDependencies` when installing all packages. |

| `--optional` | `--save-optional`, `-O` | Save as `optionalDependencies`, or only install `optionalDependencies` when installing all dependencies. |

| `--no-optional` | `--ignore-optional` | Ignore `optionalDependencies` when installing all packages. |

| `--peer`  | `--save-peer`, `-P` | Save as `peerDependecies`, or only install `peerDepedencies` when installing all dependecies. |

| `--no-peer` | `--ignore-peer` | Ignore `peerDependencies` when installing all packages. |

| `--exact` | `--save-exact`, `-E` | Save exact version of dependency. |

| `--tilde` | `--save-tilde`, `-T` | Save tilde (`~`) version of dependency. |

| `--global` | `-g` | Save global dependency. Fails for Yarn. |