Skip to content

Commit 4dce18c

Browse files
committed
docs: build enhance and cli config
1 parent 1cae314 commit 4dce18c

File tree

5 files changed

+1556
-20
lines changed

5 files changed

+1556
-20
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -435,6 +435,42 @@ You can use `stub: true` (per entry config) or the `--stub` CLI flag. In this mo
435435
>
436436
> Feedback and contributions are very welcome! If you'd like to make changes with more than a few lines of code, please open an issue first to discuss.
437437
438+
## 📚 Documentation
439+
440+
### 🎯 Guides
441+
- [Getting Started](./docs/guide/getting-started.md) - Get up and running in 5 minutes
442+
- [CLI Usage](./docs/guide/cli.md) - Complete command-line interface guide
443+
- [Configuration](./docs/guide/configuration.md) - Detailed configuration reference
444+
- [Build Modes](./docs/guide/build-modes.md) - Bundle vs Transform modes
445+
- [Watch Mode](./docs/guide/watch-mode.md) - Real-time development builds
446+
- [Stub Mode](./docs/guide/stub-mode.md) - Lightning-fast development mode
447+
- [TypeScript](./docs/guide/typescript.md) - TypeScript best practices
448+
- [ESM](./docs/guide/esm.md) - ES modules support
449+
- [Performance](./docs/guide/performance.md) - Build performance optimization
450+
451+
### 🔧 Feature Guides
452+
- [CLI & Config Enhancements](./docs/guide/cli-config-enhancements.md) - Multi-format output, platform targets, environment variables
453+
- [Build Enhancements](./docs/guide/build-enhancements.md) - File copying, hashing, banner/footer, extensions
454+
- [Development Experience](./docs/guide/dev-experience.md) - Success callbacks, watch optimization, Vite integration
455+
456+
### 🏢 Enterprise Features
457+
- [Enterprise Features](./docs/guide/enterprise.md) - Workspace, filtering, exports, migration
458+
- [Plugin System](./docs/guide/plugins.md) - Plugin development and usage
459+
- [Advanced Build Options](./docs/guide/advanced-build.md) - Loaders, shims, CJS handling
460+
- [Hooks](./docs/guide/hooks.md) - Build lifecycle hooks
461+
462+
### 📖 API Reference
463+
- [API Overview](./docs/api/index.md) - Programmatic API overview
464+
- [Configuration API](./docs/api/config.md) - Configuration options
465+
- [CLI API](./docs/api/cli.md) - Command-line interface
466+
- [Type Definitions](./docs/api/types.md) - TypeScript type definitions
467+
468+
### 🏗️ Architecture
469+
- [Core Architecture](./docs/architecture/core.md) - robuild core design
470+
- [Builders](./docs/architecture/builders.md) - Bundle and Transform builders
471+
- [Plugin System](./docs/architecture/plugins.md) - Plugin architecture design
472+
- [Performance](./docs/architecture/performance.md) - Performance optimization strategies
473+
438474
## Prior Arts
439475

