@thinkbun/plugin 1.0.6 → 1.0.7

package/README.md

@@ -1,240 +1,240 @@
 # ThinkBun Plugin
 
-ThinkBun 框架的官方插件集合，提供常用的功能扩展，包括日志增强和服务器集群支持。
+The official plugin collection for ThinkBun framework, providing common functional extensions including enhanced logging and server cluster support.
 
-## 子项目概述
+## Subproject Overview
 
-Plugin 包提供了 ThinkBun 框架的官方插件实现，这些插件可以直接集成到 ThinkBun 应用程序中，为应用提供额外的功能。当前版本包含日志插件和服务器插件，后续将添加更多官方插件。
+The Plugin package provides official plugin implementations for the ThinkBun framework. These plugins can be directly integrated into ThinkBun applications, providing additional functionality. The current version includes a logger plugin and a server plugin, with more official plugins to be added in the future.
 
-## 与主项目的关系
+## Relationship with Main Project
 
-Plugin 包依赖于 ThinkBun Core 包，为其提供扩展功能。这些插件遵循 Core 包定义的插件接口和生命周期，与框架无缝集成。
+The Plugin package depends on the ThinkBun Core package, providing extension functionality for it. These plugins follow the plugin interface and lifecycle defined by the Core package, seamlessly integrating with the framework.
 
-## 核心插件
+## Core Plugins
 
 ### LoggerPlugin
 
-增强应用程序的日志功能，支持彩色输出、作用域标识和不同日志级别。
+Enhances application logging functionality with support for colored output, scope identifiers, and different log levels.
 
-#### 功能特性
+#### Features
 
-- 彩色日志输出，提高可读性
-- 支持日志作用域标识
-- 自定义日志级别
-- 与框架日志系统无缝集成
+- Colored log output for improved readability
+- Support for log scope identifiers
+- Custom log levels
+- Seamless integration with framework logging system
 
-#### 安装
+#### Installation
 
 ```bash
-# 使用 Bun
+# Using Bun
 bun add @thinkbun/plugin
 
-# 使用 npm
+# Using npm
 npm install @thinkbun/plugin
 
-# 使用 yarn
+# Using yarn
 yarn add @thinkbun/plugin
 ```
 
-#### 使用方法
+#### Usage
 
 ```typescript
 import { createApplication } from '@thinkbun/core';
 import { LoggerPlugin } from '@thinkbun/plugin';
 
-// 创建应用实例
+// Create application instance
 const app = await createApplication({
   APP_PATH: './src',
   ROOT_PATH: __dirname,
 });
 
-// 注册 LoggerPlugin
+// Register LoggerPlugin
 app.loader.plugins.push(LoggerPlugin);
 
-// 设置应用
+// Setup application
 await app.setup();
 
-// 使用增强的日志功能
-app.logger.info('应用程序已启动');
-app.logger.error('发生错误', 'ErrorScope');
-app.logger.debug('调试信息', ['Debug', 'Detail']);
-app.logger.warn('警告信息');
+// Use enhanced logging
+app.logger.info('Application started');
+app.logger.error('An error occurred', 'ErrorScope');
+app.logger.debug('Debug information', ['Debug', 'Detail']);
+app.logger.warn('Warning message');
 ```
 
-#### 日志方法
+#### Log Methods
 
-- `app.logger.info(message, scope)`: 输出信息级别的日志
-- `app.logger.error(message, scope)`: 输出错误级别的日志
-- `app.logger.debug(message, scope)`: 输出调试级别的日志
-- `app.logger.warn(message, scope)`: 输出警告级别的日志
+- `app.logger.info(message, scope)`: Output information-level log
+- `app.logger.error(message, scope)`: Output error-level log
+- `app.logger.debug(message, scope)`: Output debug-level log
+- `app.logger.warn(message, scope)`: Output warning-level log
 
-**参数**：
+**Parameters**:
 
-- `message`: 日志消息内容
-- `scope`: 可选，日志作用域，可以是字符串或字符串数组
+- `message`: Log message content
+- `scope`: Optional, log scope, can be a string or string array
 
 ### ServerPlugin
 
-提供服务器启动和集群支持功能，优化应用程序的性能和可靠性。
+Provides server startup and cluster support functionality, optimizing application performance and reliability.
 
-#### 功能特性
+#### Features
 
-- 基于 Bun.serve 的高性能服务器
-- 自动集群管理，充分利用多核 CPU
-- 工作进程自动重启
-- 优雅的关闭流程
-- 配置化的服务器参数
+- High-performance server based on Bun.serve
+- Automatic cluster management, fully utilizing multi-core CPUs
+- Automatic worker process restart
+- Graceful shutdown process
+- Configurable server parameters
 
