hexo-theme-shokax 0.0.1-alpha5 → 0.0.2-alpha1

package/LICENSE

@@ -1,21 +1,28 @@
-MIT License
+BSD 3-Clause License
 
-Copyright (c) 2022 zkz098
+Copyright (c) 2022, zkz098
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -17,8 +17,7 @@
 - [x] 注入js和css支持
 - [x] 自定义font
 - [x] 部分功能调整为可关闭
-- [ ] 重构lib方法(长期计划)
-- [ ] 异步化js
+- [ ] 插件系统
 
 ## 和shoka的区别
 原先shoka使用了javascript+Native+nunjucks的技术 \
@@ -35,7 +34,8 @@ SXC install shokaX
 ```
 
 # 许可证
-许可证: MIT \
+许可证: BSD-3-Clause \
+请注意: `0.0.1-alpha6`版本开始,shokaX使用BSD协议,这意味着删除页脚处的shokaX标识是违反许可证的
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fzkz098%2Fhexo-theme-shokaX.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fzkz098%2Fhexo-theme-shokaX?ref=badge_large)
 
 # 致谢名单

package/_config.yml

@@ -47,11 +47,6 @@ auto_dark: # 自动亮/暗模式
   start: 20     #开始时间
   end: 7        #结束时间
 
-plugin:
-  enable: false
-  load:
-    # - example
-
 auto_scroll: true
 
 loader:

package/layout/_mixin/comment.pug

@@ -1,4 +1,5 @@
 mixin CommentRender()
+    != shokax_inject('comment')
     - var tk = theme?.twikoo?.enable,wl = theme?.waline?.enable
     if page.comment !== false
         if tk
@@ -8,3 +9,4 @@ mixin CommentRender()
             div(class="warp" id="wcomments")
             != _init_comments("waline")
 
+

package/layout/_partials/footer.pug

@@ -36,5 +36,5 @@ div(class="status")
                     img(src=theme.statics + theme.assets + '/' + theme.footer.icp.icon style="max-width: 2em;display:inline;")
                     != beianN
 
-!= insert_footer()
+!= shokax_inject('footer')
 

package/layout/_partials/header.pug

@@ -14,6 +14,7 @@ nav(id="nav")
                 i(class="ic" :class="{'i-sun': !themeStatus,'i-moon': themeStatus}")
             li(class="item search")
                 i(class="ic i-search")
+            != shokax_inject('rightNav')
             li(class="item weather")
                 div(id="he-plugin-simple")
 

package/layout/_partials/layout.pug

@@ -7,6 +7,7 @@ html(lang=page.language?page.language:config.language, style=theme.grayMode ? 'f
     head
         != partial('_partials/head/head.pug', {}, {cache: true})
         != partial('_partials/head/head_com.pug')
+        != shokax_inject('head')
         title
             block title
                 != `${alternate?alternate + " = ":""}${title}${subtitle?" = "+subtitle:""}`
@@ -133,10 +134,11 @@ html(lang=page.language?page.language:config.language, style=theme.grayMode ? 'f
             != _vendor_js()
         != _js('app.js')
         != partial('_partials/third-party/baidu-analytics.pug', {}, {cache: true})
-        != partial('_partials/third-party/qweather.pug', {}, {cache: true})
+        if theme.qweather.enable
+            != partial('_partials/third-party/qweather.pug', {}, {cache: true})
         != partial('_partials/third-party/clarity.pug', {}, {cache: true})
         != _new_comments('twikoo')
-        if theme.qweather.enable
+
 
         - var jsInjects = theme?.inject?.body?.js,cssInjects = theme?.inject?.body?.css
         if cssInjects
@@ -145,5 +147,7 @@ html(lang=page.language?page.language:config.language, style=theme.grayMode ? 'f
         if jsInjects
             != js(jsInjects)
 
+        != shokax_inject('bodyEnd')
+
 
 

package/layout/_partials/post/footer.pug

@@ -11,3 +11,4 @@ div(class="meta")
                 != __('post.edited')
             time(title=__('post.modified') + __('symbol.colon') + full_date(post.updated) itemprop="dateModified" datetime=moment(post.updated).format())
                 != date(post.updated)
+    != shokax_inject('postMeta')

package/layout/_partials/post/post.pug

@@ -24,3 +24,4 @@ article(itemscope itemtype="http://schema.org/Article" class="post block" lang="
             != partial('_partials/post/reward.pug', {}, {cache: true})
         if theme.creative_commons.license
             != partial('_partials/post/copyright.pug')
+    != shokax_inject('postBodyEnd')

package/layout/_partials/sidebar/overview.pug

@@ -35,6 +35,8 @@ div(class="social")
         - var sidebarIcon = '<i class="ic i-' + link.split('||')[1].trim() + '"></i>'
         != _url(sidebarURL, sidebarIcon, {title: sidebarURL, class: 'item ' + name})
 
+!= shokax_inject('sidebar')
+
 div(class="menu")
     //!= partial('_partials/sidebar/menu.pug', {}, {cache: true})
     != partial('_partials/sidebar/menu.pug')

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "hexo-theme-shokax",
-  "version": "0.0.1-alpha5",
+  "version": "0.0.2-alpha1",
   "description": "a hexo theme based on shoka",
   "main": "index.js",
   "repository": "https://github.com/zkz098/hexo-theme-shokaX",
   "author": "Chou kaitaku",
-  "license": "MIT",
+  "license": "BSD-3-Clause",
   "scripts": {
     "test": "cd ./source/js && tsc"
   },

package/scripts/helpers/engine.js

@@ -182,3 +182,9 @@ hexo.extend.helper.register('random_color', function () {
       b.toString(16).length > 1 ? b.toString(16) : '0' + b.toString(16)
     }`
 })