440476
- [unbuild](https://github.com/unjs/unbuild): Stable solution based on rollup and [mkdist](https://github.com/unjs/mkdist).

TODO.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,23 @@
88

99
### 🔧 CLI 和配置增强
1010

11-
- [x] **多格式输出支持** - 支持 `esm`, `cjs`, `iife`, `umd` 多种输出格式
12-
- [x] **全局变量名配置** - 为 IIFE/UMD 格式指定全局变量名 (`globalName`)
13-
- [x] **平台目标配置** - 支持 `browser`, `node`, `neutral` 平台目标
14-
- [x] **目标环境配置** - 支持 ES 版本目标如 `es2015`, `esnext`
15-
- [x] **外部依赖配置** - 更灵活的 `external``noExternal` 配置
16-
- [x] **别名配置** - 模块路径别名支持 (`alias`)
17-
- [x] **环境变量注入** - 编译时环境变量定义 (`env`, `define`)
11+
- [x] **多格式输出支持** - 支持 `esm`, `cjs`, `iife`, `umd` 多种输出格式[文档](docs/guide/cli-config-enhancements.md#多格式输出支持)
12+
- [x] **全局变量名配置** - 为 IIFE/UMD 格式指定全局变量名 (`globalName`)[文档](docs/guide/cli-config-enhancements.md#全局变量名配置)
13+
- [x] **平台目标配置** - 支持 `browser`, `node`, `neutral` 平台目标[文档](docs/guide/cli-config-enhancements.md#平台目标配置)
14+
- [x] **目标环境配置** - 支持 ES 版本目标如 `es2015`, `esnext`[文档](docs/guide/cli-config-enhancements.md#目标环境配置)
15+
- [x] **外部依赖配置** - 更灵活的 `external``noExternal` 配置[文档](docs/guide/cli-config-enhancements.md#外部依赖配置)
16+
- [x] **别名配置** - 模块路径别名支持 (`alias`)[文档](docs/guide/cli-config-enhancements.md#别名配置)
17+
- [x] **环境变量注入** - 编译时环境变量定义 (`env`, `define`)[文档](docs/guide/cli-config-enhancements.md#环境变量注入)
1818

1919
### 🏗️ 构建功能增强
2020

21-
- [x] **清理功能** - 构建前自动清理输出目录 (`clean`)
22-
- [x] **文件复制** - 静态资源复制功能 (`copy`)
23-
- [x] **文件哈希** - 输出文件名哈希支持 (`hash`)
24-
- [x] **固定扩展名** - 强制使用 `.cjs`/`.mjs` 扩展名 (`fixedExtension`)
25-
- [x] **自定义扩展名** - 灵活的输出文件扩展名配置 (`outExtensions`)
26-
- [x] **Banner/Footer** - 文件头尾注释添加
27-
- [x] **Node.js 协议处理** - `node:` 前缀的添加/移除 (`nodeProtocol`)
21+
- [x] **清理功能** - 构建前自动清理输出目录 (`clean`)[文档](docs/guide/cli-config-enhancements.md#清理功能)
22+
- [x] **文件复制** - 静态资源复制功能 (`copy`)[文档](docs/guide/build-enhancements.md#文件复制功能)
23+
- [x] **文件哈希** - 输出文件名哈希支持 (`hash`)[文档](docs/guide/build-enhancements.md#文件哈希支持)
24+
- [x] **固定扩展名** - 强制使用 `.cjs`/`.mjs` 扩展名 (`fixedExtension`)[文档](docs/guide/build-enhancements.md#扩展名控制)
25+
- [x] **自定义扩展名** - 灵活的输出文件扩展名配置 (`outExtensions`)[文档](docs/guide/build-enhancements.md#扩展名控制)
26+
- [x] **Banner/Footer** - 文件头尾注释添加[文档](docs/guide/build-enhancements.md#bannerfooter-支持)
27+
- [x] **Node.js 协议处理** - `node:` 前缀的添加/移除 (`nodeProtocol`)[文档](docs/guide/build-enhancements.md#nodejs-协议处理)
2828

2929
#### 🎯 构建功能增强实现详情
3030

@@ -61,32 +61,32 @@
6161

6262
### 🔄 开发体验
6363

64-
- [x] **成功回调** - 构建成功后执行命令 (`onSuccess`)
64+
- [x] **成功回调** - 构建成功后执行命令 (`onSuccess`)[文档](docs/guide/dev-experience.md#成功回调功能)
6565
- 支持字符串命令和函数回调
6666
- CLI 支持 `--on-success` 参数
6767
- 完整的错误处理和测试覆盖
6868

69-
- [x] **忽略监听路径** - 监听模式下忽略特定路径 (`ignoreWatch`)
69+
- [x] **忽略监听路径** - 监听模式下忽略特定路径 (`ignoreWatch`)[文档](docs/guide/dev-experience.md#忽略监听路径)
7070
- 支持 glob 模式匹配
7171
- 默认忽略常见目录(node_modules, dist, .git 等)
7272
- CLI 支持 `--ignore-watch` 参数
7373

74-
- [x] **Vite 配置复用** - 从 Vite/Vitest 复用配置 (`fromVite`)
74+
- [x] **Vite 配置复用** - 从 Vite/Vitest 复用配置 (`fromVite`)[文档](docs/guide/dev-experience.md#vite-配置复用)
7575
- 自动检测 Vite 配置文件
7676
- 转换 Vite 配置到 robuild 格式
7777
- CLI 支持 `--from-vite` 参数
7878

79-
- [x] **调试模式** - 详细的调试日志输出
79+
- [x] **调试模式** - 详细的调试日志输出[文档](docs/guide/dev-experience.md#调试模式)
8080
- 通过 `logLevel: 'verbose'` 启用
8181
- 详细的构建过程日志
8282
- 功能执行状态跟踪
8383

84-
- [x] **日志级别控制** - 可配置的日志级别 (`logLevel`)
84+
- [x] **日志级别控制** - 可配置的日志级别 (`logLevel`)[文档](docs/guide/dev-experience.md#日志级别控制)
8585
- 支持 silent, error, warn, info, verbose 级别
8686
- CLI 支持 `--log-level` 参数
8787
- 全局日志配置和计数功能
8888

89-
- [x] **构建失败处理** - 警告时失败选项 (`failOnWarn`)
89+
- [x] **构建失败处理** - 警告时失败选项 (`failOnWarn`)[文档](docs/guide/dev-experience.md#构建失败处理)
9090
- 可配置警告时构建失败
9191
- CLI 支持 `--fail-on-warn` 参数
9292
- 警告和错误计数跟踪

0 commit comments

Comments
 (0)