@snpm-io/cli

0.3.8 • Public • Published

SNPM (WIP)

SNPM is an "alternative" for NPM, but it's not meant to replace NPM/Yarn/PNPM

DISCLAIMER 🚧

This project was made to learn more about Package Managers, for now you should only use it to play with it.

CLI

The SNPM CLI is used to install packages from the package.json of a project.

Its advantages are that it is faster than NPM and saves more space.

Instalation

npm i @snpm-io/cli -g

Commands

  • snpm install [pkg (optional), flags] Installs packages
  • snpm run <script> <params> Run script from package.json
  • snpm benchmark Tests SNPM against NPM and PNPM
  • snpm clear Remove .snpm-cache folder . snpm ls <pkg> Show versions installed by SNPM

Todo

  • [ ] Make it work in some JS Frameworks (Follow progress here)
  • [ ] Fix monorepos integration (WIP, degradated performance in some repos)

Why is it faster?

SNPM uses the same installation system as PNPM, fetch dependency, download dependency. Without waiting for the rest of the dependencies.

To resolve the dependencies, a dependency tree is generated as in NPM version 2, each dependency (or subdependency) has its own node_modules.

Now you are probably wondering how that makes the space more efficient than in NPM.

Each dependency is a hard link to a common store inside .snpm-cache, so all your projects use shared dependencies.

It works?

Short answer, probably no, but in some cases it works. (For now)

I've selected some quickstart templates to test SNPM, and I'm working on make it work in all of them.

If you want to test a template, you can use Next or Vite, I've already tested them and it should work.

(If you want to test a template and it doesn't work, please open an issue)

Benchmarks

PNPM Official benchmark (alotta-files)

┌─────────┬────────────────────────────────────────────┬─────────────────┐
│ (index) │                    name                    │      time       │
├─────────┼────────────────────────────────────────────┼─────────────────┤
│    0    │ 'Bun install (with cache / with lockfile)''0.70 seconds'  │
│    1    │  'Bun install (with cache / no lockfile)''1.17 seconds'  │
│    2    │        'SNPM install (with cache)''4.94 seconds'  │
│    3    │   'Bun install (no cache / no lockfile)''9.90 seconds'  │
│    4    │        'PNPM install (with cache)''10.16 seconds' │
│    5    │ 'NPM install (with cache / with lockfile)''27.29 seconds' │
│    6    │  'NPM install (with cache / no lockfile)''35.34 seconds' │
│    7    │        'YARN install (with cache)''43.62 seconds' │
│    8    │         'SNPM install (no cache)''1.02 minutes'  │
│    9    │         'PNPM install (no cache)''1.24 minutes'  │
│   10    │   'YARN install (no cache, no lockfile)''1.68 minutes'  │
│   11    │    'YARN install (with cache, no lock)''2.13 minutes'  │
│   12    │   'NPM install (no cache / no lockfile)''2.36 minutes'  │
└─────────┴────────────────────────────────────────────┴─────────────────┘

Vite React - TS

This is an example benchmark of a Vite project using npm create vite@latest my-react-app -- --template react-ts

Check results in Pull Requests comments

Nextjs - TS

This example is generated using npx create-next-app --use-npm --ts

WARNING: It works now, but some errors may appear.

┌─────────┬────────────────────────────────────────────┬─────────────────┬───────┐
│ (index) │                    name                    │      time       │ group │
├─────────┼────────────────────────────────────────────┼─────────────────┼───────┤
│    0    │ 'Bun install (with cache / with lockfile)''0.23 seconds'  │   3   │
│    1    │   'Bun install (no cache / no lockfile)''3.37 seconds'  │   1   │
│    2    │        'PNPM install (with cache)''3.47 seconds'  │   3   │
│    3    │  'Bun install (with cache / no lockfile)''3.79 seconds'  │   2   │
│    4    │        'SNPM install (with cache)''5.04 seconds'  │   3   │
│    5    │        'YARN install (with cache)''5.93 seconds'  │   3   │
│    6    │ 'NPM install (with cache / with lockfile)''6.61 seconds'  │   3   │
│    7    │  'NPM install (with cache / no lockfile)''8.51 seconds'  │   2   │
│    8    │         'PNPM install (no cache)''15.87 seconds' │   1   │
│    9    │    'YARN install (with cache, no lock)''16.07 seconds' │   2   │
│   10    │         'SNPM install (no cache)''19.05 seconds' │   1   │
│   11    │   'NPM install (no cache / no lockfile)''22.20 seconds' │   1   │
│   12    │   'YARN install (no cache, no lockfile)''32.87 seconds' │   1   │
└─────────┴────────────────────────────────────────────┴─────────────────┴───────┘

Create React App - Craco

WARNING: Currently CRA doesn't work with symlinked dependencies.

Pending...

The commands with no-cache executes npm cache clean -f to delete NPM Cache files (SNPM uses them too npm/pacote) and also deletes the store folder for SNPM.

Readme

Keywords

none

Package Sidebar

Install

npm i @snpm-io/cli

Weekly Downloads

1

Version

0.3.8

License

ISC

Unpacked Size

41.9 kB

Total Files

34

Last publish

Collaborators

  • ialdama