+
+hexo.extend.helper.register('shokax_inject', function (point) {
+  return hexo.theme.config.injects[point]
+    .map(item => this.partial(item.layout, item.locals, item.options))
+    .join('')
+})

package/scripts/plugin/index.js

@@ -1,58 +1,6 @@
 /* global hexo */
-'use strict'
 
-/** @type {Map<string, string[]>} */
-const insertions = new Map()
-class TemplateBlock {
-  constructor (text, type = 'raw') {
-    this.text = text
-    this.type = type
-    this.result = ''
-  }
-
-  render () {
-    if (this.type === 'raw' || this.type === 'html') {
-      this.result = this.text
-    }
-    this.result = hexo.render.renderSync({ text: this.text, engine: this.type })
-  }
-
-  repalceTag (...tag) {
-    tag.forEach((item) => {
-      this.text = this.text.replace(item.tag, item.value)
-    })
-  }
-
-  insert (location) {
-    if (insertions.get(location)) {
-      insertions.get(location).push(this.result)
-    } else {
-      insertions.set(location, [])
-    }
-  }
-}
-
-const toolpack = {
-  TemplateBlock
-}
-
-hexo.extend.helper.register('insert_footer', () => {
-  if (hexo.theme.config?.plugin?.enable && insertions.get('footer')) {
-    let res = ''
-    insertions.get('footer').forEach((item) => {
-      res += item
-    })
-    return res
-  }
+hexo.on('generateBefore', () => {
+  // 加载`theme_injects`过滤器
+  require('./lib/injects')(hexo)
 })
-
-if (hexo.theme.config?.plugin?.enable) {
-  hexo.theme.config.plugin.load.forEach((item) => {
-    const p = require(item)
-    console.log(p)
-    if (p.prepare) {
-      p.prepare(hexo, this)
-    }
-    p.main(hexo, this, toolpack)
-  })
-}

package/scripts/plugin/lib/injects-point.js

@@ -0,0 +1,19 @@
+'use strict'
+
+module.exports = {
+  views: [
+    'head',
+    'sidebar',
+    'rightNav',
+    'postMeta',
+    'postBodyEnd',
+    'footer',
+    'bodyEnd',
+    'comment'
+  ],
+  styles: [
+    'variable',
+    'mixin',
+    'style'
+  ]
+}

package/scripts/plugin/lib/injects.js

@@ -0,0 +1,88 @@
+'use strict'
+
+const fs = require('fs')
+const path = require('path')
+const points = require('./injects-point')
+const defaultExtname = '.pug'
+
+// Defining stylus types
+class StylusInject {
+  constructor (base_dir) {
+    this.base_dir = base_dir
+    this.files = []
+  }
+
+  push (file) {
+    // Get absolute path base on hexo dir
+    this.files.push(path.resolve(this.base_dir, file))
+  }
+}
+
+// Defining view types
+class ViewInject {
+  constructor (base_dir) {
+    this.base_dir = base_dir
+    this.raws = []
+  }
+
+  raw (name, raw, ...args) {
+    // Set default extname
+    if (path.extname(name) === '') {
+      name += defaultExtname
+    }
+    this.raws.push({ name, raw, args })
+  }
+
+  file (name, file, ...args) {
+    // Set default extname from file's extname
+    if (path.extname(name) === '') {
+      name += path.extname(file)
+    }
+    // Get absolute path base on hexo dir
+    this.raw(name, fs.readFileSync(path.resolve(this.base_dir, file), 'utf8'), ...args)
+  }
+}
+
+// Init injects
+function initInject (base_dir) {
+  const injects = {}
+  points.styles.forEach(item => {
+    injects[item] = new StylusInject(base_dir)
+  })
+  points.views.forEach(item => {
+    injects[item] = new ViewInject(base_dir)
+  })
+  return injects
+}
+
+module.exports = (hexo) => {
+  // Exec theme_inject filter
+  const injects = initInject(hexo.base_dir)
+  hexo.execFilterSync('theme_inject', injects)
+  hexo.theme.config.injects = {}
+
+  // Inject stylus
+  points.styles.forEach(type => {
+    hexo.theme.config.injects[type] = injects[type].files
+  })
+
+  // Inject views
+  points.views.forEach(type => {
+    const configs = Object.create(null)
+    hexo.theme.config.injects[type] = []
+    // Add or override view.
+    injects[type].raws.forEach((injectObj, index) => {
+      const name = `inject/${type}/${injectObj.name}`
+      hexo.theme.setView(name, injectObj.raw)
+      configs[name] = {
+        layout: name,
+        locals: injectObj.args[0],
+        options: injectObj.args[1],
+        order: injectObj.args[2] || index
+      }
+    })
+    // Views sort.
+    hexo.theme.config.injects[type] = Object.values(configs)
+      .sort((x, y) => x.order - y.order)
+  })
+}

package/source/css/app.styl

@@ -1,7 +1,13 @@
 @import "_variables";
 
+for $inject_variable in hexo-config('injects.variable')
+  @import $inject_variable;
+
 @import "_mixins";
 
+for $inject_mixin in hexo-config('injects.mixin')
+  @import $inject_mixin;
+
 if $colors = hexo-config('style.colors')
   @import $colors;
 else
@@ -25,3 +31,8 @@ if $custom = hexo-config('style.custom')
   @import $custom;
 
 @import "plugin.styl"
+
+for $inject_style in hexo-config('injects.style')
+  @import $inject_style;
+
+