{"id":38303892,"url":"https://github.com/bbcvc/monorepo","last_synced_at":"2026-01-17T02:25:48.269Z","repository":{"id":217059919,"uuid":"742664884","full_name":"bbcvc/monorepo","owner":"bbcvc","description":"从 0 到 1 构建一个 monorepo 项目","archived":false,"fork":false,"pushed_at":"2025-11-08T10:59:12.000Z","size":2117,"stargazers_count":13,"open_issues_count":0,"forks_count":6,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-11-08T12:22:53.856Z","etag":null,"topics":["monorepo","pnpm-monorepo"],"latest_commit_sha":null,"homepage":"https://infra.monorepo.cl96.top/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bbcvc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":["bbcvc"]}},"created_at":"2024-01-13T02:06:06.000Z","updated_at":"2025-09-16T10:14:16.000Z","dependencies_parsed_at":"2025-02-07T08:34:36.344Z","dependency_job_id":null,"html_url":"https://github.com/bbcvc/monorepo","commit_stats":null,"previous_names":["bbcvc/monorepo"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/bbcvc/monorepo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbcvc%2Fmonorepo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbcvc%2Fmonorepo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbcvc%2Fmonorepo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbcvc%2Fmonorepo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bbcvc","download_url":"https://codeload.github.com/bbcvc/monorepo/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bbcvc%2Fmonorepo/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28492275,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T00:50:05.742Z","status":"online","status_checked_at":"2026-01-17T02:00:07.808Z","response_time":85,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["monorepo","pnpm-monorepo"],"created_at":"2026-01-17T02:25:48.022Z","updated_at":"2026-01-17T02:25:48.248Z","avatar_url":"https://github.com/bbcvc.png","language":"TypeScript","funding_links":["https://github.com/sponsors/bbcvc"],"categories":[],"sub_categories":[],"readme":"# 构建monorepo最佳实践\n\n\u003e [!IMPORTANT]  \n\u003e 技术栈：pnpm rollup vite umi react18 typescript\n\n## 预览\ninfra：https://infra.monorepo.cl96.top/  \n\u003cimg width=\"1512\" alt=\"image\" src=\"https://github.com/user-attachments/assets/d638cd00-e735-40c9-a8af-5716f696ab8b\" /\u003e\n\nweb：https://web.monorepo.cl96.top/\n\u003cimg width=\"1512\" alt=\"image\" src=\"https://github.com/user-attachments/assets/bda6688c-ddee-4ba1-acd7-bfae7c262abf\" /\u003e\n\n\n## 一、从零开始构建 monorepo\n\n### 1. 初始化项目文件夹\n\n```bash\n// 项目根目录\nmkdir monorepo\ncd monorepo\n\npnpm init -y\n```\n\n### 2. 创建 pnpm-workspace.yaml\n\n写入以下内容，文件名为 `pnpm-workspace.yaml`  \n`pnpm-workspace.yaml`文件中的 `packages` 都会被作为 monorepo 的子模块\n\n```yaml\npackages:\n  - 'packages/**'\n  - 'apps/*'\n```\n\n`packages`下用来存放包\n\n`apps`下用来存放程序应用\n\n### 3. 创建子文件夹\n\n```bash\nmkdir packages\nmkdir apps\n```\n\n## 二、配置项目的格式化工具\n\n### 1. prettier\n\n\u003e prettier是什么？  \n\u003e 一个代码格式化工具，可以格式化任何代码，使代码更加美观，更加易于阅读，更加易于维护\n\ni. 安装\n\n```bash\npnpm add -D prettier --workspace-root\n```\n\nii. 配置\n\n```json\n{\n  \"singleQuote\": true,\n  \"jsxSingleQuote\": true,\n  \"semi\": false,\n  \"useTabs\": false,\n  \"tabWidth\": 2,\n  \"bracketSpacing\": true,\n  \"jsxBracketSameLine\": false,\n  \"arrowParens\": \"always\"\n}\n```\n\niii. 在 CI/CD 中自动格式化\n\n```bash\npnpm add -D lint-staged --workspace-root\n```\n\n`.lintstagedrc.json`\n\n```json\n{\n  \"**/*.{js,ts,jsx,tsx}\": [\"prettier --write\"]\n}\n```\n\n### 2. Editorconfig\n\n\u003e Editorconfig for VS Code 是什么？\n\u003e 一个用于编辑器的配置文件，可以自动格式化代码，使代码更加美观，更加易于阅读，更加易于维护。\n\n这是一个 VS Code 的插件，可以通过扩张商店安装\n\n配置如下：\n\n```\nroot = true\n\n[*]\ncharset=utf-8\nend_of_line=lf\ninsert_final_newline=true\nindent_style=space\nindent_size=2\nmax_line_length = 100\n\n[*.{yml,yaml,json}]\nindent_style = space\nindent_size = 2\n\n[*.md]\ntrim_trailing_whitespace = false\n\n[Makefile]\nindent_style = tab\n```\n\n## 三、在 `packages` 中创建一些模块\n\n### 1. icons\n\n\u003e `icons` 这个包用作项目的图标，因为一些 icon 库并不能完全满足产品或设计上的需求\n\u003e 使用 `@svgr/cli` 把 svg 转换成 tsx 文件，https://github.com/gregberge/svgr\n\n`svgr.config.js`\n\n```js\nmodule.exports = {\n  // 将 SVG 转换为适合图标的 React 组件\n  icon: true,\n\n  // 替换 SVG 中的颜色值\n  replaceAttrValues: {\n    '#063855': 'currentColor', // 将 #063855 替换为 currentColor\n  },\n\n  // 生成 TypeScript 组件\n  typescript: true,\n\n  // 自定义模板\n  template: (variables, { tpl }) =\u003e {\n    return tpl`\n      import React from 'react';\n      import { SVGProps } from 'react';\n\n      const ${variables.componentName} = (props: SVGProps\u003cSVGSVGElement\u003e) =\u003e (\n        ${variables.jsx}\n      );\n\n      export default ${variables.componentName};\n    `\n  },\n\n  // 自定义输出文件名和路径\n  outDir: 'dist', // 输出到 dist/icons 目录\n  filenameCase: 'kebab', // 文件名格式为 kebab-case（例如 home-icon.tsx）\n}\n```\n\n### 2. ui\n\n\u003e `ui` 这个包用作项目的基础组件，包括按钮，输入框，弹窗，等等；\n\u003e 使用 `rollup` 进行打包，https://rollupjs.org/。目的是为了在 `apps` 里使用的时候平衡开发体验，入在 `vite` 中引用这个组件库，减少多余的请求\n\ni. `rollup.config.js`\n\n```js\nimport { defineConfig } from 'rollup'\nimport commonjs from '@rollup/plugin-commonjs'\nimport postcss from 'rollup-plugin-postcss'\nimport { nodeResolve as resolve } from '@rollup/plugin-node-resolve'\nimport typescript from 'rollup-plugin-typescript2'\nimport { babel } from '@rollup/plugin-babel'\nimport { name } from './package.json'\nimport { dts } from 'rollup-plugin-dts'\n\nexport default defineConfig([\n  {\n    input: 'src/index.tsx',\n    external: ['react', 'react-dom'],\n    plugins: [\n      typescript({\n        declaration: true,\n        check: false, // https://github.com/ezolenko/rollup-plugin-typescript2/issues/214\n      }),\n      resolve({\n        extensions: ['.tsx', '.ts', '.js'],\n      }),\n      postcss({}),\n      babel({\n        babelrc: false,\n        exclude: '**/node_modules/**',\n        babelHelpers: 'runtime',\n        skipPreflightCheck: true,\n        presets: ['@babel/preset-react', '@babel/preset-env'],\n        plugins: [\n          '@babel/plugin-proposal-object-rest-spread',\n          '@babel/plugin-syntax-object-rest-spread',\n          '@babel/plugin-transform-react-jsx',\n          [\n            '@babel/plugin-transform-runtime',\n            {\n              absoluteRuntime: false,\n              corejs: false,\n              helpers: false,\n              regenerator: false,\n              useESModules: false,\n            },\n          ],\n        ],\n      }),\n      commonjs(),\n    ],\n    output: [\n      {\n        name,\n        file: './dist/index.js',\n        format: 'es',\n        globals: {\n          react: 'React',\n          'react-dom': 'ReactDOM',\n        },\n      },\n      {\n        name,\n        file: './dist/cjs/index.cjs',\n        format: 'commonjs',\n      },\n      {\n        name,\n        file: './dist/es/index.js',\n        format: 'es',\n      },\n    ],\n  },\n  {\n    input: 'src/index.tsx',\n    watch: true,\n    output: {\n      file: './dist/index.d.ts',\n      format: 'es',\n    },\n    plugins: [dts()],\n  },\n])\n```\n\nii. `package.json`\n\n```json\n{\n  \"name\": \"@monorepo/ui\",\n  \"version\": \"1.0.0\",\n  \"description\": \"An infrastructure monorepo ui library for all front-end apps.\",\n  \"type\": \"module\",\n  \"module\": \"dist/index.js\",\n  \"main\": \"dist/index.js\",\n  \"typings\": \"dist/index.d.ts\",\n  \"files\": [\n    \"dist/\"\n  ],\n  \"scripts\": {\n    \"start\": \"pnpm run dev\",\n    \"dev\": \"rollup --config rollup.config.js --watch\",\n    \"build\": \"rollup --config rollup.config.js\",\n    \"prepare\": \"pnpm run build\"\n  },\n  ...\n}\n```\n\n### 3. pro-components\n\n\u003e `pro-components` 这个包用作项目的业务组件，通常可能是基于多个 `ui` 组件的复合组件，以满足业务的需求\n\u003e 这个不做打包处理，在开发中多次打包体验也不好\n\n使用如下的配置，可以避免使用桶文件，同时也支持了快捷的引入，直接使用 `import ReactLogo from '@monorepo/pro-components/react-logo'`\n\n`package.json`\n\n```json\n{\n  \"name\": \"@monorepo/pro-components\",\n  \"description\": \"This is a pro-components.\",\n  \"private\": true,\n  \"version\": \"1.0.0\",\n  \"type\": \"module\",\n  // 这里的配置是为了支持使用 `import ReactLogo from '@monorepo/pro-components/react-logo'`\n  \"exports\": {\n    \"./*\": \"./*/index.tsx\"\n  },\n  \"sideEffects\": false,\n  \"keywords\": [],\n  \"author\": \"\",\n  \"license\": \"ISC\",\n  \"dependencies\": {\n    \"@monorepo/ui\": \"workspace:^\",\n    \"@monorepo/icons\": \"workspace:^\"\n  }\n}\n```\n\n### 4. shared\n\n\u003e 这里可以存放一些项目的公共函数或者配置，比如 `hooks`，`tsconfig` 等\n\n## 四、在 apps 下的项目中引入\n\n### 1. infra\n\n使用 `umi` 快速构建一个用于展示基础组件的项目\n\ni. 初始化\n\n```bash\npnpm dlx create-umi@latest\n```\n\nii. 安装`packages`下的依赖\n\n```bash\npnpm add @monorepo/ui @monorepo/icons @monorepo/pro-components --workspace\n```\n\n### 2. 一个业务项目\n\ni. 使用 `vite` 创建一个项目\n\n```bash\npnpm create vite my-vue-app --template react-ts\n```\n\nii. 安装`packages`下的依赖\n\n```bash\npnpm add @monorepo/ui @monorepo/icons @monorepo/pro-components --workspace\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbbcvc%2Fmonorepo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbbcvc%2Fmonorepo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbbcvc%2Fmonorepo/lists"}