feat: some enhancements (debug / api name)

Author: ulivz

CHANGELOG.md

@@ -0,0 +1,4 @@
+## [0.0.2](https://github.com/ulivz/vuepress-plugin-blog/compare/v0.0.1...v0.0.2) (2019-06-03)
+
+
+

src/Config.ts

@@ -1,3 +1,4 @@
 export enum DefaultLayoutEnum {
-  FrontmatterClassifier = 'FrontmatterClassifier',
+  FrontmatterPagination = 'FrontmatterPagination',
+  DirectoryPagination = 'DirectoryPagination',
 }

src/client/classification.js

@@ -6,7 +6,7 @@ class Classifiable {
     this._metaMap = Object.assign({}, metaMap)
     Object.keys(this._metaMap).forEach(name => {
       const { pageKeys } = this._metaMap[name]
-      this._metaMap[name].posts = pageKeys.map(key => findPageByKey(pages, key))
+      this._metaMap[name].pages = pageKeys.map(key => findPageByKey(pages, key))
     })
   }
 
@@ -18,15 +18,19 @@ class Classifiable {
     return this._metaMap
   }
 
+  get pages() {
+    return this.list
+  }
+
   get list() {
     return this.toArray()
   }
 
   toArray() {
     const tags = []
     Object.keys(this._metaMap).forEach(name => {
-      const { posts, path } = this._metaMap[name]
-      tags.push({ name, posts, path })
+      const { pages, path } = this._metaMap[name]
+      tags.push({ name, pages, path })
     })
     return tags
   }
@@ -48,7 +52,7 @@ export default ({ Vue }) => {
           return classified
         },
         [`$current${classifiedType.charAt(0).toUpperCase() +
-          classifiedType.slice(1)}`]() {
+        classifiedType.slice(1)}`]() {
           const tagName = this.$route.meta.pid
           return this[helperName].getItemByName(tagName)
         },

src/handleOptions.ts

@@ -44,10 +44,10 @@ export function handleOptions(options: BlogPluginOptions, ctx: AppContext) {
       id,
       dirname,
       path: indexPath,
-      layout: indexLayout,
+      layout: indexLayout = 'IndexPost',
       frontmatter,
-      itemLayout,
-      itemPermalink,
+      itemLayout = 'Post',
+      itemPermalink = '/:year/:month/:day/:slug',
       pagination = {
         perPagePosts: 10,
       },
@@ -107,7 +107,7 @@ export function handleOptions(options: BlogPluginOptions, ctx: AppContext) {
       },
       options: {
         ...pagination,
-        layout: DefaultLayoutEnum.FrontmatterClassifier,
+        layout: DefaultLayoutEnum.DirectoryPagination,
       },
       getUrl(index) {
         if (index === 0) {

src/index.ts

@@ -4,6 +4,7 @@ import { registerPagination } from './pagination'
 import { BlogPluginOptions } from './interface/Options'
 import { AppContext, Page } from './interface/VuePress'
 import { DefaultLayoutEnum } from './Config'
+import { logPages } from './util'
 
 module.exports = (options: BlogPluginOptions, ctx: AppContext) => {
   const {
@@ -92,7 +93,7 @@ module.exports = (options: BlogPluginOptions, ctx: AppContext) => {
                 },
                 options: {
                   ...pagination,
-                  layout: DefaultLayoutEnum.FrontmatterClassifier,
+                  layout: DefaultLayoutEnum.FrontmatterPagination,
                   serverPageFilter(page) {
                     return clientFrontmatterClassifierPageFilter(
                       page,
@@ -122,16 +123,19 @@ module.exports = (options: BlogPluginOptions, ctx: AppContext) => {
                 pid: scope,
                 id: key,
                 frontmatter: {
-                  layout: DefaultLayoutEnum.FrontmatterClassifier,
+                  layout: DefaultLayoutEnum.FrontmatterPagination,
                   title: `${key} | ${scope}`,
                 },
               }
             })
           })
           .reduce((arr, next) => arr.concat(next), []),
       ]
-      console.log('====== allExtraPages')
-      console.log(allExtraPages)
+
+      logPages(
+        `Automatically Added Index Pages`,
+        allExtraPages
+      )
 
       await Promise.all(allExtraPages.map(async page => ctx.addPage(page)))
       await registerPagination(paginations, ctx)

src/pagination.ts

@@ -1,5 +1,6 @@
 import { AppContext } from './interface/VuePress'
 import { InternalPagination } from './interface/Pagination'
+import { logPages } from './util'
 
 export async function registerPagination(paginations: InternalPagination[], ctx: AppContext) {
   ctx.paginations = []
@@ -71,8 +72,10 @@ export async function registerPagination(paginations: InternalPagination[], ctx:
     recordPageFilters(pid, clientPageFilter)
     recordPageSorters(pid, clientPageSorter)
 
-    console.log('==== pagination.paginationPages')
-    console.log(pagination.paginationPages)
+    logPages(
+      `Automatically Added Pagination Pages`,
+      pagination.paginationPages.slice(1)
+    )
 
     await Promise.all(
       pagination.paginationPages.map(async ({ path }, index) => {

src/util.ts

@@ -1,3 +1,5 @@
+import { env } from '@vuepress/shared-utils'
+
 export type FrontmatterHandler = (key: string, pageKey: string) => void
 export interface FrontmatterTempMap {
   scope: string;
@@ -22,3 +24,36 @@ export function curryFrontmatterHandler(scope, map) {
     }
   }
 }
+
+export function logPages(title, pages) {
+  if (env.isDebug) {
+    const table = require('text-table')
+    const chalk = require('chalk')
+    console.log()
+    console.log(chalk.cyan(`[@vuepress/plugin-blog] ====== ${title} ======`))
+    const data: any[] = [
+      ['permalink', 'meta', 'pid', 'id', 'frontmatter'],
+    ]
+    data.push(
+      ...pages.map(({
+        // @ts-ignore
+        path,
+        permalink,
+        meta,
+        // @ts-ignore
+        pid,
+        // @ts-ignore
+        id,
+        frontmatter,
+      }) => [
+        permalink || path || '',
+        JSON.stringify(meta) || '',
+        pid || '',
+        id || '',
+        JSON.stringify(frontmatter) || '',
+      ]),
+    )
+    console.log(table(data))
+    console.log()
+  }
+}