hexo-theme-shokax 0.3.13 → 0.4.0-alpha.1

package/_config.yml

@@ -21,7 +21,6 @@ pwa:
 
 # 实验性特性
 experiments:
-  noPlayer: false # 禁用音乐播放器
   gradient: false # 使用CSS渐变作为文章封面
   fixedCover: "" # 主页面cover(为空则使用bing随机图片)
   debug: false # 使用debug模式启动
@@ -31,6 +30,17 @@ experiments:
   # 具体见https://docs.kaitaku.xyz/guide/theme.html#%E9%95%BF%E6%96%87%E7%AB%A0%E4%BC%98%E5%8C%96
   mobileWidth: 820px # 移动版和桌面版导航栏最短切换长度
 
+# ShokaX 模块化分包引入设置
+# 请关闭所有不使用的模块以优化主题 js 体积和性能
+modules:
+  player: true # 启用音乐播放器
+  fireworks: true # 启用鼠标点击烟花特效
+  unlazyHash: false # 启用unlazy hash预览图支持
+  visibilityListener: true # 启用可见度监听器
+  tabs: true # 启用选项卡扩展支持，如需开启 summary 功能请一并开启
+  quiz: true # 启用文章内问题扩展支持
+  fancybox: true # 启用 fancybox 支持（不建议禁用）
+
 # 优化性能区
 performance:
   # 使用preconnect预加载的网址(不建议超过三个)
@@ -38,15 +48,11 @@ performance:
     - "https://lf9-cdn-tos.bytecdntp.com"
   # 使用dns-prefetch预解析的网址
   dnsPrefetch:
-    - "https://cdn.jsdelivr.net"
-    - "https://unpkg.com"
 
 playerAPI: "https://api.injahow.cn" # 结尾不带/,只填写域名
 # 如果条件允许,请参考 https://github.com/injahow/meting-api 自建API
 # 使用vercel自行部署,请参考: https://github.com/xizeyoupan/Meting-API
 
-disableVL: false # 禁用可见度监听
-
 icon:
   favicon: "/favicon.ico"
   apple_touch_icon: "/apple-touch-icon.png"

package/layout/_mixin/comment.pug

@@ -3,17 +3,17 @@ mixin CommentRender()
     - var tk = theme?.twikoo?.enable,wl = theme?.waline?.enable
     if page.comment !== false && !theme.experiments.disableThemeComment
         if tk
-            div(class="wrap" id="tcomments")
+            div(class="wrap" id="comments")
             script(type="text/javascript" data-pjax).
                 setTimeout(function () {
                     twikoo.init({
                         envId: '#{ theme.twikoo.envId }',
-                        el: '#tcomments',
+                        el: '#comments',
                         region: '#{theme.twikoo.region}'
                     })
                 }, 1000)
         else if wl
-            div(class="wrap" id="wcomments")
+            div(class="wrap" id="comments")
             - var locale = JSON.stringify(theme.waline.locale)
             - var emoji = JSON.stringify(theme.waline.emoji)
             - var meta = JSON.stringify(theme.waline.meta)
