mm_statics 1.8.9 → 1.9.1

package/README.md

@@ -24,12 +24,12 @@ npm install mm_statics
 
 ```javascript
 const Koa = require('koa');
-const static = require('mm_statics');
+const { statics } = require('mm_statics');
 
 const app = new Koa();
 
-// 使用默认配置
-app.use(static());
+// 使用默认配置（root 为 ./static）
+app.use(statics({ root: './static' }));
 
 app.listen(3000, () => {
   console.log('服务器运行在 http://localhost:3000');
@@ -40,12 +40,12 @@ app.listen(3000, () => {
 
 ```javascript
 const Koa = require('koa');
-const { static } = require('mm_statics');
+const { statics } = require('mm_statics');
 
 const app = new Koa();
 
 // 自定义配置
-app.use(static({
+app.use(statics({
   root: './public',           // 静态文件根目录
   path: '/src',               // 需要转换的文件路径前缀
   files: ['.js', '.vue'],     // 需要转换的文件类型
@@ -64,19 +64,21 @@ app.listen(3000);
 
 | 配置项 | 类型 | 默认值 | 描述 |
 |--------|------|--------|------|
-| `root` | string | `'./static'` | 静态文件根目录 |
-| `path` | string | `'/src'` | 需要转换的文件路径前缀 |
-| `files` | array | `['.js', '.vue']` | 需要转换的文件类型 |
+| `root` | string | `''` | 静态文件根目录，为空时由 `dir` 推导，处理器兜底为 `./static` |
+| `path` | string | `''` | 路由根路径，为空时自动生成 `/${app}/` |
+| `files` | array | `['.js', '.vue', '.html']` | 需要转换的文件类型 |
 | `convert_amd` | boolean | `true` | 是否启用ES6到AMD转换 |
 | `compile_vue` | boolean | `true` | 是否编译Vue单文件组件 |
-| `max_age` | number | `7200` | 缓存时间（秒） |
+| `compile_md` | boolean | `true` | 是否将Markdown转换为HTML |
+| `max_age` | number | `600` | 缓存时间（秒） |
 | `immutable` | boolean | `true` | 是否启用不可变缓存 |
+| `cache` | boolean | `true` | 是否启用服务端缓存 |
 | `hidden` | boolean | `false` | 是否支持隐藏文件 |
 | `index` | string | `'index.html'` | 默认索引文件 |
-| `format` | boolean | `false` | 是否格式化路径 |
+| `format` | boolean | `true` | 是否格式化转换后的代码 |
 | `extensions` | boolean | `false` | 是否自动添加扩展名 |
-| `brotli` | boolean | `false` | 是否支持brotli压缩 |
-| `gzip` | boolean | `false` | 是否支持gzip压缩 |
+| `brotli` | boolean | `true` | 是否支持brotli压缩 |
+| `gzip` | boolean | `true` | 是否支持gzip压缩 |
 
 ## 使用场景
 
@@ -84,7 +86,7 @@ app.listen(3000);
 
 ```javascript
 // 禁用AMD转换，仅提供静态文件服务
-app.use(static({
+app.use(statics({
   convert_amd: false,
   compile_vue: false,
   root: './public'
@@ -95,7 +97,7 @@ app.use(static({
 
 ```javascript
 // 启用AMD转换，自动转换ES6模块
-app.use(static({
+app.use(statics({
   convert_amd: true,
   compile_vue: false,
   root: './src',
@@ -108,7 +110,7 @@ app.use(static({
 
 ```javascript
 // 启用AMD转换，将Vue组件转换为AMD格式
-app.use(static({
+app.use(statics({
   convert_amd: true,
   compile_vue: true,
   root: './components',
@@ -121,7 +123,7 @@ app.use(static({
 
 ```javascript
 // 禁用AMD转换，但启用Vue编译，生成可直接使用的组件
-app.use(static({
+app.use(statics({
   convert_amd: false,
   compile_vue: true,
   root: './components',
@@ -216,15 +218,12 @@ new Static(config)
 
 #### 方法
 
-- `setConfig(config)` - 更新配置
-- `main(ctx, next)` - 主要处理逻辑（包含AMD转换和Vue编译）
-- `run(ctx, next)` - 仅静态文件服务
-- `_shouldProcess(ctx)` - 判断是否需要处理请求
-- `_convertible(path)` - 判断是否需要转换
-- `_toAmd(ctx, path)` - 执行ES6到AMD转换
-- `_handleVueFile(vue_content)` - 处理Vue文件转换
-- `_convertToDirectVueComponent(script_content, vue_content)` - Vue文件直接转换
-- `_send(ctx, path)` - 发送静态文件
+- `main(ctx, next)` - 主处理逻辑，作为中间件使用（路径取自 `ctx.path`）
+- `main(ctx, file_path)` - 直接发送指定文件
+- `run(ctx, next)` - 中间件方式处理静态文件
+- `send(ctx, file_path, config)` - 直接发送指定文件
+- `_delCache(url)` - 删除指定请求路径的服务端缓存
+- `init()` / `start()` / `stop()` - 生命周期方法（继承自 `mm_mod`）
 
 ## 缓存策略
 
@@ -269,14 +268,14 @@ npm test
 npx eslint index.js
 ```
 
-### 测试Vue转换功能
+### 测试与示例
 
 ```bash
-# 运行Vue转换测试
-node test_vue_direct_conversion.js
+# 运行自动化测试
+npm test
 
-# 调试Vue转换
-node debug_vue_conversion.js
+# 运行使用示例
+node example/index.js
 ```
 
 ### 贡献代码
@@ -292,7 +291,8 @@ node debug_vue_conversion.js
 - **@vue/compiler-sfc**: Vue单文件组件解析器
 - **mm_es6_to_amd**: ES6到AMD转换器
 - **mm_cache**: 缓存模块
-- **koa-send**: Koa静态文件发送
+- **mm_corejs**: 核心管理基类
+- **mm_helper**: 静态处理器依赖的字符串/路径原型扩展
 
 ## 许可证