feat: default date -> git -> mtime & date.format, close #45

YunYouJun · YunYouJun · commit bdcf09724316 · 2022-07-12T22:14:38.000+08:00
diff --git a/demo/yun/pages/docs/dev/index.md b/demo/yun/pages/docs/dev/index.md
@@ -14,9 +14,7 @@ end: false
 ## Todo
 
 - [ ] create-valaxy-theme: Script to generate theme template.
-- [ ] Github actions auto generate site from theme repo/npm.
 - [ ] Debug component.
-- [ ] Git timestamp for post without `date`.
 - [ ] local search
 
 ## Dev
diff --git a/packages/valaxy/node/config.ts b/packages/valaxy/node/config.ts
@@ -47,6 +47,9 @@ const defaultValaxyConfig: ValaxyConfig = {
   },
   social: [],
 
+  date: {
+    format: '',
+  },
   lastUpdated: true,
 
   license: {
diff --git a/packages/valaxy/node/plugins/preset.ts b/packages/valaxy/node/plugins/preset.ts
@@ -2,8 +2,6 @@ import fs from 'fs'
 import type { PluginOption } from 'vite'
 import { splitVendorChunkPlugin } from 'vite'
 
-import consola from 'consola'
-
 import MarkdownIt from 'markdown-it'
 import matter from 'gray-matter'
 
@@ -13,10 +11,10 @@ import Layouts from 'vite-plugin-vue-layouts'
 import Components from 'unplugin-vue-components/vite'
 import VueI18n from '@intlify/vite-plugin-vue-i18n'
 
-import { dim, yellow } from 'kolorist'
 import type { ResolvedValaxyOptions, ValaxyPluginOptions, ValaxyServerOptions } from '../options'
 import { setupMarkdownPlugins } from '../markdown'
 // import { createMarkdownPlugin, excerpt_separator } from './markdown'
+import { formatMdDate } from '../utils/date'
 import { createUnocssPlugin } from './unocss'
 import { createConfigPlugin } from './extendConfig'
 import { createClientSetupPlugin } from './setupClient'
@@ -117,28 +115,23 @@ export async function ViteValaxyPlugins(
         })
 
         // page is post
-        let isPost = false
-        if (route.path.startsWith('/posts/')) {
-          isPost = true
+        if (route.path.startsWith('/posts/'))
           route.meta.layout = 'post'
-        }
 
         // set default frontmatter
-        const defaultFrontmatter = {
-          date: new Date(),
-        }
-        if (!route.meta.frontmatter)
-          route.meta.frontmatter = defaultFrontmatter
+        const defaultFrontmatter = {}
 
         if (path.endsWith('.md')) {
           const md = fs.readFileSync(path, 'utf-8')
           const { data, excerpt } = matter(md, { excerpt_separator: '<!-- more -->' })
 
-          if (isPost) {
-            // warn for post frontmatter
-            if (!data.date)
-              consola.warn(`You forgot to write ${yellow('date')} for post: ${dim(`${route.component}`)}`)
-          }
+          // todo, optimize it to cache or on demand
+          formatMdDate(
+            data,
+            path,
+            options.config.date.format,
+            options.config.lastUpdated,
+          )
 
           route.meta = Object.assign(route.meta, {
             frontmatter: Object.assign(defaultFrontmatter, data),
diff --git a/packages/valaxy/node/rss.ts b/packages/valaxy/node/rss.ts
@@ -9,6 +9,7 @@ import type { Author, FeedOptions, Item } from 'feed'
 import { Feed } from 'feed'
 import consola from 'consola'
 import type { ResolvedValaxyOptions } from './options'
+import { formatMdDate } from './utils/date'
 
 const markdown = MarkdownIt({
   html: true,
@@ -64,17 +65,13 @@ export async function build(options: ResolvedValaxyOptions) {
       const raw = fs.readFileSync(i, 'utf-8')
       const { data, content, excerpt } = matter(raw)
 
-      // not add to posts
-      if (!data.date) {
-        consola.warn(`Do you forget to write date for ${dim(i)}`)
-        return false
-      }
-
       if (data.draft) {
         consola.warn(`Ignore draft post: ${dim(i)}`)
         return false
       }
 
+      formatMdDate(data, i, config.date.format, config.lastUpdated)
+
       // todo i18n
 
       // render excerpt
diff --git a/packages/valaxy/node/utils/date.ts b/packages/valaxy/node/utils/date.ts
@@ -0,0 +1,35 @@
+import dayjs from 'dayjs'
+import fs from 'fs-extra'
+import { getGitTimestamp } from './getGitTimestamp'
+
+/**
+ * get created time of file
+ * @param file
+ * @returns
+ */
+export async function getCreatedTime(file: string): Promise<Date | number> {
+  return await getGitTimestamp(file, 'created') || (await fs.stat(file)).ctime
+}
+
+/**
+ * get created time of file
+ * @param file
+ * @returns
+ */
+export async function getUpdatedTime(file: string): Promise<Date | number> {
+  return await getGitTimestamp(file, 'created') || (await fs.stat(file)).mtime
+}
+
+export function formatMdDate(data: any, path: string, format = 'YYYY-MM-DD HH:mm:ss', lastUpdated = true) {
+  if (!data.date)
+    data.date = getCreatedTime(path)
+
+  if (!data.updated && lastUpdated)
+    data.updated = getUpdatedTime(path)
+
+  // format
+  data.date = dayjs(data.date).format(format)
+
+  if (lastUpdated)
+    data.updated = dayjs(data.updated).format(format)
+}
diff --git a/packages/valaxy/node/utils/getGitTimestamp.ts b/packages/valaxy/node/utils/getGitTimestamp.ts
@@ -1,8 +1,15 @@
 import { spawn } from 'cross-spawn'
 
-export function getGitTimestamp(file: string) {
+export function getGitTimestamp(file: string, type: 'created' | 'updated' = 'updated') {
   return new Promise<number>((resolve, reject) => {
-    const child = spawn('git', ['log', '-1', '--pretty="%ci"', file])
+    const params = ['log']
+    if (type === 'updated')
+      params.push('-1')
+    params.push('--pretty="%ci"', file)
+    if (type === 'created')
+      params.push('|', 'tail', '-1')
+
+    const child = spawn('git', params)
     let output = ''
     child.stdout.on('data', d => (output += String(d)))
     child.on('close', () => {
diff --git a/packages/valaxy/types/config.ts b/packages/valaxy/types/config.ts
@@ -84,8 +84,15 @@ export interface ValaxyConfig<T = ValaxyThemeConfig> {
     }
   }
 
+  date: {
+    /**
+     * The format of date
+     * @default '' as 'YYYY-MM-DD HH:mm:ss'
+     */
+    format: string
+  }
   /**
-   * show last updated time by git
+   * show last updated time by git/mtime
    */
   lastUpdated: boolean
 
