Umijs Father 项目使用教程

Umijs Father 项目使用教程

father NPM package development tool 项目地址: https://gitcode.com/gh_mirrors/fath/father

1. 项目目录结构及介绍

Umijs Father 是一款 NPM 包研发工具，其项目目录结构如下：

father/
├── .github/              # GitHub 配置目录
├── .husky/               # Husky 配置目录，用于 Git 钩子
├── bin/                  # 可执行文件目录
├── boilerplate/          # 项目模板目录
├── docs/                 # 文档目录
├── examples/             # 示例项目目录
├── scripts/              # 脚本目录
├── src/                  # 源代码目录
├── tests/                # 测试目录
├── .editorconfig          # 编辑器配置文件
├── .gitignore            # Git 忽略文件
├── .npmrc                # npm 配置文件
├── .prettierignore        # Prettier 忽略文件
├── .prettierrc.js         # Prettier 配置文件
├── CONTRIBUTING.md        # 贡献指南
├── LICENSE               # 许可证文件
├── README.md             # 项目说明文件
├── jest.config.ts        # Jest 配置文件
├── package.json          # 项目配置文件
├── pnpm-lock.yaml         # pnpm 锁文件
├── pnpm-workspace.yaml    # pnpm 工作区配置文件
└── tsconfig.json         # TypeScript 配置文件

每个目录和文件的作用如下：

• .github/: 包含 GitHub 仓库的配置文件。
• .husky/: 包含 Git 钩子的配置文件。
• bin/: 包含可以全局安装的命令行工具。
• boilerplate/: 包含项目模板。
• docs/: 包含项目文档。
• examples/: 包含使用 Father 的示例项目。
• scripts/: 包含项目的脚本文件。
• src/: 包含项目的主要源代码。
• tests/: 包含项目的测试代码。
• .editorconfig: 定义代码编辑器的配置。
• .gitignore: 指定 Git 应该忽略的文件和目录。
• .npmrc: 定义 npm 的配置。
• .prettierignore: 指定 Prettier 应该忽略的文件。
• .prettierrc.js: 定义 Prettier 的配置。
• CONTRIBUTING.md: 提供项目贡献指南。
• LICENSE: 项目使用的许可证。
• README.md: 项目的自述文件。
• jest.config.ts: Jest 测试框架的配置文件。
• package.json: 定义项目依赖和脚本。
• pnpm-lock.yaml: pnpm 的锁文件。
• pnpm-workspace.yaml: pnpm 的工作区配置文件。
• tsconfig.json: TypeScript 编译器的配置文件。

2. 项目的启动文件介绍

在 package.json 文件中定义了项目的启动脚本。通常，启动脚本会定义在 scripts 字段下。例如：

"scripts": {
  "start": "father-scripts start",
  "build": "father-scripts build",
  // 其他脚本...
}

在这里，start 脚本使用 father-scripts 工具启动项目。你可以通过运行 npm start 或者 yarn start 来执行这个脚本。

3. 项目的配置文件介绍

项目的配置文件主要集中在 package.json 和 tsconfig.json。

• package.json 文件中包含了项目的名称、版本、描述、关键词、作者、许可证、依赖、脚本等信息。这是 npm 的核心配置文件。

• tsconfig.json 文件是 TypeScript 项目的配置文件，它定义了 TypeScript 编译器的选项，例如包含的文件、排除的文件、编译选项等。

例如：

{
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    // 其他 TypeScript 编译选项...
  },
  "include": [
    "src/**/*"
  ],
  "exclude": [
    "node_modules",
    "**/*.spec.ts"
  ]
}

以上配置指定了 TypeScript 编译器将代码编译为 ES6 语法，使用 commonjs 模块系统，并开启了严格模式。同时，它包含了 src 目录下的所有文件，并排除了 node_modules 目录和所有 .spec.ts 测试文件。

father NPM package development tool 项目地址: https://gitcode.com/gh_mirrors/fath/father