@vuepress/core 2.0.0-rc.27 → 2.0.0-rc.29

package/dist/index.d.ts

@@ -183,7 +183,7 @@ interface Hooks {
   onInitialized: LifeCycleHook;
   onPrepared: LifeCycleHook;
   onWatched: LifeCycleHook<[watchers: Closable[], restart: () => Promise<void>]>;
-  onPageUpdated: LifeCycleHook<[type: 'create' | 'delete' | 'update', page: Page, oldPage: Page | null]>;
+  onPageUpdated: LifeCycleHook<[type: 'create', newPage: Page, oldPage: null] | [type: 'delete', newPage: null, oldPage: Page] | [type: 'update', newPage: Page, oldPage: Page]>;
   onGenerated: LifeCycleHook;
   extendsMarkdownOptions: ExtendsHook<MarkdownOptions>;
   extendsMarkdown: ExtendsHook<Markdown>;
@@ -322,6 +322,10 @@ interface ThemeObject extends Omit<PluginObject, 'multiple'> {
    * Allow overriding default templateDev
    */
   templateDev?: string;
+  /**
+   * Allow specifying user styles, which will be injected into client at the bottom
+   */
+  userStyle?: string;
 }
 /**
  * Resolved theme info
@@ -343,6 +347,10 @@ interface ThemeInfo {
    * Default dev template
    */
   templateDev?: string;
+  /**
+   * Allow specifying user styles, which will be injected into client at the bottom
+   */
+  userStyle?: string;
 }
 //#endregion
 //#region src/types/app/options.d.ts
