hexo-swpp 2.7.0-beta.0 → 2.7.0-beta.2

package/index.js

@@ -4,51 +4,15 @@
 
 const config = hexo.config
 const enable = (config.swpp ?? hexo.theme.config.swpp)?.enable
-const logger = require('hexo-log')()
+
 
 if (enable) {
-    const rules = loadRules()
-    const defConfig = require('./lib/defConfig')
-    if (!rules.config) {
-        logger.error("未在 sw-rules.js 中查找到插件配置！")
-        throw '插件配置缺失'
-    }
+    const configLoader = require('./lib/configLoader')
+    const rules = configLoader.load(hexo)
     // 排序
-    require('./lib/sort.js')(defConfig, rules.config)
+    require('./lib/sort.js')(rules.config)
     // 生成 update.json
-    require('./lib/jsonBuilder.js')(hexo, config, defConfig, rules)
+    require('./lib/jsonBuilder.js')(hexo, config, rules)
     // 生成 sw.js
-    require('./lib/swBuilder.js')(hexo, config, defConfig, rules)
-}
-
-// 加载 sw-rules.js 文件
-function loadRules() {
-    const nodePath = require('path')
-    const fs = require('fs')
-    const themeName = hexo.config.theme
-    // 根目录下的文件
-    const root = nodePath.resolve('./', 'sw-rules.js')
-    // themes 文件夹下的文件
-    const themes = nodePath.resolve('./themes/', themeName, 'sw-rules.js')
-    // node_modules 文件下的文件
-    const modules = nodePath.resolve('./node_modules/', `hexo-theme-${themeName}/sw-rules.js`)
-    const exists = {
-        root: fs.existsSync(root),
-        themes: fs.existsSync(themes),
-        modules: fs.existsSync(modules)
-    }
-    if (!(exists.root || exists.themes || exists.modules)) {
-        const tip = "未找到 sw-rules.js 文件"
-        logger.error(`[sw-rules]: ${tip}`)
-        throw tip
-    }
-    let result = {}
-    if (exists.themes)
-        result = require(themes)
-    else if (exists.modules) {
-        result = require(modules)
-    }
-    if ('afterTheme' in result)
-        logger.error("[sw-rules]: 主题目录下的 sw-rules.js 中不应当包含 afterTheme 函数！")
-    return exists.root ? { ...result, ...require(root) } : result
+    require('./lib/swBuilder.js')(hexo, config, rules)
 }

package/lib/configLoader.js

