hexo-swpp 3.2.3 → 3.3.0

package/README.md

@@ -17,6 +17,7 @@ npm install hexo-swpp swpp-backends
 |     ~3.0     |      ^1.0.0      |
 |     ~3.1     |      ^1.1.0      |
 |     ~3.2     |      ^2.0.0      |
+|     ~3.3     |      ^2.1.2      |
 
 ## 使用
 
@@ -28,6 +29,11 @@ swpp:
   enable: true
   # 是否在发布前自动执行脚本
   # auto_exec: true
+  # 构建时拉取版本文件的警告等级，缺省为 1
+  # 0 - 表示不允许出现 404 情况；1 - 表示允许服务器返回 404 状态码；2 - 表示允许任何 404（包括 DNS 解析失败等）
+  # warn_level: 1
+  # 检查版本的 URL，不能以 '/' 结尾
+  # npm_url: 'https://registry.npmmirror.com'
 ```
 
 插件会在生成网站时自动生成 Service Worker、注册代码、DOM 端支持代码（如果功能开启了的话），版本更新文件需要通过 `hexo swpp` 命令手动生成。
@@ -36,8 +42,10 @@ swpp:
 
 ⚠ 注意：
 
++ 如果你的网站启用 `swpp` 后还没有发布过，请勿将 `warn_level` 设置为 0，这会导致构建失败。
 + 尽可能在压缩网站内容前执行 `hexo swpp`，因为部分压缩插件可能会出现同样的内容连续压缩结果不一样的问题，这会导致插件错误地更新缓存。
 + 如果你的网站发布过程不使用 `hexo deploy` 指令，则不要启用 `auto_exec` 选项。
++ 将 `npm_url` 调整为非官方 URL 后检查版本时可能会出现 404 错误。
 
 插件的具体配置见 [Swpp Backends 官方文档 | 山岳库博](https://kmar.top/posts/b70ec88f/)。
 
@@ -70,6 +78,12 @@ module.exports.config = {
   3. 支持发布前自动执行 swpp \[3.2.1]
   4. 修复构建时报错的**严重漏洞** \[3.2.2]
   5. 插入的 DOM JS 加载方式改为 async \[3.2.2]
+  6. 修复运行 `hexo s` 时报错的问题 \[3.2.3]
+  7. 支持版本检查 \[3.2.3]
+  8. 版本检查移动到 `generateBefore` 事件中 \[3.2.4]
+  9. 支持调整文件拉取的判断等级 \[3.3.0]
+  10. 版本检查改为仅在执行 `hexo server` 时执行 \[3.3.0]
+  11. 支持自定义版本更新检查的 URL \[3.3.0]
 + 3.1+
 
   1. 支持 `swpp-backends@1.1` \[3.1.0]

package/dist/index.js

@@ -35,9 +35,10 @@ const logger = require('hexo-log').default();
 function start(hexo) {
     const config = hexo.config;
     const pluginConfig = config['swpp'] ?? config.theme_config['swpp'];
-    if (!pluginConfig.enable)
+    if (!pluginConfig?.enable)
         return;
-    checkVersion();
+    if (process.argv.find(it => 'server'.startsWith(it)))
+        checkVersion(pluginConfig);
     let init = false;
     hexo.on('generateBefore', () => {
         if (init)
@@ -49,16 +50,16 @@ function start(hexo) {
     });
     if (pluginConfig['auto_exec']) {
         hexo.on('deployBefore', async () => {
-            await runSwpp(hexo);
+            await runSwpp(hexo, pluginConfig);
         });
     }
     else {
         hexo.extend.console.register('swpp', '生成前端更新需要的 json 文件及后端使用的版本文件', {}, async () => {
-            await runSwpp(hexo);
+            await runSwpp(hexo, pluginConfig);
         });
     }
 }
-async function runSwpp(hexo) {
+async function runSwpp(hexo, pluginConfig) {
     const config = hexo.config;
     if (!fs.existsSync(config.public_dir))
         return logger.warn(`[SWPP] 未检测到发布目录，跳过指令执行`);
@@ -67,20 +68,23 @@ async function runSwpp(hexo) {
         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')
+        swpp_backends_1.default.loader.loadUpdateJson(url + '/update.json', pluginConfig['warn_level'] ?? 1),
+        swpp_backends_1.default.loader.loadVersionJson(url + '/cacheList.json', pluginConfig['warn_level'] ?? 1)
     ]);
     await buildVersionJson(hexo);
     const dif = swpp_backends_1.default.builder.analyzeVersion();
     await buildUpdateJson(hexo, dif);
 }
-function checkVersion() {
-    (0, node_fetch_1.default)(`https://registry.npmjs.org/swpp-backends/${swpp_backends_1.default.version}`)
+function checkVersion(pluginConfig) {
+    const root = pluginConfig['npm_url'] ?? 'https://registry.npmjs.org';
+    (0, node_fetch_1.default)(`${root}/swpp-backends/${swpp_backends_1.default.version}`)
         .then(response => {
         if (![200, 301, 302, 307, 308].includes(response.status))
             return Promise.reject(response.status);
         return response.json();
     }).then(json => {
+        if ('error' in json)
+            return Promise.reject(json.error);
         if ('deprecated' in json) {
             logger.error(`[SWPP VersionChecker] 您使用的 swpp-backends@${swpp_backends_1.default.version} 已被弃用，请更新版本！`);
             logger.error(`\t补充信息：${json['deprecated']}`);
@@ -89,9 +93,9 @@ function checkVersion() {
             logger.info('[SWPP VersionChecker] 版本检查通过，注意定期检查版本更新。');
         }
     }).catch(err => {
-        const isNumber = typeof err === 'number';
-        logger.warn(`[SWPP VersionChecker] 版本检查失败${isNumber ? ('（' + err + '）') : ''}`);
-        if (!isNumber)
+        const isSimple = ['number', 'string'].includes(typeof err);
+        logger.warn(`[SWPP VersionChecker] 版本检查失败${isSimple ? ('（' + err + '）') : ''}`);
+        if (!isSimple)
             logger.warn(err);
     });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hexo-swpp",
-  "version": "3.2.3",
+  "version": "3.3.0",
   "main": "dist/index.js",
   "types": "types/index.d.ts",
   "files": [
@@ -32,7 +32,7 @@
     "node-fetch": "^2.6.12"
   },
   "peerDependencies": {
-    "swpp-backends": "^2.0.0"
+    "swpp-backends": "^2.1.2"
   },
   "scripts": {}
 }