valaxy 0.5.0 → 0.6.2

package/node/plugins/index.ts

@@ -1,11 +1,14 @@
 import fs from 'fs'
 
-import { join } from 'path'
-import type { Plugin } from 'vite'
+import { join, relative } from 'path'
+import type { Plugin, ResolvedConfig } from 'vite'
 // import consola from 'consola'
 import { resolveConfig } from '../config'
 import type { ResolvedValaxyOptions, ValaxyServerOptions } from '../options'
-import { resolveImportPath, toAtFS } from '../utils'
+import { resolveImportPath, slash, toAtFS } from '../utils'
+import { createMarkdownToVueRenderFn } from '../markdown/markdownToVue'
+import type { PageDataPayload } from '../../types'
+import { checkMd } from '../markdown/check'
 import { VALAXY_CONFIG_ID } from './valaxy'
 
 /**
@@ -19,7 +22,7 @@ function generateStyles(roots: string[], options: ResolvedValaxyOptions) {
   // katex
   if (options.config.features.katex) {
     imports.push(`import "${toAtFS(resolveImportPath('katex/dist/katex.min.css', true))}"`)
-    imports.push(`import "${join(options.clientRoot, 'styles/third/katex.scss')}"`)
+    imports.push(`import "${toAtFS(join(options.clientRoot, 'styles/third/katex.scss'))}"`)
   }
 
   for (const root of roots) {
@@ -68,8 +71,26 @@ export function createValaxyPlugin(options: ResolvedValaxyOptions, serverOptions
 
   const roots = [options.clientRoot, options.themeRoot, options.userRoot]
 
+  let markdownToVue: Awaited<ReturnType<typeof createMarkdownToVueRenderFn>>
+  let hasDeadLinks = false
+  let config: ResolvedConfig
+
   return {
-    name: 'Valaxy',
+    name: 'valaxy',
+    enforce: 'pre',
+
+    async configResolved(resolvedConfig) {
+      config = resolvedConfig
+      markdownToVue = await createMarkdownToVueRenderFn(
+        options.userRoot,
+        options.config.markdownIt,
+        options.pages,
+        config.define,
+        config.command === 'build',
+        config.base,
+        options.config.lastUpdated,
+      )
+    },
 
     configureServer(server) {
       server.watcher.add([
@@ -90,6 +111,13 @@ export function createValaxyPlugin(options: ResolvedValaxyOptions, serverOptions
         // stringify twice for \"
         return `export default ${JSON.stringify(JSON.stringify(valaxyConfig))}`
 
+      if (id === '/@valaxyjs/context') {
+        return `export default ${JSON.stringify(JSON.stringify({
+          userRoot: options.userRoot,
+          // clientRoot: options.clientRoot,
+        }))}`
+      }
+
       // generate styles
       if (id === '/@valaxyjs/styles')
         return generateStyles(roots, options)
@@ -101,12 +129,81 @@ export function createValaxyPlugin(options: ResolvedValaxyOptions, serverOptions
         return ''
     },
 
+    async transform(code, id) {
+      if (id.endsWith('.md')) {
+        checkMd(code, id)
+        code.replace('{%', '\{\%')
+        code.replace('%}', '\%\}')
+
+        // const scripts = [
+        // '<script setup>',
+        // 'import { useRoute } from "vue-router"',
+        // 'const route = useRoute()',
+        // `route.meta.headers = ${JSON.stringify(_md.__data)}`,
+        // `export const data = JSON.parse(${JSON.stringify(JSON.stringify(pageData))})`,
+        // `frontmatter.data = JSON.parse(${JSON.stringify(JSON.stringify(pageData))})`,
+        // '</script>',
+        // ]
+
+        // const li = code.lastIndexOf('</script>')
+        // code = code.slice(0, li) + scripts.join('\n') + code.slice(li + 9)
+
+        // transform .md files into vueSrc so plugin-vue can handle it
+        const { vueSrc, deadLinks, includes } = await markdownToVue(
+          code,
+          id,
+          config.publicDir,
+        )
+        if (deadLinks.length)
+          hasDeadLinks = true
+
+        if (includes.length) {
+          includes.forEach((i) => {
+            this.addWatchFile(i)
+          })
+        }
+
+        return vueSrc
+      }
+    },
+
+    renderStart() {
+      if (hasDeadLinks)
+        throw new Error('One or more pages contain dead links.')
+    },
+
     async handleHotUpdate(ctx) {
       // handle valaxy.config.ts hmr
-      const { file, server } = ctx
+      const { file, server, read } = ctx
       if (file !== options.configFile)
         return
 
+      // send headers
+      if (file.endsWith('.md')) {
+        const content = await read()
+        const { pageData, vueSrc } = await markdownToVue(
+          content,
+          file,
+          join(options.userRoot, 'public'),
+        )
+
+        const path = `/${slash(relative(`${options.userRoot}/pages`, file))}`
+        const payload: PageDataPayload = {
+          // path: `/${slash(relative(srcDir, file))}`,
+          path,
+          pageData,
+        }
+
+        server.ws.send({
+          type: 'custom',
+          event: 'valaxy:pageData',
+          data: payload,
+        })
+
+        // overwrite src so vue plugin can handle the HMR
+        ctx.read = () => vueSrc
+      }
+
       const { config } = await resolveConfig()
 
       serverOptions.onConfigReload?.(config, options.config)
@@ -116,7 +213,7 @@ export function createValaxyPlugin(options: ResolvedValaxyOptions, serverOptions
       //   consola.warn('[valaxy]: config.base has changed. Please restart the dev server.')
       valaxyConfig = config
 
-      const moduleIds = [`/${VALAXY_CONFIG_ID}`]
+      const moduleIds = [`/${VALAXY_CONFIG_ID}`, '/@valaxyjs/context']
       const moduleEntries = [
         ...Array.from(moduleIds).map(id => server.moduleGraph.getModuleById(id)),
       ].filter(<T>(item: T): item is NonNullable<T> => !!item)

package/node/plugins/preset.ts

@@ -16,7 +16,7 @@ import Inspect from 'vite-plugin-inspect'
 import { dim, yellow } from 'kolorist'
 import type { ResolvedValaxyOptions, ValaxyServerOptions } from '../options'
 import { setupMarkdownPlugins } from '../markdown'
-import { createMarkdownPlugin, excerpt_separator } from './markdown'
+// import { createMarkdownPlugin, excerpt_separator } from './markdown'
 import { createUnocssPlugin } from './unocss'
 import { createConfigPlugin } from './extendConfig'
 import { createValaxyPlugin } from '.'
@@ -32,17 +32,17 @@ export async function ViteValaxyPlugins(
 ): Promise<(PluginOption | PluginOption[])[] | undefined> {
   const { clientRoot, themeRoot, userRoot } = options
 
-  const MarkdownPlugin = createMarkdownPlugin(options)
+  // const MarkdownPlugin = createMarkdownPlugin(options)
   const UnocssPlugin = await createUnocssPlugin(options)
 
   const ValaxyPlugin = createValaxyPlugin(options, serverOptions)
 
   const mdIt = new MarkdownIt({ html: true })
-  setupMarkdownPlugins(mdIt, options.config.markdownIt)
+  await setupMarkdownPlugins(mdIt, options.config.markdownIt)
 
   const roots = [clientRoot, themeRoot, userRoot]
 
-  const { default: ThemePlugin } = await import(`valaxy-theme-${options.theme}`)
+  const { default: ThemePlugin } = (await import(`valaxy-theme-${options.theme}`))
 
   const customElements = new Set([
   // katex
@@ -90,8 +90,8 @@ export async function ViteValaxyPlugins(
       },
     }),
 
-    ValaxyPlugin,
     createConfigPlugin(options),
+    ValaxyPlugin,
 
     ThemePlugin(options.config.themeConfig),
 
@@ -118,7 +118,7 @@ export async function ViteValaxyPlugins(
         })
 
         const md = fs.readFileSync(path, 'utf-8')
-        const { data, excerpt } = matter(md, { excerpt_separator })
+        const { data, excerpt } = matter(md, { excerpt_separator: '<!-- more -->' })
 
         // warn for post frontmatter
         if (route.path.startsWith('/posts/')) {
@@ -160,7 +160,7 @@ export async function ViteValaxyPlugins(
       allowOverrides: true,
       // override: user -> theme -> client
       // latter override former
-      dirs: roots.map(root => `${root}/components`).concat(['src/components', 'components']),
+      dirs: roots.map(root => `${root}/components`).concat(roots.map(root => `${root}/layouts`)).concat(['src/components', 'components']),
       dts: `${options.userRoot}/components.d.ts`,
 
       ...pluginOptions,
@@ -170,7 +170,7 @@ export async function ViteValaxyPlugins(
     // UnocssPlugin,
     UnocssPlugin,
 
-    ...MarkdownPlugin,
+    // ...MarkdownPlugin,
 
     // https://github.com/intlify/bundle-tools/tree/main/packages/vite-plugin-vue-i18n
     VueI18n({

package/node/rss.ts

@@ -24,7 +24,7 @@ const markdown = MarkdownIt({
 export async function build(options: ResolvedValaxyOptions) {
   const { config } = options
 
-  if (!config.url) {
+  if (!config.url || config.url === '/') {
     consola.error('You must set "config.url" to generate rss.')
     return
   }

package/node/shims.d.ts

@@ -3,11 +3,6 @@ declare module 'escape-html' {
   export default def
 }
 
-declare module 'prismjs' {
-  const def: any
-  export default def
-}
-
 declare module 'markdown-it-attrs' {
   const def: any
   export default def

package/node/utils/getGitTimestamp.ts

@@ -0,0 +1,13 @@
+import { spawn } from 'cross-spawn'
+
+export function getGitTimestamp(file: string) {
+  return new Promise<number>((resolve, reject) => {
+    const child = spawn('git', ['log', '-1', '--pretty="%ci"', file])
+    let output = ''
+    child.stdout.on('data', d => (output += String(d)))
+    child.on('close', () => {
+      resolve(+new Date(output))
+    })
+    child.on('error', reject)
+  })
+}

package/node/utils/index.ts

@@ -4,6 +4,17 @@ import globalDirs from 'global-dirs'
 import { sync as resolve } from 'resolve'
 import consola from 'consola'
 
+export * from './getGitTimestamp'
+
+/**
+ * transform obj for vite cde
+ * @param obj
+ * @returns
+ */
+export const transformObject = (obj: any) => {
+  return `JSON.parse(${JSON.stringify(JSON.stringify(obj))})`
+}
+
 export function slash(str: string) {
   return str.replace(/\\/g, '/')
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "valaxy",
-  "version": "0.5.0",
+  "version": "0.6.2",
   "description": "📄 Vite & Vue powered static blog generator.",
   "author": {
     "email": "me@yunyoujun.cn",
@@ -17,16 +17,22 @@
   ],
   "exports": {
     ".": {
-      "types": "./index.d.ts",
+      "types": "./dist/index.d.ts",
       "require": "./dist/index.js",
       "import": "./dist/index.mjs"
     },
     "./client": "./dist/client.d.ts",
     "./client/*": "./client/*",
+    "./node": {
+      "types": "./dist/node/index.d.ts",
+      "require": "./dist/node/index.js",
+      "import": "./dist/node/index.mjs"
+    },
     "./*": "./*"
   },
   "main": "dist/index.js",
-  "types": "index.d.ts",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
   "bin": {
     "vala": "./bin/valaxy.js",
     "valaxy": "./bin/valaxy.js"
@@ -35,6 +41,7 @@
     "node": ">=14.0.0"
   },
   "dependencies": {
+    "@antfu/utils": "^0.5.2",
     "@ctrl/tinycolor": "^3.4.1",
     "@docsearch/css": "^3.1.0",
     "@docsearch/js": "^3.1.0",
@@ -42,15 +49,19 @@
     "@iconify-json/ri": "^1.1.2",
     "@intlify/vite-plugin-vue-i18n": "^3.4.0",
     "@vitejs/plugin-vue": "^2.3.3",
-    "@vueuse/core": "^8.7.3",
+    "@vueuse/core": "^8.7.4",
     "@vueuse/head": "^0.7.6",
     "consola": "^2.15.3",
     "critters": "^0.0.16",
+    "cross-spawn": "^7.0.3",
     "dayjs": "^1.11.3",
     "escape-html": "^1.0.3",
     "feed": "^4.2.2",
+    "gray-matter": "^4.0.3",
     "katex": "^0.16.0",
     "kolorist": "^1.5.1",
+    "lru-cache": "^7.10.1",
+    "markdown-it": "^13.0.1",
     "markdown-it-anchor": "^8.6.4",
     "markdown-it-attrs": "^4.1.4",
     "markdown-it-container": "^3.0.0",
@@ -61,16 +72,14 @@
     "nprogress": "^0.2.0",
     "open": "^8.4.0",
     "pinia": "^2.0.14",
-    "prism-theme-vars": "^0.2.3",
-    "prismjs": "^1.28.0",
     "sass": "^1.52.3",
+    "shiki": "^0.10.1",
     "star-markdown-css": "^0.3.3",
     "unconfig": "^0.3.4",
-    "unocss": "^0.39.0",
+    "unocss": "^0.39.3",
     "unplugin-vue-components": "^0.19.6",
     "vite": "^2.9.12",
     "vite-plugin-inspect": "^0.5.0",
-    "vite-plugin-md": "^0.13.1",
     "vite-plugin-pages": "^0.24.2",
     "vite-plugin-vue-layouts": "^0.6.0",
     "vite-ssg": "0.19.2",
@@ -81,7 +90,9 @@
     "yargs": "^17.5.1"
   },
   "devDependencies": {
+    "@types/cross-spawn": "^6.0.2",
     "@types/katex": "^0.14.0",
+    "@types/lru-cache": "^7.10.10",
     "@types/markdown-it-link-attributes": "^3.0.1",
     "@types/nprogress": "^0.2.0",
     "@types/yargs": "^17.0.10",
@@ -92,7 +103,7 @@
   },
   "scripts": {
     "build": "rimraf dist && tsup --splitting",
-    "dev": "tsup --watch --splitting",
+    "dev": "tsup --splitting --watch",
     "lint": "eslint \"**/*.{vue,ts,js}\"",
     "preview": "vite preview",
     "preview-https": "serve dist"

package/shared/index.ts

@@ -0,0 +1 @@
+export const EXTERNAL_URL_RE = /^https?:/i

package/tsup.config.ts

@@ -3,20 +3,22 @@ import { defineConfig } from 'tsup'
 export default defineConfig((options) => {
   return {
     entry: [
-      'client/index.ts',
+      'index.ts',
+      // 'client/index.ts',
       'node/index.ts',
       'node/cli.ts',
-      'types/index.ts',
+      // 'types/index.ts',
     ],
     // https://tsup.egoist.sh/#code-splitting
     // Code splitting currently only works with the esm output format, and it's enabled by default. If you want code splitting for cjs output format as well, try using --splitting flag which is an experimental feature to get rid of the limitation in esbuild.
-    splitting: true,
+    // splitting: true,
     clean: true,
     dts: true,
     format: ['cjs', 'esm'],
     minify: !options.watch,
     external: [
       '@valaxyjs/config',
+      '@valaxyjs/context',
       'valaxy-theme-yun',
     ],
   }

package/types/config.ts

@@ -1,10 +1,7 @@
 import type { PartialDeep } from 'type-fest'
 import type { VitePluginConfig } from 'unocss/vite'
-import type Markdown from 'vite-plugin-md'
 import type { MarkdownOptions } from '../node/markdown'
 
-export type ViteMdOptions = Parameters<typeof Markdown>[0]
-
 export type ValaxyThemeConfig = Record<string, any>
 
 export interface SocialLink {
@@ -32,6 +29,7 @@ export interface AlgoliaSearchOptions {
   initialQuery?: string
 }
 
+// packages/valaxy/node/config.ts
 export interface ValaxyConfig<T = ValaxyThemeConfig> {
   /**
    * Default language
@@ -42,6 +40,7 @@ export interface ValaxyConfig<T = ValaxyThemeConfig> {
   /**
    * You site url in web, required for ssg & rss
    * @description 站点的 URL，SSG & RSS 需要（譬如生成版权处文章永久链接）
+   * @default '/'
    */
   url: string
   /**
@@ -84,6 +83,11 @@ export interface ValaxyConfig<T = ValaxyThemeConfig> {
     }
   }
 
+  /**
+   * show last updated time by git
+   */
+  lastUpdated: boolean
+
   /**
    * icon for your website
    */
@@ -203,7 +207,6 @@ export interface ValaxyConfig<T = ValaxyThemeConfig> {
   /**
    * for markdown
    */
-  markdown: ViteMdOptions
   markdownIt: MarkdownOptions
 }
 

package/types/data.ts

@@ -0,0 +1,31 @@
+import type { Post } from './posts'
+
+export interface Header {
+  level: number
+  title: string
+  slug: string
+  /**
+   * i18n
+   */
+  lang?: string
+}
+
+export interface PageData {
+  path: string
+  relativePath: string
+  title: string
+  titleTemplate?: string
+  description: string
+  headers: Header[]
+  frontmatter: Post
+  lastUpdated?: number
+}
+
+export interface PageDataPayload {
+  path: string
+  pageData: PageData
+}
+
+export type HeadConfig =
+  | [string, Record<string, string>]
+  | [string, Record<string, string>, string]

package/types/index.ts

@@ -1,2 +1,3 @@
 export * from './config'
 export * from './posts'
+export * from './data'

package/types/posts.ts

@@ -118,5 +118,5 @@ export interface Post extends Record<string, any> {
    * enable markdown-body class
    * @description 是否启用默认的 markdown 样式
    */
-  markdown: boolean
+  markdown?: boolean
 }