3.7 KiB
贡献指南
概览
项目仓库借助于 Yarn Classic 工作区 来实现 Monorepo ，在 packages 目录下存放了多个互相关联的独立 Package 。
-
@vuepress/core: Core 模块。提供 Node API 来创建 VuePress App ，包括页面逻辑、插件系统、数据准备等功能。 -
@vuepress/client: Client 模块。包含客户端页面入口，并提供了客户端开发时可以用到的类型和工具函数。 -
@vuepress/bundler-webpack: 基于 Webpack 的 Bundler 模块。使用 Webpack 对 VuePress App 执行dev和build操作。 -
@vuepress/cli: 命令行接口 (CLI) 模块。包含解析用户配置文件、调用@vuepress/core创建 VuePress App 、调用@vuepress/bundler-${name}来执行对应命令等功能。 -
@vuepress/theme-default: 默认主题。 -
@vuepress/plugin-${name}: 官方插件。 -
@vuepress/shared: 既可以在 Node 端使用、也可以在客户端使用的工具函数模块。 -
@vuepress/utils: 仅可以在 Node 端使用的工具函数模块。 -
vuepress: 是@vuepress/cli+@vuepress/bundler-webpack+@vuepress/theme-default的简单封装。如果用户想使用 默认主题 + Webpack ，仅安装这个 Package 就可以了。
开发配置
开发要求：
- Node.js version 12+
- Yarn v1 classic
克隆代码仓库，并安装依赖：
yarn
监听源文件修改：
yarn dev
打开另一个终端，开始开发项目文档网站：
yarn docs:dev
本项目开发使用的一些主要工具：
- TypeScript 作为开发语言
- Jest 用于单元测试
- ESLint + Prettier 用于代码检查和格式化
开发脚本
yarn build
build 命令会使用 tsc 将 TS 源文件编译为 JS 文件。
你在克隆代码仓库后，可能需要先执行该命令来确保项目代码可以顺利运行，因为编译后的 JS 文件被 .gitignore 排除在仓库以外了。
yarn copy
copy 命令会执行所有子 Package 中的 copy 命令，将一些资源文件从源代码目录复制到输出目录。
一些资源文件（如 .vue, .styl 文件等）不能被 build 命令处理，但是同样需要将他们放置到输出目录中。
你在克隆代码仓库后，可能也需要先执行该命令来确保项目代码可以顺利运行。
yarn dev
dev 命令使用监听 (watch) 模式执行 copy 和 build 命令。
yarn clean
clean 命令会执行所有子 Package 中的 clean 命令，清除所有的输出文件目录和缓存文件。换言之，它将移除所有通过 build 和 copy 命令生成的文件。
当你想要从最初状态重新构建源代码时，你可以执行该命令。
yarn docs:*
yarn docs:build, yarn docs:dev, yarn docs:clean
docs: 前缀表明，这些命令是针对文档 (documentation) 进行操作的，即 docs 目录。
VuePress 使用它自己来构建自己的文档网站。
你需要先执行 yarn build && yarn copy 来构建 VuePress 源代码，然后再运行这些 docs: 开头的命令来开发或构建文档。
yarn docs:serve
在本地启动文档网站服务器。
你需要先运行 yarn docs:build 来生成文档网站的输出文件，然后再通过该命令来启动文档网站。
yarn lint
lint 命令使用 ESLint 来检查所有源文件。
yarn test
test 命令使用 Jest 来运行单元测试。