@@ -23,7 +23,7 @@ mixin CommentRender()
 
                 setTimeout(function () {
                     init({
-                        el: '#wcomments',
+                        el: '#comments',
                         serverURL: '#{theme.waline.serverURL.replace(/\/+$/, '')}',
                         lang: '#{theme.waline.lang}',
                         locale: !{locale},

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "hexo-theme-shokax",
-    "version": "0.3.13",
+    "version": "0.4.0-alpha.1",
     "description": "a hexo theme based on shoka",
     "main": "index.js",
     "repository": "https://github.com/theme-shoka-x/hexo-theme-shokaX",
@@ -9,15 +9,15 @@
     "packageManager": "pnpm@8.14.1",
     "scripts": {
         "test": "tsc --build --verbose",
-        "build": "cd ./source && tsc --build --verbose && cd ../scripts && tsc --build --verbose"
+        "build": "cd ./scripts && tsc --build --verbose"
     },
     "devDependencies": {
         "@types/fancybox": "^3.5.6",
         "@types/jquery": "^3.5.29",
         "@types/js-yaml": "^4.0.9",
         "@types/node": "^20.11.10",
-        "@typescript-eslint/eslint-plugin": "^6.19.1",
-        "@typescript-eslint/parser": "^6.19.1",
+        "@typescript-eslint/eslint-plugin": "^6.20.0",
+        "@typescript-eslint/parser": "^6.20.0",
         "eslint": "^8.56.0",
         "eslint-config-standard": "~17",
         "eslint-plugin-import": "^2.29.1",

package/scripts/filters/locals.d.ts

@@ -0,0 +1 @@
+declare const fmtNum: (num: any) => any;

package/scripts/filters/locals.ts

@@ -0,0 +1,59 @@
+
+// @ts-ignore
+const fmtNum = (num) => {
+  return num < 10 ? '0' + num : num
+}
+
+hexo.extend.filter.register('template_locals', (locals:localsPlus) => {
+  const { config } = hexo
+  const { __, theme } = locals
+  // @ts-ignore
+  const { i18n } = hexo.theme
+
+  const pangu = {
+    spacing: (data) => {
+      return data
+    }
+  }
+
+  // Language & Config
+  // 根据主题配置的 Creative Commons 许可证生成链接
+  locals.alternate = theme.alternate
+  locals.title = pangu.spacing(__('title') !== 'title' ? __('title') : config.title)
+  locals.subtitle = pangu.spacing(__('subtitle') !== 'subtitle' ? __('subtitle') : config.subtitle)
+  locals.author = __('author') !== 'author' ? __('author') : config.author
+  locals.description = pangu.spacing(__('description') !== 'description' ? __('description') : config.description)
+  locals.languages = [...i18n.languages]
+  locals.languages.splice(locals.languages.indexOf('default'), 1)
+  locals.page.lang = locals.page.lang || locals.page.language
+  locals.hostname = new URL(config.url).hostname || config.url
+
+  // Creative Commons
+  // 根据主题配置的 Creative Commons 许可证生成链接
+  if (theme.creative_commons.license === 'zero') {
+    locals.ccURL = 'https://creativecommons.org/' + 'publicdomain/zero/1.0/' + (theme.creative_commons.language || '')
+  } else {
+    locals.ccURL = 'https://creativecommons.org/' + 'licenses/' + theme.creative_commons.license + '/4.0/' + (theme.creative_commons.language || '')
+  }
+
+  if (locals.page.title) {
+    locals.page.title = pangu.spacing(locals.page.title)
+  }
+  locals.page.lastcat = ''
+  if (locals.page.categories) {
+    locals.page.categories.map((cat) => {
+      if (cat.name) {
+        cat.name = locals.page.lastcat = pangu.spacing(cat.name)
+      }
+      return cat
+    })
+  }
+
+  if (locals.page.category) {
+    locals.page.title = pangu.spacing(locals.page.category)
+  }
+
+  if (locals.page.month) {
+    locals.page.month = fmtNum(locals.page.month)
+  }
+})

package/scripts/filters/post.ts

@@ -0,0 +1,6 @@
+/* global hexo */
+
+hexo.extend.filter.register('after_post_render', (data) => {
+  // 使用正则表达式将<img>标签的src属性替换为data-src属性
+  data.content = data.content.replace(/(<img[^>]*) src=/img, '$1 loading="lazy" data-src=')
+}, 0)

package/scripts/generaters/archive.d.ts

@@ -0,0 +1 @@
+export {};

package/scripts/generaters/archive.ts

@@ -0,0 +1,144 @@
+/* global hexo */
+'use strict'
+
+// @ts-ignore
+import pagination from 'hexo-pagination'
+
+// @ts-ignore
+const fmtNum = num => {
+  return num < 10 ? '0' + num : num
+}
+
+if (!(hexo.config.archive && hexo.config.archive.enabled === false)) {
+  // when archive disabled pagination, per_page should be 0.
+  let per_page
+
+  if (hexo.config.archive === 1) {
+    per_page = 0
+  } else if (typeof hexo.config.per_page === 'undefined') {
+    per_page = 10
+  } else {
+    per_page = hexo.config.per_page
+  }
+
+  hexo.config.archive_generator = Object.assign({
+    per_page,
+    yearly: true,
+    monthly: true,
+    daily: false
+  }, hexo.config.archive_generator)
+
+  hexo.extend.generator.register('archive', function (locals) {
+    const config = hexo.config
+    let archiveDir = config.archive_dir
+    const paginationDir = config.pagination_dir || 'page'
+    // @ts-ignore
+    const allPosts = locals.posts.sort(config.archive_generator.order_by || '-date')
+    const perPage = config.archive_generator.per_page
+    let result = []
+
+    if (!allPosts.length) return
+
+    if (archiveDir[archiveDir.length - 1] !== '/') archiveDir += '/'
+
+    function generate (path, posts, options?) {
+      options = options || {}
+      options.archive = true
+
+      result = result.concat(pagination(path, posts, {
+        perPage: path === archiveDir ? 0 : perPage,
+        layout: ['archive', 'index'],
+        format: paginationDir + '/%d/',
+        data: options
+      }))
+    }
+
+    generate(archiveDir, allPosts)
+
+    if (!config.archive_generator.yearly) return result
+
+    const posts = {}
+
+    // 按日期对文章进行分类
+    allPosts.forEach(post => {
+      const date = post.date
+      const year = date.year()
+      const month = date.month() + 1 // month is started from 0
+
+      if (!Object.prototype.hasOwnProperty.call(posts, year)) {
+        // 13个数组. 第一个数组是给这一年的文章准备的
+        // 其他则是各个月份的文章
+        posts[year] = [
+          [],
+          [],
+          [],
+          [],
+          [],
+          [],
+          [],
+          [],
+          [],
+          [],
+          [],
+          [],
+          []
+        ]
+      }
+
+      posts[year][0].push(post)
+      posts[year][month].push(post)
+      // Daily
+      if (config.archive_generator.daily) {
+        const day = date.date()
+        if (!Object.prototype.hasOwnProperty.call(posts[year][month], 'day')) {
+          posts[year][month].day = {}
+        }
+
+        (posts[year][month].day[day] || (posts[year][month].day[day] = [])).push(post)
+      }
+    })
+
+    const Query = this.model('Post').Query
+    const years = Object.keys(posts)
+    let year, data, month, monthData, url
+
+    // Yearly
+    for (let i = 0, len = years.length; i < len; i++) {
+      year = +years[i]
+      data = posts[year]
+      url = archiveDir + year + '/'
+      if (!data[0].length) continue
+
+      generate(url, new Query(data[0]), { year })
+
+      if (!config.archive_generator.monthly && !config.archive_generator.daily) continue
+
+      // Monthly
+      for (month = 1; month <= 12; month++) {
+        monthData = data[month]
+        if (!monthData.length) continue
+        if (config.archive_generator.monthly) {
+          generate(url + fmtNum(month) + '/', new Query(monthData), {
+            year,
+            month
+          })
+        }
+
+        if (!config.archive_generator.daily) continue
+
+        // Daily
+        for (let day = 1; day <= 31; day++) {
+          const dayData = monthData.day[day]
+          if (!dayData || !dayData.length) continue
+          generate(url + fmtNum(month) + '/' + fmtNum(day) + '/', new Query(dayData), {
+            year,
+            month,
+            day
+          })
+        }
+      }
+    }
+
+    return result
+  })
+}

package/scripts/generaters/config.d.ts

@@ -0,0 +1 @@
+export {};

package/scripts/generaters/config.ts

@@ -0,0 +1,52 @@
+'use strict'
+/* global hexo */
+
+import { deepMerge } from 'hexo-util'
+import fs from 'node:fs'
+import path from 'path'
+import yaml from 'js-yaml'
+
+hexo.extend.filter.register('before_generate', () => {
+  if (hexo.config.theme_config) {
+    // @ts-ignore
+    hexo.theme.config = deepMerge(hexo.theme.config, hexo.config.theme_config) as any
+  }
+
+  const data = hexo.locals.get('data')
+
+  if (data.languages) {
+    // @ts-ignore
+    const { i18n } = hexo.theme
+
+    const mergeLang = lang => {
+      if (data.languages[lang]) { // @ts-ignore
+        i18n.set(lang, deepMerge(i18n.get([lang]), data.languages[lang]))
+      }
+    }
+
+    for (const lang of ['en', 'ja', 'zh-CN', 'zh-HK', 'zh-TW']) {
+      mergeLang(lang)
+    }
+  }
+
+  (hexo.theme.config as any).style = {}
+
+  for (const style of ['iconfont', 'colors', 'custom']) {
+    const custom_file = 'source/_data/' + style + '.styl'
+    if (fs.existsSync(custom_file)) {
+      hexo.theme.config.style[style] = path.resolve(hexo.base_dir, custom_file)
+    }
+  }
+
+  if (data.images && data.images.length > 0) {
+    hexo.theme.config.image_list = data.images
+  } else {
+    hexo.theme.config.image_list = yaml.load(fs.readFileSync(path.join(__dirname, '../../_images.yml'), { encoding: 'utf-8' }))
+  }
+
+  if (fs.existsSync(path.join(__dirname, '../../_images_index.yml'))) {
+    hexo.theme.config.index_images = yaml.load(fs.readFileSync(path.join(__dirname, '../../_images_index.yml'), { encoding: 'utf-8' }))
+  } else {
+    hexo.theme.config.index_images = data.index_images || []
+  }
+})

package/scripts/generaters/images.d.ts

@@ -0,0 +1 @@
+export {};

package/scripts/generaters/images.ts

@@ -0,0 +1,26 @@
+/* global hexo */
+'use strict'
+
+// @ts-ignore
+import fs = require('hexo-fs')
+
+hexo.extend.generator.register('images', function (locals) {
+  const theme = hexo.theme.config
+  const dir = 'source/_data/' + theme.assets + '/'
+
+  if (!fs.existsSync(dir)) { return }
+
+  const result = []
+  const files = fs.listDirSync(dir) as string[]
+
+  files.forEach((file) => {
+    result.push({
+      path: theme.assets + '/' + file,
+      data: function () {
+        return fs.createReadStream(dir + file)
+      }
+    })
+  })
+
+  return result
+})

package/scripts/generaters/index.d.ts

@@ -0,0 +1 @@
+export {};

package/scripts/generaters/index.ts

@@ -0,0 +1,110 @@
+// @ts-nocheck
+/* global hexo */
+'use strict'
+
+import fs = require('hexo-fs')
+import pagination from 'hexo-pagination'
+
+hexo.config.index_generator = Object.assign({
+  per_page: typeof hexo.config.per_page === 'undefined' ? 10 : hexo.config.per_page,
+  order_by: '-date'
+}, hexo.config.index_generator)
+
+hexo.extend.generator.register('index', function (locals) {
+  const covers = []
+  const catlist = []
+  let pages
+  const config = hexo.config
+  const sticky = locals.posts.find({ sticky: true }).sort(config.index_generator.order_by)
+  const posts = locals.posts.find({ sticky: {$in: [false, undefined]} }).sort(config.index_generator.order_by)
+  const paginationDir = config.pagination_dir || 'page'
+  const path = config.index_generator.path || ''
+  const categories = locals.categories
+
+  const getTopcat = function (cat) {
+    if (cat.parent) {
+      const pCat = categories.findOne({ _id: cat.parent })
+      return getTopcat(pCat)
+    } else {
+      return cat
+    }
+  }
+
+  if (categories && categories.length) {
+    categories.forEach((cat) => {
+      const cover = `source/_posts/${cat.slug}`
+      if (fs.existsSync(cover + '/cover.avif')) {
+        covers.push({
+          path: cat.slug + '/cover.avif',
+          data: function () {
+            return fs.createReadStream(cover + '/cover.avif')
+          }
+        })
+      } else if (fs.existsSync(cover + '/cover.webp')) {
+        covers.push({
+          path: cat.slug + '/cover.webp',
+          data: function () {
+            return fs.createReadStream(cover + '/cover.webp')
+          }
+        })
+      } else if (fs.existsSync(cover + '/cover.jpg')) {
+        covers.push({
+          path: cat.slug + '/cover.jpg',
+          data: function () {
+            return fs.createReadStream(cover + '/cover.jpg')
+          }
+        })
+
+        const topcat = getTopcat(cat)
+
+        if (topcat._id !== cat._id) {
+          cat.top = topcat
+        }
+
+        const child = categories.find({ parent: cat._id })
+        let pl = 6
+
+        if (child.length !== 0) {
+          cat.child = child.length
+          cat.subs = child.sort({ name: 1 }).limit(6).toArray()
+          pl = Math.max(0, pl - child.length)
+          if (pl > 0) {
+            cat.subs.push(...cat.posts.sort({ title: 1 })
+              .filter(function (item, i) { return item.categories.last()._id === cat._id })
+              .limit(pl).toArray())
+          }
+        } else {
+          cat.subs = cat.posts.sort({ title: 1 }).limit(6).toArray()
+        }
+
+        catlist.push(cat)
+      }
+    })
+  }
+
+  if (posts.length > 0) {
+    pages = pagination(path, posts, {
+      perPage: config.index_generator.per_page,
+      layout: ['index', 'archive'],
+      format: paginationDir + '/%d/',
+      data: {
+        __index: true,
+        catlist,
+        sticky
+      }
+    })
+  } else {
+    pages = [{
+      path,
+      layout: ['index', 'archive'],
+      data: {
+        __index: true,
+        catlist,
+        sticky,
+        current: 1,
+      }
+    }]
+  }
+
+  return [...covers, ...pages]
+})

package/scripts/generaters/pages.ts

@@ -0,0 +1,16 @@
+hexo.extend.generator.register('pages', function () {
+  const config = hexo.config
+
+  return [
+    {
+      path: config.category_dir + '/index.html',
+      data: { type: 'categories' },
+      layout: 'page'
+    },
+    {
+      path: config.tag_dir + '/index.html',
+      data: { type: 'tags' },
+      layout: 'page'
+    }
+  ]
+})

package/scripts/generaters/script.d.ts

@@ -0,0 +1 @@
+export {};

package/scripts/generaters/script.js

@@ -67,8 +67,6 @@ hexo.extend.generator.register('script', function (locals) {
             priority: theme.quicklink.priority
         },
         playerAPI: theme.playerAPI,
-        disableVL: theme.disableVL,
-        noPlayer: theme.experiments?.noPlayer,
         audio: undefined,
         fireworks: (theme.fireworks && theme.fireworks.enable && theme.fireworks.options)
             ? theme.fireworks.options
@@ -87,23 +85,41 @@ hexo.extend.generator.register('script', function (locals) {
     }
     let text;
     let enterPoint;
-    if (fs.existsSync('themes/shokaX/source/js/_app/pjax/siteInit.js')) {
-        enterPoint = 'themes/shokaX/source/js/_app/pjax/siteInit.js';
+    if (fs.existsSync('themes/shokaX/source/js/_app/pjax/siteInit.ts')) {
+        enterPoint = 'themes/shokaX/source/js/_app/pjax/siteInit.ts';
     }
     else {
-        enterPoint = 'node_modules/hexo-theme-shokax/source/js/_app/pjax/siteInit.js';
+        enterPoint = 'node_modules/hexo-theme-shokax/source/js/_app/pjax/siteInit.ts';
     }
     text = 'const CONFIG = ' + JSON.stringify(siteConfig) + ';';
     (0, esbuild_1.buildSync)({
         entryPoints: [enterPoint],
         bundle: true,
         outfile: 'shokax_temp.js',
+        tsconfigRaw: {
+            compilerOptions: {
+                target: 'ES2022',
+                esModuleInterop: true,
+                module: 'ESNext',
+                moduleResolution: 'Node',
+                skipLibCheck: true
+            }
+        },
         platform: 'browser',
         format: 'iife',
         target: ['es2022'],
         minify: true,
         define: {
-            __UNLAZY_LOGGING__: 'false'
+            __UNLAZY_LOGGING__: 'false',
+            __UNLAZY_HASH_DECODING__: theme.modules.unlazyHash ? 'true' : 'false',
+            __shokax_player__: theme.modules.player ? 'true' : 'false',
+            __shokax_VL__: theme.modules.visibilityListener ? 'true' : 'false',
+            __shokax_fireworks__: (theme.fireworks && theme.fireworks.enable && theme.fireworks.options && theme.modules.fireworks) ? 'true' : 'false',
+            __shokax_search__: config?.algolia ? 'true' : 'false',
+            __shokax_outime__: theme.outime.enable ? 'true' : 'false',
+            __shokax_tabs__: theme.modules.tabs ? 'true' : 'false',
+            __shokax_quiz__: theme.modules.quiz ? 'true' : 'false',
+            __shokax_fancybox__: theme.modules.fancybox ? 'true' : 'false'
         }
     });
     text += fs.readFileSync('shokax_temp.js');