剪藏
Rethinking your position
Learn how to learn
3R编码 | nestjs最佳实践 - 课程概览
3R编码 | Node.js开发环境搭建
3R编码 | Nestjs+Eslint+SWC应用初始化及断点调试
3R编码 | 装饰器与反射
3R编码 | Nestjs核心概念
3R编码 | 无懈可击的Linux服务器构建
3R编码 | 使用Turborepo+pnpm workspaces构建monorepo应用
3R编码 | 使用Gitea+Drone自建CICD平台
3R编码 | 整合Typeorm实现CRUD
3R编码 | 请求数据的验证和响应数据的序列化
3R编码 | 数据关联与树形嵌套结构的分类和评论的实现
3R编码 | 自定义全局的验证管道,拦截器和过滤器
3R编码 | 自定义数据验证约束及约束中的依赖注入
3R编码 | 批量操作及软删除(回收站)功能使用
3R编码 | 数据库与MeiliSearch的全文搜索
3R编码 | 数据操作代码的抽象化
3R编码 | 整合bun与pm2实现开发环境与生产环境免编译和自启
3R编码 | 自建配置系统实现
3R编码 | 嵌套路由与Swagger文档实现
3R编码 | 使用Yargs构建命令行工具
3R编码 | 生产环境下静默启动以及PM2 API的使用
3R编码 | 数据迁移功能的实现
3R编码 | 数据填充命令实现
3R编码 | 用户模块开发以及使用Passport实现JWT认证和无痛刷新
3R编码 | 基于CASL的RBAC动态角色及权限系统实现
3R编码 | 模型动态关联与基于CASL的动态权限的实现
3R编码 | 使用BullMQ实现异步验证短信与邮件发送
3R编码 | WebSocket实现消息广播功能
3R编码 | chapter27
3R编码 | chapter28
3R编码 | TS全栈+AI开发实战 - 课程概览
3R编码 | Node.js环境搭建及应用初始化
3R编码 | Next.js应用初始化
3R编码 | React内置Hooks的使用与自定义详解
3R编码 | Next.js中使用Zustand进行状态管理详解
3R编码 | Next.js核心概念及应用构建
微电子学第1话 MOS Differential Pair (I)
微电子学第1话 MOS Differential Pair (I)
微电子学第3话 CMRR
微电子学第2话 MOS Differential Pair (II)
终于有人讲了,凭什么三极管能放大?
降低人类负担:类型系统即边界
固态变压器SST是什么
本站点使用 MrDoc 构建
-
+
3R编码 | 使用Turborepo+pnpm workspaces构建monorepo应用
本节课的目的是通过[pnpm workspaces](https://pnpm.io/workspaces)结合[turborepo](https://turbo.build/)把多个自己开发的JS/TS应用和类库放入一个仓库,实现monorepo结构的项目,从而实现函数、类型、模块等共用和同构 ### 课程目标[](#课程目标 "课程目标的直接链接") 本节课的目标如下 - 使用turborepo+pnpm实现一个react+nextjs+nestjs的基础monorepo,使前后端可以同构和共享代码 - 共享代码风格化、TS配置以及一些通用的函数和模块 - 简单地改造monorepo应用(比如添加一些命令等),使我们开发时更加便捷 - 对第三方包进行依赖运行和依赖编译 - 同时编译出一个`esm`和`commonjs`的包 - 使用[bun](https://bun.sh/)直接运行[nodemon](https://nodemon.io/)编写的应用启动器 后续的课程我们还将学习 - 如何发布扩展包 - 如何在monorepo进行TDD和E2E测试 - 如何在ci中自动部署不同的应用 - 更加细致化的monorepo项目管理 - ... ### 前置准备[](#前置准备 "前置准备的直接链接") 请先按照新课的方法,新增`next.js`、`vite+react`两个前端应用。创建应用的课程地址如下 - [创建vite+react应用](https://docs.3rcd.com/courses/ts-fullstack/chapter2) - [创建next.js应用](https://docs.3rcd.com/courses/ts-fullstack/chapter4) 然后仔细阅读以下文档 - \[turborepo官网文档\]\[[https://turbo.build/repo/docs](https://turbo.build/repo/docs)\] - [pnpm workspaces使用方法](https://pnpm.io/workspaces) - [package.json的字段列表](https://docs.npmjs.com/cli/v10/configuring-npm/package-json) - [esm与commonjs的区别与改造](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) ### 技术概念[](#技术概念 "技术概念的直接链接") 以下为本节课所涉及的技术的概念 - [turborepo](https://turbo.build/):一个比较新monorepo构建框架,你也可以同时了解一下[lerna.js](https://lerna.js.org/)(站长最习惯的monorepo框架)、nx.js、rush.js等等 - [pnpm workspaces](https://pnpm.io/workspaces):pnpm原生的monorepo构建方式。目前turborepo支持整合pnpm的workspaces达到更好的mono应用构建效果 - [bunchee](https://github.com/huozhi/bunchee):一个零配置的ES6+/TS编译包,可同时编译出commonjs和esm模块 使用turborepo构建monorepo应用的好处如下 - 代码同构,比如前后端能使用同一个函数或者接口 - 方便管理,因为在一个仓库里了 - 发包方便并且可以降低代码耦合度,很多模块或组件直接可以拆分单独发包,方便循环使用,因为主应用是`private: true`的 - 启动或者编译方便,效率高,因为不需要开几个窗口启动不同应用,并且编译和开发启动时,可以并行 - turorepo独有的缓存可以提高重复执行一个相同任务的速度 ### 文件结构[](#文件结构 "文件结构的直接链接") 本节课代码的文件结构如下 ``` .├── README.md├── apps│ ├── admin # 后台应用包,来自上节课的vite+react应用改造│ │ ├── ...│ ├── api # 后端API应用包,来自上节课的nestjs应用改造│ │ ├── bin # 使用bun+nodemon启动开发环境│ │ ├── ...│ └── web # 网站前端应用包,来自上节课的next.js应用改造│ ├── ...├── package.json # monorepo全局依赖├── packages│ ├── code # 代码风格化配置扩展包│ │ ├── README.md│ │ ├── eslint # eslint配置│ │ ├── package.json│ │ ├── prettier.js # prettier配置│ │ ├── stylelint.js # stylelint配置│ │ └── tsconfig # ts配置│ ├── store│ │ ├── ...│ └── utils│ ├── ...├── pnpm-lock.yaml├── pnpm-workspace.yaml # pnpm workspaces配置├── tsconfig.json # monorepo全局ts配置└── turbo.json # turborepo配置、 ``` 创建一个turborepo项目 ``` pnpm dlx create-turbo@latest ``` 输入项目名称,例如`monoapp`,并选择"pnpm workspaces",如下图  用vscode打开目录后你会发现这样一个结构,解释一下他们的作用 ``` .├── README.md├── apps # 放置应用的目录│ ├── docs │ │ ├── README.md│ │ ├── app│ │ ├── next-env.d.ts│ │ ├── next.config.js│ │ ├── node_modules # 应用下的依赖,如果是多个项目都使用该依赖则会被提到根目录的node_modules,而此处仅做软链接│ │ ├── package.json│ │ ├── public│ │ └── tsconfig.json│ └── web│ ├── README.md│ ├── app│ ├── next-env.d.ts│ ├── next.config.js│ ├── node_modules│ ├── package.json│ ├── public│ └── tsconfig.json├── node_modules├── package.json # monorepo全局使用的依赖列表和全局的script命令├── packages # 放置扩展包的目录│ ├── eslint-config│ │ ├── README.md│ │ ├── library.js│ │ ├── next.js│ │ ├── node_modules│ │ ├── package.json│ │ └── react-internal.js│ ├── typescript-config│ │ ├── base.json│ │ ├── nextjs.json│ │ ├── package.json│ │ └── react-library.json│ └── ui│ ├── node_modules│ ├── package.json│ ├── src│ ├── tsconfig.json│ ├── tsconfig.lint.json│ └── turbo├── pnpm-lock.yaml├── pnpm-workspace.yaml # pnpm workspaces配置├── tsconfig.json # monorepo全局使用的ts配置└── turbo.json # turborepo配置 ``` 首先,我们需要取消`pnpm`的版本锁定。修改跟根目录下的`.npmrc`,如下 ``` package-manager-strict=false ``` 然后运行`pnpm dev`,打开[127.0.0.1:3000](http://127.0.0.1:3000/)或[127.0.0.1:3001](http://127.0.0.1:3001/)都能看到下图,代表两个next.js都跑起来了  我们可以看到`pnpm-workspace.yaml`文件,它指定了你可以放包的目录,只要指定`apps`和`packages`用来放我们的开发包即可,如下 信息 关于`pnpm`的`workspaces`的更多内容可以查看它的[官网文档](https://pnpm.io/zh/workspaces) ``` packages: - "apps/*" - "packages/*" ``` 可以看到`turbo.json`,这是turborepo的配置 信息 - `globalDependencies`可以用来指定一些改变全局缓存更改文件,一旦这些文件改变,turbo会自动更新编译等任务的缓存 - `pipeline`用来指定任务(每个包的每个任务都可以单独指定,可以自行查看其官网文档) - `dependsOn`的设置是,如果是加上`^`的,比如`^build`则在运行该任务前,它依赖的其他包如果有`build`命令则先运行,如果不加`^`,比如在`build`中添加`lint`,则代表在运行当前包的`build`命令时先运行自身的`lint`命令 - `outputs`用于指明该任务换成的文件 - `cache`用于禁用缓存 - `persistent`用来标记常驻内存的任务,比如`dev` ``` { "$schema": "https://turbo.build/schema.json", "globalDependencies": ["**/.env.*local"], "pipeline": { "build": { "dependsOn": ["^build"], "outputs": [".next/**", "!.next/cache/**"] }, "lint": { "dependsOn": ["^lint"] }, "dev": { "cache": false, "persistent": true } }} ``` 为了契合我们的应用,我们把它暂时改成如下配置,给`pipeline.build.outputs`添加 `"dist/**"` 然后,清空`packages`和`apps`目录,并删除根目录下下的`@repo/eslint-config`和`@repo/typescript-config`两个依赖,再执行`pnpm i`重新安装依赖 在根目录的`package.json`中添加一个包生成命令 success 后续《进阶篇》的课程,我们将会自己制作一个包生成器或通过模板生成扩展包及应用包 ``` { // ... "scripts": { "gen": "turbo gen workspace --", // ... },} ``` 运行`pnpm gen --name @3rapp/code`命令 信息 `@3rapp`指代这个包的前缀,可以按自己的需求设定,但是建议所有包(`packages`、`apps`等)统一前缀  为`packages/code`目录建立以下文件结构 ``` ./packages/code├── README.md├── eslint # eslint规则│ ├── base.js # 基本规则│ ├── lib.js # 自定义类库规则,一般用于简单的纯js扩展包│ ├── next.js # next.js扩展包或应用的规则│ ├── node.js # node/nestjs的扩展包或应用的规则│ ├── react.js # react扩展包或应用的规则│ └── ts-base.js # 基本的ts规则├── package.json├── prettier.js # prettier规则├── stylelint.js # stylelint规则└── tsconfig # tsconfig规则 ├── base.json # 基本规则 ├── next.json # next.js应用规则 ├── node.json # node/nestjs类库或应用规则 └── react.json # react类库或应用规则 ``` 复制[.gitignore](https://git.3rcd.com/classroom/classlts-temporary/src/branch/main/chapter2/packages/code/.eslintignore)到`packages/code`目录下 安装一下用于代码风格扩展包的依赖 信息 `--filter`参数用于指定安装到哪个包中,我们可以用全名`--filter @3rapp/code`,也可以直接用`code`。另外,也可以在`--filter`和包名之间用`=`相连,例如`--filter=@3rapp/code` ``` pnpm add eslint-config-turbo typescript @typescript-eslint/eslint-plugin eslint@^8.57.0 eslint-plugin-jest jest eslint-config-airbnb eslint-config-airbnb-typescript eslint-config-prettier eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-prettier eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-unused-imports stylelint stylelint-config-css-modules stylelint-config-recess-order stylelint-config-standard stylelint-prettier eslint-plugin-react-refresh @next/eslint-plugin-next -D --filter code ``` 像前面的课程一样在**根目录**下的`package.json`中添加eslint的版本升级忽略 注意 请注意:这类对依赖版本的设定,不能放每个包独资的`package.json`中,需要统一放置在根目录的`package.json`中 我们开始拆分上一节课程中node(fastify)、nestjs、vite+react、next.js四个应用的eslint配置,找到共同的基本规则放置在`eslint/base.js`中 注意:对于turborepo创建的应用,必须加上`eslint-config-turbo`规则。`base.js`中只需要包含"ES6+"和"Module Import"两种规则即可 ``` // packages/code/eslint/base.js/** @type {import("eslint").Linter.Config} */module.exports = { parserOptions: { ecmaVersion: 'latest', sourceType: 'module', }, plugins: ['prettier', 'import', 'unused-imports'], extends: [ // 使用prettier格式化代码 // https://github.com/prettier/eslint-config-prettier#readme 'prettier', // 整合typescript-eslint与prettier // https://github.com/prettier/eslint-plugin-prettier 'plugin:prettier/recommended', 'eslint-config-turbo', ], rules: { /* ********************************** ES6+ ********************************** */ // ... /* ********************************** Module Import ********************************** */ // ... },}; ``` 复制[ts-base.js](https://git.3rcd.com/classroom/classlts-temporary/src/branch/main/chapter2/packages/code/eslint/ts-base.js)的内容。`ts-base.js`继承自`base.js`,并添加了typescript的解析器和一些常用规则 ``` // packages/code/eslint/ts-base.js/** @type {import("eslint").Linter.Config} */module.exports = { parser: '@typescript-eslint/parser', plugins: ['@typescript-eslint', 'import', 'unused-imports', 'prettier'], extends: [ // typescript的eslint插件 'plugin:@typescript-eslint/recommended', 'plugin:@typescript-eslint/recommended-requiring-type-checking', './base', ], rules: { /* ********************************** Typescript ********************************** */ // ... },}; ``` `lib.js`继承自`base.js` ``` // packages/code/eslint/lib.js/** @type {import("eslint").Linter.Config} */module.exports = { env: { node: true, }, extends: [ // airbnb规范 // https://www.npmjs.com/package/eslint-config-airbnb-base 'airbnb-base', './base', ], ignorePatterns: [ // 忽略的文件 'node_modules/', ], overrides: [ { // 仅格式化.js、.jsx、.json后缀的文件 files: ['*.js?(x)', '*.json'], }, ],}; ``` `node.js`继承自`ts-base.js`,并添加了jest扩展 ``` // packages/code/eslint/node.js/** @type {import("eslint").Linter.Config} */module.exports = { env: { node: true, jest: true, }, plugins: ['@typescript-eslint', 'jest', 'import', 'unused-imports', 'prettier'], extends: [ // airbnb规范 'airbnb-base', // 兼容typescript的airbnb规范 'airbnb-typescript/base', // 支持jest 'plugin:jest/recommended', './ts-base', ], ignorePatterns: [ // 忽略的文件 'node_modules/', 'dist/', ], overrides: [ { // 仅格式化.js、.jsx、.ts、.tsx、.json后缀的文件 files: ['*.js?(x)', '*.ts?(x)', '*.json'], }, ],}; ``` 复制[react.js](https://git.3rcd.com/classroom/classlts-temporary/src/branch/main/chapter2/packages/code/eslint/react.js)的规则。该规则继承自`ts-base.js` ``` // packages/code-config/eslint/react.js/** @type {import("eslint").Linter.Config} */module.exports = { parserOptions: { // React启用jsx ecmaFeatures: { jsx: true, }, }, env: { browser: true, es2024: true }, plugins: ['@typescript-eslint', 'react-refresh', 'import', 'unused-imports', 'prettier'], extends: [ // airbnb规范 'airbnb', // 兼容typescript的airbnb规范 'airbnb-typescript', // react hooks的airbnb规范 'airbnb/hooks', './ts-base', ], ignorePatterns: [ 'node_modules/', 'dist/', ], overrides: [ { files: ['*.js?(x)', '*.ts?(x)', '*.json'], }, ], rules: { /* ********************************** React and Hooks ********************************** */ // ... /* ********************************** jax-a11y ********************************** */ // ... },}; ``` 复制[next.js](https://git.3rcd.com/classroom/classlts-temporary/src/branch/main/chapter2/packages/code/eslint/next.js)的规则。该规则继承自`ts-base.js`。相对于`react.js`,去除了`react-refresh/only-export-components`规则,添加了`plugin:@next/next/recommended`扩展。另外,不需要添加`ecmaFeatures`,因为`next/recommended`已带有。 ``` module.exports = { env: { node: true, browser: true, }, plugins: ['@typescript-eslint', 'import', 'unused-imports', 'prettier'], extends: [ // airbnb规范 'airbnb', // 兼容typescript的airbnb规范 'airbnb-typescript', // react hooks的airbnb规范 'airbnb/hooks', 'plugin:@next/next/recommended', './ts-base' ], ignorePatterns: [ 'node_modules/', 'dist/', ], overrides: [ { files: ['*.js?(x)', '*.ts?(x)', '*.json'], }, ], rules: { /* ********************************** React and Hooks ********************************** */ // ... /* ********************************** jax-a11y ********************************** */ // ... },}; ``` tsconfig的配置也不再赘述,直接复制[base.json](https://git.3rcd.com/classroom/classlts-temporary/src/branch/main/chapter2/packages/code/tsconfig/base.json)以及继承它的[node.json](https://git.3rcd.com/classroom/classlts-temporary/src/branch/main/chapter2/packages/code/tsconfig/node.json)、[react.json](https://git.3rcd.com/classroom/classlts-temporary/src/branch/main/chapter2/packages/code/tsconfig/react.json)、[next.json](https://git.3rcd.com/classroom/classlts-temporary/src/branch/main/chapter2/packages/code/tsconfig/next.json)的内容即可 接下来,配置一下vscode(**vscode配置请放在根目录**)。大体与前面课程的react和next.js配置是一样的(复制配置的[代码](https://git.3rcd.com/classroom/classlts-temporary/src/branch/main/chapter2/.vscode/settings.json)即可),但是需要加上eslint的工作空间 success 在创建turborepo项目的时候已经自动加上了 ``` // .vscode/settings.json{ "editor.formatOnSave": false, "editor.codeActionsOnSave": { "source.fixAll.eslint": "explicit", "source.fixAll.stylelint": "explicit" }, "eslint.workingDirectories": [ { "mode": "auto" } ], "css.validate": false, // ...} ``` 现在,我们尝试用我们配置的eslint和prettier格式化我们当前的`@3rapp/code`包自身的代码。在`packages/code`目录下,添加以下文件 ``` // packages/code/.eslintrc.jsmodule.exports = { root: true, extends: ['./eslint/lib'],};// packages/code/prettier.jsmodule.exports = require.resolve('./prettier') ``` 并复制源码中的[.eslintignore](https://git.3rcd.com/classroom/classlts-temporary/src/branch/main/chapter2/packages/code/.eslintignore)和[.prettierignore](https://git.3rcd.com/classroom/classlts-temporary/src/branch/main/chapter2/packages/code/.prettierignore)文件到该目录下 然后打开这个包里的文件,保存一下就可以自动格式化。当然,我们也可以在`packages/code/package.json`添加一个格式化命令 ``` { "scripts": { "lint": "eslint \"**/*.ts\" --fix" },} ``` 然后运行`pnpm lint --filter code`或者`pnpm lint`(此命令格式化全部包)就可以格式化 我们编写上面的代码格式化扩展包的目的在于,让其他应用或扩展包可以使用`@3rapp/code`而不必再单独配置各种复杂的代码格式化规则,以方便统一维护。现在,就来看一下如何让其他包或者根目录下使用这个包的格式化规则吧! 首先,把`@3rapp/code`中的文件暴露出来。在`packages/code/package.json`中添加`files` ``` { "name": "@3rapp/code", "version": "0.0.0", "private": true, "files": [ "eslint/*.js", "stylelint.js", "prettier.js", "tsconfig/*.json" ], // ...} ``` 然后,为全局安装eslint和prettier 信息 在全局安装,需要加上`-w`参数 ``` pnpm add eslint@^8.57.0 prettier -D -w ``` 再就是在根目录下的`package.json`中`@3rapp/code`的依赖,如下 ``` { // ... "devDependencies": { "@3rapp/code": "workspace:*", "eslint": "8.56.0", "prettier": "^3.2.5", "turbo": "latest" },} ``` 运行`pnpm i`就可以像安装第三方包一样链接扩展包。添加完包链接后,配置一下`.eslintrc.js`和`.prettierrc.js` 注意 注意:一定要加上`ignorePatterns: ['apps/**', 'packages/**']`,防止与每个包内的eslint冲突 ``` // .eslintrc.js/** @type {import("eslint").Linter.Config} */module.exports = { ignorePatterns: ['apps/**', 'packages/**'], extends: [require.resolve('@3rapp/code/eslint/lib')], parserOptions: { project: true, },};// .prettierrc.js/** @format */module.exports = require.resolve('@3rapp/code/prettier') ``` 然后把`packages/code`目录下的`.eslintignore`和`.prettierignore`复制到根目录下。 现在,重启vscode窗口,可以看到打开根目录下的文件已经可以自动格式化了 接下来,尝试链接扩展包到其它扩展包或应用中。 我们先把上一节课的[nestjs](https://git.3rcd.com/classroom/classlts-temporary/src/branch/main/chapter1/1-2)、[react](https://git.3rcd.com/classroom/classlts-temporary/src/branch/main/chapter1/1-3)、[next.js](https://git.3rcd.com/classroom/classlts-temporary/src/branch/main/chapter1/1-4)三个应用的源代码复制到`apps`目录中,并分别命名为`api`、`admin`、`web`用于开发服务端API、后台管理面板和网站前台。 然后,把他们各自的编译目录和vscode配置目录删除掉,运行以下命令 ``` rm -rf apps/**/.vscode apps/**/dist apps/**/.next ``` 把三个包中的`package.json`中的eslint、stylelint相关规则统统删除,仅保留eslint和stylelint以及prettier本身。然后把`"@3rapp/code": "workspace:*"`添加到每一个应用的`package.json`的`devDependencies`中。 注意 别忘了删除每个包的`package.json`中的`pnpm`配置 例如`apps/admin/package.json` ``` { //... "devDependencies": { "@3rapp/code": "workspace:*", "eslint": "^8.57.0", "stylelint": "^16.5.0", "prettier": "^3.2.5", "@types/node": "^20.12.12", "@types/react": "^18.3.2", "@types/react-dom": "^18.3.0", "autoprefixer": "^10.4.19", "postcss": "^8.4.38", "postcss-import": "^16.1.0", "postcss-mixins": "^10.0.1", "postcss-nested": "^6.0.1", "postcss-nesting": "^12.1.4", "tailwindcss": "^3.4.3", "typescript": "^5.4.5" }} ``` 运行`pnpm i`安装扩展包 然后修改三个包的eslint、prettier、stylelint、tsconfig.json配置, tsconfig配置如下 ``` // apps/api/tsconfig.json{ "extends": "@3rapp/code/tsconfig/node.json", "compilerOptions": { "baseUrl": ".", "outDir": "./dist", "paths": { "@/*": ["./src/*"] } }, "include": ["src", "test", "typings/**/*.d.ts", "**.js"]}// apps/admin/tsconfig.json{ "extends": "@3rapp/code/tsconfig/react.json", "compilerOptions": { "outDir": "./dist", "baseUrl": "./", "paths": { "@/*": ["src/*"] } }, "include": ["src"], "references": [{ "path": "./tsconfig.node.json" }]}// apps/web/tsconfig.json{ "extends": "@3rapp/code/tsconfig/next.json", "compilerOptions": { "paths": { "@/*": ["./src/*"] } }, "include": ["next-env.d.ts", "typings/**/*.d.ts", ".next/types/**/*.ts", "**/*.ts", "**/*.tsx"], "exclude": ["node_modules"]} ``` 格式化配置如下 ``` // apps/api/.eslintrc.js/** @type {import("eslint").Linter.Config} */module.exports = { root: true, parserOptions: { project: true, }, extends: [require.resolve('@3rapp/code/eslint/node')],};// apps/api/.prettierrc.js/** @format */module.exports = require.resolve('@3rapp/code/prettier')// apps/admin/.eslintrc.cjs/** @type {import("eslint").Linter.Config} */module.exports = { root: true, parserOptions: { project: './tsconfig.eslint.json', }, extends: [require.resolve('@3rapp/code/eslint/react')],};// apps/web/.eslintrc.js/** @type {import("eslint").Linter.Config} */module.exports = { root: true, parserOptions: { project: './tsconfig.eslint.json', }, extends: [require.resolve('@3rapp/code/eslint/next')],};// apps/api/.prettierrc.js、 apps/admin/.prettierrc.cjs 、apps/web/.prettierrc.js/** @format */module.exports = require.resolve('@3rapp/code/prettier')// apps/admin/.stylelintrc.cjs 、apps/web/.stylelintrc.jsmodule.exports = { extends: [require.resolve('@3rapp/code/stylelint')],}; ``` 重启vscode窗口,修改某个代码空两格,发现会报错,保存自动空四格,证明配置已经生效。运行`pnpm lint`命令尝试自动格式化 也可以修改几个应用的名称,比如`apps/admin/package.json`的`name`属性可以修改为 `"name": "@3rapp/admin",` 如果,一个包需要多个应用或其它扩展包引用。那么,有两种方式 - 对于ts编写的node包,需要先编译后再引用 - 对于前端包则直接可以导入 ### node包[](#node包 "node包的直接链接") 使用`pnpm gen --name @3rapp/utils`生成一个常用的自定义函数类库工具包。 为了编译出的js文件能给esm和commonjs通用(例如,vite和next.js的配置使用esm,而nestjs使用commonjs),我们需要一个叫做[bunchee](https://github.com/huozhi/bunchee)的工具 success 如果有兴趣也可以自行写个shell工具去生成 在包中安装该工具以及typescript、eslint和prettier ``` pnpm add typescript bunchee prettier eslint@^8.57.0 @types/node -D --filter utils ``` 然后按照[bunchee](https://github.com/huozhi/bunchee)的方法在`package.json`中配置编译脚本命令和导出结构 ``` { "name": "@3rapp/utils", "version": "0.0.0", "private": true, "files": [ "dist" ], "main": "./dist/cjs/index.cjs", "module": "./dist/es/index.mjs", "types": "./dist/cjs/index.d.ts", "typesVersions": { "*": { "*": [ "./dist/*", "./dist/index.d.ts" ] } }, "exports": { ".": { "import": { "types": "./dist/es/index.d.ts", "default": "./dist/es/index.mjs" }, "require": { "types": "./dist/cjs/index.d.cts", "default": "./dist/cjs/index.cjs" } } }, "scripts": { "dev": "bunchee -w --tsconfig tsconfig.build.json", "build": "bunchee --tsconfig tsconfig.build.json", "lint": "eslint . --ext ts,tsx" }, "devDependencies": { "bunchee": "^5.1.5", "eslint": "^8.57.0", "prettier": "^3.2.5" }} ``` 在`devDependencies`中添加上格式化配置依赖 `"@3rapp/code": "workspace:*"`,并使用`pnpm i`链接 把[apps/api](https://git.3rcd.com/classroom/classlts-temporary/src/branch/main/chapter2/apps/api)目录中的`tsconfig.json`、`tsconfig.build.json`、`.eslintrc.js`、`.prettierrc.js`、`.eslintignore`、`.prettierignore`、`.gitignore`几个文件复制一份到`packages/utils`目录下,因为这是一个与nestjs一样的node类库包 安装一下,这个包中编写的第一个函数用到的`deepmerge`库(`pnpm add deepmerge --filter utils`),把新增一个用于放置源码的`packages/utils/src`目录。然后重新加载vscode窗口 编写以下函数 ``` // packages/utils/src/utils/tools.tsimport deepmerge from 'deepmerge';/** * 深度合并对象 * @param x 初始值 * @param y 新值 * @param arrayMode 对于数组采取的策略,`replace`为直接替换,`merge`为合并数组 */export const deepMerge = <T1, T2>( x: Partial<T1>, y: Partial<T2>, arrayMode: 'replace' | 'merge' = 'merge',) => { const options: deepmerge.Options = {}; if (arrayMode === 'replace') { options.arrayMerge = (_d, s, _o) => s; } else if (arrayMode === 'merge') { options.arrayMerge = (_d, s, _o) => Array.from(new Set([..._d, ...s])); } return deepmerge(x, y, options) as T2 extends T1 ? T1 : T1 & T2;}; ``` 然后在`index.ts`把函数导出 ``` // packages/utils/src/index.tsexport * from './utils/tools'; ``` 怎么使用这个包呢? 先配置一下`turbo.json`,在`pipeline.build.outputs`中添加`"dist/**"`缓存编译任务。这可以在源码不变动的时候再次运行`build`而不会重复编译。因为这个包的函数暂时用于vite的配置生成(也许也有可能用在nestjs应用上)。所以,在启动vite应用或者nestjs应用的时候,我们需要预编译这个包。另外,每次在运行`api`的`dev`前可以先编译一遍这种依赖包,每次运行`admin`的`dev`前也需要先编译一下`@3rapp/utils`。可以如下配置`turbo.json` ``` { "$schema": "https://turbo.build/schema.json", "globalDependencies": ["**/.env.*local"], "pipeline": { "build": { "dependsOn": ["^build"], "outputs": [".next/**", "!.next/cache/**", "dist/**"] }, "lint": { "dependsOn": ["^lint"] }, "dev": { "cache": false, "persistent": true }, "@3rapp/api#dev": { "dependsOn": ["^build"] }, "@3rapp/admin#dev": { "dependsOn": ["@3rapp/utils#build"] } }} ``` 这样的配置,可以在启动vite+react应用或者nestjs应用时,也能预先编译`@3rapp/utils`。 现在,我们在`apps/api/package.json`的`dependencies`和`apps/admin/package.json`的`devDependencies`都添加`"@3rapp/utils": "workspace:*"`。运行`pnpm i`链接该包,然后先运行一次`utils`这个包的编译命令,不至于在一开始导入时报错 ``` pnpm build --filter utils ``` 重新加载vscode窗口 运行`pnpm remove deepmerge --filter admin` 修改`apps/admin/scripts/index.ts`,如下 ``` import { deepMerge } from '@3rapp/utils';// ...export const createConfig = (params: ConfigEnv, configure?: Configure): UserConfig => { const isBuild = params.command === 'build'; return deepMerge<UserConfig, UserConfig>( { resolve: { alias: { '@': resolve(__dirname, '../src'), }, }, // ... }, typeof configure === 'function' ? configure(params, isBuild) : {}, 'merge', );}; ``` 运行`pnpm dev --filter=admin` ### 包监控[](#包监控 "包监控的直接链接") 对于一些常用的node包,比如某个nestjs的模块,想做成独立包。这时候,每次启动应用时,这个扩展包必须先编译好。然后,在更改扩展包时,又得关闭应用,重新编译扩展包再启动应用,这样很是麻烦。接下来,我们来实现以下操作 - 同时启动扩展包和应用的`dev`的监控状态 - 在扩展包更改并编译后也会重启应用 要实现以上功能,我的方案是使用[nodemon](https://nodemon.io/)监控`utils`包的产出物(`api`包下的`node_modules/@3rapp/**/*.js`)并启动`nest start -w`,一旦有改变就重启该进程。 这需要编写一个ts执行文件,而该执行该文件,需要安装[bun](https://bun.sh/)。同时,安装[nodemon](https://nodemon.io/)用于监控启动`nest start --watch` ``` pnpm add bun nodemon @types/node -D --filter api ``` 在`tsconfig.json`添加一个`bin`目录,同时在`tsconfig.build.json`排除该目录 ``` // apps/server/tsconfig.json{ // ... "include": ["src", "bin", "test", "typings/**/*.d.ts", "**.js"]}// apps/server/tsconfig.build.json{ "extends": "./tsconfig.json", "exclude": ["node_modules", "bin", "test", "dist", "**/*spec.ts", "**.js", "**.mjs"]} ``` 编写一个启动文件 ``` // apps/api/bin/dev.tsimport nodemon from 'nodemon';nodemon({ script: 'node_modules/.bin/nest', args: [ 'start', '-c', 'nest-cli.json', '-p', 'tsconfig.build.json', '-w', '--preserveWatchOutput', ], watch: ['node_modules/@3rapp/**/dist/**/*'], ignore: [], ignoreRoot: [], ext: 'js',}).on('quit', () => { process.exit();}); ``` 修改`apps/api/package.json`的启动命令 ``` { "scripts": { "dev": "bun bin/dev.ts", // ... },} ``` 然后,添加对`api`和`utils`的同时`dev` ``` { "scripts": { "gen": "turbo gen workspace", "build": "turbo build", "dev": "turbo dev", "lint": "turbo lint", "api:dev": "turbo dev --filter=utils --filter=api", // ... },} ``` 现在,去除`turbo.json`中的`@3rapp/api#dev`这段,因为接下来,我们不需要预编译了 在`utils`包中添加一个工具函数 ``` // packages/utils/src/utils/tools.ts// ...export const echoTest = () => 'test'; ``` 然后在`api`应用中调用该函数 ``` // apps/server/src/app.service.tsimport { echoTest } from '@3rapp/utils';import { Injectable } from '@nestjs/common';@Injectable()export class AppService { getHello(): string { return echoTest(); }} ``` 然后运行`pnpm api:dev`启动应用,并打开[127.0.0.1](http://127.0.0.1/),可以看到显示"test"。再修改`echoTest`函数,让它输出`changed`。会发现`utils`包会监控编译,然后刷新浏览器会显示`changed`~  ### 前端包[](#前端包 "前端包的直接链接") 相对于后端node包来说,纯前端包就显得简单得多了。 使用`pnpm gen --name @3rapp/store`生成一个新包。 `packages/store/package.json`的配置如下 ``` { "name": "@3rapp/store", "version": "0.0.0", "private": true, "files": [ "dist" ], "main": "./src/index.ts", "exports": { ".": "./src/index.ts" }, "scripts": { "lint": "eslint . --ext ts,tsx" }, "devDependencies": { "@3rapp/code": "workspace:*", "@types/node": "^20.12.12", "eslint": "^8.57.0", "prettier": "^3.2.5", "typescript": "^5.4.5" }, "dependencies": { "react": "^18.3.1" }} ``` 这个包中,我们直接导出ts作为入口,并且取消了编译。因为前端直接使用ts导入编译成一个应用即可,没多大单独发包的需求。 然后这样配置TS(注意:`baseUrl`使用`src`) ``` // packages/store/tsconfig.json{ "extends": "@3rapp/code/tsconfig/react.json", "compilerOptions": { "baseUrl": "src", "paths": { "@/*": ["src/*"] } }, "include": ["src"]}// packages/store/tsconfig.eslint.json{ "extends": "./tsconfig.json", "include": ["./src", "./test", "./typings", "**.cjs"], "exclude": ["node_modules"]} ``` 代码格式化相关的配置文件直接复制[admin](https://git.3rcd.com/classroom/classlts-temporary/src/branch/main/chapter2/apps/admin)包的即可 然后,在`admin`包的`package.json`中添加这个包作为依赖 ``` { // ... "dependencies": { "@3rapp/store": "workspace:*", "react": "^18.3.1", "react-dom": "^18.3.1" },} ``` 运行`pnpm i`进行链接,并重启vscode窗口。在`apps/admin/src/app.tsx`中尝试使用这个包 ``` const App: FC = () => { return ( <div className={$styles.app}> <div className={$styles.container}> <h2 className="tw-text-center">First React App</h2> <div className="tw-flex tw-items-center tw-flex-col"> // ... <p>{createStore()}</p> </div> </div> </div> </div> );};export default App; ``` 运行`pnpm dev --filter admin`,然后打开[127.0.0.1:5173](http://127.0.0.1:5173/)查看效果  在next.js应用中使用这个包,需要多一步操作 在`apps/web/next.config.mjs`的`transpilePackages`中加上该包 ``` /** @type {import('next').NextConfig} */const nextConfig = { transpilePackages: ['@3rapp/store'],};export default nextConfig; ``` 然后修改`apps/admin/src/app.tsx` ``` const App: FC = () => { return ( // ... <main id="app"> <div className={$styles.container}> <div className={$styles.block}> // ... <p>{createStore()}</p> </div> </div> </main> );};export default App; ``` 运行`pnpm dev --filter web`,然后打开[127.0.0.1:3000](http://127.0.0.1:3000/)查看效果  ### 同构方法[](#同构方法 "同构方法的直接链接") monorepo不仅可以使前后端不同的应用之间使用同一个包,并且不同的应用中也可以互相使用它们建的模块、函数、类型等。 下面,我们尝试在`admin`应用中调用`api`的接口类型 先在`api`中返回一个`IPost`类型的文章列表 ``` // apps/api/src/types.tsexport interface IPost { id: number; title: string; body: string;}// apps/api/src/app.service.ts@Injectable()export class AppService { // ... async getPosts(): Promise<IPost[]> { return [{ id: 0, title: 'post1', body: 'post1' }]; }}// apps/api/src/app.controller.ts@Controller()export class AppController { // ... @Get('posts') getPosts(): Promise<IPost[]> { return this.appService.getPosts(); }} ``` 启用服务端跨域 ``` // apps/api/src/main.tsasync function bootstrap() { const app = await NestFactory.create(AppModule, { // 启用跨域访问 cors: true, }); await app.listen(3000);}bootstrap(); ``` 在`apps/api/package.json`中添加导出入口 ``` { "exports": { ".": { "import": "./dist/main.d.ts" }, "./*": "./dist/*.d.ts" },} ``` 然后先运行`pnpm build --filter api`编译一次`api`应用,或者直接运行`pnpm api:dev`启动`api` 在`apps/admin/package.json`中添加`@3rapp/api`依赖,并运行`pnpm i`和重载vscode窗口。 启用客户端代理并允许跨域访问 ``` // apps/admin/scripts/index.tsexport const createConfig = (params: ConfigEnv, configure?: Configure): UserConfig => { const isBuild = params.command === 'build'; return deepMerge<UserConfig, UserConfig>( { //... server: { proxy: { '/api': { target: 'http://localhost:3000', changeOrigin: true, rewrite: (path) => path.replace(/^\/api/, ''), }, }, cors: true, }, plugins: createPlugins(isBuild), }, // ... );}; ``` `pnpm add axios --filter admin`,然后在客户端中调用`IPost`接口,并通过`axios`获取数据 ``` // apps/admin/src/app.tsxconst getPosts = async (): Promise<IPost[]> => { const res = await fetch('/api/posts'); if (res.ok) return res.json(); throw new Error(res.statusText);};const App: FC = () => { const getPosts = async (): Promise<IPost[]> => { try { const res = await axios('/api/posts'); return res.data; } catch (err) { throw new Error(err as string); } }; return ( <div className={$styles.app}> <div className={$styles.container}> <h2 className="tw-text-center">First React App</h2> <div className="tw-flex tw-items-center tw-flex-col"> // ... <div className="tw-flex-auto tw-flex-col tw-my-5"> <h2>文章列表</h2> <ul> {data.map((item) => ( <li key={item.id}>{item.title}</li> ))} </ul> </div> </div> </div> </div> );};export default App; ``` 运行`pnpm dev --filter admin`启动`admin`查看效果  值得注意的是,在真实项目中,我们一般不会直接用这种前端应用导入后端应用类型的方法进行同构,而会采用以下方法(后续课程会使用) - 对于耦合性不是很敏感的项目,会把类型抽取到一个单独的库中(比如`@3rapp/types`)然后共用 - 稍微复杂的项目会使用open api文档生成类型给前端或者直接使用trpc这类进行同构 为了让monorepo变得更好用,我们进行少许改造 ### 应用改造[](#应用改造 "应用改造的直接链接") 实现以下几点 - 为了防止`web`应用和`api`应用端口冲突(默认都是`3000`),修改`api`应用端口为`8080`或者其它 - 减少日志输出,启动后端应用后在终端输出URL - 后端应用使用`/api`作为URL的前缀 - Vite静止刷新控制台(与`api`的`--preserveWatchOutput`一样) ``` // apps/api/src/main.ts// ...async function bootstrap() { const app = await NestFactory.create(AppModule, { // 启用跨域访问 cors: true, // 只使用error和warn这两种输出,避免在控制台冗余输出 logger: ['error', 'warn'], }); // 设置全局访问前缀 app.setGlobalPrefix('api'); // 关闭nestjs进程自动关闭mikroorm等进程 app.enableShutdownHooks(); // 启动后的输出 await app.listen(8080, () => { console.log(); console.log('api: http://localhost:8080/api'); });}bootstrap();// apps/admin/scripts/index.ts// ...export const createConfig = (params: ConfigEnv, configure?: Configure): UserConfig => { const isBuild = params.command === 'build'; return deepMerge<UserConfig, UserConfig>( { server: { proxy: { '/api': { target: 'http://localhost:8080/api', changeOrigin: true, rewrite: (path) => path.replace(/^\/api/, ''), }, }, cors: true, }, //... } );};// apps/admin/package.json{ "scripts": { "dev": "vite --no-clearScreen", // ... },} ``` ### 脚本命令[](#脚本命令 "脚本命令的直接链接") 添加几个常用命令 - 去除`format`命令,统一使用`lint`代替 - 添加`api:*`、`admin:*`、`web:*`几个包的单独命令 - 添加`api`包的`nest`命令,用于创建控制器等 ``` // apps/api/package.json{ "scripts": { "cli": "nest", //... },}// apps/admin/package.json{ "scripts": { "start": "pnpm preview", // ... },}// turbo.json{ "$schema": "https://turbo.build/schema.json", "globalDependencies": ["**/.env.*local"], "pipeline": { // ... "@3rapp/api#cli": { "cache": false }, }}// package.json{ "scripts": { "gen": "turbo gen workspace", "build": "turbo build", "dev": "turbo dev", "lint": "turbo lint", "api:dev": "turbo dev --filter=utils --filter=api", "api:build": "turbo build --filter=api", "api:start": "turbo start --filter=api", "api:cli": "turbo cli --filter=api --", "admin:dev": "turbo dev --filter=admin", "admin:build": "turbo dev --filter=build", "admin:start": "turbo start --filter=admin", "aa:dev": "turbo dev --filter=api --filter=admin", "web:dev": "turbo dev --filter=web", "web:build": "turbo build --filter=web", "web:start": "turbo start --filter=web", "wa:dev": "turbo dev --filter=api --filter=web" },} ``` 添加一键升级所有包以及一键删除所有`node_modules`的命令 ``` pnpm add rimraf -D -w ``` 修改根目录的`package.json` ``` { "name": "3rapp", "private": true, "scripts": { // ... "upall": "pnpm up --filter @3rapp/* --latest && pnpm up --latest", "clean": "rimraf --glob '**/node_modules' && rimraf node_modules" }, // ...} ``` 当前部分的课只是实现了一个基本的monorepo结构的项目,离最终可上线生产环境的项目还有非常大的距离。比如创建用于快速创建应用或扩展的模版、环境变量文件、真正的同构方案、数据库操作命令、如何CICD、代码提交前的lint等等。对于这些内容,我们将在后续的课程中一步步去完善和优化。无论如何,恭喜你,目前已经叩开TS全栈的开发大门!
peipeo
2026年11月8日 10:26
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
Markdown文件
PDF文档(打印)
分享
链接
类型
密码
更新密码