hexo-swpp 3.2.0 → 3.2.2

package/README.md

@@ -24,9 +24,21 @@ npm install hexo-swpp swpp-backends
 
 ```yml
 swpp:
+  # 是否启用插件
   enable: true
+  # 是否在发布前自动执行脚本
+  # auto_exec: true
 ```
 
+插件会在生成网站时自动生成 Service Worker、注册代码、DOM 端支持代码（如果功能开启了的话），版本更新文件需要通过 `hexo swpp` 命令手动生成。
+
+`auto_exec` 配置项允许用户在执行 `hexo deploy` 指令时自动执行 `hexo swpp` 的内容（注意开启该配置项后无法再使用 `hexo swpp` 命令）。
+
+⚠ 注意：
+
++ 尽可能在压缩网站内容前执行 `hexo swpp`，因为部分压缩插件可能会出现同样的内容连续压缩结果不一样的问题，这会导致插件错误地更新缓存。
++ 如果你的网站发布过程不使用 `hexo deploy` 指令，则不要启用 `auto_exec` 选项。
+
 插件的具体配置见 [Swpp Backends 官方文档 | 山岳库博](https://kmar.top/posts/b70ec88f/)。
 
 ### sort
@@ -45,4 +57,31 @@ module.exports.config = {
 
 该配置项是为了对 hexo 中的一些变量进行排序，避免每次生成 HTML 时由于这些变量的顺序变动导致生成结果不完全相同。上方代码给出的值为插件的缺省值，用户设置该项不会直接覆盖这些值，只有用户也声明 `posts`、`pages` 或 `tags` 时才会覆盖对应的值。
 
-其中 key 值为要排序的变量的名称，value 为变量排序时的依据，填 `false` 表示禁用该项排序，填 `true` 表示以 value 本身为键进行排序，填字符串表示以 `value[tag]` 为键进行排序。
+其中 key 值为要排序的变量的名称，value 为变量排序时的依据，填 `false` 表示禁用该项排序，填 `true` 表示以 value 本身为键进行排序，填字符串表示以 `value[tag]` 为键进行排序。
+
+---
+
+## 更新日志
+
++ 3.2+
+
+  1. 支持 `swpp-backends@2` \[3.2.0]
+  2. 优化不运行 swpp 时的性能 \[3.2.1]
+  3. 支持发布前自动执行 swpp \[3.2.1]
+  4. 修复构建时报错的**严重漏洞** \[3.2.2]
+  5. 插入的 DOM JS 加载方式改为 async \[3.2.2]
++ 3.1+
+
+  1. 支持 `swpp-backends@1.1` \[3.1.0]
+  2. 修复无法正确读取主题配置文件的问题 \[3.1.1]
++ 3.0+
+    
+  该版本与 V2 不兼容，请注意修改配置文件！
+
+  相比于 V2，V3 有以下改动：
+  1. 移除了配置项中的 `json.precisionMode` 选项
+  2. 修改了配置项 `json` 中的 `merge` 和 `exclude` 的写法
+  3. 修改了配置项中的 `external.js` 的写法
+  4. 将配置项 `external` 中的 `skip` 替换为 `stable`，`replace` 替换为 `replacer`
+  5. 规则文件中的 `cacheList` 替换为 `cacheRules`，`getCdnList` 替换为 `getRaceUrls`
+  6. 兼容 hexo 7

package/dist/index.js

@@ -32,10 +32,44 @@ const path_1 = __importDefault(require("path"));
 const logger = require('hexo-log').default();
 // noinspection JSUnusedGlobalSymbols
 function start(hexo) {
-    const { config } = hexo;
-    if (!(config['swpp']?.enable || config.theme_config['swpp']?.enable))
+    const config = hexo.config;
+    const pluginConfig = config['swpp'] ?? config.theme_config['swpp'];
+    if (!pluginConfig.enable)
         return;
-    const themeName = config.theme;
+    hexo.on('generateBefore', () => {
+        loadRules(hexo);
+        sort(hexo);
+        buildServiceWorker(hexo);
+    });
+    if (pluginConfig['auto_exec']) {
+        hexo.on('deployBefore', async () => {
+            await runSwpp(hexo);
+        });
+    }
+    else {
+        hexo.extend.console.register('swpp', '生成前端更新需要的 json 文件及后端使用的版本文件', {}, async () => {
+            await runSwpp(hexo);
+        });
+    }
+}
+async function runSwpp(hexo) {
+    const config = hexo.config;
+    if (!fs.existsSync(config.public_dir))
+        return logger.warn(`[SWPP] 未检测到发布目录，跳过指令执行`);
+    const rules = loadRules(hexo);
+    if (!rules.config.json)
+        return logger.error(`[SWPP] JSON 生成功能未开启，跳过指令执行`);
+    const url = config.url;
+    await Promise.all([
+        swpp_backends_1.default.loader.loadUpdateJson(url + '/update.json'),
+        swpp_backends_1.default.loader.loadVersionJson(url + '/cacheList.json')
+    ]);
+    await buildVersionJson(hexo);
+    const dif = swpp_backends_1.default.builder.analyzeVersion();
+    await buildUpdateJson(hexo, dif);
+}
+function loadRules(hexo) {
+    const themeName = hexo.config.theme;
     swpp_backends_1.default.event.addRulesMapEvent(rules => {
         if ('cacheList' in rules && !('cacheRules' in rules)) {
             rules.cacheRules = rules['cacheList'];
@@ -46,24 +80,9 @@ function start(hexo) {
             delete rules['getCdnList'];
         }
     });
-    const rules = swpp_backends_1.default.loader.loadRules('./', 'sw-rules', [`./themes/${themeName}/`, `./node_modules/hexo-${themeName}/`]);
+    const result = swpp_backends_1.default.loader.loadRules('./', 'sw-rules', [`./themes/${themeName}/`, `./node_modules/hexo-${themeName}/`]);
     swpp_backends_1.default.builder.calcEjectValues(hexo);
-    sort(hexo);
-    buildServiceWorker(hexo);
-    if (rules.config.json) {
-        hexo.extend.console.register('swpp', '生成前端更新需要的 json 文件及后端使用的版本文件', {}, async () => {
-            if (!fs.existsSync(hexo.config.public_dir))
-                return logger.warn(`[SWPP] 未检测到发布目录，跳过指令执行`);
-            const url = hexo.config.url;
-            await Promise.all([
-                swpp_backends_1.default.loader.loadUpdateJson(url + '/update.json'),
-                swpp_backends_1.default.loader.loadVersionJson(url + '/cacheList.json')
-            ]);
-            await buildVersionJson(hexo);
-            const dif = swpp_backends_1.default.builder.analyzeVersion();
-            await buildUpdateJson(hexo, dif);
-        });
-    }
+    return result;
 }
 async function buildUpdateJson(hexo, dif) {
     const url = hexo.config.url;
@@ -105,7 +124,7 @@ function buildServiceWorker(hexo) {
     // 生成 sw-dom.js
     if (pluginConfig.dom) {
         // noinspection HtmlUnknownTarget
-        hexo.extend.injector.register('body_begin', () => `<script src="/sw-dom.js"></script>`);
+        hexo.extend.injector.register('body_begin', () => `<script async src="/sw-dom.js"></script>`);
         hexo.extend.generator.register('build_dom_js', () => {
             return {
                 path: 'sw-dom.js',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hexo-swpp",
-  "version": "3.2.0",
+  "version": "3.2.2",
   "main": "dist/index.js",
   "types": "types/index.d.ts",
   "files": [