hexo-component-inferno 1.0.2 → 2.0.0

package/lib/hexo/tag/tabs.js

@@ -0,0 +1,290 @@
+/**
+ * Register custom Hexo tag {% tabs %}.
+ * @module hexo/tag/tabs
+ */
+
+/**
+ * Register custom Hexo tag {% tabs %}.
+ * <p>
+ * This tag is rendered as a Bulma tabs component.
+ * <p>
+ * Each individual tab must be wrapped with <code>&lt;!-- tab [...tab_param] --&gt;&lt;!-- endtab --&gt;</code>
+ *
+ * <h5>Tag Parameters:<h5>
+ * <table class="params">
+ * <tr>
+ *     <th>Name</th>
+ *     <th>Type</th>
+ *     <th class="description">Description</th>
+ * </tr>
+ * <tr>
+ *     <td class="name"><code>align</code></td>
+ *     <td class="type"><span class="param-type"><code>string</code></span></td>
+ *     <td class="description">[Optional] Alignment of the tabs. Available values are: left, centered, right, fullwidth. Default alignment is left.</td>
+ * </tr>
+ * <tr>
+ *     <td class="name"><code>size</code></td>
+ *     <td class="type"><span class="param-type"><code>string</code></span></td>
+ *     <td class="description">[Optional] Size of the tabs. Available values are: small, medium, large. Default size is normal.</td>
+ * </tr>
+ * <tr>
+ *     <td class="name"><code>style</code></td>
+ *     <td class="type"><span class="param-type"><code>string</code></span></td>
+ *     <td class="description">[Optional] Style of the tabs. Available values are: boxed, toggle, toggle-rounded. Default style is none.</td>
+ * </tr>
+ * </table>
+ *
+ * <h5>Tab Parameters:<h5>
+ * <table class="params">
+ * <tr>
+ *     <th>Name</th>
+ *     <th>Type</th>
+ *     <th class="description">Description</th>
+ * </tr>
+ * <tr>
+ *     <td class="name"><code>id</code></td>
+ *     <td class="type"><span class="param-type"><code>string</code></span></td>
+ *     <td class="description">[Optional] The ID of the current tab. This value must be unique on each page.</td>
+ * </tr>
+ * <tr>
+ *     <td class="name"><code>active</code></td>
+ *     <td class="type"><span class="param-type"><code>boolean</code></span></td>
+ *     <td class="description">[Optional] Whether to show current tab by default. Only one of the tabs can be set to active.</td>
+ * </tr>
+ * <tr>
+ *     <td class="name"><code>title</code></td>
+ *     <td class="type"><span class="param-type"><code>string</code></span></td>
+ *     <td class="description">[Optional] Title of the current tab.</td>
+ * </tr>
+ * <tr>
+ *     <td class="name"><code>icon</code></td>
+ *     <td class="type"><span class="param-type"><code>string</code></span></td>
+ *     <td class="description">[Optional] Icon of the current tab. Use FontAwesome icon class name for this field.</td>
+ * </tr>
+ * </table>
+ *
+ * @see https://bulma.io/documentation/components/tabs/.
+ *
+ * @param {Hexo} hexo The Hexo instance.
+ *
+ * @example
+ * {% tabs align:fullwidth size:small style:toggle-rounded %}
+ * <!-- tab active id:tab_hello title:Hello -->
+ * This is hello.
+ * <!-- endtab -->
+ * <!-- tab id:tab_info 'icon:fas fa-info' 'title:Info Tab' -->This is info.<!-- endtab -->
+ * {% endmessage %}
+ */
+module.exports = function (hexo) {
+  function splitTabOptions(s) {
+    const options = [];
+    const EOL = -1;
+    let i = 0;
+    let state = 1;
+    let begin = 0;
+
+    while (i <= s.length) {
+      const c = i < s.length ? s.charAt(i) : '';
+
+      switch (state) {
+        case 1:
+          if (c === ' ') {
+            state = 1;
+            begin = i + 1;
+          } else if (c === '"') {
+            state = 2;
+            begin = i + 1;
+          } else if (c === "'") {
+            state = 4;
+            begin = i + 1;
+          } else if (c === '') {
+            state = EOL;
+          } else {
+            state = 7;
+          }
+
+          break;
+
+        case 2:
+          if (c === '\\') {
+            state = 3;
+          } else if (c === '"') {
+            state = 6;
+          }
+
+          break;
+
+        case 3:
+          state = 2;
+          break;
+
+        case 4:
+          if (c === '\\') {
+            state = 5;
+          } else if (c === "'") {
+            state = 6;
+          }
+
+          break;
+
+        case 5:
+          state = 4;
+          break;
+
+        case 6:
+          options.push(s.substring(begin, i - 1));
+          begin = i + 1;
+
+          if (c === ' ') {
+            state = 1;
+          } else if (c === '') {
+            state = EOL;
+          } else {
+            throw new Error(`malformatted tab options: ${s}`);
+          }
+
+          break;
+
+        case 7:
+          if (c === ' ') {
+            options.push(s.substring(begin, i));
+            begin = i + 1;
+            state = 1;
+          } else if (c === '') {
+            options.push(s.substring(begin, i));
+            begin = i + 1;
+            state = EOL;
+          }
+
+          break;
+      }
+
+      i++;
+    }
+
+    if (state !== EOL) {
+      throw new Error(`malformatted tab options: ${s}`);
+    }
+
+    return options;
+  }
+
+  function processTag(options, content) {
+    let classes = '';
+
+    for (const option of options) {
+      const [key, value] = option.split(':');
+
+      switch (key) {
+        case 'align':
+          classes += ` is-${value}`;
+          break;
+
+        case 'size':
+          classes += ` is-${value}`;
+          break;
+
+        case 'style':
+          if (value === 'toggle-rounded') {
+            classes += ' is-toggle';
+          }
+
+          classes += ` is-${value}`;
+          break;
+      }
+    }
+
+    const pattern = /<!--\s*tab\s*(.*?)\s*-->([\s\S]*?)<!--\s*endtab\s*-->/g;
+    let match;
+    let tabElements = '';
+    let contentElements = '';
+
+    while ((match = pattern.exec(content)) !== null) {
+      const [, tabOptions, tabContent] = match;
+      let id = 'tab-' + Date.now() + (Math.random() * 1000 | 0);
+      let icon = '';
+      let title = '';
+      let active = false;
+
+      for (const option of splitTabOptions(tabOptions)) {
+        const [key, value] = option.split(':');
+
+        switch (key) {
+          case 'id':
+            id = value;
+            break;
+
+          case 'active':
+            active = true;
+            break;
+
+          case 'icon':
+            icon = `<span class="icon is-small ml-0">
+                <i class="${value}" aria-hidden="true"></i>
+            </span>`;
+            break;
+
+          case 'title':
+            title = value;
+            break;
+        }
+      }
+
+      tabElements += `<li${active ? ' class="is-active"' : ''}>
+          <a href="#${id}">
+              ${hexo.render.renderSync({
+        text: icon + title,
+        engine: 'markdown'
+      })}
+          </a>
+      </li>`;
+      contentElements += `<div id="${id}" class="tab-content${active ? '' : ' is-hidden'}">
+          ${hexo.render.renderSync({
+        text: tabContent,
+        engine: 'markdown'
+      })}
+      </div>`;
+    }
+
+    return `<div class="tabs my-3${classes}">
+        <ul class="mx-0 my-0">
+            ${tabElements}
+        </ul>
+    </div>
+    ${contentElements}`;
+  }
+
+  const script = `<script>
+  (function () {
+      function switchTab() {
+          if (!location.hash) {
+            return;
+          }
+          Array
+              .from(document.querySelectorAll('.tab-content'))
+              .forEach($tab => {
+                  $tab.classList.add('is-hidden');
+              });
+          Array
+              .from(document.querySelectorAll('.tabs li'))
+              .forEach($tab => {
+                  $tab.classList.remove('is-active');
+              });
+          const $activeTab = document.querySelector(location.hash);
+          if ($activeTab) {
+              $activeTab.classList.remove('is-hidden');
+          }
+          const $tabMenu = document.querySelector(\`a[href="\${location.hash}"]\`);
+          if ($tabMenu) {
+              $tabMenu.parentElement.classList.add('is-active');
+          }
+      }
+      switchTab();
+      window.addEventListener('hashchange', switchTab, false);
+  })();
+  </script>`;
+  hexo.extend.injector.register('head_end', script);
+  hexo.extend.tag.register('tabs', processTag, {
+    ends: true
+  });
+};