-#### 安装
+#### Installation
 
 ```bash
-# 使用 Bun
+# Using Bun
 bun add @thinkbun/plugin
 
-# 使用 npm
+# Using npm
 npm install @thinkbun/plugin
 
-# 使用 yarn
+# Using yarn
 yarn add @thinkbun/plugin
 ```
 
-#### 使用方法
+#### Usage
 
 ```typescript
 import { createApplication } from '@thinkbun/core';
 import { ServerPlugin } from '@thinkbun/plugin';
 
-// 创建应用实例
+// Create application instance
 const app = await createApplication({
   APP_PATH: './src',
   ROOT_PATH: __dirname,
 });
 
-// 注册 ServerPlugin
+// Register ServerPlugin
 app.loader.plugins.push(ServerPlugin);
 
-// 设置应用
+// Setup application
 await app.setup();
 
-// 运行应用（ServerPlugin 会自动启动服务器）
+// Run application (ServerPlugin will automatically start the server)
 await app.run();
 ```
 
-#### 配置选项
+#### Configuration Options
 
-在应用配置文件中配置服务器参数：
+Configure server parameters in the application configuration file:
 
 ```typescript
 // src/config/index.ts
 export default {
-  port: 3000,           // 服务器端口
-  host: '0.0.0.0',      // 服务器主机
-  workers: 4,           // 工作进程数量，默认自动检测 CPU 核心数
-  // 其他配置...
+  port: 3000,           // Server port
+  host: '0.0.0.0',      // Server host
+  workers: 4,           // Number of worker processes, defaults to auto-detecting CPU cores
+  // Other configurations...
 };
 ```
 
-#### 集群模式
+#### Cluster Mode
 
-ServerPlugin 自动支持集群模式：
+ServerPlugin automatically supports cluster mode:
 
-- 主进程管理工作进程的创建和重启
-- 工作进程处理实际的 HTTP 请求
-- 当工作进程意外退出时，自动创建新的工作进程
-- 支持优雅关闭，确保请求处理完成后再退出
+- Master process manages worker process creation and restarts
+- Worker processes handle actual HTTP requests
+- When a worker process exits unexpectedly, a new worker process is automatically created
+- Supports graceful shutdown, ensuring requests are completed before exiting
 
-## 插件生命周期
+## Plugin Lifecycle
 
-### LoggerPlugin 生命周期
+### LoggerPlugin Lifecycle
 
-| 阶段    | 执行顺序 | 功能                           |
-| ------- | -------- | ------------------------------ |
-| `setup` | `pre`    | 初始化日志功能，替换默认日志器 |
-| `run`   | -        | 无                             |
-| `close` | -        | 无                             |
+| Phase | Execution Order | Functionality                           |
+| ------ | --------------- | -------------------------------------- |
+| `setup` | `pre`            | Initialize logging, replace default logger |
+| `run`   | -                | None                                    |
+| `close` | -                | None                                    |
 
-### ServerPlugin 生命周期
+### ServerPlugin Lifecycle
 
-| 阶段    | 执行顺序 | 功能                             |
-| ------- | -------- | -------------------------------- |
-| `setup` | -        | 无                               |
-| `run`   | `post`   | 启动服务器，根据配置创建工作进程 |
-| `close` | -        | 优雅关闭服务器和工作进程         |
+| Phase | Execution Order | Functionality                             |
+| ------ | --------------- | ---------------------------------------- |
+| `setup` | -                | None                                      |
+| `run`   | `post`           | Start server, create worker processes      |
+| `close` | -                | Gracefully shutdown server and workers      |
 
-## 独立运行/测试
+## Standalone Running/Testing
 
-### 运行示例
+### Running Examples
 
 ```bash
-# 安装依赖
+# Install dependencies
 bun install
 
-# 运行测试
+# Run tests
 bun test
 ```
 
-### 测试
+### Testing
 
 ```bash
-# 运行单元测试
+# Run unit tests
 bun test
 
-# 运行测试并生成覆盖率报告
+# Run tests and generate coverage report
 bun test --coverage
 ```
 
-## 自定义插件开发
+## Custom Plugin Development
 
