Skip to content

Latest commit

 

History

History
145 lines (104 loc) · 4.49 KB

README_zh-CN.md

File metadata and controls

145 lines (104 loc) · 4.49 KB
Raw

English | 中文简体

Build Status Go Report Card Latest Version 996.icu Repo Size

介绍

Nodapt (/noʊˈdæpt/) 是一个适配多个 NodeJS 版本的命令行工具，它会根据 packages.json 中的 NodeJS 版本约束，使用合适的 NodeJS 版本运行命令。

背景

在开发 NodeJS 项目时，我们经常需要切换 NodeJS 版本，例如，项目 A 需要16.x.y，而项目 B 使用20.x.y。

但是全局的版本管理工具类似 nvm 并不能满足，它有一下几个问题：

  1. nvm 并不是跨平台的，windows 上使用起来并不是很方便。
  2. nvm 需要提前安装好指定的版本才能切换，这对于 CI/CD 环境并不是很友好。
  3. 在 Monorepo 中可能会存在 package A 需要16.x.y，而 package B 需要20.x.y，这时候 nvm 并不能很好的解决这个问题。

所以我开发了这个工具，用于解决这个问题。

它会根据 packages.json 中的 NodeJS 版本约束，使用合适的 NodeJS 版本运行命令。

用法

# 自动选择 NodeJS 版本运行命令
$ nodapt node -v

# 指定 NodeJS 版本并运行指定命令
$ nodapt use ^18 node -v

集成到你的 NodeJS 项目中

  1. 在 package.json 中添加 NodeJS 版本约束。
+  "engines": {
+    "node": "^20.x.x"
+  },
  "scripts": {
    "dev": "vite dev"
  }
  1. 使用 nodapt 命令运行脚本。
- yarn dev
+ nodapt yarn dev

运行 --help 查看更多选项。

$ nodapt --help
nodapt - A virtual node environment for node.js, node version manager for projects.

USAGE:
  nodapt [OPTIONS] <ARGS...>
  nodapt [OPTIONS] run <ARGS...>
  nodapt [OPTIONS] use <CONSTRAINT> [ARGS...]
  nodapt [OPTIONS] rm <CONSTRAINT>
  nodapt [OPTIONS] clean
  nodapt [OPTIONS] ls
  nodapt [OPTIONS] ls-remote

COMMANDS:
  <ARGS...>                   Alias for 'run <ARGS...>' but shorter
  run <ARGS...>               Automatically select node version to run commands
  use <CONSTRAINT> <ARGS...>  Use the specified version of node to run the command
  rm|remove <CONSTRAINT>      Remove the specified version of node that installed by nodapt
  clean                       Remove all the node version that installed by nodapt
  ls|list                     List all the installed node version
  ls-remote|list-remote       List all the available node version

OPTIONS:
  --help|-h                   Print help information
  --version|-v                Print version information

ENVIRONMENT VARIABLES:
  NODE_MIRROR                 The mirror of the nodejs download, defaults to: https://nodejs.org/dist/
                              Chinese users defaults to: https://registry.npmmirror.com/-/binary/node/
  NODE_ENV_DIR                The directory where the nodejs is stored, defaults to: $HOME/.nodapt
  DEBUG                       Print debug information when set DEBUG=1

EXAMPLES:
  nodapt node -v
  nodapt run node -v
  nodapt use v14.17.0 node -v

SOURCE CODE:
  https://github.com/axetroy/nodapt

安装

  1. 通过 Cask 安装 (Mac/Linux/Windows)
$ cask install github.com/axetroy/nodapt
$ nodapt --help
  1. 通过 npm 安装
$ npm install @axetroy/nodapt -g
$ nodapt --help

卸载

$ nodapt clean
# 然后移除可执行文件或者通过包管理器卸载

NodeJS 版本选择算法

本节解释运行 nodapt 时发生的情况以及它如何选择节点版本。

  1. 检查 package.json 是否存在。
  2. 如果 package.json 存在：
    1. 如果指定了 engines.node 字段：
      1. 如果当前安装的版本与 engines.node 匹配，则使用当前安装版本运行命令。
      2. 否则，从远程列表中选择匹配的最新版本，然后安装并运行命令。
    2. 否则, 直接运行命令。
  3. 否则, 直接运行命令。

类似项目

https://github.com/jdx/mise

https://github.com/gvcgo/version-manager

https://github.com/version-fox/vfox

开源许可

The Anti-996 License