valaxy 1.0.0-rc.9 → 1.0.0

package/dist/node/index.d.mts

@@ -1,6 +1,5 @@
-import * as vite from 'vite';
-import { UserConfig, InlineConfig, ViteDevServer, PluginOption, Plugin } from 'vite';
-import { S as SiteConfig, D as DefaultTheme, R as RuntimeConfig, a as RedirectItem, V as ValaxyConfig, P as PartialDeep, b as ValaxyAddon, U as UserSiteConfig } from '../shared/valaxy.CmvWuejN.mjs';
+import { Plugin, UserConfig, InlineConfig, ViteDevServer, PluginOption } from 'vite';
+import { SiteConfig, DefaultTheme, RuntimeConfig, RedirectItem, ValaxyConfig, PartialDeep, ValaxyAddon, UserSiteConfig } from '../types/index.mjs';
 import Vue from '@vitejs/plugin-vue';
 import { Hookable } from 'hookable';
 import { PluginVisualizerOptions } from 'rollup-plugin-visualizer';
@@ -8,16 +7,16 @@ import { presetAttributify, presetIcons, presetTypography, presetWind4 } from 'u
 import { VitePluginConfig } from 'unocss/vite';
 import Components from 'unplugin-vue-components/vite';
 import Markdown from 'unplugin-vue-markdown/vite';
-import Layouts from 'vite-plugin-vue-layouts-next';
 import { EditableTreeNode } from 'vue-router/unplugin';
 import Router from 'vue-router/vite';
 import { MarkdownEnv } from 'unplugin-vue-markdown/types';
+import { ValaxyDevtoolsAddon } from '@valaxyjs/devtools/plugin';
 import { Argv } from 'yargs';
 import { KatexOptions } from 'katex';
-import MarkdownIt, { MarkdownItOptions, Env, MarkdownIt as MarkdownIt$1, StateCore, Token } from 'markdown-it';
+import { MarkdownExitOptions, MarkdownExit, StateCore, Token } from 'markdown-exit';
 import { ThemeRegistration, BuiltinTheme, LanguageInput, ShikiTransformer, Highlighter } from 'shiki';
 import { Header } from '@valaxyjs/utils';
-export { CreateCliOptions, createCli, registerDevCommand, run, startValaxyDev } from './cli/index.mjs';
+export { CreateCliOptions, createCli, desktopRuntimeVersion, execBuild, registerDevCommand, run, startValaxyDev } from './cli/index.mjs';
 import { Awaitable } from '@antfu/utils';
 import * as defu from 'defu';
 import '@vueuse/integrations/useFuse';
@@ -27,6 +26,48 @@ import 'vue-router';
 import '@vueuse/core';
 import '@unhead/schema-org';
 
