From f6ecebb238b25d95ae11e8cb987faa84edef7654 Mon Sep 17 00:00:00 2001 From: PeachScript Date: Mon, 24 Oct 2022 21:59:08 +0800 Subject: [PATCH] docs: update cache & swc description --- README.md | 1 + docs/config.md | 6 +++--- docs/guide.md | 2 +- docs/guide/index.md | 3 ++- 4 files changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 65dd76e9..65b51545 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ father 是一款 NPM 包研发工具，能够帮助开发者更高效、高质 - ⚔️ **双模式构建：** 支持 Bundless 及 Bundle 两种构建模式，ESModule 及 CommonJS 产物使用 Bundless 模式，UMD 产物使用 Bundle 模式 - 🎛 **多构建核心：** Bundle 模式使用 Webpack 作为构建核心，Bundless 模式使用 esbuild 及 Babel 两种构建核心，可通过配置自由切换 - 🔖 **类型生成：** 无论是源码构建还是依赖预打包，都支持为 TypeScript 模块生成 `.d.ts` 类型定义 +- 🚀 **持久缓存：** 所有产物类型均支持持久缓存，二次构建或增量构建只需『嗖』的一下 - 🩺 **项目体检：** 对 NPM 包研发常见误区做检查，让每一次发布都更加稳健 - 🏗 **微生成器：** 为项目追加生成常见的工程化能力，例如使用 jest 编写测试 - 📦 **依赖预打包：** 开箱即用的依赖预打包能力，帮助 Node.js 框架/库提升稳定性、不受上游依赖更新影响（实验性） diff --git a/docs/config.md b/docs/config.md index c7f37c93..71f9a9fe 100644 --- a/docs/config.md +++ b/docs/config.md @@ -32,7 +32,7 @@ father 支持以下配置项。 指定要额外挂载的 babel 插件。 -> 注：在 Bundless 模式下、且 `transformer` 为 `esbuild` 时，该配置不生效。 +> 注：在 Bundless 模式下、且 `transformer` 为 `esbuild` 或 `swc` 时，该配置不生效。 ### extraBabelPresets @@ -41,7 +41,7 @@ father 支持以下配置项。 指定要额外挂载的 babel 插件集。 -> 注：在 Bundless 模式下、且 `transformer` 为 `esbuild` 时，该配置不生效。 +> 注：在 Bundless 模式下、且 `transformer` 为 `esbuild` 或 `swc` 时，该配置不生效。 ### platform @@ -88,7 +88,7 @@ father 以构建产物类型划分构建配置，其中 `esm`、`cjs` 产物为 #### transformer -- 类型：`babel` | `esbuild` +- 类型：`babel` | `esbuild` | `swc` - 默认值：`` 指定源码的编译工具，当 `platform` 为 `node` 时，默认值为 `esbuild`，当 `platform` 为 `browser` 时，默认值为 `babel`。 diff --git a/docs/guide.md b/docs/guide.md index b717503c..f8912be4 100644 --- a/docs/guide.md +++ b/docs/guide.md @@ -5,7 +5,7 @@ father 是一款 NPM 包研发工具，能够帮助开发者更高效、高质量地研发 NPM 包、生成构建产物、再完成发布。它主要具备以下特性： - ⚔️ **双模式构建：** 支持 Bundless 及 Bundle 两种构建模式，ESModule 及 CommonJS 产物使用 Bundless 模式，UMD 产物使用 Bundle 模式 -- 🎛 **多构建核心：** Bundle 模式使用 Webpack 作为构建核心，Bundless 模式使用 esbuild 及 Babel 两种构建核心，可通过配置自由切换 +- 🎛 **多构建核心：** Bundle 模式使用 Webpack 作为构建核心，Bundless 模式支持 esbuild、Babel 及 SWC 三种构建核心，可通过配置自由切换 - 🔖 **类型生成：** 无论是源码构建还是依赖预打包，都支持为 TypeScript 模块生成 `.d.ts` 类型定义 - 🩺 **项目体检：** 对 NPM 包研发常见误区做检查，让每一次发布都更加稳健 - 🏗 **微生成器：** 为项目追加生成常见的工程化能力，例如使用 jest 编写测试 diff --git a/docs/guide/index.md b/docs/guide/index.md index 21e8d4d6..2ba07c13 100644 --- a/docs/guide/index.md +++ b/docs/guide/index.md @@ -5,8 +5,9 @@ father 是一款 NPM 包研发工具，能够帮助开发者更高效、高质量地研发 NPM 包、生成构建产物、再完成发布。它主要具备以下特性： - ⚔️ **双模式构建：** 支持 Bundless 及 Bundle 两种构建模式，ESModule 及 CommonJS 产物使用 Bundless 模式，UMD 产物使用 Bundle 模式 -- 🎛 **多构建核心：** Bundle 模式使用 Webpack 作为构建核心，Bundless 模式使用 esbuild 及 Babel 两种构建核心，可通过配置自由切换 +- 🎛 **多构建核心：** Bundle 模式使用 Webpack 作为构建核心，Bundless 模式支持 esbuild、Babel 及 SWC 三种构建核心，可通过配置自由切换 - 🔖 **类型生成：** 无论是源码构建还是依赖预打包，都支持为 TypeScript 模块生成 `.d.ts` 类型定义 +- 🚀 **持久缓存：** 所有产物类型均支持持久缓存，二次构建或增量构建只需『嗖』的一下 - 🩺 **项目体检：** 对 NPM 包研发常见误区做检查，让每一次发布都更加稳健 - 🏗 **微生成器：** 为项目追加生成常见的工程化能力，例如使用 jest 编写测试 - 📦 **依赖预打包：** 开箱即用的依赖预打包能力，帮助 Node.js 框架/库提升稳定性、不受上游依赖更新影响（实验性）