@@ -0,0 +1,245 @@
+// 配置加载器
+
+const logger = require('hexo-log')()
+
+// 加载 sw-rules.js
+module.exports.load = hexo => {
+    const rules = loadRules(hexo)
+    const handle = (obj, def, list) => {
+        for (let key in def) {
+            const defValue = def[key]
+            const value = obj[key]
+            switch (typeof value) {
+                case 'undefined':
+                    obj[key] = defValue
+                    break
+                case 'object':
+                    const defA = Array.isArray(defValue)
+                    const objA = Array.isArray(value)
+                    if (defA !== objA) {
+                        logger.error(`[ConfigLoader] ${list.join('.')} 值与标准值类型不相同！已经使用默认配置项替代。`)
+                        obj[key] = defValue
+                        break
+                    }
+                    if (!defA) {
+                        list.append(key)
+                        handle(value, defValue, list)
+                        list.pop()
+                    }
+                    break
+            }
+        }
+    }
+    if (!('config' in rules)) {
+        logger.error("[ConfigLoader] 未在 sw-rules.js 中查询到配置项！")
+        throw '配置项缺失！'
+    }
+    handle(rules.config, defConfig, [])
+    return rules
+}
+
+// 存储缺省配置
+const defConfig = {
+    // sw 有关配置项
+    serviceWorker: {
+        /**
+         * 是否让插件自动生成 sw，为 false 该分类下所有配置项失效
+         * @type boolean
+         */
+        enable: true,
+        /**
+         * 逃生门
+         * @type number
+         * @see https://kmar.top/posts/73014407/#6c7c33f0
+         */
+        escape: 0,
+        /**
+         * 缓存库名称
+         * 发布网站后 **切勿修改** 该配置项！
+         * @type string
+         */
+        cacheName: 'kmarBlogCache',
+        /**
+         * 是否启用调试，启用后会在 sw 中插入一些辅助调试的代码，不建议开启
+         * @type boolean
+         */
+        debug: false
+    },
+    // 与 SW 注册有关的配置项
+    register: {
+        /**
+         * 是否让插件生成注册代码，为 false 时该分类下所有配置项失效
+         * @type boolean
+         */
+        enable: true,
+        /**
+         * sw 注册成功时的动作
+         * @type ?VoidFunction
+         * */
+        onsuccess: undefined,
+        /**
+         * sw 注册失败时的动作
+         * @type ?VoidFunction
+         */
+        onerror: undefined,
+        /**
+         * 生成注册 SW 的 HTML 代码片段
+         * @param root {string} 网页根目录的 URL
+         * @param hexoConfig {Object} Hexo 配置项
+         * @param pluginConfig {Object} SW 配置项
+         * @return {string} 一个 HTML 标签的字符串形式
+         */
+        builder: (root, hexoConfig, pluginConfig) => {
+            const {onerror, onsuccess} = pluginConfig
+            return `<script>
+                (() => {
+                    const sw = navigator.serviceWorker
+                    const error = () => ${onerror}
+                    if (!sw?.register('${new URL(root).pathname}sw.js')
+                        ${onsuccess ? '?.then(() => ' + onsuccess + ')' : ''}
+                        ?.catch(error)
+                        ) error()
+                })()
+            </script>`
+        }
+    },
+    // 与 DOM 端有关的配置项
+    dom: {
+        /**
+         * 是否让插件生成 DOM 端 JS，为 false 是该分类下所有配置项失效
+         * @type boolean
+         */
+        enable: true,
+        /**
+         * 版本更新完成后的动作
+         * @type VoidFunction
+         */
+        onsuccess: () => {}
+    },
+    /**
+     * 与插件生成的版本文件相关的配置项
+     * 该功能目前无法关闭
+     */
+    json: {
+        /**
+         * 更新缓存时允许更新的最大 HTML 页面数量，需要更新的 HTML 文件数量超过这个值后会清除所有 HTML 缓存
+         * @type number
+         */
+        maxHtml: 15,
+        /**
+         * 版本文件（update.json）字符数量限制，插件将保证版本文件的字符数量不超过该值
+         * @type number
+         */
+        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: {
+            index: true,
+            tags: true,
+            archives: true,
+            categories: true,
+            /**
+             * 这里填写目录名称列表（不带两边的斜杠）
+             * @type string[]
+             */
+            custom: []
+        },
+        /**
+         * 生成版本文件时忽略的文件
+         * 注：匹配的时候不附带域名，只有 pathname，匹配的内容一定是博客本地的文件
+         * @type RegExp[]
+         */
+        exclude: [
+            /sw\.js$/
+        ]
+    },
+    /**
+     * 外部文件更新监听
+     * @see https://kmar.top/posts/73014407/#c60b3060
+     */
+    external: {
+        /**
+         * 是否启用外部文件的更新
+         * @type boolean
+         */
+        enable: false,
+        /**
+         * 拉取网络文件时的超时时间
+         * @type number
+         */
+        timeout: 1500,
+        /**
+         * 匹配 JS 代码中的 URL
+         * @see https://kmar.top/posts/73014407/#c60b3060
+         */
+        js: [],
+        /**
+         * 某些外链只要 URL 不变其内容就一定不会变
+         * 可以通过正则表达式排除这些外链的文件内容监控，加快构建速度
+         * 注意：当某一个文件被跳过拉取后，这个文件中包含的 URL 也会被跳过
+         * @type RegExp[]
+         */
+        skip: [],
+        /**
+         * 在构建过程中替换部分链接，该替换结果不会影响文件内容
+         * 该设置项是为了应对构建服务器在国外，但是网站内部分缓存资源无法在国外访问导致拉取时超时的问题
+         * @type Object[]
+         * @see https://kmar.top/posts/73014407/#4ea71e00
+         */
+        replace: []
+    },
+    /**
+     * 对 Hexo 中的变量进行排序
+     * 默认插件对 posts、tags、categories、pages 四个变量进行排序
+     * 排序规则为优先按照字符串长度排序，若长度一致按照字典序排序
+     */
+    sort: {}
+}
+
+// 加载 sw-rules.js 文件
+const loadRules = hexo => {
+    const nodePath = require('path')
+    const fs = require('fs')
+    // noinspection JSUnresolvedReference
+    const themeName = hexo.config.theme
+    // 根目录下的文件
+    const root = nodePath.resolve('./', 'sw-rules.js')
+    // themes 文件夹下的文件
+    const themes = nodePath.resolve('./themes/', themeName, 'sw-rules.js')
+    // node_modules 文件下的文件
+    const modules = nodePath.resolve('./node_modules/', `hexo-theme-${themeName}/sw-rules.js`)
+    const exists = {
+        root: fs.existsSync(root),
+        themes: fs.existsSync(themes),
+        modules: fs.existsSync(modules)
+    }
+    if (!(exists.root || exists.themes || exists.modules)) {
+        const tip = "未找到 sw-rules.js 文件"
+        logger.error(`[sw-rules]: ${tip}`)
+        throw tip
+    }
+    let result = {}
+    if (exists.themes)
+        result = require(themes)
+    else if (exists.modules) {
+        result = require(modules)
+    }
+    if ('afterTheme' in result)
+        logger.error("[sw-rules]: 主题目录下的 sw-rules.js 中不应当包含 afterTheme 函数！")
+    return exists.root ? { ...result, ...require(root) } : result
+}