@@ -405,7 +413,7 @@ interface AppConfigCommon extends Partial<SiteData$1> {
   /**
    * Patterns to match the markdown files as pages
    *
-   * @default ['**\/*.md', '!.vuepress', '!node_modules']
+   * @default ['**\/*.md', '!.vuepress']
    */
   pagePatterns?: string[];
   /**
@@ -414,6 +422,10 @@ interface AppConfigCommon extends Partial<SiteData$1> {
    * @default null
    */
   permalinkPattern?: string | null;
+  /**
+   * Allow specifying user styles, which will be injected into client at the bottom
+   */
+  userStyle?: string | null;
   /**
    * Vuepress bundler
    *
@@ -560,7 +572,18 @@ interface AppEnv {
 /**
  * Write temp file util
  */
-type AppWriteTemp = (file: string, content: string) => Promise<string>;
+interface AppWriteTemp {
+  (file: string, content: string): Promise<string>;
+  /**
+   * Clean up the internal write temp cache.
+   *
+   * This should be called when the dev server restarts
+   * to avoid stale cache and to release references to any
+   * in-memory write state so that pending write promises can
+   * complete and be garbage-collected naturally.
+   */
+  cleanup: () => void;
+}
 //#endregion
 //#region src/types/app/app.d.ts
 /**
@@ -707,4 +730,7 @@ declare const createPage: (app: App, options: PageOptions) => Promise<Page>;
  */
 declare const renderPageToVue: (app: App, page: Page) => string;
 //#endregion
-export { AliasHook, App, AppConfig, AppConfigBuild, AppConfigCommon, AppConfigDev, AppDir, AppDirFunction, AppEnv, AppOptions, AppPropertiesBase, AppPropertiesInitialized, AppWriteTemp, BuildApp, Bundler, BundlerOptions, ClientConfigFileHook, DefineHook, DevApp, ExtendsHook, type HeadAttrsConfig, type HeadConfig, type HeadTag, type HeadTagEmpty, type HeadTagNonEmpty, Hook, HookItem, HookQueue, Hooks, HooksExposed, HooksName, HooksNormalized, HooksResult, LifeCycleHook, type LocaleConfig, type LocaleData, Page, type PageData, type PageFrontmatter, type PageHeader, PageOptions, Plugin, PluginApi, PluginConfig, PluginFunction, PluginObject, type SiteData, type SiteLocaleConfig, Theme, ThemeFunction, ThemeInfo, ThemeObject, createBuildApp, createDevApp, createPage, preparePageChunk, prepareRoutes, renderPageToVue, resolveAppDir };
+//#region src/constants.d.ts
+declare const DEFAULT_IGNORE_PATTERNS: string[];
+//#endregion
+export { AliasHook, App, AppConfig, AppConfigBuild, AppConfigCommon, AppConfigDev, AppDir, AppDirFunction, AppEnv, AppOptions, AppPropertiesBase, AppPropertiesInitialized, AppWriteTemp, BuildApp, Bundler, BundlerOptions, ClientConfigFileHook, DEFAULT_IGNORE_PATTERNS, DefineHook, DevApp, ExtendsHook, type HeadAttrsConfig, type HeadConfig, type HeadTag, type HeadTagEmpty, type HeadTagNonEmpty, Hook, HookItem, HookQueue, Hooks, HooksExposed, HooksName, HooksNormalized, HooksResult, LifeCycleHook, type LocaleConfig, type LocaleData, Page, type PageData, type PageFrontmatter, type PageHeader, PageOptions, Plugin, PluginApi, PluginConfig, PluginFunction, PluginObject, type SiteData, type SiteLocaleConfig, Theme, ThemeFunction, ThemeInfo, ThemeObject, createBuildApp, createDevApp, createPage, preparePageChunk, prepareRoutes, renderPageToVue, resolveAppDir };

package/dist/index.js

@@ -12,6 +12,7 @@ const prepareClientConfigs = async (app) => {
 	const clientConfigFiles = await app.pluginApi.hooks.clientConfigFile.process(app);
 	const content = `\
 ${clientConfigFiles.map((filePath, index) => `import * as clientConfig${index} from '${filePath}'`).join("\n")}
+${app.options.userStyle ? `\nimport '${app.options.userStyle}'` : ""}
 
 export const clientConfigs = [
 ${clientConfigFiles.map((_, index) => `  clientConfig${index},`).join("\n")}
@@ -513,6 +514,15 @@ const resolveAppMarkdown = async (app) => {
 	return markdown;
 };
 //#endregion
+//#region src/constants.ts
+const DEFAULT_IGNORE_PATTERNS = [
+	"**/node_modules",
+	"**/.yarn",
+	"**/.git",
+	"**/.svn",
+	"**/.hg"
+];
+//#endregion
 //#region src/app/resolveAppPages.ts
 const log$4 = debug("vuepress:core/app");
 /**
@@ -524,7 +534,8 @@ const resolveAppPages = async (app) => {
 	log$4("resolveAppPages start");
 	const pageFilePaths = await tinyglobby.glob(app.options.pagePatterns, {
 		absolute: true,
-		cwd: app.dir.source()
+		cwd: app.dir.source(),
+		ignore: DEFAULT_IGNORE_PATTERNS
 	});
 	let hasNotFoundPage = false;
 	const pagesMap = {};
@@ -799,11 +810,7 @@ const require$1 = createRequire(import.meta.url);
 *
 * @internal
 */
-const resolveAppOptions = ({ base = "/", lang = "en-US", title = "", description = "", head = [], locales = {}, source, dest = path.resolve(source, ".vuepress/dist"), temp = path.resolve(source, ".vuepress/.temp"), cache = path.resolve(source, ".vuepress/.cache"), public: publicDir = path.resolve(source, ".vuepress/public"), host = "0.0.0.0", port = 8080, open = false, templateDev = path.normalize(require$1.resolve("@vuepress/client/templates/dev.html")), shouldPreload = true, shouldPrefetch = true, templateBuild = path.normalize(require$1.resolve("@vuepress/client/templates/build.html")), templateBuildRenderer = templateRenderer, bundler, debug = false, markdown = {}, pagePatterns = [
-	"**/*.md",
-	"!.vuepress",
-	"!node_modules"
-], permalinkPattern = null, plugins = [], theme }) => {
+const resolveAppOptions = ({ base = "/", lang = "en-US", title = "", description = "", head = [], locales = {}, source, dest = path.resolve(source, ".vuepress/dist"), temp = path.resolve(source, ".vuepress/.temp"), cache = path.resolve(source, ".vuepress/.cache"), public: publicDir = path.resolve(source, ".vuepress/public"), host = "0.0.0.0", port = 8080, open = false, templateDev = path.normalize(require$1.resolve("@vuepress/client/templates/dev.html")), shouldPreload = true, shouldPrefetch = true, templateBuild = path.normalize(require$1.resolve("@vuepress/client/templates/build.html")), templateBuildRenderer = templateRenderer, bundler, debug = false, markdown = {}, pagePatterns = ["**/*.md", "!.vuepress"], permalinkPattern = null, userStyle = null, plugins = [], theme }) => {
 	locales["/"] ??= {
 		lang,
 		title,
@@ -834,6 +841,7 @@ const resolveAppOptions = ({ base = "/", lang = "en-US", title = "", description
 		markdown,
 		pagePatterns,
 		permalinkPattern,
+		userStyle,
 		plugins,
 		theme
 	};
@@ -875,7 +883,7 @@ const resolveAppVersion = () => {
 */
 const resolveAppWriteTemp = (dir) => {
 	const cache = /* @__PURE__ */ new Map();
-	const writeTemp = async (file, content) => {
+	const writeTemp = (async (file, content) => {
 		const filePath = dir.temp(file);
 		const contentHash = hash(content);
 		let item = cache.get(filePath);
@@ -894,6 +902,9 @@ const resolveAppWriteTemp = (dir) => {
 		};
 		await item.current;
 		return filePath;
+	});
+	writeTemp.cleanup = () => {
+		cache.clear();
 	};
 	return writeTemp;
 };
@@ -940,7 +951,8 @@ const resolveThemeInfo = (app, theme) => {
 		plugins: [...themeObject.plugins ?? [], themeObject],
 		templateBuild: themeObject.templateBuild,
 		templateBuildRenderer: themeObject.templateBuildRenderer,
-		templateDev: themeObject.templateDev
+		templateDev: themeObject.templateDev,
+		userStyle: themeObject.userStyle
 	};
 	if (!themeObject.extends) return themeInfo;
 	const parentThemeInfo = resolveThemeInfo(app, themeObject.extends);
@@ -948,7 +960,8 @@ const resolveThemeInfo = (app, theme) => {
 		plugins: [...parentThemeInfo.plugins, ...themeInfo.plugins],
 		templateBuild: themeObject.templateBuild ?? parentThemeInfo.templateBuild,
 		templateBuildRenderer: themeObject.templateBuildRenderer ?? parentThemeInfo.templateBuildRenderer,
-		templateDev: themeObject.templateDev ?? parentThemeInfo.templateDev
+		templateDev: themeObject.templateDev ?? parentThemeInfo.templateDev,
+		userStyle: themeObject.userStyle ?? parentThemeInfo.userStyle
 	};
 };
 //#endregion
@@ -963,6 +976,7 @@ const setupAppThemeAndPlugins = (app, config) => {
 	app.options.templateDev = config.templateDev ?? themeInfo.templateDev ?? app.options.templateDev;
 	app.options.templateBuild = config.templateBuild ?? themeInfo.templateBuild ?? app.options.templateBuild;
 	app.options.templateBuildRenderer = config.templateBuildRenderer ?? themeInfo.templateBuildRenderer ?? app.options.templateBuildRenderer;
+	app.options.userStyle = config.userStyle ?? themeInfo.userStyle ?? app.options.userStyle;
 	[...themeInfo.plugins, ...app.options.plugins].flat().forEach((plugin) => app.use(plugin));
 };
 //#endregion
@@ -990,4 +1004,4 @@ const createDevApp = (config) => {
 	return app;
 };
 //#endregion
-export { appInit, appPrepare, appUse, createAppDirFunction, createBaseApp, createBuildApp, createDevApp, createHookQueue, createPage, createPluginApi, createPluginApiHooks, createPluginApiRegisterHooks, inferPagePath, normalizeAliasDefineHook, normalizeClientConfigFileHook, parsePageContent, prepareClientConfigs, preparePageChunk, prepareRoutes, prepareSiteData, renderPageToVue, resolveAppDir, resolveAppEnv, resolveAppOptions, resolveAppPages, resolveAppSiteData, resolveAppVersion, resolveAppWriteTemp, resolvePageChunkInfo, resolvePageContent, resolvePageDate, resolvePageFilePath, resolvePageHtmlInfo, resolvePageLang, resolvePagePath, resolvePagePermalink, resolvePageRouteMeta, resolvePageSlug, resolvePluginObject, resolveThemeInfo };
+export { DEFAULT_IGNORE_PATTERNS, appInit, appPrepare, appUse, createAppDirFunction, createBaseApp, createBuildApp, createDevApp, createHookQueue, createPage, createPluginApi, createPluginApiHooks, createPluginApiRegisterHooks, inferPagePath, normalizeAliasDefineHook, normalizeClientConfigFileHook, parsePageContent, prepareClientConfigs, preparePageChunk, prepareRoutes, prepareSiteData, renderPageToVue, resolveAppDir, resolveAppEnv, resolveAppOptions, resolveAppPages, resolveAppSiteData, resolveAppVersion, resolveAppWriteTemp, resolvePageChunkInfo, resolvePageContent, resolvePageDate, resolvePageFilePath, resolvePageHtmlInfo, resolvePageLang, resolvePagePath, resolvePagePermalink, resolvePageRouteMeta, resolvePageSlug, resolvePluginObject, resolveThemeInfo };

package/package.json

@@ -1,48 +1,48 @@
 {
   "name": "@vuepress/core",
-  "version": "2.0.0-rc.27",
+  "version": "2.0.0-rc.29",
   "description": "Core package of VuePress",
   "keywords": [
-    "vuepress",
-    "core"
+    "core",
+    "vuepress"
   ],
   "homepage": "https://github.com/vuepress",
   "bugs": {
     "url": "https://github.com/vuepress/core/issues"
   },
+  "license": "MIT",
+  "author": "meteorlxy",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vuepress/core.git"
   },
-  "license": "MIT",
-  "author": "meteorlxy",
+  "files": [
+    "dist"
+  ],
   "type": "module",
-  "exports": {
-    ".": "./dist/index.js",
-    "./package.json": "./package.json"
-  },
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "dependencies": {
-    "vue": "^3.5.29",
-    "@vuepress/client": "2.0.0-rc.27",
-    "@vuepress/markdown": "2.0.0-rc.27",
-    "@vuepress/utils": "2.0.0-rc.27",
-    "@vuepress/shared": "2.0.0-rc.27"
+  "exports": {
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
   },
   "publishConfig": {
     "access": "public"
   },
+  "dependencies": {
+    "vue": "^3.5.34",
+    "@vuepress/client": "2.0.0-rc.29",
+    "@vuepress/markdown": "2.0.0-rc.29",
+    "@vuepress/shared": "2.0.0-rc.29",
+    "@vuepress/utils": "2.0.0-rc.29"
+  },
   "tsdown": {
-    "entry": "./src/index.ts",
     "dts": true,
+    "entry": "./src/index.ts",
+    "fixedExtension": false,
     "format": "esm",
     "target": "es2023",
-    "fixedExtension": false,
     "tsconfig": "../../tsconfig.dts.json"
   },
   "scripts": {