npm - mm_statics - Versions diffs - 1.6.1 → 1.6.2 - Mend

mm_statics 1.6.1 → 1.6.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

package/index.js CHANGED Viewed

@@ -3,29 +3,52 @@ const { EsToAmdConvert } = require('mm_es6_to_amd');
 const { parse } = require('@vue/compiler-sfc');
 const { compile } = require('@vue/compiler-dom');
 const prettier = require('prettier');
+const { marked } = require('marked');
 /**
  * 静态文件处理类
  */
 class Static {
   static config = {
+    // 默认索引文件
     index: 'index.html',
+    // 默认缓存过期时间
     max_age: 7200,
-    key_prefix: 'static:',
-    cache: true,
+    // 静态文件缓存键前缀
+    prefix: 'static:',
+    // 缓存过期时间
     cache_age: 7200,
+    // 是否开启缓存
+    cache: true,
+    // 是否开启不可变缓存
     immutable: true,
+    // 是否隐藏静态文件
     hidden: false,
+    // 是否格式化静态文件内容
     format: true,
+    // 是否开启文件扩展名
     extensions: false,
+    // 是否开启Brotli压缩
     brotli: false,
+    // 是否压缩静态文件
     gzip: false,
+    // 静态文件根目录
     root: './static',
+    // 是否编译Vue文件为JS
     compile_vue: true,
+    // 是否编译Markdown文件为HTML
+    compile_md: true,
+    // 编译Markdown文件时，是否添加引入css和js文件
+    markdown_link: ['/css/common.css', '/css/markdown.css', '/js/markdown.js'],
+    // 需要转换的静态文件路径前缀
     path: '/src',
+    // 需要转换的静态文件扩展名
     files: ['.js', '.vue', '.html'],
+    // 是否转换ES6模块为AMD模块
     convert_amd: true,
+    // 是否开启文件监听
     watch: false,
+    // 监听的文件扩展名
     watch_files: ['.js', '.css', '.html', '.vue', '.json', '.md', '.txt', '.xml']
   };
@@ -371,7 +394,17 @@ Static.prototype._compileVue = async function (code) {
  */
 Static.prototype._sendFile = async function (ctx, path) {
   // koa-send会自动处理查询参数，直接传递路径
-  await send(ctx, path, this.config);
+  const config = { ...this.config };
+  // 为markdown文件设置正确的MIME类型
+  if (path.endsWith('.md')) {
+    config.setHeaders = (res) => {
+      // 当代码走到_sendFile路径时，说明文件没有被编译，应该返回原始markdown类型
+      res.setHeader('Content-Type', 'text/plain; charset=utf-8');
+    };
+  }
+  await send(ctx, path, config);
 };
 /**
@@ -405,6 +438,93 @@ Static.prototype._runVue = async function (path) {
   return code;
 };
+/**
+ * 从Markdown内容中提取第一个一级标题
+ * @param {string} text Markdown文本内容
+ * @returns {string|null} 提取的标题，未找到时返回null
+ */
+Static.prototype._extractMarkdownTitle = function (text) {
+  if (!text || typeof text !== 'string') {
+    return null;
+  }
+  // 匹配一级标题格式：# 标题
+  var title_regex = /^#\s+(.+)$/m;
+  var match = text.match(title_regex);
+  if (match && match[1]) {
+    return match[1].trim();
+  }
+  return null;
+};
+/**
+ * 处理Markdown文件转换
+ * @param {string} path 文件路径
+ * @returns {string|null} 转换后的HTML内容
+ */
+Static.prototype._runMarkdown = async function (path) {
+  let html = null;
+  let file = `.${path}`.fullname(this.config.root);
+  let text = file.loadText();
+  if (text) {
+    try {
+      // 使用marked将markdown转换为HTML
+      let markdown_html = marked.parse(text);
+      // 优先从Markdown内容中提取一级标题，后备使用文件名
+      var title_from_content = this._extractMarkdownTitle(text);
+      var title_from_file = path.split('/').pop().replace('.md', '');
+      var title = title_from_content || title_from_file;
+      // 构建外部资源链接
+      let links = '';
+      if (this.config.markdown_link && Array.isArray(this.config.markdown_link)) {
+        this.config.markdown_link.forEach(path => {
+          if (path.endsWith('.css')) {
+            links += `    <link rel="stylesheet" href="${path}">\n`;
+          } else if (path.endsWith('.js')) {
+            links += `    <script src="${path}"></script>\n`;
+          }
+        });
+      }
+      // 构建完整的HTML结构
+      html = `<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>${title}</title>
+${links}
+</head>
+<body>
+${markdown_html}
+</body>
+</html>`;
+      // 如果启用了格式化，使用prettier格式化完整的HTML
+      if (this.config.format) {
+        try {
+          html = prettier.format(html, {
+            parser: 'html',
+            printWidth: 100,
+            tabWidth: 2
+          });
+        } catch (error) {
+          console.warn('HTML格式化失败，使用原始HTML:', error.message);
+        }
+      }
+    } catch (error) {
+      console.error('Markdown转换错误:', error);
+      return null;
+    }
+  }
+  return html;
+};
 /**
  * 返回响应
  * @param {object} ctx Koa上下文对象
@@ -456,7 +576,7 @@ Static.prototype._initWatcher = function () {
 Static.prototype._handleFileChange = function (event, file_path) {
   // 构建缓存键（相对于静态目录的路径）
   const relative_path = file_path.replace(this.config.root, '').replace(/^[\\\/]/, '');
-  const cache_key = this.config.key_prefix + relative_path;
+  const cache_key = this.config.prefix + relative_path;
   // 根据事件类型处理缓存
   switch (event) {
@@ -503,6 +623,14 @@ Static.prototype._getHeaders = function (file_type) {
     case 'html':
       headers['content-type'] = 'text/html; charset=utf-8';
       break;
+    case 'md':
+      if (this.config.compile_md) {
+        headers['content-type'] = 'text/html; charset=utf-8';
+      }
+      else {
+        headers['content-type'] = 'text/plain; charset=utf-8';
+      }
+      break;
     default:
       headers['content-type'] = 'text/plain; charset=utf-8';
       break;
@@ -517,7 +645,7 @@ Static.prototype._getHeaders = function (file_type) {
  */
 Static.prototype._setCache = async function (path, ret) {
   // 使用完整路径（包含查询参数）作为缓存键
-  await this._cache.set(this.config.key_prefix + path, ret, this.config.cache_age);
+  await this._cache.set(this.config.prefix + path, ret, this.config.cache_age);
 };
 /**
@@ -552,7 +680,7 @@ Static.prototype._getType = function (path) {
  */
 Static.prototype._getCache = async function (path) {
   // 使用完整路径（包含查询参数）作为缓存键
-  return await this._cache.get(this.config.key_prefix + path);
+  return await this._cache.get(this.config.prefix + path);
 };
 /**
@@ -560,7 +688,7 @@ Static.prototype._getCache = async function (path) {
  * @param {string} path 文件路径（包含查询参数）
  */
 Static.prototype._delCache = async function (path) {
-  await this._cache.del(this.config.key_prefix + path);
+  await this._cache.del(this.config.prefix + path);
 };
 /**
@@ -597,7 +725,9 @@ Static.prototype._handleFileCompile = async function (path) {
   else if (compile_vue && file_type === 'vue') {
     return await this._runVue(path);
   }
+  else if (this.config.compile_md && file_type === 'md') {
+    return await this._runMarkdown(path);
+  }
   return null;
 };
@@ -610,6 +740,10 @@ Static.prototype._handleFileCompile = async function (path) {
  */
 Static.prototype._handleCompiledResp = async function (url, path, body, ctx) {
   let file_type = this._getType(path);
+  // 只有当启用了Markdown转换时，才将markdown文件类型设置为HTML
+  if (file_type === 'md' && this.config.compile_md) {
+    file_type = 'html';
+  }
   let headers = this._getHeaders(file_type);
   let ret = this._return(ctx, body, headers);

package/package.json CHANGED Viewed

@@ -1,10 +1,10 @@
 {
     "name": "mm_statics",
-    "version": "1.6.1",
+    "version": "1.6.2",
     "description": "这是超级美眉statics函数模块，用于web服务端statics缓存",
     "main": "index.js",
     "scripts": {
-        "test": "node ./tests/index.js",
+        "test": "mocha tests/index.js",
         "tests": "mocha tests/*.js"
     },
     "repository": {
@@ -41,6 +41,7 @@
         "chokidar": "^5.0.0",
         "koa": "^3.1.1",
         "koa-send": "^5.0.1",
+        "marked": "^17.0.1",
         "mm_cache": "^1.4.8",
         "mm_es6_to_amd": "^1.4.7",
         "prettier": "^3.7.4"

package/static/test.txt DELETED Viewed

	@@ -1 +0,0 @@
1	- This is a test static file for mm_statics module.