机密术典

Appearance

开发环境准备 ​

Node.js ​

Node.js 的版本选取原则是使用当前主流的 LTS 版本，目前是 lts/hydrogen。

安装方式 ​

  1. 通过自己喜欢的管理器来安装
  2. 直接在 官网 下载

通过 nvm 安装 ​

sh
# 检查当前已安装的版本
nvm ls

# 首次安装最新稳定版
nvm install lts/hydrogen

# 更新版本
nvm install lts/hydrogen --reinstall-packages-from=lts/hydrogen

# 卸载特定版本
nvm uninstall 18.17.1

# 设置默认版本
nvm alias default lts/hydrogen

pnpm ​

我们全部的项目都会使用 pnpm 作为包管理器，安装 pnpm 的方式需要确保使用 corepack。 Node.js 安装完毕后，在终端输入 corepack enable 即可。

WARNING

请不要使用 npm i -g pnpm 来安装 pnpm。

为什么用 corepack？ ​

corepack 能够接管 pnpm cli 的指向，根据项目的 package.json 文件中定义的 packageManager 字段， 自动准备好并使用约定的版本，确保成员使用的包管理器版本一致。 在开启 corepack 并配置好 packageManager 字段的环境中，你不会使用错误的包管理器来下载依赖。

@antfu/ni（可选） ​

ni 是一个很有用的小工具，可以自动识别当前项目下应该使用 npm yarn 还是 pnpm，使用 ni 即可安装依赖。 同时也可以通过 nr 来交互式地执行当前项目下所有可执行的命令。这里有一些方便的命令简写：

bash
alias nio="ni --prefer-offline"
alias s="nr start"
alias d="nr dev"
alias b="nr build"
alias bw="nr build --watch"
alias t="nr test"
alias tu="nr test -u"
alias tw="nr test --watch"
alias w="nr watch"
alias p="nr play"
alias c="nr typecheck"
alias lint="nr lint"
alias lintf="nr lint --fix"
alias release="nr release"
alias re="nr release"

VS Code ​

团队使用 VS Code 作为编辑器，项目可能会配置一些必要的设置项和插件。 如果你还在使用 JetBrains 系，不妨来试试 VS Code 吧，不然你需要自己设置一些关键插件的设置，如 ESLint 和 Prettier。

有利于项目维护的 tips ​

  1. 不要在项目中使用自己在本地全局安装的依赖，对于 monorepo，优先考虑将依赖定义在特定子模块中。
  2. 项目使用到的 VS Code 插件和设置项，添加到 .vscode/extensions.json 和 .vscode/settings.json 文件中并提交至 git。