hexo-swpp 3.0.0 → 3.1.1

package/README.md

@@ -1,3 +1,70 @@
-  该插件用于在 hexo 中自动构建可用的 ServiceWorker，插件内自带了一个缺省的 sw.js，也支持使用自定义的 sw。
+这是 `swpp-backends` 的 hexo 端实现，绝大多数功能由 [swpp-backends](https://github.com/EmptyDreams/swpp-backends) 提供。
 
-  三代版本仍在开发中，有兴趣的可以先看一看 v2 分支。
+## 安装
+
+使用时需要同时安装 `hexo-swpp` 和 `swpp-backends`：
+
+```bash
+npm install hexo-swpp swpp-backends
+```
+
+当 `swpp-backends` 存在版本更新时，可以直接更新 `swpp-backends` 版本，不需要更新 `hexo-swpp` 的版本。（不过 `hexo-swpp` 有更新的话最好也跟进一下。）
+
+## 使用
+
+在 hexo 或主题的配置文件中添加如下内容即可启用插件：
+
+```yml
+swpp:
+  enable: true
+```
+
+插件的具体配置见 [Swpp Backends 官方文档 | 山岳库博](https://kmar.top/posts/b70ec88f/)。
+
+### sort
+
+`hexo-swpp` 在规则文件中添加了一个配置项——`sort`，用法如下：
+
+```javascript
+module.exports.config = {
+    sort: {
+        posts: 'title',
+        pages: 'title',
+        tags: 'name'
+    }
+}
+```
+
+该配置项是为了对 hexo 中的一些变量进行排序，避免每次生成 HTML 时由于这些变量的顺序变动导致生成结果不完全相同。上方代码给出的值为插件的缺省值，用户设置该项不会直接覆盖这些值，只有用户也声明 `posts`、`pages` 或 `tags` 时才会覆盖对应的值。
+
+其中 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` 类型
+
+### extraListenedUrls
+
+`hexo-swpp` 支持用户通过 `extraListenedUrls` 项向插件添加需要监听的 URL，按照如下格式填写：
+
+```javascript
+module.exports.extraListenedUrls = []
+```
+
+`extraListenedUrls` 的值不一定要是数组，只要是包含 `forEach` 函数的对象就可以，元素类型必须是 `string`。

package/dist/index.js

@@ -33,7 +33,7 @@ const logger = require('hexo-log').default();
 // noinspection JSUnusedGlobalSymbols
 function start(hexo) {
     const { config } = hexo;
-    if (!(config['swpp']?.enable || hexo.theme.config['swpp']?.enable))
+    if (!(config['swpp']?.enable || config.theme_config['swpp']?.enable))
         return;
     const themeName = config.theme;
     swpp_backends_1.default.event.addRulesMapEvent(rules => {
@@ -55,8 +55,10 @@ function start(hexo) {
             if (!fs.existsSync(hexo.config.public_dir))
                 return logger.warn(`[SWPP] 未检测到发布目录，跳过指令执行`);
             const url = hexo.config.url;
-            await swpp_backends_1.default.loader.loadUpdateJson(url + '/update.json');
-            const versionJson = await swpp_backends_1.default.loader.loadVersionJson(url + '/cacheList.json');
+            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;
@@ -75,6 +77,20 @@ function start(hexo) {
                         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)
@@ -87,21 +103,22 @@ async function buildUpdateJson(hexo, dif) {
     const url = hexo.config.url;
     const json = swpp_backends_1.default.builder.buildNewInfo(url, dif);
     fs.writeFileSync(`${hexo.config.public_dir}/update.json`, JSON.stringify(json), 'utf-8');
+    logger.info('成功生成：update.json');
 }
 async function buildVersionJson(hexo) {
     const url = hexo.config.url;
     let protocol, domain;
     if (url.startsWith('https:')) {
         protocol = 'https://';
-        domain = url.substring(protocol.length);
     }
     else {
         protocol = 'http://';
-        domain = url.substring(protocol.length);
     }
+    domain = url.substring(protocol.length, url.endsWith('/') ? url.length - 1 : url.length);
     // @ts-ignore
     const json = await swpp_backends_1.default.builder.buildVersionJson(protocol, domain, path_1.default.resolve('./', hexo.config.public_dir));
     fs.writeFileSync(`${hexo.config.public_dir}/cacheList.json`, JSON.stringify(json), 'utf-8');
+    logger.info('成功生成：cacheList.json');
 }
 function buildServiceWorker(hexo) {
     const rules = swpp_backends_1.default.cache.readRules();
@@ -166,7 +183,7 @@ function sort(hexo) {
         tags: 'name'
     };
     // @ts-ignore
-    Object.assign(list, swpp_backends_1.default.cache.readRules().config['sort']);
+    Object.assign(list, swpp_backends_1.default.cache.readRules().config['sort'] ?? {});
     const getter = Locals.get;
     Locals.get = function (name) {
         const result = getter.call(this, name);

package/package.json

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