package/lib/hexo/tag/tabs.test.js

@@ -0,0 +1,106 @@
+const {
+  join
+} = require('path');
+
+const Hexo = require('hexo');
+
+const {
+  minify
+} = require('html-minifier');
+
+const cheerio = require('cheerio');
+
+const register = require('./tabs');
+
+const rootDir = join(__dirname, '../../../fixture/site');
+const hexo = new Hexo(rootDir, {
+  silent: true
+});
+const cheerioOptions = {
+  xml: {
+    normalizeWhitespace: true
+  }
+};
+const minifierOptions = {
+  collapseWhitespace: true,
+  conservativeCollapse: true,
+  keepClosingSlash: true
+};
+beforeAll(async () => {
+  await hexo.init();
+  await hexo.load();
+  register(hexo);
+  await hexo.loadPlugin(require.resolve('hexo-renderer-marked'));
+});
+test('create default tabs', async () => {
+  const render = hexo.extend.tag.render.bind(hexo.extend.tag);
+  let source = '{% tabs %}<!--tab id:tab1-->**content**<!--endtab-->{% endtabs %}';
+  let actual = cheerio.load(await render(source), cheerioOptions, false).html();
+  expect(minify(actual, minifierOptions)).toEqual('<div class="tabs my-3"> <ul class="mx-0 my-0"> <li> <a href="#tab1"> </a> </li> </ul> ' + '</div> <div id="tab1" class="tab-content is-hidden"> <p><strong>content</strong></p> </div>');
+  source = `{% tabs %}
+  <!-- tab --># title 1<!-- endtab -->
+  <!-- tab --># title 2<!-- endtab -->
+  {% endtabs %}`;
+  const $ = cheerio.load(await render(source), cheerioOptions, false);
+  const [tabId1, tabId2] = $('.tab-content').get().map(element => $(element).attr('id'));
+  actual = $.html();
+  expect(minify(actual, minifierOptions)).toEqual(`<div class="tabs my-3"> <ul class="mx-0 my-0"> <li> <a href="#${tabId1}"> </a> ` + `</li><li> <a href="#${tabId2}"> </a> </li> </ul> </div> ` + `<div id="${tabId1}" class="tab-content is-hidden"> <h1 id="title-1">` + '<a href="#title-1" class="headerlink" title="title 1"/>title 1</h1> </div>' + `<div id="${tabId2}" class="tab-content is-hidden"> <h1 id="title-2">` + '<a href="#title-2" class="headerlink" title="title 2"/>title 2</h1> </div>');
+});
+test('create tabs with different alignment', async () => {
+  const render = hexo.extend.tag.render.bind(hexo.extend.tag);
+
+  for (const align of ['left', 'centered', 'right', 'fullwidth']) {
+    const source = `{% tabs align:${align} %}<!--tab id:tab1-->content<!--endtab-->{% endtabs %}`;
+    const actual = cheerio.load(await render(source), cheerioOptions, false).html();
+    expect(minify(actual, minifierOptions)).toEqual(`<div class="tabs my-3 is-${align}"> <ul class="mx-0 my-0"> <li> <a href="#tab1"> </a> ` + '</li> </ul> </div> <div id="tab1" class="tab-content is-hidden"> ' + '<p>content</p> </div>');
+  }
+});
+test('create tabs with different sizes', async () => {
+  const render = hexo.extend.tag.render.bind(hexo.extend.tag);
+
+  for (const size of ['small', 'medium', 'large']) {
+    const source = `{% tabs size:${size} %}<!--tab id:tab1-->content<!--endtab-->{% endtabs %}`;
+    const actual = cheerio.load(await render(source), cheerioOptions, false).html();
+    expect(minify(actual, minifierOptions)).toEqual(`<div class="tabs my-3 is-${size}"> <ul class="mx-0 my-0"> <li> <a href="#tab1"> </a> ` + '</li> </ul> </div> <div id="tab1" class="tab-content is-hidden"> ' + '<p>content</p> </div>');
+  }
+});
+test('create tabs with different styles', async () => {
+  const render = hexo.extend.tag.render.bind(hexo.extend.tag);
+
+  for (const style of ['boxed', 'toggle', 'toggle-rounded']) {
+    const source = `{% tabs style:${style} %}<!--tab id:tab1-->content<!--endtab-->{% endtabs %}`;
+    const actual = cheerio.load(await render(source), cheerioOptions, false).html();
+    const classname = style === 'toggle-rounded' ? 'toggle is-toggle-rounded' : style;
+    expect(minify(actual, minifierOptions)).toEqual(`<div class="tabs my-3 is-${classname}"> <ul class="mx-0 my-0"> <li> <a href="#tab1"> </a> ` + '</li> </ul> </div> <div id="tab1" class="tab-content is-hidden"> ' + '<p>content</p> </div>');
+  }
+});
+test('create tabs with active status', async () => {
+  const render = hexo.extend.tag.render.bind(hexo.extend.tag);
+  const source = `{% tabs %}
+  <!-- tab id:tab1 -->tab 1<!-- endtab -->
+  <!-- tab id:tab2 active -->tab 2<!-- endtab -->
+  {% endtabs %}`;
+  const actual = cheerio.load(await render(source), cheerioOptions, false).html();
+  expect(minify(actual, minifierOptions)).toEqual('<div class="tabs my-3"> <ul class="mx-0 my-0"> <li> <a href="#tab1"> </a> ' + '</li><li class="is-active"> <a href="#tab2"> </a> </li> </ul> </div> ' + '<div id="tab1" class="tab-content is-hidden"> <p>tab 1</p> </div>' + '<div id="tab2" class="tab-content"> <p>tab 2</p> </div>');
+});
+test('create tabs with a title', async () => {
+  const render = hexo.extend.tag.render.bind(hexo.extend.tag);
+  const source = '{% tabs %}<!--tab id:tab1 "title:Tab Title"-->tab<!--endtab-->{% endtabs %}';
+  const actual = cheerio.load(await render(source), cheerioOptions, false).html();
+  expect(minify(actual, minifierOptions)).toEqual('<div class="tabs my-3"> <ul class="mx-0 my-0"> <li> <a href="#tab1"> <p>Tab Title</p> </a> ' + '</li> </ul> </div> <div id="tab1" class="tab-content is-hidden"> <p>tab</p> </div>');
+});
+test('create tabs with an icon', async () => {
+  const render = hexo.extend.tag.render.bind(hexo.extend.tag);
+  const source = '{% tabs %}<!--tab id:tab1 "icon:fab fa-github"-->tab<!--endtab-->{% endtabs %}';
+  const actual = cheerio.load(await render(source), cheerioOptions, false).html();
+  expect(minify(actual, minifierOptions)).toEqual('<div class="tabs my-3"> <ul class="mx-0 my-0"> <li> <a href="#tab1"> ' + '<span class="icon is-small ml-0"> <i class="fab fa-github" aria-hidden="true"/> ' + '</span> </a> </li> </ul> </div> <div id="tab1" class="tab-content is-hidden"> ' + '<p>tab</p> </div>');
+});
+test('create tabs with all properties', async () => {
+  const render = hexo.extend.tag.render.bind(hexo.extend.tag);
+  const source = `{% tabs align:fullwidth 'size:large' style:boxed %}
+  <!-- tab id:tab1 "icon:fas\\ fa-file" -->tab 1<!-- endtab -->
+  <!-- tab id:tab2 active 'title:Tim\\'s Tab' -->tab 2<!-- endtab -->
+  {% endtabs %}`;
+  const actual = cheerio.load(await render(source), cheerioOptions, false).html();
+  expect(minify(actual, minifierOptions)).toEqual('<div class="tabs my-3 is-fullwidth is-large is-boxed"> <ul class="mx-0 my-0"> <li> ' + '<a href="#tab1"> <span class="icon is-small ml-0"> ' + '<i class="fas\\ fa-file" aria-hidden="true"/> </span> </a> </li><li class="is-active"> ' + '<a href="#tab2"> <p>Tim&apos;s Tab</p> </a> </li> </ul> </div> ' + '<div id="tab1" class="tab-content is-hidden"> <p>tab 1</p> </div>' + '<div id="tab2" class="tab-content"> <p>tab 2</p> </div>');
+});

