hexo-swpp 1.1.5 → 1.2.0

package/README.md

@@ -1,50 +1,5 @@
-# 介绍
-
   该插件用于在 hexo 中自动构建可用的 ServiceWorker，插件内自带了一个缺省的 sw.js，也支持使用自定义的 sw。
 
-# 配置说明
-
-  `enable`、`onError`及`onSuccess`为必填项（无缺省设置），其余为可选项，可选项的缺省设置为下方列出的设置。
-
-```yaml
-swpp:
-  enable: true
-  # 是否使用自定义的 sw，为 true 时不自动生成 sw.js，但是仍然会插入注册 sw 的代码
-  # 注意：不支持自定义 sw.js 的路径及文件名，sw.js 必须放置在 source_dir 中
-  customJS: false
-  # 注册 sw 发生错误时触发的 js 代码，如果包含多个指令需使用花括号（{}）包裹
-  # 注意：SW 注册代码将直接内嵌在 HTML 首部，该代码执行时其它 JS 不一定完成了加载
-  onError: "document.addEventListener('DOMContentLoaded', () => kms.pushInfo('当前浏览器不支持SW，建议更换浏览器以获取最佳体验~'))"
-  # 注册 sw 成功后触发的 js 代码，如果包含多个指令需使用花括号（{}）包裹
-  # 注意：SW 注册代码将直接内嵌在 HTML 首部，该代码执行时其它 JS 不一定完成了加载
-  onSuccess: "location.reload()"
-  # 最大 HTML 数量，超过这个数量后会直接清除所有 HTML 缓存
-  maxHtml: 15
-  # update.json 的最大字符数量
-  # 超过后会移除旧的版本号，直到满足要求，如果只有全部清空才能满足就会直接刷新所有缓存
-  charLimit: 1024
-  # 文件缓存匹配采取精确模式
-  # 关闭时更新缓存时仅匹配文件名称，如 https://kmar.top/simple/a/index.html 仅匹配 /a/index.html
-  # 开启后更新缓存时将会匹配完整名称，如 https://kmar.top/simple/a/index.html 将匹配 /simple/a/index.html
-  # 两种方式各有优劣，开启后会增加 update.json 的空间占用，但会提升精确度
-  # 如果网站内没有多级目录结构，就可以放心大胆的关闭了
-  # key 值为文件拓展名，default 用于指代所有未列出的拓展名以及没有拓展名的文件
-  precisionMode:
-    default: false
-  # 是否合并指定项目
-  # 例如当 tags 为 true 时（假设标签目录为 https://kmar.top/tags/...）
-  # 如果标签页存在更新，则直接匹配 https://kmar.top/tags/ 目录下的所有文件
-  # 推荐将此项开启
-  merge:
-    tags: true
-    archives: true
-    categories: true
-    index: true
-  # 忽略哪些文件，正则表达式，不写两边的斜杠，不区分大小写
-  # 注：匹配的时候不附带域名，只有 pathname
-  exclude:
-    # 这里写正则表达式，格式如下：
-    - sw\.js
-```
+  具体说明见：[小白也能用的 SW 构建插件 - 山岳库博](https://kmar.top/posts/73014407/)
 
-  具体说明见：[小白也能用的 SW 构建插件 - 山岳库博](https://kmar.top/posts/73014407/)
+  `1.2.0`之前的版本存在功能缺陷，请勿使用！

package/index.js

@@ -4,7 +4,7 @@
 
 const fs = require('fs')
 const logger = require('hexo-log')()
-const axios = require('axios')
+const fetch = require('node-fetch')
 const path = require('path')
 
 const findScript = () => path.resolve('./', 'sw-cache')
@@ -30,7 +30,7 @@ if (pluginConfig?.enable) {
 
     // 生成 sw.js
     hexo.extend.generator.register('buildSw', () => {
-        if (pluginConfig.customJS) return
+        if (pluginConfig.sw.custom) return
         const absPath = module.path + '/sw-template.js'
         const rootPath = path.resolve('./')
         const relativePath = path.relative(rootPath, absPath)
@@ -40,7 +40,8 @@ if (pluginConfig?.enable) {
             .replace('module.exports.replaceList', 'const replaceList')
         return {
             path: 'sw.js',
-            data: template.replace('const { cacheList, replaceList } = require(\'../sw-cache\')', cache)
+            data: template.replace('const { cacheList, replaceList } = require(\'../sw-cache\')', cache),
+            layout: 'js'
         }
     })
 
@@ -49,13 +50,32 @@ if (pluginConfig?.enable) {
         return `<script>
               (() => {
                 const sw = navigator.serviceWorker
-                const error = () => ${pluginConfig.onError}
+                const error = () => ${pluginConfig.sw.onerror}
                 if (!sw?.register('/sw.js')?.then(() => {
-                  if (!sw.controller) ${pluginConfig.onSuccess}
+                  if (!sw.controller) ${pluginConfig.sw.onsuccess}
                 })?.catch(error)) error()
               })()
           </script>`
     }, "default")
+
+    if (!pluginConfig.dom?.custom) {
+        hexo.extend.injector.register('body_begin', () => {
+            // noinspection HtmlUnknownTarget
+            return `<script src="/js/sw-dom.js"></script>`
+        })
+        hexo.extend.generator.register('buildDomJs', () => {
+            const absPath = module.path + '/sw-dom.js'
+            const rootPath = path.resolve('./')
+            const relativePath = path.relative(rootPath, absPath)
+            const template = fs.readFileSync(relativePath, 'utf-8')
+                .replaceAll('// ${onSuccess}', pluginConfig.dom.onsuccess)
+            return {
+                path: 'sw-dom.js',
+                data: template,
+                layout: 'js'
+            }
+        })
+    }
 }
 
 /** 遍历指定目录下的所有文件 */
@@ -117,14 +137,11 @@ const buildNewJson = path => {
 const getJsonFromNetwork = async path => {
     const url = root + path
     try {
-        const result = await axios.get(url, {
-            responseEncoding: 'utf-8',
-            headers: pluginConfig.headers
-        })
+        const result = await fetch(url)
         if (result.status < 200 || result.status >= 400 || !result.data)
             // noinspection ExceptionCaughtLocallyJS
             throw `拉取 ${url} 时出现异常（${result.status}）`
-        return result.data
+        return await result.json()
     } catch (e) {
         if (e.toString().includes('404'))
             logger.error(`拉取 ${url} 时出现 404，如果您是第一次构建请忽略这个错误`)
@@ -197,7 +214,7 @@ const buildUpdateJson = (name, dif, oldUpdate) => {
     // 读取拓展 json
     const expand = fs.existsSync(name) ? JSON.parse(fs.readFileSync(name, 'utf-8')) : undefined
     // 获取上次最新的版本
-    let oldVersion = oldUpdate?.info[0]?.version ?? 0
+    let oldVersion = oldUpdate?.info?.at(0)?.version ?? 0
     if (typeof oldVersion !== 'number') {
         // 当上次最新的版本号不是数字是尝试对其进行转换，如果无法转换则直接置零
         if (oldVersion.match('\D')) oldVersion = 0

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "hexo-swpp",
-  "version": "1.1.5",
+  "version": "1.2.0",
   "main": "index.js",
   "dependencies": {
-    "axios": "^1.2.0",
-    "hexo-log": "^3.0.0"
+    "hexo-log": "^3.0.0",
+    "node-fetch": "^2.0.0"
   },
   "files": [
     "index.js",