@sugarat/theme 0.1.39 → 0.1.41

package/src/utils/node/index.ts

@@ -0,0 +1,118 @@
+/* eslint-disable global-require */
+/* eslint-disable prefer-rest-params */
+import { spawn, spawnSync } from 'child_process'
+import { formatDate } from '../client'
+
+export function clearMatterContent(content: string) {
+  let first___: unknown
+  let second___: unknown
+
+  const lines = content.split('\n').reduce<string[]>((pre, line) => {
+    // 移除开头的空白行
+    if (!line.trim() && pre.length === 0) {
+      return pre
+    }
+    if (line.trim() === '---') {
+      if (first___ === undefined) {
+        first___ = pre.length
+      } else if (second___ === undefined) {
+        second___ = pre.length
+      }
+    }
+    pre.push(line)
+    return pre
+  }, [])
+  return (
+    lines
+      // 剔除---之间的内容
+      .slice((second___ as number) || 0)
+      .join('\n')
+  )
+}
+export function getDefaultTitle(content: string) {
+  const title =
+    clearMatterContent(content)
+      .split('\n')
+      ?.find((str) => {
+        return str.startsWith('# ')
+      })
+      ?.slice(2)
+      .replace(/^\s+|\s+$/g, '') || ''
+  return title
+}
+
+export function getFileBirthTime(url: string) {
+  let date = new Date()
+
+  try {
+    // 参考 vitepress 中的 getGitTimestamp 实现
+    const infoStr = spawnSync('git', ['log', '-1', '--pretty="%ci"', url])
+      .stdout?.toString()
+      .replace(/["']/g, '')
+      .trim()
+    if (infoStr) {
+      date = new Date(infoStr)
+    }
+  } catch (error) {
+    return formatDate(date)
+  }
+
+  return formatDate(date)
+}
+
+export function getGitTimestamp(file: string) {
+  return new Promise((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)
+  })
+}
+
+export function getTextSummary(text: string, count = 100) {
+  return (
+    clearMatterContent(text)
+      .match(/^# ([\s\S]+)/m)?.[1]
+      // 除去标题
+      ?.replace(/#/g, '')
+      // 除去图片
+      ?.replace(/!\[.*?\]\(.*?\)/g, '')
+      // 除去链接
+      ?.replace(/\[(.*?)\]\(.*?\)/g, '$1')
+      // 除去加粗
+      ?.replace(/\*\*(.*?)\*\*/g, '$1')
+      ?.split('\n')
+      ?.filter((v) => !!v)
+      ?.slice(1)
+      ?.join('\n')
+      ?.replace(/>(.*)/, '')
+      ?.slice(0, count)
+  )
+}
+
+export function aliasObjectToArray(obj: Record<string, string>) {
+  return Object.entries(obj).map(([find, replacement]) => ({
+    find,
+    replacement
+  }))
+}
+
+export const EXTERNAL_URL_RE = /^[a-z]+:/i
+
+/**
+ * Join two paths by resolving the slash collision.
+ */
+export function joinPath(base: string, path: string): string {
+  return `${base}${path}`.replace(/\/+/g, '/')
+}
+
+export function withBase(base: string, path: string) {
+  return EXTERNAL_URL_RE.test(path) || path.startsWith('.')
+    ? path
+    : joinPath(base, path)
+}

package/src/utils/node/mdPlugins.ts

@@ -0,0 +1,95 @@
+/* eslint-disable global-require */
+import { tabsMarkdownPlugin } from 'vitepress-plugin-tabs'
+import type { UserConfig } from 'vitepress'
+import { aliasObjectToArray } from './index'
+import type { Theme } from '../../composables/config/index'
+
+export function getMarkdownPlugins(cfg?: Partial<Theme.BlogConfig>) {
+  const markdownPlugin: any[] = []
+  // tabs支持
+  if (cfg?.tabs) {
+    markdownPlugin.push(tabsMarkdownPlugin)
+  }
+
+  // 添加mermaid markdown 插件
+  if (cfg) {
+    cfg.mermaid = cfg?.mermaid ?? true
+    if (cfg?.mermaid !== false) {
+      const { MermaidMarkdown } = require('vitepress-plugin-mermaid')
+      markdownPlugin.push(MermaidMarkdown)
+    }
+  }
+  return markdownPlugin
+}
+
+export function registerMdPlugins(vpCfg: any, plugins: any[]) {
+  if (plugins.length) {
+    vpCfg.markdown = {
+      config(...rest: any[]) {
+        plugins.forEach((plugin) => {
+          plugin?.(...rest)
+        })
+      }
+    }
+  }
+}
+
+/**
+ * 流程图支持，配置mermaid
+ */
+export function assignMermaid(config: any) {
+  if (!config?.mermaid) return
+
+  if (!config.vite) config.vite = {}
+  if (!config.vite.plugins) config.vite.plugins = []
+  const { MermaidPlugin } = require('vitepress-plugin-mermaid')
+  config.vite.plugins.push(MermaidPlugin(config.mermaid))
+  if (!config.vite.resolve) config.vite.resolve = {}
+  if (!config.vite.resolve.alias) config.vite.resolve.alias = {}
+
+  config.vite.resolve.alias = [
+    ...aliasObjectToArray({
+      ...config.vite.resolve.alias,
+      'cytoscape/dist/cytoscape.umd.js': 'cytoscape/dist/cytoscape.esm.js',
+      mermaid: 'mermaid/dist/mermaid.esm.mjs'
+    }),
+    { find: /^dayjs\/(.*).js/, replacement: 'dayjs/esm/$1' }
+  ]
+}
+
+export function wrapperCfgWithMermaid(config: UserConfig<Theme.Config>): any {
+  // @ts-ignore
+  const extendThemeConfig = (config.extends?.themeConfig?.blog ||
+    {}) as Theme.BlogConfig
+
+  // 开关支持Mermaid
+  const resultConfig =
+    extendThemeConfig.mermaid === false
+      ? config
+      : {
+          ...config,
+          mermaid:
+            extendThemeConfig.mermaid === true ? {} : extendThemeConfig.mermaid
+        }
+  assignMermaid(resultConfig)
+  return resultConfig
+}
+
+export function supportRunExtendsPlugin(config: UserConfig<Theme.Config>) {
+  // 处理markdown插件
+  if (!config.markdown) config.markdown = {}
+  // 支持运行继承的markdown插件
+  // @ts-ignore
+  if (config.extends?.markdown?.config) {
+    const markdownExtendsConfigOriginal =
+      // @ts-ignore
+      config.extends?.markdown?.config
+    const selfMarkdownConfig = config.markdown?.config
+
+    config.markdown.config = (...rest: any[]) => {
+      // @ts-ignore
+      selfMarkdownConfig?.(...rest)
+      markdownExtendsConfigOriginal?.(...rest)
+    }
+  }
+}

package/src/utils/node/theme.ts

@@ -0,0 +1,147 @@
+/* eslint-disable prefer-rest-params */
+import glob from 'fast-glob'
+import matter from 'gray-matter'
+import fs from 'fs'
+import path from 'path'
+import type { Theme } from '../../composables/config/index'
+import { getDefaultTitle, getFileBirthTime, getTextSummary } from './index'
+import { formatDate } from '../client'
+
+export function patchDefaultThemeSideBar(cfg?: Partial<Theme.BlogConfig>) {
+  return cfg?.blog !== false && cfg?.recommend !== false
+    ? {
+        sidebar: [
+          {
+            text: '',
+            items: []
+          }
+        ]
+      }
+    : undefined
+}
+
+// hack：RSS用
+export const pageMap = new Map<string, string>()
+
+export function getArticles(cfg?: Partial<Theme.BlogConfig>) {
+  const srcDir = cfg?.srcDir || process.argv.slice(2)?.[1] || '.'
+  const files = glob.sync(`${srcDir}/**/*.md`, { ignore: ['node_modules'] })
+
+  // 文章数据
+  const data = files
+    .map((v) => {
+      let route = v
+        // 处理文件后缀名
+        .replace('.md', '')
+
+      // 去除 srcDir 处理目录名
+      if (route.startsWith('./')) {
+        route = route.replace(
+          new RegExp(
+            `^\\.\\/${path
+              .join(srcDir, '/')
+              .replace(new RegExp(`\\${path.sep}`, 'g'), '/')}`
+          ),
+          ''
+        )
+      } else {
+        route = route.replace(
+          new RegExp(
+            `^${path
+              .join(srcDir, '/')
+              .replace(new RegExp(`\\${path.sep}`, 'g'), '/')}`
+          ),
+          ''
+        )
+      }
+      // hack：RSS使用
+      pageMap.set(`/${route}`, v)
+
+      const fileContent = fs.readFileSync(v, 'utf-8')
+      // TODO：摘要生成优化
+      const { data: frontmatter, excerpt } = matter(fileContent, {
+        excerpt: true
+      })
+
+      const meta: Partial<Theme.PageMeta> = {
+        ...frontmatter
+      }
+
+      if (!meta.title) {
+        meta.title = getDefaultTitle(fileContent)
+      }
+      if (!meta.date) {
+        // getGitTimestamp(v).then((v) => {
+        //   meta.date = formatDate(v)
+        // })
+        meta.date = getFileBirthTime(v)
+      } else {
+        const timeZone = cfg?.timeZone ?? 8
+        meta.date = formatDate(
+          new Date(`${new Date(meta.date).toUTCString()}+${timeZone}`)
+        )
+      }
+
+      // 处理tags和categories,兼容历史文章
+      meta.categories =
+        typeof meta.categories === 'string'
+          ? [meta.categories]
+          : meta.categories
+      meta.tags = typeof meta.tags === 'string' ? [meta.tags] : meta.tags
+      meta.tag = [meta.tag || []]
+        .flat()
+        .concat([
+          ...new Set([...(meta.categories || []), ...(meta.tags || [])])
+        ])
+
+      // 获取摘要信息
+      const wordCount = 100
+      meta.description =
+        meta.description || getTextSummary(fileContent, wordCount)
+
+      // 获取封面图
+      meta.cover =
+        meta.cover ??
+        (fileContent.match(/[!]\[.*?\]\((https:\/\/.+)\)/)?.[1] || '')
+
+      // 是否发布 默认发布
+      if (meta.publish === false) {
+        meta.hidden = true
+        meta.recommend = false
+      }
+
+      return {
+        route: `/${route}`,
+        meta
+      }
+    })
+    .filter((v) => v.meta.layout !== 'home')
+  return data as Theme.PageData[]
+}
+
+export function patchVPConfig(vpConfig: any, cfg?: Partial<Theme.BlogConfig>) {
+  // TODO: 待确定场景
+}
+
+export function patchVPThemeConfig(
+  cfg?: Partial<Theme.BlogConfig>,
+  vpThemeConfig: any = {}
+) {
+  // 添加 icon
+  const RSS = cfg?.RSS
+  if (RSS && RSS.showIcon !== false) {
+    vpThemeConfig.socialLinks = [
+      {
+        icon: {
+          svg: '<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 448 512"><path d="M400 32H48C21.49 32 0 53.49 0 80v352c0 26.51 21.49 48 48 48h352c26.51 0 48-21.49 48-48V80c0-26.51-21.49-48-48-48zM112 416c-26.51 0-48-21.49-48-48s21.49-48 48-48s48 21.49 48 48s-21.49 48-48 48zm157.533 0h-34.335c-6.011 0-11.051-4.636-11.442-10.634c-5.214-80.05-69.243-143.92-149.123-149.123c-5.997-.39-10.633-5.431-10.633-11.441v-34.335c0-6.535 5.468-11.777 11.994-11.425c110.546 5.974 198.997 94.536 204.964 204.964c.352 6.526-4.89 11.994-11.425 11.994zm103.027 0h-34.334c-6.161 0-11.175-4.882-11.427-11.038c-5.598-136.535-115.204-246.161-251.76-251.76C68.882 152.949 64 147.935 64 141.774V107.44c0-6.454 5.338-11.664 11.787-11.432c167.83 6.025 302.21 141.191 308.205 308.205c.232 6.449-4.978 11.787-11.432 11.787z" fill="currentColor"></path></svg>'
+        },
+        link: RSS.url
+      }
+    ]
+  }
+
+  // 用于自定义sidebar卡片slot
+  vpThemeConfig.sidebar = patchDefaultThemeSideBar(cfg)?.sidebar
+
+  return vpThemeConfig
+}

package/src/utils/node/vitePlugins.ts

@@ -0,0 +1,98 @@
+import type { SiteConfig } from 'vitepress'
+import path from 'path'
+import { execSync } from 'child_process'
+import type { Theme } from '../../composables/config/index'
+import { genFeed } from './genFeed'
+
+export function getVitePlugins(cfg?: Partial<Theme.BlogConfig>) {
+  const plugins: any[] = []
+
+  // Build完后运行的一系列列方法
+  const buildEndFn: any[] = []
+  // 执行自定义的 buildEnd 钩子
+  plugins.push(inlineBuildEndPlugin(buildEndFn))
+
+  // 内置简化版的pagefind
+  if (
+    cfg?.search === 'pagefind' ||
+    (cfg?.search instanceof Object && cfg.search.mode === 'pagefind')
+  ) {
+    plugins.push(inlinePagefindPlugin(buildEndFn))
+  }
+
+  buildEndFn.push(genFeed)
+  return plugins
+}
+
+export function registerVitePlugins(vpCfg: any, plugins: any[]) {
+  vpCfg.vite = {
+    plugins
+  }
+}
+
+export function inlinePagefindPlugin(buildEndFn: any[]) {
+  buildEndFn.push(() => {
+    // 调用pagefind
+    const ignore: string[] = [
+      // 侧边栏内容
+      'div.aside',
+      // 标题锚点
+      'a.header-anchor'
+    ]
+    const { log } = console
+    log()
+    log('=== pagefind: https://pagefind.app/ ===')
+    let command = `npx pagefind --source ${path.join(
+      process.argv.slice(2)?.[1] || '.',
+      '.vitepress/dist'
+    )}`
+
+    if (ignore.length) {
+      command += ` --exclude-selectors "${ignore.join(', ')}"`
+    }
+
+    log(command)
+    log()
+    execSync(command, {
+      stdio: 'inherit'
+    })
+  })
+  return {
+    name: '@sugarar/theme-plugin-pagefind',
+    enforce: 'pre',
+    // 添加检索的内容标识
+    transform(code: string, id: string) {
+      if (id.endsWith('theme-default/Layout.vue')) {
+        return code.replace('<VPContent>', '<VPContent data-pagefind-body>')
+      }
+      return code
+    }
+  }
+}
+
+export function inlineBuildEndPlugin(buildEndFn: any[]) {
+  let rewrite = false
+  return {
+    name: '@sugarar/theme-plugin-build-end',
+    enforce: 'pre',
+    configResolved(config: any) {
+      // 避免重复定义
+      if (rewrite) {
+        return
+      }
+      const vitepressConfig: SiteConfig = config.vitepress
+      if (!vitepressConfig) {
+        return
+      }
+      rewrite = true
+      // 添加 自定义 vitepress build 的钩子
+      const selfBuildEnd = vitepressConfig.buildEnd
+      vitepressConfig.buildEnd = (siteCfg) => {
+        selfBuildEnd?.(siteCfg)
+        buildEndFn
+          .filter((fn) => typeof fn === 'function')
+          .forEach((fn) => fn(siteCfg))
+      }
+    }
+  }
+}