《UMIJS Father 项目安装与配置指南》

《UMIJS Father 项目安装与配置指南》

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

1. 项目基础介绍

UMIJS Father 是一款专为 NPM 包研发设计的工具。它能够帮助开发者高效地研发、构建、生成产物以及发布 NPM 包。Father 支持两种构建模式——Bundless 和 Bundle，适用于不同类型的产物构建。项目主要使用 TypeScript 编程语言。

2. 项目使用的关键技术和框架

• 构建模式：支持 Bundless（无打包）和 Bundle（打包）两种模式，Bundless 模式适用于 ESModule 和 CommonJS 产物，Bundle 模式适用于 UMD 产物。
• 构建核心：Bundle 模式使用 Webpack 作为构建核心，Bundless 模式则支持 esbuild、Babel 和 SWC 三种构建核心。
• 类型生成：为 TypeScript 模块生成 .d.ts 类型定义文件。
• 持久缓存：所有产物类型均支持持久缓存，提高构建效率。
• 项目体检：对 NPM 包研发中的常见误区进行检查。
• 微生成器：为项目追加生成常见的工程化能力，如测试、文档等。
• 依赖预打包：提供实验性的依赖预打包能力。

3. 项目安装和配置的准备工作

在开始安装和配置 UMIJS Father 项目之前，请确保您的环境中已经安装了以下依赖：

• Node.js（推荐使用 LTS 版本）
• npm 或者 yarn

确保您的 Node.js 和 npm/yarn 是最新版本的，这将有助于避免兼容性问题。

3.1 详细安装步骤

1. 克隆项目

   在您的本地开发环境中，使用 Git 命令克隆项目：

   git clone https://github.com/umijs/father.git
   

2. 进入项目目录

   克隆完成后，进入项目目录：

   cd father
   

3. 安装依赖

   在项目目录中，运行以下命令安装项目依赖：

   npm install
   

   或者，如果您使用 yarn：

   yarn
   

4. 构建项目

   依赖安装完成后，可以构建项目以查看其结构：

   npm run build
   

   或者，使用 yarn：

   yarn build
   

5. 运行项目

   构建完成后，运行以下命令启动项目：

   npm start
   

   或者，使用 yarn：

   yarn start
   

按照上述步骤，您可以成功安装和配置 UMIJS Father 项目。接下来，您可以开始探索和开发该项目，根据自己的需要调整配置和代码。

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