-Plugin 包不仅提供官方插件，还展示了如何开发自定义插件。以下是开发自定义插件的示例：
+The Plugin package not only provides official plugins but also demonstrates how to develop custom plugins. Here's an example of developing a custom plugin:
 
 ```typescript
 import { type Plugin } from '@thinkbun/core';
 
 export const CustomPlugin: Plugin = {
   name: 'CustomPlugin',
-  enforce: 'pre',  // 插件执行顺序，可以是 'pre'、'post' 或省略
+  enforce: 'pre',  // Plugin execution order, can be 'pre', 'post', or omitted
   setup(app) {
-    // 插件初始化逻辑
-    console.log('CustomPlugin 初始化');
+    // Plugin initialization logic
+    console.log('CustomPlugin initialized');
   },
   run(app) {
-    // 应用运行时逻辑
-    console.log('CustomPlugin 运行中');
+    // Application runtime logic
+    console.log('CustomPlugin running');
   },
   close(app) {
-    // 应用关闭时清理逻辑
-    console.log('CustomPlugin 已关闭');
+    // Cleanup logic when application closes
+    console.log('CustomPlugin closed');
   },
 };
 ```
 
-## 插件执行顺序
+## Plugin Execution Order
 
-插件的执行顺序由 `enforce` 属性决定：
+Plugin execution order is determined by the `enforce` property:
 
-- `pre`: 在核心功能之前执行
-- `post`: 在核心功能之后执行
-- 省略: 默认执行顺序
+- `pre`: Execute before core functionality
+- `post`: Execute after core functionality
+- Omitted: Default execution order
 
-## 最佳实践
+## Best Practices
 
-1. **插件注册**：
-   - 将插件注册放在 `plugins.ts` 文件中，集中管理
-   - 按照依赖关系和执行顺序注册插件
+1. **Plugin Registration**:
+   - Place plugin registration in the `plugins.ts` file for centralized management
+   - Register plugins in dependency order and execution order
 
-2. **插件配置**：
-   - 将插件配置放在应用配置文件中
-   - 支持环境特定的配置
+2. **Plugin Configuration**:
+   - Place plugin configuration in the application configuration file
+   - Support environment-specific configuration
 
-3. **错误处理**：
-   - 在插件中添加适当的错误处理
-   - 提供清晰的错误信息
+3. **Error Handling**:
+   - Add appropriate error handling in plugins
+   - Provide clear error messages
 
-4. **性能考虑**：
-   - 避免在插件中执行耗时操作
-   - 合理使用插件生命周期阶段
+4. **Performance Considerations**:
+   - Avoid executing time-consuming operations in plugins
+   - Use plugin lifecycle stages appropriately
 
-## API 参考
+## API Reference
 
 ### LoggerPlugin
 
@@ -257,54 +257,54 @@ interface Plugin {
 }
 ```
 
-## 常见问题
+## FAQ
 
-### Q: 如何自定义日志颜色？
+### Q: How to customize log colors?
 
-A: 目前 LoggerPlugin 支持的颜色是预定义的，可以通过修改源代码来自定义：
+A: Currently LoggerPlugin supports predefined colors. You can customize by modifying the source code:
 
 ```typescript
-// 在 logger.ts 中修改 colorMap 对象
+// Modify colorMap object in logger.ts
 const colorMap = {
   app: 'yellow',
   PluginManager: 'yellow',
-  // 添加自定义颜色映射
+  // Add custom color mappings
   CustomScope: 'cyan',
 };
 ```
 
-### Q: 如何配置服务器端口？
+### Q: How to configure server port?
 
-A: 在应用配置文件中设置 `port` 选项：
+A: Set the `port` option in the application configuration file:
 
 ```typescript
 // src/config/index.ts
 export default {
-  port: 8080,  // 设置为不同的端口
+  port: 8080,  // Set to a different port
 };
 ```
 
-### Q: 如何禁用集群模式？
+### Q: How to disable cluster mode?
 
-A: 在应用配置文件中将 `workers` 设置为 1：
+A: Set `workers` to 1 in the application configuration file:
 
 ```typescript
 // src/config/index.ts
 export default {
-  workers: 1,  // 禁用集群模式，只使用一个进程
+  workers: 1,  // Disable cluster mode, use only one process
 };
 ```
 
-## 许可证
+## License
 
 [MIT License](LICENSE)
 
-## 联系方式
+## Contact
 
-- 📧 邮箱：contact@thinkbun.dev
-- 📦 GitHub：[https://github.com/thinkbun/thinkbun](https://github.com/thinkbun/thinkbun)
-- 💬 Discord：[ThinkBun Community](https://discord.gg/thinkbun)
+- 📧 Email: contact@thinkbun.dev
+- 📦 GitHub: [https://github.com/thinkbun/thinkbun](https://github.com/thinkbun/thinkbun)
+- 💬 Discord: [ThinkBun Community](https://discord.gg/thinkbun)
 
 ---
 
-**ThinkBun Plugin** - 为 ThinkBun 框架提供强大的扩展功能 🧩
+**ThinkBun Plugin** - Providing powerful extension functionality for ThinkBun framework 🧩

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thinkbun/plugin",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "type": "module",
   "exports": {
     ".": "./dist/index.mjs",