hexo-theme-shokax 0.1.9 → 0.2.0-rc1

package/README.md

@@ -7,7 +7,6 @@
 语言(language): 简体中文 | [English](./README_en.md) \
 此项目是shoka的一个二次开发版(算精神续作),致力于提高性能和优化魔改体验 \
 诞生原因是目前shoka已经两年没有更新了,积压了大量BUG和功能请求。\
-`0.0.2-alpha2`开始,`lantern`和`qweather`已迁移为插件
 
 shokaX的社区资源导航和插件仓库为[awesome-shokaX](https://github.com/zkz098/awesome-shokaX)
 
@@ -39,7 +38,7 @@ npm i shokax-cli --location=global
 # hexo init 初始化环境
 SXC install shokaX
 ```
-[点此](https://docs.kaitaku.xyz/guide/#%E9%85%8D%E7%BD%AE%E4%B8%BB%E9%A2%98)以进行下一步配置([国内加速源](https://www.kaitaku.xyz/webbuild/shokaX/))
+[点此](https://docs.kaitaku.xyz/guide/#%E9%85%8D%E7%BD%AE%E4%B8%BB%E9%A2%98)以进行下一步配置
 
 github仓库建议通过右边的 releases 下载,步骤为:
 - 点击 Releases 的 Latest 版本
@@ -71,14 +70,8 @@ GPL许可证主要目的是限制修改后的分发行为，避免未经许可
 | Hexo             | Hexo contributors | 为本项目提供了良好的基础       |
 | hexo-theme-shoka | amehime           | 本项目的父主题            |
 
-## 贡献者
-shokaX的贡献者包括以非代码形式进行贡献的开发者(例如社区教程、想法分享、DEBUG等)和以代码形式进行贡献的开发者
-
-| 名称                                      | 站点                         |
-|:----------------------------------------|:---------------------------|
-| Lavender                                | https://www.lavenderdh.cn/ |
-| AdminZhang                              | https://www.a9-9.top/      |
-| [D-Sketon](https://github.com/D-Sketon) | https://d-sketon.top/      |
+## 开发者们
+[![](https://contributors-img.web.app/image?repo=zkz098/hexo-theme-shokaX)](https://github.com/zkz098/hexo-theme-shokaX/graphs/contributors)
 
 ## 特别鸣谢
 [<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" width="25%">](https://jb.gg/OpenSourceSupport)

package/_config.yml

@@ -21,7 +21,7 @@ pwa:
 
 # 实验性特性
 experiments:
-  noIE: true # 阻止IE浏览器访问(ShokaX不支持IE的任何版本)
+  noIE: true # TODO 阻止IE浏览器访问(ShokaX不支持IE的任何版本)
   noPlayer: false # 禁用音乐播放器
   gradient: false # 使用CSS渐变作为文章封面
   fixedCover: "" # 主页面cover(为空则使用bing随机图片)

package/layout/_partials/sidebar/menu.pug

@@ -1,5 +1,5 @@
-mixin item(name, path, parent, dropdown, sublist)
-    - var trimn = (str)=>{if (str!=null) return str.trim(); else return ""}
+mixin item(name, path, parent, sublist)
+    - var trimn = (str)=>{return str!=null?str.trim():"";}
     - var path = path.split('||')
     - var itemURL = path[0].trim()
     - if (!itemURL.startsWith('http')){ itemURL = itemURL.replace('//', '/') }
@@ -12,19 +12,18 @@ mixin item(name, path, parent, dropdown, sublist)
                     != menuIcon + menuText
             else
                 != _url(itemURL, menuIcon + menuText, {rel: 'section'})
-            if dropdown
-                ul(class="submenu")
-                    each subvalue, subname in sublist
-                        - var path = subvalue.split('||')
-                        - var itemURL = path[0].trim()
-                        - if (itemURL==='/') itemURL='javascript:void(0)'
-                        - var menuText = __('menu.' + subname).replace('menu.', '')
-                        if subname == 'default'
-                            - var menuText = __('menu.' + name).replace('menu.', '')
-                        else
-                            - var menuIcon = '<i class="ic i-' + trimn(path[1]) + '"></i>'
-                            li(class="item")
-                                != _url(itemURL, menuIcon + menuText, {rel: 'section'})
+            ul(class="submenu")
+                each subvalue, subname in sublist
+                    - var path = subvalue.split('||')
+                    - var itemURL = path[0].trim()
+                    - if (itemURL==='/') itemURL='javascript:void(0)'
+                    - var menuText = __('menu.' + subname).replace('menu.', '')
+                    if subname == 'default'
+                        - var menuText = __('menu.' + name).replace('menu.', '')
+                    else
+                        - var menuIcon = '<i class="ic i-' + trimn(path[1]) + '"></i>'
+                        li(class="item")
+                            != _url(itemURL, menuIcon + menuText, {rel: 'section'})
     else
         li(class="item")
             != _url(itemURL, menuIcon + menuText, {rel: 'section'})
@@ -33,6 +32,6 @@ each value, name in theme.menu
     if value == '[object Object]'
         each subvalue, subname in value
             if subname == 'default'
-                +item(name, subvalue, true, true, value)
+                +item(name, subvalue, true, value)
     else
         +item(name, value)

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "hexo-theme-shokax",
-    "version": "0.1.9",
+    "version": "0.2.0-rc1",
     "description": "a hexo theme based on shoka",
     "main": "index.js",
     "repository": "https://github.com/zkz098/hexo-theme-shokaX",
@@ -19,10 +19,10 @@
         "@types/jquery": "^3.5.16",
         "@types/js-yaml": "^4.0.5",
         "@types/lozad": "^1.16.1",
-        "@types/node": "^18.13.0",
+        "@types/node": "^18.14.1",
         "@types/shelljs": "^0.8.11",
-        "@typescript-eslint/eslint-plugin": "^5.51.0",
-        "@typescript-eslint/parser": "^5.51.0",
+        "@typescript-eslint/eslint-plugin": "^5.53.0",
+        "@typescript-eslint/parser": "^5.53.0",
         "@vuepress/client": "2.0.0-beta.60",
         "eslint": "^8.34.0",
         "eslint-config-standard": "^17.0.0",
@@ -30,10 +30,12 @@
         "eslint-plugin-n": "^15.6.1",
         "eslint-plugin-promise": "^6.1.1",
         "eslint-plugin-vue": "^9.9.0",
+        "hexo-fs": "^4.1.1",
+        "hexo-util": "^3.0.1",
         "typescript": "^4.9.5",
         "vue": "^3.2.47",
         "vuepress": "2.0.0-beta.60",
-        "vuepress-plugin-sitemap2": "2.0.0-beta.180"
+        "vuepress-plugin-sitemap2": "2.0.0-beta.181"
     },
     "dependencies": {
         "js-yaml": "^4.1.0"

package/scripts/filters/post.js

@@ -1,21 +1,17 @@
+/* global hexo */
 'use strict'
 
 hexo.extend.filter.register('after_post_render', data => {
   const { config } = hexo
-  const theme = hexo.theme.config
 
   data.content = data.content.replace(/(<img[^>]*) src=/img, '$1 data-src=')
 
-  const url = require('url')
-  // eslint-disable-next-line n/no-deprecated-api
-  const siteHost = url.parse(config.url).hostname || config.url
+  const siteHost = new URL(config.url).hostname || config.url
   data.content = data.content.replace(/<a[^>]* href="([^"]+)"[^>]*>([^<]*)<\/a>/img, (match, href, html) => {
-    // Exit if the href attribute doesn't exists.
     if (!href) return match
 
     // Exit if the url has same host with `config.url`, which means it's an internal link.
-    // eslint-disable-next-line n/no-deprecated-api
-    const link = url.parse(href)
+    const link = new URL(href, config.url)
     if (!link.protocol || link.hostname === siteHost) return match
 
     return `<span class="exturl" data-url="${Buffer.from(href).toString('base64')}">${html}</span>`

package/scripts/generaters/config.js

@@ -14,7 +14,6 @@ hexo.extend.filter.register('before_generate', () => {
   const data = hexo.locals.get('data')
 
   if (data.languages) {
-    const { language } = hexo.config
     const { i18n } = hexo.theme
 
     const mergeLang = lang => {

package/scripts/generaters/images.js

@@ -4,7 +4,6 @@
 const fs = require('hexo-fs')
 
 hexo.extend.generator.register('images', function (locals) {
-  const config = hexo.config
   const theme = hexo.theme.config
   const dir = 'source/_data/' + theme.assets + '/'
 

package/scripts/generaters/index.js

@@ -14,7 +14,6 @@ hexo.extend.generator.register('index', function (locals) {
   const catlist = []
   let pages
   const config = hexo.config
-  const theme = hexo.theme.config
   const sticky = locals.posts.find({ sticky: true }).sort(config.index_generator.order_by)
   const posts = locals.posts.find({ sticky: { $exists: false } }).sort(config.index_generator.order_by)
   const paginationDir = config.pagination_dir || 'page'
@@ -69,9 +68,9 @@ hexo.extend.generator.register('index', function (locals) {
           cat.subs = child.sort({ name: 1 }).limit(6).toArray()
           pl = Math.max(0, pl - child.length)
           if (pl > 0) {
-            // eslint-disable-next-line array-callback-return
+            // TODO 需要测试
             cat.subs.push.apply(cat.subs, cat.posts.sort({ title: 1 }).filter(function (item, i) {
-              if (item.categories.last()._id === cat._id) { return true }
+              return item.categories.last()._id === cat._id
             }).limit(pl).toArray())
           }
         } else {

package/scripts/helpers/engine.js

@@ -3,10 +3,8 @@
 'use strict'
 
 const { htmlTag, url_for } = require('hexo-util')
-const url = require('url')
-const crypto = require('crypto')
 
-const randomServer = parseInt(Math.random() * 4, 10) + 1
+const randomServer = parseInt(String(Math.random() * 4), 10) + 1
 
 const randomBG = function (count = 1, image_server = null, image_list = []) {
   let i
@@ -53,24 +51,27 @@ const randomBG = function (count = 1, image_server = null, image_list = []) {
   return parseImage(image_list[Math.floor(Math.random() * image_list.length)], 'mw690')
 }
 
+// 注册hexo主题中的URL帮助方法
 hexo.extend.helper.register('_url', function (path, text, options = {}) {
+  // 如果未提供URL路径，则返回
   if (!path) { return }
 
+  // 获取hexo配置和URL路径信息
   const { config } = this
-  // eslint-disable-next-line n/no-deprecated-api
-  const data = url.parse(path)
-  // eslint-disable-next-line n/no-deprecated-api
-  const siteHost = url.parse(config.url).hostname || config.url
+  const data = new URL(path, hexo.config.url)
+  const siteHost = new URL(config.url).hostname || config.url
 
+  // 获取主题配置
   const theme = hexo.theme.config
   let exturl = ''
   let tag = 'a'
   let attrs = { href: url_for.call(this, path) }
 
-  // If `exturl` enabled, set spanned links only on external links.
+  // 如果启用了 `exturl`，则只为外部链接设置spanned链接。
   if (theme.exturl && data.protocol && data.hostname !== siteHost) {
     tag = 'span'
     exturl = 'exturl'
+    // 编码URL字符串，并将其存储在数据属性中。
     const encoded = Buffer.from(path).toString('base64')
     attrs = {
       class: exturl,
@@ -80,8 +81,8 @@ hexo.extend.helper.register('_url', function (path, text, options = {}) {
 
   for (const key in options) {
     /**
-         * If option have `class` attribute, add it to
-         * 'exturl' class if `exturl` option enabled.
+         * 如果选项包含 `class` 属性，则将其添加到 `exturl` 类中（如果启用了 `exturl` 选项）。
+         * 否则，将其添加到属性集中。
          */
     if (exturl !== '' && key === 'class') {
       attrs[key] += ' ' + options[key]
@@ -94,20 +95,21 @@ hexo.extend.helper.register('_url', function (path, text, options = {}) {
     attrs.class = attrs.class.join(' ')
   }
 
-  // If it's external link, rewrite attributes.
+  // 如果是外部链接，则重写属性
   if (data.protocol && data.hostname !== siteHost) {
     attrs.external = null
 
     if (!theme.exturl) {
-      // Only for simple link need to rewrite/add attributes.
+      // 仅需要为简单链接重写/添加属性。
       attrs.rel = 'noopener'
       attrs.target = '_blank'
     } else {
-      // Remove rel attributes for `exturl` in main menu.
+      // 在主菜单中移除 `exturl` 的 rel 属性。
       attrs.rel = null
     }
   }
 
+  // 返回HTML标记字符串
   return htmlTag(tag, attrs, decodeURI(text), false)
 })
 
@@ -123,7 +125,7 @@ hexo.extend.helper.register('_image_url', function (img, path = '') {
 })
 
 hexo.extend.helper.register('_cover', function (item, num) {
-  const { statics, js, image_server, image_list } = hexo.theme.config
+  const { image_server, image_list } = hexo.theme.config
 
   if (item.cover) {
     return this._image_url(item.cover, item.path)
@@ -134,20 +136,17 @@ hexo.extend.helper.register('_cover', function (item, num) {
   }
 })
 
-// TODO 此函数已被废弃
-hexo.extend.helper.register('_md5', function (path) {
-  const str = url_for.call(this, path)
-  str.replace('index.html', '')
-  return crypto.createHash('md5').update(str).digest('hex')
-})
-
+// 注册hexo主题的永久链接帮助方法
 hexo.extend.helper.register('_permapath', function (str) {
-  // https://support.google.com/webmasters/answer/139066
+  // 获取hexo的永久链接配置
   const { permalink } = hexo.config
+  // 将输入字符串中的'index.html'替换为空字符串
   let url = str.replace(/index\.html$/, '')
+  // 如果永久链接不以'.html'结尾，将输入字符串中的'.html'替换为空字符串
   if (!permalink.endsWith('.html')) {
     url = url.replace(/\.html$/, '')
   }
+  // 返回处理后的URL字符串
   return url
 })
 
@@ -158,21 +157,31 @@ hexo.extend.helper.register('canonical', function () {
 /**
  * Get page path given a certain language tag
  */
+// 注册hexo主题的国际化路径帮助方法
 hexo.extend.helper.register('i18n_path', function (language) {
+  // 获取当前页面的path和lang
   const { path, lang } = this.page
+  // 如果path以lang开头，则截取掉lang部分，作为基础路径
   const base = path.startsWith(lang) ? path.slice(lang.length + 1) : path
+  // 通过调用url_for方法，生成国际化路径
   return url_for.call(this, `${this.languages.indexOf(language) === 0 ? '' : '/' + language}/${base}`)
 })
 
 /**
  * Get the language name
  */
+// 注册hexo主题的语言名称帮助方法
 hexo.extend.helper.register('language_name', function (language) {
+  // 从主题配置中获取指定语言的名称
   const name = hexo.theme.i18n.__(language)('name')
+  // 如果名称为默认值'name'，则返回语言代码，否则返回语言名称
   return name === 'name' ? language : name
 })
 
 hexo.extend.helper.register('random_color', function () {
+  /**
+  @type {number[]}
+   */
   const arr = []
   for (let i = 0; i < 3; i++) {
     arr.push(Math.floor(Math.random() * 128 + 128))

package/source/js/_app/global.js

@@ -1,5 +1,5 @@
 const statics = CONFIG.statics.indexOf('//') > 0 ? CONFIG.statics : CONFIG.root;
-const scrollAction = { x: undefined, y: undefined };
+const scrollAction = { x: 0, y: 0 };
 let diffY = 0;
 let originTitle, titleTime;
 const BODY = document.getElementsByTagName('body')[0];
@@ -53,7 +53,7 @@ const lazyload = lozad('img, [data-background-image]', {
     }
 });
 const Loader = {
-    timer: null,
+    timer: undefined,
     lock: false,
     show: function () {
         clearTimeout(this.timer);

package/source/js/_app/player.js

@@ -231,7 +231,7 @@ const mediaPlayer = function (t, config) {
             const el = playlist.el;
             playlist.data.map(function (item, index) {
                 if (item.el) {
-                    return;
+                    return null;
                 }
                 const id = 'list-' + t.player._id + '-' + item.group;
                 let tab = $dom('#' + id);
@@ -320,7 +320,7 @@ const mediaPlayer = function (t, config) {
             }, 300);
         }
     };
-    let option = {
+    const option = {
         type: 'audio',
         mode: 'random',
         btns: ['play-pause', 'music'],
@@ -345,7 +345,7 @@ const mediaPlayer = function (t, config) {
             }
         }
     };
-    let utils = {
+    const utils = {
         random: function (len) {
             return Math.floor((Math.random() * len));
         },