package/lib/schema/comment/twikoo.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/comment/twikoo.json",
+  "description": "Twikoo comment plugin configurations",
+  "type": "object",
+  "properties": {
+    "type": {
+      "type": "string",
+      "const": "twikoo"
+    },
+    "env_id": {
+      "type": "string",
+      "description": "envId from Tencent CloudBase or Vercel URL"
+    },
+    "region": {
+      "type": "string",
+      "description": "Region of Tencent CloudBase",
+      "nullable": true
+    },
+    "lang": {
+      "type": "string",
+      "description": "i18n support",
+      "default": "zh-CN",
+      "nullable": true
+    }
+  },
+  "required": ["type", "env_id"]
+}

package/lib/schema/comment/waline.json

@@ -12,17 +12,20 @@
       "type": "string",
       "description": "Waline server address url."
     },
+    "path": {
+      "type": "string",
+      "description": "Article path id."
+    },
     "lang": {
       "type": "string",
       "description": "Display language.",
-      "enum": ["zh", "zh-CN", "zh-TW", "en", "en-US", "jp", "jp-JP"],
+      "enum": ["zh", "zh-CN", "zh-TW", "en", "en-US", "jp", "jp-JP", "pt-BR", "ru", "ru-RU"],
       "default": "zh-CN",
       "nullable": true
     },
