hexo-swpp 3.1.2 → 3.2.1

package/README.md

@@ -10,15 +10,35 @@ npm install hexo-swpp swpp-backends
 
 当 `swpp-backends` 存在版本更新时，可以直接更新 `swpp-backends` 版本，不需要更新 `hexo-swpp` 的版本。（不过 `hexo-swpp` 有更新的话最好也跟进一下。）
 
+注意：更新 `swpp-backends` 版本时需要注意其版本是否与 `hexo-swpp` 匹配，版本匹配列表如下：
+
+| hexo-swpp 版本 | swpp-backends 版本 |
+|:------------:|:----------------:|
+|     ~3.0     |      ^1.0.0      |
+|     ~3.1     |      ^1.1.0      |
+|     ~3.2     |      ^2.0.0      |
+
 ## 使用
 
 在 hexo 或主题的配置文件中添加如下内容即可启用插件：
 
 ```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
@@ -39,32 +59,27 @@ module.exports.config = {
 
 其中 key 值为要排序的变量的名称，value 为变量排序时的依据，填 `false` 表示禁用该项排序，填 `true` 表示以 value 本身为键进行排序，填字符串表示以 `value[tag]` 为键进行排序。
 
-### update
+---
 
-`hexo-swpp` 允许用户通过 `update` 项向插件手动提交更新，按照如下格式填写：
+## 更新日志
 
-```javascript
-module.exports.update = {
-    flag: true,
-    force: false,
-    /** @type string[] */
-    refresh: [],
-    /** @type ChangeExpression[] */
-    change: []
-}
-```
-
-+ `flag` 是更新标记，只有当本次更新标记与上次值不相同时 `update` 的内容才会生效，所以修改 `update` 后没有必要手动清空 `update` 的内容。
-+ `force` 为强制更新标记，当设置为 `true` 时会清除前端所有缓存。
-+ `refresh` 为 URL 刷新列表，填写想要刷新缓存的 URL
-+ `change` 为刷新列表，填写要提交的缓存刷新表达式，表达式写法见 `swpp-backends` 中的 `ChangeExpression` 类型
++ 3.2+
 
-### extraListenedUrls
+  1. 支持 `swpp-backends@2` \[3.2.0]
+  2. 优化不运行 swpp 时的性能 \[3.2.1]
+  3. 支持发布前自动执行 swpp \[3.2.1]
++ 3.1+
 
-`hexo-swpp` 支持用户通过 `extraListenedUrls` 项向插件添加需要监听的 URL，按照如下格式填写：
-
-```javascript
-module.exports.extraListenedUrls = []
-```
+  1. 支持 `swpp-backends@1.1` \[3.1.0]
+  2. 修复无法正确读取主题配置文件的问题 \[3.1.1]
++ 3.0+
+    
+  该版本与 V2 不兼容，请注意修改配置文件！
 
-`extraListenedUrls` 的值不一定要是数组，只要是包含 `forEach` 函数的对象就可以，元素类型必须是 `string`。
+  相比于 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;
+    sort(hexo);
+    hexo.on('generateBefore', () => {
+        loadRules(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,62 +80,13 @@ 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;
-            const versionJson = await Promise.all([
-                swpp_backends_1.default.loader.loadUpdateJson(url + '/update.json'),
-                swpp_backends_1.default.loader.loadVersionJson(url + '/cacheList.json')
-            ]).then(array => array[1]);
-            let forceRefreshCache = false;
-            if ('update' in rules) {
-                const update = rules.update;
-                const { flag, change, refresh, force } = update;
-                if (!flag) {
-                    logger.error(`[SWPP Console] 规则文件的 update 项目必须包含 flag 值！`);
-                    throw 'update.flag 缺失';
-                }
-                swpp_backends_1.default.event.submitCacheInfo('flag', flag);
-                if (flag !== versionJson?.external?.flag) {
-                    if (change)
-                        swpp_backends_1.default.event.submitChange(...change);
-                    if (refresh)
-                        refresh.forEach(swpp_backends_1.default.event.refreshUrl);
-                    if (force)
-                        forceRefreshCache = true;
-                }
-            }
-            if ('extraListenedUrls' in rules) {
-                const urls = rules.extraListenedUrls;
-                if (!('forEach' in urls)) {
-                    logger.error(`[SWPP Console] extraListenedUrls 应当附带 forEach 函数！`);
-                    throw 'extraListenedUrls 类型错误';
-                }
-                urls.forEach((it) => {
-                    if (typeof it !== 'string') {
-                        logger.error(`[SWPP Console] extraListenedUrls 中的 ${it} 类型不为 string`);
-                        throw it;
-                    }
-                    swpp_backends_1.default.event.submitExternalUrl(it);
-                });
-            }
-            await buildVersionJson(hexo);
-            const dif = swpp_backends_1.default.builder.analyze(swpp_backends_1.default.cache.readNewVersionJson());
-            if (forceRefreshCache)
-                dif.force = true;
-            await buildUpdateJson(hexo, dif);
-        });
-    }
+    return result;
 }
 async function buildUpdateJson(hexo, dif) {
     const url = hexo.config.url;
-    const json = swpp_backends_1.default.builder.buildNewInfo(url, dif);
+    const json = swpp_backends_1.default.builder.buildUpdateJson(url, dif);
     fs.writeFileSync(`${hexo.config.public_dir}/update.json`, JSON.stringify(json), 'utf-8');
     logger.info('成功生成：update.json');
 }
@@ -141,14 +126,9 @@ function buildServiceWorker(hexo) {
         // noinspection HtmlUnknownTarget
         hexo.extend.injector.register('body_begin', () => `<script src="/sw-dom.js"></script>`);
         hexo.extend.generator.register('build_dom_js', () => {
-            const onsuccess = pluginConfig.dom.onsuccess;
-            let template = fs.readFileSync(path_1.default.resolve('./', 'node_modules/swpp-backends/dist/resources/sw-dom.js'), 'utf-8');
-            // @ts-ignore
-            if (onsuccess)
-                template = template.replaceAll(`// \${onSuccess}`, `(${pluginConfig.dom.onsuccess.toString()})()`);
             return {
                 path: 'sw-dom.js',
-                data: template
+                data: swpp_backends_1.default.builder.buildDomJs()
             };
         });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hexo-swpp",
-  "version": "3.1.2",
+  "version": "3.2.1",
   "main": "dist/index.js",
   "types": "types/index.d.ts",
   "files": [
@@ -30,7 +30,7 @@
     "hexo-log": "^4.1.0"
   },
   "peerDependencies": {
-    "swpp-backends": "^1.1.1"
+    "swpp-backends": "^2.0.0"
   },
   "scripts": {}
 }

package/types/index.d.ts

@@ -1,7 +1 @@
-import { ChangeExpression } from 'swpp-backends';
-export interface HexoSwppUpdate {
-    flag: any;
-    force?: boolean;
-    change?: ChangeExpression[];
-    refresh?: string[];
-}
+export {};