package/lib/jsonBuilder.js

@@ -1,4 +1,4 @@
-module.exports = (hexo, hexoConfig, defConfig, swRules) => {
+module.exports = (hexo, hexoConfig, swRules) => {
     const logger = require('hexo-log')()
     const fs = require('fs')
     const fetch = require('node-fetch')
@@ -47,7 +47,7 @@ module.exports = (hexo, hexoConfig, defConfig, swRules) => {
     /** 判断指定文件是否需要排除 */
     const isExclude = pathname => {
         // noinspection JSUnresolvedVariable
-        const exclude = config.json?.exclude ?? defConfig.json.exclude
+        const exclude = config.json?.exclude
         for (let reg of exclude) {
             if (pathname.match(reg)) return true
         }
@@ -56,7 +56,7 @@ module.exports = (hexo, hexoConfig, defConfig, swRules) => {
 
     /** 判断是否跳过网络拉取 */
     const isSkipFetch = url => {
-        const skipList = config.external?.skip ?? defConfig.external.skip
+        const skipList = config.external.skip
         for (let reg of skipList) {
             if (url.match(reg)) return true
         }
@@ -96,7 +96,7 @@ module.exports = (hexo, hexoConfig, defConfig, swRules) => {
                 result[key] = crypto.createHash('md5').update(content).digest('hex')
             }
             // 外链监控
-            const external = config.external ?? defConfig.external
+            const external = config.external
             if (!external.enable) return
             const indexOf = (str, ...chars) => {
                 let result = str.length
@@ -221,7 +221,7 @@ module.exports = (hexo, hexoConfig, defConfig, swRules) => {
                 referer: new URL(link).hostname,
                 'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36 Edg/107.0.1418.62'
             },
-            timeout: config.external?.timeout ?? defConfig.external.timeout
+            timeout: config.external.timeout
         }).then(response => {
             switch (response.status) {
                 case 200: case 301: case 302: case 307: case 308:
@@ -356,7 +356,7 @@ module.exports = (hexo, hexoConfig, defConfig, swRules) => {
             info: [newInfo]
         }
         // noinspection JSUnresolvedVariable
-        const charLimit = config.json?.charLimit ?? defConfig.json.charLimit
+        const charLimit = config.json.charLimit
         if (JSON.stringify(result).length > charLimit) {
             return {
                 global: result.global,
@@ -411,7 +411,7 @@ module.exports = (hexo, hexoConfig, defConfig, swRules) => {
         const merges = []       // 要合并的更新
         // 推送页面更新
         // noinspection JSUnresolvedVariable
-        if (tidied.page.size > (config.json?.maxHtml ?? defConfig.json.maxHtml)) {
+        if (tidied.page.size > (config.json.maxHtml)) {
             // 如果 html 数量超过阈值就直接清掉所有 html
             info.change.push({flag: 'html'})
         } else {
@@ -466,7 +466,7 @@ module.exports = (hexo, hexoConfig, defConfig, swRules) => {
             return tidied
         }
         // noinspection JSUnresolvedVariable
-        const mode = config.json?.precisionMode ?? defConfig.json.precisionMode
+        const mode = config.json.precisionMode
         for (let it of dif) {
             const url = new URL(it.match(/^(https?|\/\/)/) ? it : nodePath.join(root, it))  // 当前文件的 URL
             const cache = findCache(url)    // 查询缓存
@@ -510,7 +510,7 @@ module.exports = (hexo, hexoConfig, defConfig, swRules) => {
     }
 
     function replaceDevRequest(url) {
-        const external = config.external ?? defConfig.external
+        const external = config.external
         if (!external.enable || !external.replace) return url
         for (let value of external.replace) {
             for (let source of value.source) {

package/lib/sort.js

@@ -1,7 +1,7 @@
 const nodePath = require("path")
 
 /** 对 Hexo 内的属性进行排序 */
-module.exports = (defConfig, config) => {
+module.exports = config => {
     const compare = (a, b) => {
         const result = a.length === b.length ? a < b : a.length < b.length
         return result ? -1 : 1
@@ -19,7 +19,7 @@ module.exports = (defConfig, config) => {
         tags: 'name',
         categories: 'name'
     }
-    Object.assign(list, config.sort ?? defConfig.sort)
+    Object.assign(list, config.sort)
     const Locals = require(`${nodePath.resolve('./', 'node_modules/hexo/lib/hexo/locals')}`).prototype
     const get = Locals.get
     Locals.get = function(name) {

package/lib/swBuilder.js

@@ -1,4 +1,4 @@
-module.exports = (hexo, hexoConfig, defConfig, rules) => {
+module.exports = (hexo, hexoConfig, rules) => {
     const {
         modifyRequest,
         fetchNoCache,
@@ -12,7 +12,7 @@ module.exports = (hexo, hexoConfig, defConfig, rules) => {
     const logger = require('hexo-log')()
 
     const root = hexoConfig.url + (hexoConfig.root ?? '/')
-    const serviceWorkerConfig = config.serviceWorker ?? defConfig.serviceWorker
+    const serviceWorkerConfig = config.serviceWorker
 
     // noinspection JSUnresolvedVariable
     hexo.extend.generator.register('buildSw', () => {
@@ -141,8 +141,8 @@ module.exports = (hexo, hexoConfig, defConfig, rules) => {
         // noinspection JSUnresolvedVariable
         let swContent = fs.readFileSync(relativePath, 'utf8')
             .replaceAll(keyword, cache)
-            .replaceAll("'@$$[escape]'", (serviceWorkerConfig.escape ?? 0).toString())
-            .replaceAll("'@$$[cacheName]'", `'${serviceWorkerConfig.cacheName ?? 'kmarBlogCache'}'`)
+            .replaceAll("'@$$[escape]'", (serviceWorkerConfig.escape).toString())
+            .replaceAll("'@$$[cacheName]'", `'${serviceWorkerConfig.cacheName}'`)
         if (modifyRequest) {
             swContent = swContent.replaceAll('// [modifyRequest call]', `
                 const modify = modifyRequest(request)
@@ -176,14 +176,14 @@ module.exports = (hexo, hexoConfig, defConfig, rules) => {
     })
 
     // 生成注册 sw 的代码
-    const registerConfig = config.register ?? defConfig.register
+    const registerConfig = config.register
     if (registerConfig.enable) {
         // noinspection JSUnresolvedVariable
         hexo.extend.injector.register('head_begin', () => registerConfig.builder(root, hexoConfig, config), "default")
     }
 
     // 插入 sw-dom.js
-    const domConfig = config.dom ?? defConfig.dom
+    const domConfig = config.dom
     if (domConfig.enable) {
         // noinspection JSUnresolvedVariable,HtmlUnknownTarget
         hexo.extend.injector.register('body_begin', () => `<script src="/sw-dom.js"></script>`)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hexo-swpp",
-  "version": "2.7.0-beta.0",
+  "version": "2.7.0-beta.2",
   "main": "index.js",
   "dependencies": {
     "hexo-log": "^3.0.0",
@@ -14,7 +14,8 @@
     "lib/sw-dom.js",
     "lib/swBuilder.js",
     "lib/jsonBuilder.js",
-    "lib/sort.js"
+    "lib/sort.js",
+    "lib/configLoader.js"
   ],
   "keywords": [
     "hexo",