-    "visitor": {
-      "type": "boolean",
-      "description": "Show visitor count",
-      "default": false,
+    "locale": {
+      "type": "object",
+      "description": "I18n configurations",
       "nullable": true
     },
     "emoji": {
@@ -34,31 +37,31 @@
           },
           {
             "type": "object",
-            "description": "Emoji set configuration",
+            "description": "Emoji set configuration.",
             "properties": {
               "name": {
                 "type": "string",
-                "description": "Emoji name on the tab"
+                "description": "Emoji name on the tab."
               },
               "folder": {
                 "type": "string",
-                "description": "Image folder link"
+                "description": "Image folder link."
               },
               "prefix": {
                 "type": "string",
-                "description": "The general prefix of images' filename"
+                "description": "The general prefix of images' filename."
               },
               "type": {
                 "type": "string",
-                "description": "Type of the picture, which will be used as file extension"
+                "description": "Type of the picture, which will be used as file extension."
               },
               "icon": {
                 "type": "string",
-                "description": "Filename of the icon image used in tab (requirement is the same as items)"
+                "description": "Filename of the icon image used in tab (requirement is the same as items)."
               },
               "items": {
                 "type": "array",
-                "description": "Each item is the picture filename without common prefix (do not include file extension)",
+                "description": "Each item is the picture filename without common prefix (do not include file extension).",
                 "items": {
                   "type": "string"
                 }
@@ -68,18 +71,18 @@
           }
         ]
       },
-      "description": "Emoji settings",
-      "default": ["https://cdn.jsdelivr.net/gh/walinejs/emojis/weibo"],
+      "description": "Emoji settings.",
+      "default": ["//unpkg.com/@waline/emojis@1.0.1/weibo"],
       "nullable": true
     },
     "dark": {
-      "type": "string",
-      "description": "Darkmode support",
+      "type": ["string", "boolean"],
+      "description": "Darkmode support.",
       "nullable": true
     },
     "meta": {
       "type": "array",
-      "description": "Reviewer attributes",
+      "description": "Reviewer attributes.",
       "items": {
         "type": "string"
       },
@@ -88,24 +91,17 @@
     },
     "required_meta": {
       "type": "array",
-      "description": "Required commenter information fields",
+      "description": "Required commenter information fields.",
       "default": [],
       "nullable": true
     },
     "login": {
       "type": "string",
-      "description": "Login mode status",
+      "description": "Login mode status.",
       "enum": ["enable", "disable", "force"],
       "default": "enable",
       "nullable": true
     },
