From 2c2d3bc126aeb9dfe18a7ab19bdf91406dfcf7bc Mon Sep 17 00:00:00 2001 From: Ramu Narasinga Date: Sat, 15 Feb 2025 14:56:54 +0530 Subject: [PATCH] docs: translated docs to english --- README.en-US.md | 20 +++++++++++++++ docs/guide/index.en-US.md | 54 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 74 insertions(+) create mode 100644 README.en-US.md create mode 100644 docs/guide/index.en-US.md diff --git a/README.en-US.md b/README.en-US.md new file mode 100644 index 00000000..f6d123f6 --- /dev/null +++ b/README.en-US.md @@ -0,0 +1,20 @@ +# father + +[![version](https://badgen.net/npm/v/father)](https://www.npmjs.com/package/father) [![codecov](https://codecov.io/gh/umijs/father/branch/master/graph/badge.svg)](https://codecov.io/gh/umijs/father) [![GitHub Actions status](https://github.com/umijs/father/workflows/CI/badge.svg)](https://github.com/umijs/father) + +**Father** is an NPM package development tool that helps developers efficiently and reliably develop NPM packages, generate build artifacts, and publish them. It offers the following key features: + +โš”๏ธ **Dual-mode Build**: Supports both **Bundless** and **Bundle** build modesโ€”ESModule and CommonJS outputs use Bundless mode, while UMD outputs use Bundle mode. +๐ŸŽ› **Multiple Build Engines**: Bundle mode uses **Webpack** as the build engine, while Bundless mode supports **esbuild, Babel, and SWC**, allowing flexible configuration switching. +๐Ÿ”– **Type Generation**: Supports generating `.d.ts` type definitions for TypeScript modules, whether for source code builds or dependency pre-bundling. +๐Ÿš€ **Persistent Caching**: All output types support persistent caching, enabling faster incremental builds. +๐Ÿฉบ **Project Inspection**: Checks for common pitfalls in NPM package development to ensure more stable releases. +๐Ÿ— **Micro Generators**: Adds commonly used engineering capabilities to projects, such as setting up Jest for testing. +๐Ÿ“ฆ **Dependency Pre-Bundling**: Provides out-of-the-box dependency pre-bundling to improve the stability of Node.js frameworks/libraries and prevent issues caused by upstream dependency updates (experimental). + +Visit the **Guide** and **Configuration** sections for more details. + +If you're looking for documentation for older versions of **father/father-build**, switch to the **2.x** branch. It is recommended to check the **Upgrade Guide** to migrate to **Father 4** for an improved development experience. + +### Contribution Guide +Refer to the **CONTRIBUTING** document. diff --git a/docs/guide/index.en-US.md b/docs/guide/index.en-US.md new file mode 100644 index 00000000..045be8ff --- /dev/null +++ b/docs/guide/index.en-US.md @@ -0,0 +1,54 @@ +# Guide + +## Introduction + +**Father** is an NPM package development tool that helps developers efficiently and reliably develop NPM packages, generate build artifacts, and publish them. It offers the following key features: + +- โš”๏ธ **Dual-mode Build**: Supports both **Bundless** and **Bundle** build modesโ€”ESModule and CommonJS outputs use Bundless mode, while UMD outputs use Bundle mode. +- ๐ŸŽ› **Multiple Build Engines**: Bundle mode uses **Webpack** as the build engine, while Bundless mode supports **esbuild, Babel, and SWC**, allowing flexible configuration switching. +- ๐Ÿ”– **Type Generation**: Supports generating `.d.ts` type definitions for TypeScript modules, whether for source code builds or dependency pre-bundling. +- ๐Ÿš€ **Persistent Caching**: All output types support persistent caching, enabling faster incremental builds. +- ๐Ÿฉบ **Project Inspection**: Checks for common pitfalls in NPM package development to ensure more stable releases. - +- ๐Ÿ— **Micro Generators**: Adds commonly used engineering capabilities to projects, such as setting up Jest for testing. +- ๐Ÿ“ฆ **Dependency Pre-Bundling**: Provides out-of-the-box dependency pre-bundling to improve the stability of Node.js frameworks/libraries and prevent issues caused by upstream dependency updates (experimental). + +--- + +#### **Compatibility** + +- **Father** requires **Node.js v14 or later** to run. Please ensure that you have Node.js **v14+** installed before using it. +- The **default Node.js output** from Father is compatible with **Node.js v14+**. +- **Browser output** is compatible with **ES5 (IE11)** by default. + +--- + +#### **Quick Start** + +Use `create-father` to quickly create a new **Father** project: + +```sh +npx create-father my-father-project +``` + +This template includes only the basic configuration. For additional configuration options, refer to the **Configuration** documentation. + +To build the project, run: + +```sh +npx father build +``` + +After the build completes, check the `dist` folder to see the generated output. **Congratulations!** ๐ŸŽ‰ You've successfully built your first Father project! + +--- + +#### **Next Steps** + +Explore more features of **Father**: +- **Bundless vs. Bundle build modes** +- **Building ESModule & CommonJS outputs** +- **Building UMD outputs** +- **Dependency pre-bundling** +- **Running project inspections** +- **Development guide** +- **Publishing guide**