+//#region src/types.d.ts
+interface Options {
+  /**
+   * Relative path to the directory to search for layout components.
+   * @default 'src/layouts'
+   */
+  layoutsDirs: string | string[];
+  /**
+   * Valid file extensions for layout components.
+   * @default ['vue']
+   */
+  extensions: string[];
+  /**
+   * List of path globs to exclude when resolving layouts.
+   */
+  exclude: string[];
+  /**
+   * Normalized layout name/key to use as the default layout
+   * (for example, myDefault.vue -> my-default)
+   * @default 'default'
+   */
+  defaultLayout: string;
+  /**
+   * Layout name/key to render when a page asks for a layout that does not exist.
+   * Defaults to `defaultLayout`.
+   */
+  fallbackLayout?: string;
+  /**
+   * `sync` bundles a layout into the main chunk, `async` lazy-loads it.
+   * Defaults to `sync` for `default` (and for every layout under `VITE_SSG`), `async` otherwise.
+   */
+  importMode: (name: string) => 'sync' | 'async';
+  /**
+   * Whether nested routes should inherit the default layout from parent routes.
+   * When false, if a child route has its own layout, the parent route won't use the default layout.
+   * @default true
+   */
+  inheritDefaultLayout: boolean;
+}
+type UserOptions = Partial<Options>;
+declare function Layout(userOptions?: UserOptions): Plugin;
+
 interface ValaxyFileInfo {
     /**
      * file path id
@@ -295,21 +336,15 @@ interface TocPluginOptions {
   linkClass?: string;
 }
 
-type MarkdownItPresetName = 'default' | 'zero' | 'commonmark';
-type AsyncHighlighter = (str: string, lang: string, attrs: string) => string | Promise<string>;
-interface MarkdownItAsyncOptions extends Omit<MarkdownItOptions, 'highlight'> {
-    highlight?: AsyncHighlighter | null;
-    /** Emit a warning when an async renderer is called through render(). */
-    warnOnSyncRender?: boolean;
-}
-declare class MarkdownItAsync extends MarkdownIt {
-    private readonly pendingHighlights;
-    private readonly warnOnSyncRender;
-    private disableSyncRenderWarning;
-    constructor(presetName: MarkdownItPresetName, options?: MarkdownItAsyncOptions);
-    constructor(options?: MarkdownItAsyncOptions);
-    render(src: string, env?: Env): string;
-    renderAsync(src: string, env?: Env): Promise<string>;
+/**
+ * The Markdown renderer used by every Valaxy compile path.
+ *
+ * Keep the concrete parser behind this module so page compilation, excerpts,
+ * search, and RSS share the same async rendering semantics.
+ */
+type MarkdownRenderer = MarkdownExit;
+interface MarkdownRendererOptions extends Omit<MarkdownExitOptions, 'highlight'> {
+    highlight?: ((str: string, lang: string, attrs: string) => string | Promise<string>) | null;
 }
 
 interface BlockItem {
@@ -357,19 +392,25 @@ interface MarkdownAnchorOptions {
  * Extend Markdown options
  * @zh 扩展 Markdown 配置，包含代码高亮、Markdown-it 和插件配置
  */
-interface MarkdownOptions extends MarkdownItAsyncOptions {
+interface MarkdownOptions extends MarkdownRendererOptions {
+    /**
+     * Cache repeated highlighted code blocks (up to 8 MiB per highlighter).
+     * Enabled for built-in transforms. Custom codeTransformers/shikiSetup must
+     * opt in only when their output depends solely on the code, language and attrs.
+     */
+    highlightCache?: boolean;
     /**
      * Setup markdown-it instance before applying plugins
      */
-    preConfig?: (md: MarkdownItAsync) => void;
+    preConfig?: (md: MarkdownRenderer) => void;
     /**
      * markdown-it options
      */
-    options?: MarkdownIt$1['options'];
+    options?: MarkdownRenderer['options'];
     /**
      * config markdown-it
      */
-    config?: (md: MarkdownItAsync) => void;
+    config?: (md: MarkdownRenderer) => void;
     anchor?: MarkdownAnchorOptions;
     attrs?: {
         leftDelimiter?: string;
@@ -553,7 +594,11 @@ interface ContentLoaderContext {
 }
 interface ContentLoader {
     name: string;
+    /** Validate the complete output before writing; fail production builds on errors. */
+    strict?: boolean;
     load: (ctx: ContentLoaderContext) => Promise<ContentItem[]> | ContentItem[];
+    /** Publish associated metadata only after content has been validated and written. */
+    onLoaded?: (ctx: ContentLoaderContext) => void | Promise<void>;
     /**
      * Polling interval (ms) for dev mode.
      * undefined = no polling
@@ -814,7 +859,7 @@ interface ValaxyExtendConfig {
          * - `true` (default): all pages render KaTeX, unless `frontmatter.katex: false`
          * - `false`: no pages render KaTeX by default, but individual pages can opt-in via `frontmatter.katex: true`
          *
-         * @see [Example | Valaxy](https://valaxy.site/examples/katex)
+         * @see [Example | Valaxy](https://valaxy.site/examples/math)
          * @see https://katex.org/
          * @default true
          */
@@ -878,7 +923,7 @@ interface ValaxyExtendConfig {
     /**
      * @see https://github.com/loicduong/vite-plugin-vue-layouts-next
      */
-    layouts?: Parameters<typeof Layouts>[0];
+    layouts?: Parameters<typeof Layout>[0];
     /**
      * @see https://router.vuejs.org/file-based-routing/
      */
@@ -918,10 +963,19 @@ interface ValaxyExtendConfig {
     };
     /**
      * @experimental
-     * Enable Vue Devtools & Valaxy Devtools
-     * @see https://devtools-next.vuejs.org/
+     * Enable Vite DevTools, Valaxy DevTools and Vue DevTools
+     * @see https://devtools.vite.dev/
      */
     devtools?: boolean;
+    /**
+     * Enable the local, read-only MCP endpoint during development.
+     * @zh 开启开发环境的本地只读 MCP 服务，默认关闭。
+     * @default false
+     */
+    mcp?: boolean | {
+        /** Include drafts in MCP results. Password-protected pages remain excluded. */
+        includeDrafts?: boolean;
+    };
     /**
      * @en config for markdown (include markdown-it plugins)
      * @zh markdown 相关配置
@@ -1008,10 +1062,14 @@ interface ValaxyAddonResolver {
     options: Record<string, any>;
     configFile?: string;
     pkg: Record<string, any>;
+    /** Loaded only when development tools are enabled. */
+    devtools?: ValaxyDevtoolsAddon;
     extendCli?: ValaxyAddonExtendCli;
     setup?: (node: ValaxyNode) => void;
 }
 type ValaxyNodeAddon = ValaxyAddon & {
+    /** Loaded only when development tools are enabled. */
+    devtools?: ValaxyDevtoolsAddon;
     extendCli?: ValaxyAddonExtendCli;
     setup?: ValaxyAddonResolver['setup'];
 };
@@ -1160,6 +1218,57 @@ declare const customElements: Set<string>;
  */
 declare const defaultViteConfig: UserConfig;
 
+interface ContentDiagnostic {
+    code: string;
+    severity: 'error' | 'warning';
+    message: string;
+    hint: string;
+    line?: number;
+}
+interface ContentPageInfo {
+    path: string;
+    /** Routes after configured build-time hooks; runtime router changes are excluded. */
+    routes: {
+        path: string;
+        aliases: string[];
+        previewPath: string;
+        layout: string | false;
+    }[];
+    /** Only public article metadata, never raw configuration or frontmatter. */
+    metadata: Record<string, string | string[] | boolean>;
+    draft: boolean;
+    hidden: boolean;
+    includedInProductionRoutes: boolean;
+}
+interface ContentCheckResult {
+    path: string;
+    ok: boolean;
+    page?: ContentPageInfo;
+    diagnostics: ContentDiagnostic[];
+    /** At most 100 diagnostics are returned; this counts all detected diagnostics. */
+    totalDiagnostics: number;
+}
+interface ContentServiceOptions {
+    /** Apply the MCP visibility policy. CLI/API callers can inspect their own private files. */
+    publicOnly?: boolean;
+    includeDrafts?: boolean;
+    /** Resolved Vite base, when called from a running development server. */
+    base?: string;
+    /** Resolved Vite public directory; false disables public assets. */
+    publicDir?: string | false;
+}
+
+/**
+ * Inspect Markdown through Valaxy's route pipeline without starting a server.
+ * Configured route/Markdown hooks run as they do during route generation. Scans
+ * are serialized and rebuilt per request so edits and removals are observable.
+ */
+declare function createContentService(app: ValaxyNode, settings?: ContentServiceOptions): {
+    inspectPage: (path: string) => Promise<ContentPageInfo>;
+    checkPage: (path: string) => Promise<ContentCheckResult>;
+    dispose: () => Promise<void>;
+};
+
 declare let version: string;
 
 declare const GLOBAL_STATE: {
@@ -1167,6 +1276,12 @@ declare const GLOBAL_STATE: {
     server: ViteDevServer | undefined;
 };
 
+/**
+ * Load content from all loaders and write .md files to cache directory.
+ * Uses digest-based incremental caching to skip unchanged files.
+ */
+declare function loadAllContent(loaders: ContentLoader[], ctx: ContentLoaderContext): Promise<void>;
+
 /**
  * Post process valaxyOptions
  * @param valaxyOptions
@@ -1200,7 +1315,7 @@ declare function createValaxyPlugin(options: ResolvedValaxyOptions, serverOption
  * with valaxyPrefix
  */
 declare function getServerInfoText(msg: string): string;
-declare function createServer(valaxyApp: ValaxyNode, viteConfig?: InlineConfig, serverOptions?: ValaxyServerOptions): Promise<vite.ViteDevServer>;
+declare function createServer(valaxyApp: ValaxyNode, viteConfig?: InlineConfig, serverOptions?: ValaxyServerOptions): Promise<ViteDevServer>;
 
 /**
  * @see https://github.com/mdn/dom-examples/blob/main/web-crypto/encrypt-decrypt/aes-cbc.js
@@ -1212,6 +1327,7 @@ declare function encryptContent(content: string, options: {
     salt: Uint8Array;
 }): Promise<string>;
 
+/** Read commit timestamps from the file's repository, following renames. */
 declare function getGitTimestamp(file: string, type?: 'created' | 'updated'): Promise<number>;
 
 /**
@@ -1251,5 +1367,5 @@ declare function toAtFS(path: string): string;
 declare function resolveImportPath(importName: string, ensure?: true): Promise<string>;
 declare function resolveImportPath(importName: string, ensure?: boolean): Promise<string | undefined>;
 
-export { $t, ALL_ROUTE, EXCERPT_SEPARATOR, GLOBAL_STATE, PATHNAME_PROTOCOL_RE, StateManager, ViteValaxyPlugins, build, createMemoryReleasePlugin, createServer, createValaxyPlugin, customElements, defaultSiteConfig, defaultValaxyConfig, defaultViteConfig, defineAddon, defineConfig, defineContentLoader, defineSiteConfig, defineTheme, defineUnoSetup, defineValaxyAddon, defineValaxyConfig, defineValaxyTheme, encryptContent, generateClientRedirects, getGitTimestamp, getIndexHtml, getServerInfoText, isExternal, isInstalledGlobally, isKatexEnabled, isKatexPluginNeeded, isMathJaxEnabled, isPath, loadConfigFromFile, mergeValaxyConfig, mergeViteConfigs, postProcessForSSG, processValaxyOptions, resolveAddonsConfig, resolveImportPath, resolveImportUrl, resolveOptions, resolveSiteConfig, resolveSiteConfigFromRoot, resolveThemeConfigFromRoot, resolveThemeValaxyConfig, resolveUserThemeConfig, resolveValaxyConfig, resolveValaxyConfigFromRoot, ssgBuild, toAtFS, transformObject, version };
-export type { CdnModule, ContentItem, ContentLoader, ContentLoaderContext, GroupIconOptions, GroupIconValue, HookResult, LoadConfigFromFileOptions, MdAfterRenderContext, ResolvedConfig, ResolvedValaxyOptions, UnoSetup, UserInputConfig, UserValaxyNodeConfig, ValaxyAddonCliContext, ValaxyAddonExport, ValaxyAddonExtendCli, ValaxyAddonFn, ValaxyAddonLike, ValaxyAddonResolver, ValaxyAddons, ValaxyApp, ValaxyConfigExport, ValaxyConfigExtendKey, ValaxyConfigFn, ValaxyEntryOptions, ValaxyExtendConfig, ValaxyFileInfo, ValaxyHooks, ValaxyNode, ValaxyNodeAddon, ValaxyNodeConfig, ValaxyPickConfig, ValaxyServerOptions, ValaxyTheme };
+export { $t, ALL_ROUTE, EXCERPT_SEPARATOR, GLOBAL_STATE, PATHNAME_PROTOCOL_RE, StateManager, ViteValaxyPlugins, build, createContentService, createMemoryReleasePlugin, createServer, createValaxyNode, createValaxyPlugin, customElements, defaultSiteConfig, defaultValaxyConfig, defaultViteConfig, defineAddon, defineConfig, defineContentLoader, defineSiteConfig, defineTheme, defineUnoSetup, defineValaxyAddon, defineValaxyConfig, defineValaxyTheme, encryptContent, generateClientRedirects, getGitTimestamp, getIndexHtml, getServerInfoText, isExternal, isInstalledGlobally, isKatexEnabled, isKatexPluginNeeded, isMathJaxEnabled, isPath, loadAllContent, loadConfigFromFile, mergeValaxyConfig, mergeViteConfigs, postProcessForSSG, processValaxyOptions, resolveAddonsConfig, resolveImportPath, resolveImportUrl, resolveOptions, resolveSiteConfig, resolveSiteConfigFromRoot, resolveThemeConfigFromRoot, resolveThemeValaxyConfig, resolveUserThemeConfig, resolveValaxyConfig, resolveValaxyConfigFromRoot, ssgBuild, toAtFS, transformObject, version };
+export type { CdnModule, ContentCheckResult, ContentDiagnostic, ContentItem, ContentLoader, ContentLoaderContext, ContentPageInfo, ContentServiceOptions, GroupIconOptions, GroupIconValue, HookResult, LoadConfigFromFileOptions, MarkdownRenderer, MdAfterRenderContext, ResolvedConfig, ResolvedValaxyOptions, UnoSetup, UserInputConfig, UserValaxyNodeConfig, ValaxyAddonCliContext, ValaxyAddonExport, ValaxyAddonExtendCli, ValaxyAddonFn, ValaxyAddonLike, ValaxyAddonResolver, ValaxyAddons, ValaxyApp, ValaxyConfigExport, ValaxyConfigExtendKey, ValaxyConfigFn, ValaxyEntryOptions, ValaxyExtendConfig, ValaxyFileInfo, ValaxyHooks, ValaxyNode, ValaxyNodeAddon, ValaxyNodeConfig, ValaxyPickConfig, ValaxyServerOptions, ValaxyTheme };

package/dist/node/index.mjs

@@ -1,4 +1,4 @@
-export { A as ALL_ROUTE, E as EXCERPT_SEPARATOR, G as GLOBAL_STATE, P as PATHNAME_PROTOCOL_RE, S as StateManager, V as ViteValaxyPlugins, b as build, c as createCli, a as createMemoryReleasePlugin, d as createServer, e as createValaxyPlugin, f as customElements, g as defaultSiteConfig, h as defaultValaxyConfig, i as defaultViteConfig, j as defineAddon, k as defineConfig, l as defineSiteConfig, m as defineTheme, n as defineValaxyAddon, o as defineValaxyConfig, p as defineValaxyTheme, q as encryptContent, r as generateClientRedirects, s as getGitTimestamp, t as getIndexHtml, u as getServerInfoText, v as isExternal, w as isInstalledGlobally, x as isKatexEnabled, y as isKatexPluginNeeded, z as isMathJaxEnabled, B as isPath, C as loadConfigFromFile, D as mergeValaxyConfig, F as mergeViteConfigs, H as postProcessForSSG, I as processValaxyOptions, J as registerDevCommand, K as resolveAddonsConfig, L as resolveImportPath, M as resolveImportUrl, N as resolveOptions, O as resolveSiteConfig, Q as resolveSiteConfigFromRoot, R as resolveThemeConfigFromRoot, T as resolveThemeValaxyConfig, U as resolveUserThemeConfig, W as resolveValaxyConfig, X as resolveValaxyConfigFromRoot, Y as run, Z as ssgBuild, _ as startValaxyDev, $ as toAtFS, a0 as transformObject, a1 as version } from '../shared/valaxy.Cb_HdczD.mjs';
+export { A as ALL_ROUTE, E as EXCERPT_SEPARATOR, G as GLOBAL_STATE, P as PATHNAME_PROTOCOL_RE, S as StateManager, V as ViteValaxyPlugins, b as build, c as createCli, a as createContentService, d as createMemoryReleasePlugin, e as createServer, f as createValaxyNode, g as createValaxyPlugin, h as customElements, i as defaultSiteConfig, j as defaultValaxyConfig, k as defaultViteConfig, l as defineAddon, m as defineConfig, n as defineSiteConfig, o as defineTheme, p as defineValaxyAddon, q as defineValaxyConfig, r as defineValaxyTheme, s as desktopRuntimeVersion, t as encryptContent, u as execBuild, v as generateClientRedirects, w as getGitTimestamp, x as getIndexHtml, y as getServerInfoText, z as isExternal, B as isInstalledGlobally, C as isKatexEnabled, D as isKatexPluginNeeded, F as isMathJaxEnabled, H as isPath, I as loadAllContent, J as loadConfigFromFile, K as mergeValaxyConfig, L as mergeViteConfigs, M as postProcessForSSG, N as processValaxyOptions, O as registerDevCommand, Q as resolveAddonsConfig, R as resolveImportPath, T as resolveImportUrl, U as resolveOptions, W as resolveSiteConfig, X as resolveSiteConfigFromRoot, Y as resolveThemeConfigFromRoot, Z as resolveThemeValaxyConfig, _ as resolveUserThemeConfig, $ as resolveValaxyConfig, a0 as resolveValaxyConfigFromRoot, a1 as run, a2 as ssgBuild, a3 as startValaxyDev, a4 as toAtFS, a5 as transformObject, a6 as version } from '../shared/valaxy.BVZF0N6Q.mjs';
 import 'node:path';
 import 'consola';
 import 'fs-extra';
@@ -8,8 +8,8 @@ import 'define-config-ts';
 import 'yargs';
 import 'yargs/helpers';
 import 'node:os';
-import 'fast-glob';
 import 'gray-matter';
+import 'tinyglobby';
 import 'js-yaml';
 import '@antfu/utils';
 import 'debug';
@@ -23,22 +23,35 @@ import 'cross-spawn';
 import 'mlly';
 import 'resolve-global';
 import '@valaxyjs/utils';
+import 'node:fs';
 import 'node:fs/promises';
 import 'dayjs';
 import 'feed';
-import 'markdown-it';
+import 'markdown-exit';
 import 'table';
 import 'hookable';
-import 'node:fs';
-import '@intlify/unplugin-vue-i18n/vite';
-import '@unhead/addons/vite';
-import 'unplugin-vue-components/vite';
-import 'vite-plugin-vue-layouts-next';
+import '@unhead/bundler/vite';
 import 'vitepress-plugin-group-icons';
-import 'p-map';
+import 'local-pkg';
+import 'picomatch';
+import 'chokidar';
+import 'unplugin';
+import 'unplugin-utils';
+import 'obug';
+import 'magic-string';
 import 'node:buffer';
+import 'p-map';
+import '@intlify/shared';
+import '@intlify/bundle-utils';
+import '@rollup/pluginutils';
+import 'vue/compiler-sfc';
+import 'picocolors';
+import '@eslint-community/eslint-utils';
+import '@intlify/vue-i18n-extensions';
+import '@typescript-eslint/scope-manager';
 import 'minisearch';
 import '@shikijs/transformers';
+import 'lru-cache';
 import 'shiki';
 import 'css-i18n';
 import 'markdown-it-anchor';
@@ -52,31 +65,29 @@ import 'markdown-it-container';
 import 'katex';
 import 'katex/contrib/mhchem';
 import 'unplugin-vue-markdown/vite';
-import 'js-base64';
-import 'lru-cache';
 import 'jiti';
 import 'unocss';
 import 'pascalcase';
 import 'html-to-text';
 import 'vue-router/vite';
-import 'node:child_process';
-import 'node:v8';
 import 'vite-ssg-sitemap';
 import '@unhead/vue/server';
+import 'vue-router/unplugin';
+import 'node:child_process';
 import '@clack/prompts';
 import 'node:net';
 import 'node:readline';
 import 'qrcode';
 import 'ejs';
 
-function $t(key) {
-  return `$locale:${key}`;
-}
-
 function defineUnoSetup(fn) {
   return fn;
 }
 
+function $t(key) {
+  return `$locale:${key}`;
+}
+
 function defineContentLoader(loader) {
   return loader;
 }