-    "avatar": {
-      "type": "string",
-      "description": "Gravatar type",
-      "enum": ["", "mp", "identicon", "monsterid", "wavatar", "robohash", "retro", "hide", "mm"],
-      "default": "mp",
-      "nullable": true
-    },
     "word_limit": {
       "oneOf": [
         {
@@ -129,31 +125,43 @@
     },
     "page_size": {
       "type": "number",
-      "description": "number of comments per page.",
+      "description": "Number of comments per page.",
       "default": 10,
       "nullable": true
     },
-    "avatar_cdn": {
-      "type": "string",
-      "description": "Gravatar CDN baseURL.",
-      "default": "https://sdn.geekzu.org/avatar/",
+    "image_uploader": {
+      "type": "boolean",
+      "description": "Whether to disable the image upload feature.",
+      "default": false,
       "nullable": true
     },
-    "avatar_force": {
+    "highlighter": {
       "type": "boolean",
-      "description": "Whether force pulling the latest avatar each time.",
+      "description": "Whether to disable the code highlight feature.",
       "default": false,
       "nullable": true
     },
-    "highlight": {
+    "tex_renderer": {
       "type": "boolean",
-      "description": "Code highlighting, it's enabled by default, please close it selectively.",
-      "default": true,
+      "description": "Whether to disable TeX rendering.",
+      "default": false,
       "nullable": true
     },
-    "math_tag_support": {
+    "search": {
       "type": "boolean",
-      "description": "Whether inject extra styles to display <math> block",
+      "description": "Whether to disable the search feature.",
+      "default": false,
+      "nullable": true
+    },
+    "pageview": {
+      "type": ["string", "boolean"],
+      "description": "Whether to show page view count. It can also be a CSS selector to page view count container.",
+      "default": false,
+      "nullable": true
+    },
+    "comment": {
+      "type": ["string", "boolean"],
+      "description": "Whether to show comment count. It can also be a CSS selector to comment count container.",
       "default": false,
       "nullable": true
     },
@@ -162,11 +170,6 @@
       "description": "Whether show copyright and version in footer.",
       "default": true,
       "nullable": true
-    },
-    "locale": {
-      "type": "object",
-      "description": "I18n configurations",
-      "nullable": true
     }
   },
   "required": ["type", "server_url"]

package/lib/schema/schema/comment/changyan.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/comment/changyan.json",
+  "description": "Changyan comment plugin configurations",
+  "type": "object",
+  "properties": {
+    "type": {
+      "type": "string",
+      "const": "changyan"
+    },
+    "app_id": {
+      "type": "string",
+      "description": "Changyan app ID"
+    },
+    "conf": {
+      "type": "string",
+      "description": "Changyan configuration ID"
+    }
+  },
+  "required": ["type", "app_id", "conf"]
+}

package/lib/schema/schema/comment/disqus.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "/comment/disqus.json",
+  "description": "Disqus comment plugin configurations",
+  "type": "object",
+  "properties": {
+    "type": {
+      "type": "string",
+      "const": "disqus"
+    },
+    "shortname": {
+      "type": "string",
+      "description": "Disqus shortname"
+    }
+  },
+  "required": ["type", "shortname"]
+}