@uni-helper/vite-plugin-uni-pages 0.2.8 → 0.2.10

package/client.d.ts

@@ -1,6 +1,7 @@
-declare module "virtual:uni-pages" {
-  import { PageMetaDatum } from "./src/types";
-  import { SubPackage } from "./src/config/types/index";
-  export const pages: PageMetaDatum[];
-  export const subPackages: SubPackage[];
+declare module 'virtual:uni-pages' {
+  import type { PageMetaDatum } from './src/types'
+  import type { SubPackage } from './src/config/types/index'
+
+  export const pages: PageMetaDatum[]
+  export const subPackages: SubPackage[]
 }

package/dist/index.cjs

@@ -4,35 +4,81 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 const path = require('node:path');
 const node_child_process = require('node:child_process');
+const process = require('node:process');
 const vite = require('vite');
 const MagicString = require('magic-string');
 const chokidar = require('chokidar');
-const process$1 = require('node:process');
 const unconfig = require('unconfig');
-const uniEnv = require('@uni-helper/uni-env');
 const Debug = require('debug');
-const lodashUnified = require('lodash-unified');
-const fg = require('fast-glob');
 const fs = require('node:fs');
+const promises = require('node:fs/promises');
+const lodashUnified = require('lodash-unified');
 const JSON5 = require('json5');
 const yaml = require('yaml');
 const compilerSfc = require('@vue/compiler-sfc');
+const fg = require('fast-glob');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
 
 const path__default = /*#__PURE__*/_interopDefaultCompat(path);
+const process__default = /*#__PURE__*/_interopDefaultCompat(process);
 const MagicString__default = /*#__PURE__*/_interopDefaultCompat(MagicString);
 const chokidar__default = /*#__PURE__*/_interopDefaultCompat(chokidar);
-const process__default = /*#__PURE__*/_interopDefaultCompat(process$1);
 const Debug__default = /*#__PURE__*/_interopDefaultCompat(Debug);
-const fg__default = /*#__PURE__*/_interopDefaultCompat(fg);
 const fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
 const JSON5__default = /*#__PURE__*/_interopDefaultCompat(JSON5);
+const fg__default = /*#__PURE__*/_interopDefaultCompat(fg);
 
 function slash(str) {
   return str.replace(/\\/g, "/");
 }
 
+function getDeclaration(ctx) {
+  const subPagesPath = ctx.subPageMetaData.map((sub) => {
+    return sub.pages.map((v) => `"${vite.normalizePath(path.join(sub.root, v.path))}"`);
+  }).flat();
+  const tabsPagesPath = ctx.pagesGlobConfig?.tabBar?.list?.map((v) => {
+    return `"${v.pagePath}"`;
+  }) ?? [];
+  const allPagesPath = [...ctx.pageMetaData.filter((page) => !tabsPagesPath.includes(page.path)).map((v) => `"${v.path}"`), ...subPagesPath];
+  const code = `/* eslint-disable */
+/* prettier-ignore */
+// @ts-nocheck
+// Generated by vite-plugin-uni-pages
+
+interface NavigateToOptions {
+  url: ${allPagesPath.join(" |\n       ")};
+}
+interface RedirectToOptions extends NavigateToOptions {}
+
+interface SwitchTabOptions {
+  ${tabsPagesPath.length ? `url: ${tabsPagesPath.join(" | ")}` : ""}
+}
+
+type ReLaunchOptions = NavigateToOptions | SwitchTabOptions;
+
+declare interface Uni {
+  navigateTo(options: UniNamespace.NavigateToOptions & NavigateToOptions): void;
+  redirectTo(options: UniNamespace.RedirectToOptions & RedirectToOptions): void;
+  switchTab(options: UniNamespace.SwitchTabOptions & SwitchTabOptions): void;
+  reLaunch(options: UniNamespace.ReLaunchOptions & ReLaunchOptions): void;
+}
+`;
+  return code;
+}
+async function writeFile(filePath, content) {
+  await promises.mkdir(path.dirname(filePath), { recursive: true });
+  return await promises.writeFile(filePath, content, "utf-8");
+}
+async function writeDeclaration(ctx, filepath) {
+  const originalContent = fs.existsSync(filepath) ? await promises.readFile(filepath, "utf-8") : "";
+  const code = getDeclaration(ctx);
+  if (!code)
+    return;
+  if (code !== originalContent)
+    await writeFile(filepath, code);
+}
+
 const MODULE_ID_VIRTUAL = "virtual:uni-pages";
 const RESOLVED_MODULE_ID_VIRTUAL = `\0${MODULE_ID_VIRTUAL}`;
 const OUTPUT_NAME = "pages.json";
@@ -121,7 +167,8 @@ const debug = {
   pages: Debug__default("vite-plugin-uni-pages:pages"),
   subPages: Debug__default("vite-plugin-uni-pages:subPages"),
   error: Debug__default("vite-plugin-uni-pages:error"),
-  cache: Debug__default("vite-plugin-uni-pages:cache")
+  cache: Debug__default("vite-plugin-uni-pages:cache"),
+  declaration: Debug__default("vite-plugin-uni-pages:declaration")
 };
 function extsToGlob(extensions) {
   return extensions.length > 1 ? `{${extensions.join(",")}}` : extensions[0] || "";
@@ -130,9 +177,6 @@ function isTargetFile(path) {
   const ext = path.split(".").pop();
   return FILE_EXTENSIONS.includes(ext);
 }
-function isConfigFile(path) {
-  return path.includes("pages.config");
-}
 function mergePageMetaDataArray(pageMetaData) {
   const pageMetaDataObj = lodashUnified.groupBy(pageMetaData, "path");
   const result = [];
@@ -147,13 +191,6 @@ function mergePageMetaDataArray(pageMetaData) {
   }
   return result;
 }
-async function getPagesConfigSourcePaths(configSource) {
-  return await fg__default(configSource.map((v) => v.files).flat(), {
-    deep: 0,
-    onlyFiles: true,
-    absolute: true
-  });
-}
 function useCachedPages() {
   const pages = /* @__PURE__ */ new Map();
   function parseData(block) {
@@ -176,8 +213,9 @@ function useCachedPages() {
   };
 }
 
-function resolveOptions(userOptions, viteRoot) {
+function resolveOptions(userOptions, viteRoot = process__default.cwd()) {
   const {
+    dts = true,
     configSource = "pages.config",
     homePage = ["pages/index", "pages/index/index"],
     mergePages = true,
@@ -210,7 +248,9 @@ function resolveOptions(userOptions, viteRoot) {
   const resolvedSubDirs = subPackages.map((dir2) => slash(dir2));
   const resolvedHomePage = typeof homePage === "string" ? [homePage] : homePage;
   const resolvedConfigSource = typeof configSource === "string" ? [{ files: configSource }] : configSource;
+  const resolvedDts = !dts ? false : typeof dts === "string" ? dts : path.resolve(viteRoot, "uni-pages.d.ts");
   const resolvedOptions = {
+    dts: resolvedDts,
     configSource: Array.isArray(resolvedConfigSource) ? resolvedConfigSource : [resolvedConfigSource],
     homePage: resolvedHomePage,
     mergePages,
@@ -277,6 +317,7 @@ class PageContext {
   constructor(userOptions, viteRoot = process__default.cwd()) {
     __publicField(this, "_server");
     __publicField(this, "pagesGlobConfig");
+    __publicField(this, "pagesConfigSourcePaths", []);
     __publicField(this, "pagesPath", []);
     __publicField(this, "subPagesPath", {});
     __publicField(this, "pageMetaData", []);
@@ -303,9 +344,10 @@ class PageContext {
     this.logger = logger;
   }
   async loadUserPagesConfig() {
-    const sources = this.options.configSource;
-    const { config } = await unconfig.loadConfig({ cwd: this.root, sources, defaults: {} });
+    const configSource = this.options.configSource;
+    const { config, sources } = await unconfig.loadConfig({ cwd: this.root, sources: configSource, defaults: {} });
     this.pagesGlobConfig = config;
+    this.pagesConfigSourcePaths = sources;
     debug.options(config);
   }
   async scanPages() {
@@ -331,12 +373,9 @@ class PageContext {
     this.setupWatcher(server.watcher);
   }
   async setupWatcher(watcher) {
-    if (!uniEnv.isH5) {
-      const configs = await getPagesConfigSourcePaths(this.options.configSource);
-      watcher.add(configs);
-    }
+    watcher.add(this.pagesConfigSourcePaths);
     const targetDirs = [...this.options.dirs, ...this.options.subPackages].map((v) => slash(path__default.resolve(this.root, v)));
-    const isInTargetDirs = (path2) => targetDirs.some((v) => path2.startsWith(v));
+    const isInTargetDirs = (filePath) => targetDirs.some((v) => slash(path__default.resolve(this.root, filePath)).startsWith(v));
     watcher.on("add", async (path2) => {
       path2 = slash(path2);
       if (!isTargetFile(path2))
@@ -349,7 +388,7 @@ class PageContext {
     });
     watcher.on("change", async (path2) => {
       path2 = slash(path2);
-      if (!isTargetFile(path2) && !isConfigFile(path2))
+      if (!isTargetFile(path2))
         return;
       if (!isInTargetDirs(path2))
         return;
@@ -359,6 +398,13 @@ class PageContext {
       if (await this.updatePagesJSON(path2))
         this.onUpdate();
     });
+    watcher.on("change", async (path2) => {
+      if (this.pagesConfigSourcePaths.includes(path2)) {
+        debug.pages(`Config source changed: ${path2}`);
+        if (await this.updatePagesJSON())
+          this.onUpdate();
+      }
+    });
     watcher.on("unlink", async (path2) => {
       path2 = slash(path2);
       if (!isTargetFile(path2))
@@ -476,6 +522,7 @@ class PageContext {
       subPackages: this.subPageMetaData
     };
     const pagesJson = JSON.stringify(data, null, this.options.minify ? void 0 : 2);
+    this.generateDeclaration();
     if (lsatPagesJson === pagesJson) {
       debug.pages("PagesJson Not have change");
       return false;
@@ -496,6 +543,12 @@ class PageContext {
   resolveSubRoutes() {
     return JSON.stringify(this.subPageMetaData, null, 2);
   }
+  generateDeclaration() {
+    if (!this.options.dts)
+      return;
+    debug.declaration("generating");
+    return writeDeclaration(this, this.options.dts);
+  }
 }
 function getPagePaths(dir, options) {
   const pagesDirPath = slash(path__default.resolve(options.root, dir));
@@ -515,22 +568,22 @@ function defineUniPages(config) {
 
 async function restart() {
   return new Promise((resolve) => {
-    const build = node_child_process.spawn(process.argv.shift(), process.argv, {
-      cwd: process.cwd(),
+    const build = node_child_process.spawn(process__default.argv.shift(), process__default.argv, {
+      cwd: process__default.cwd(),
       detached: true,
-      env: process.env
+      env: process__default.env
     });
-    build.stdout?.pipe(process.stdout);
-    build.stderr?.pipe(process.stderr);
+    build.stdout?.pipe(process__default.stdout);
+    build.stderr?.pipe(process__default.stderr);
     build.on("close", (code) => {
-      resolve(process.exit(code));
+      resolve(process__default.exit(code));
     });
   });
 }
 function VitePluginUniPages(userOptions = {}) {
   let ctx;
   const resolvedPagesJSONPath = path__default.join(
-    process.cwd(),
+    process__default.cwd(),
     userOptions.outDir ?? "src",
     OUTPUT_NAME
   );
@@ -606,11 +659,9 @@ exports.default = VitePluginUniPages;
 exports.defineUniPages = defineUniPages;
 exports.extsToGlob = extsToGlob;
 exports.getPageFiles = getPageFiles;
-exports.getPagesConfigSourcePaths = getPagesConfigSourcePaths;
 exports.getRouteBlock = getRouteBlock;
 exports.getRouteSfcBlock = getRouteSfcBlock;
 exports.invalidatePagesModule = invalidatePagesModule;
-exports.isConfigFile = isConfigFile;
 exports.isTargetFile = isTargetFile;
 exports.mergePageMetaDataArray = mergePageMetaDataArray;
 exports.parseCustomBlock = parseCustomBlock;

package/dist/index.d.cts

@@ -224,7 +224,7 @@ interface GlobalStyle {
     'app-plus'?: AppPlus;
     /**
      * 设置编译到 H5 平台的特定样式，配置项参考下方 H5
-     * @type H5
+     * @type {H5}
      * @desc H5
      */
     h5?: H5;
@@ -270,7 +270,7 @@ interface GlobalStyle {
     'mp-jd'?: object;
     /**
      * 引用小程序组件，参考 小程序组件
-     * @type Record<string, string>
+     * @type {Record<string, string>}
      * @desc
      */
     usingComponents?: Record<string, string>;
@@ -441,9 +441,9 @@ interface TabBar {
     blurEffect?: string;
     /**
      * tab 的列表，详见 list 属性说明，最少2个、最多5个 tab
-     * @type TabBarItem[]
+     * @type {TabBarItem[]}
      */
-    list?: TabBarItem[];
+    list: [TabBarItem, TabBarItem, TabBarItem?, TabBarItem?, TabBarItem?];
     /**
      * 可选值 bottom、top
      * @default "bottom"
@@ -639,6 +639,7 @@ declare function defineUniPages(config: UserPagesConfig): UserPagesConfig;
 declare class PageContext {
     private _server;
     pagesGlobConfig: PagesConfig | undefined;
+    pagesConfigSourcePaths: string[];
     pagesPath: PagePath[];
     subPagesPath: Record<string, PagePath[]>;
     pageMetaData: PageMetaDatum[];
@@ -665,6 +666,7 @@ declare class PageContext {
     virtualModule(): string;
     resolveRoutes(): string;
     resolveSubRoutes(): string;
+    generateDeclaration(): Promise<void> | undefined;
 }
 
 declare function invalidatePagesModule(server: ViteDevServer): void;
@@ -676,17 +678,16 @@ declare const debug: {
     subPages: Debug.Debugger;
     error: Debug.Debugger;
     cache: Debug.Debugger;
+    declaration: Debug.Debugger;
 };
 declare function extsToGlob(extensions: string[]): string;
 declare function isTargetFile(path: string): boolean;
-declare function isConfigFile(path: string): boolean;
 /**
  * merge page meta data array by path and assign style
  * @param pageMetaData  page meta data array
  * TODO: support merge middleware
  */
 declare function mergePageMetaDataArray(pageMetaData: PageMetaDatum[]): PageMetaDatum[];
-declare function getPagesConfigSourcePaths(configSource: LoadConfigSource<PagesConfig>[]): Promise<string[]>;
 declare function useCachedPages(): {
     setCache: (filePath: string, routeBlock?: SFCBlock) => void;
     hasChanged: (filePath: string, routeBlock?: SFCBlock) => Promise<boolean>;
@@ -699,6 +700,14 @@ interface CustomBlock {
 type debugType = keyof typeof debug;
 type ConfigSource = string | LoadConfigSource<PagesConfig> | LoadConfigSource<PagesConfig>[];
 interface Options {
+    /**
+     * Generate TypeScript declaration for pages path
+     *
+     * Accept boolean or a path related to project root
+     *
+     * @default true
+     */
+    dts?: boolean | string;
     /**
      * Load from configs files
      *
@@ -759,12 +768,13 @@ interface Options {
     onAfterWriteFile: (ctx: PageContext) => void;
 }
 type UserOptions = Partial<Options>;
-interface ResolvedOptions extends Omit<Options, 'dir' | 'homePage' | 'configSource'> {
+interface ResolvedOptions extends Omit<Options, 'dir' | 'homePage' | 'configSource' | 'dts'> {
     /**
      * Resolves to the `root` value from Vite config.
      * @default config.root
      */
     root: string;
+    dts: string | false;
     /**
      * Resolved page dirs
      */
@@ -801,7 +811,7 @@ interface SubPageMetaDatum {
 }
 
 declare const MODULE_ID_VIRTUAL = "virtual:uni-pages";
-declare const RESOLVED_MODULE_ID_VIRTUAL: string;
+declare const RESOLVED_MODULE_ID_VIRTUAL = "\0virtual:uni-pages";
 declare const OUTPUT_NAME = "pages.json";
 declare const FILE_EXTENSIONS: string[];
 
@@ -825,4 +835,4 @@ declare function getRouteBlock(path: string, blockStr: SFCBlock | undefined, opt
 
 declare function VitePluginUniPages(userOptions?: UserOptions): Plugin;
 
-export { type Condition, type ConditionItem, type ConfigSource, type CustomBlock, type EasyCom, FILE_EXTENSIONS, type GlobalStyle, type IconFont, MODULE_ID_VIRTUAL, type MidButton, OUTPUT_NAME, type Options, PageContext, type PageMetaDatum, type PagePath, type PagesConfig, type PreloadRule, RESOLVED_MODULE_ID_VIRTUAL, type ResolvedOptions, type SubPackage, type SubPageMetaDatum, type TabBar, type TabBarItem, type TheWindow, type UniIdRouter, type UserOptions, type UserPagesConfig, VitePluginUniPages, checkPagesJsonFile, debug, type debugType, VitePluginUniPages as default, defineUniPages, extsToGlob, getPageFiles, getPagesConfigSourcePaths, getRouteBlock, getRouteSfcBlock, invalidatePagesModule, isConfigFile, isTargetFile, mergePageMetaDataArray, parseCustomBlock, parseSFC, resolveOptions, resolvePageDirs, useCachedPages, writeFileSync };
+export { type Condition, type ConditionItem, type ConfigSource, type CustomBlock, type EasyCom, FILE_EXTENSIONS, type GlobalStyle, type IconFont, MODULE_ID_VIRTUAL, type MidButton, OUTPUT_NAME, type Options, PageContext, type PageMetaDatum, type PagePath, type PagesConfig, type PreloadRule, RESOLVED_MODULE_ID_VIRTUAL, type ResolvedOptions, type SubPackage, type SubPageMetaDatum, type TabBar, type TabBarItem, type TheWindow, type UniIdRouter, type UserOptions, type UserPagesConfig, VitePluginUniPages, checkPagesJsonFile, debug, type debugType, VitePluginUniPages as default, defineUniPages, extsToGlob, getPageFiles, getRouteBlock, getRouteSfcBlock, invalidatePagesModule, isTargetFile, mergePageMetaDataArray, parseCustomBlock, parseSFC, resolveOptions, resolvePageDirs, useCachedPages, writeFileSync };

package/dist/index.d.mts

@@ -224,7 +224,7 @@ interface GlobalStyle {
     'app-plus'?: AppPlus;
     /**
      * 设置编译到 H5 平台的特定样式，配置项参考下方 H5
-     * @type H5
+     * @type {H5}
      * @desc H5
      */
     h5?: H5;
@@ -270,7 +270,7 @@ interface GlobalStyle {
     'mp-jd'?: object;
     /**
      * 引用小程序组件，参考 小程序组件
-     * @type Record<string, string>
+     * @type {Record<string, string>}
      * @desc
      */
     usingComponents?: Record<string, string>;
@@ -441,9 +441,9 @@ interface TabBar {
     blurEffect?: string;
     /**
      * tab 的列表，详见 list 属性说明，最少2个、最多5个 tab
-     * @type TabBarItem[]
+     * @type {TabBarItem[]}
      */
-    list?: TabBarItem[];
+    list: [TabBarItem, TabBarItem, TabBarItem?, TabBarItem?, TabBarItem?];
     /**
      * 可选值 bottom、top
      * @default "bottom"
@@ -639,6 +639,7 @@ declare function defineUniPages(config: UserPagesConfig): UserPagesConfig;
 declare class PageContext {
     private _server;
     pagesGlobConfig: PagesConfig | undefined;
+    pagesConfigSourcePaths: string[];
     pagesPath: PagePath[];
     subPagesPath: Record<string, PagePath[]>;
     pageMetaData: PageMetaDatum[];
@@ -665,6 +666,7 @@ declare class PageContext {
     virtualModule(): string;
     resolveRoutes(): string;
     resolveSubRoutes(): string;
+    generateDeclaration(): Promise<void> | undefined;
 }
 
 declare function invalidatePagesModule(server: ViteDevServer): void;
@@ -676,17 +678,16 @@ declare const debug: {
     subPages: Debug.Debugger;
     error: Debug.Debugger;
     cache: Debug.Debugger;
+    declaration: Debug.Debugger;
 };
 declare function extsToGlob(extensions: string[]): string;
 declare function isTargetFile(path: string): boolean;
-declare function isConfigFile(path: string): boolean;
 /**
  * merge page meta data array by path and assign style
  * @param pageMetaData  page meta data array
  * TODO: support merge middleware
  */
 declare function mergePageMetaDataArray(pageMetaData: PageMetaDatum[]): PageMetaDatum[];
-declare function getPagesConfigSourcePaths(configSource: LoadConfigSource<PagesConfig>[]): Promise<string[]>;
 declare function useCachedPages(): {
     setCache: (filePath: string, routeBlock?: SFCBlock) => void;
     hasChanged: (filePath: string, routeBlock?: SFCBlock) => Promise<boolean>;
@@ -699,6 +700,14 @@ interface CustomBlock {
 type debugType = keyof typeof debug;
 type ConfigSource = string | LoadConfigSource<PagesConfig> | LoadConfigSource<PagesConfig>[];
 interface Options {
+    /**
+     * Generate TypeScript declaration for pages path
+     *
+     * Accept boolean or a path related to project root
+     *
+     * @default true
+     */
+    dts?: boolean | string;
     /**
      * Load from configs files
      *
@@ -759,12 +768,13 @@ interface Options {
     onAfterWriteFile: (ctx: PageContext) => void;
 }
 type UserOptions = Partial<Options>;
-interface ResolvedOptions extends Omit<Options, 'dir' | 'homePage' | 'configSource'> {
+interface ResolvedOptions extends Omit<Options, 'dir' | 'homePage' | 'configSource' | 'dts'> {
     /**
      * Resolves to the `root` value from Vite config.
      * @default config.root
      */
     root: string;
+    dts: string | false;
     /**
      * Resolved page dirs
      */
@@ -801,7 +811,7 @@ interface SubPageMetaDatum {
 }
 
 declare const MODULE_ID_VIRTUAL = "virtual:uni-pages";
-declare const RESOLVED_MODULE_ID_VIRTUAL: string;
+declare const RESOLVED_MODULE_ID_VIRTUAL = "\0virtual:uni-pages";
 declare const OUTPUT_NAME = "pages.json";
 declare const FILE_EXTENSIONS: string[];
 
@@ -825,4 +835,4 @@ declare function getRouteBlock(path: string, blockStr: SFCBlock | undefined, opt
 
 declare function VitePluginUniPages(userOptions?: UserOptions): Plugin;
 
-export { type Condition, type ConditionItem, type ConfigSource, type CustomBlock, type EasyCom, FILE_EXTENSIONS, type GlobalStyle, type IconFont, MODULE_ID_VIRTUAL, type MidButton, OUTPUT_NAME, type Options, PageContext, type PageMetaDatum, type PagePath, type PagesConfig, type PreloadRule, RESOLVED_MODULE_ID_VIRTUAL, type ResolvedOptions, type SubPackage, type SubPageMetaDatum, type TabBar, type TabBarItem, type TheWindow, type UniIdRouter, type UserOptions, type UserPagesConfig, VitePluginUniPages, checkPagesJsonFile, debug, type debugType, VitePluginUniPages as default, defineUniPages, extsToGlob, getPageFiles, getPagesConfigSourcePaths, getRouteBlock, getRouteSfcBlock, invalidatePagesModule, isConfigFile, isTargetFile, mergePageMetaDataArray, parseCustomBlock, parseSFC, resolveOptions, resolvePageDirs, useCachedPages, writeFileSync };
+export { type Condition, type ConditionItem, type ConfigSource, type CustomBlock, type EasyCom, FILE_EXTENSIONS, type GlobalStyle, type IconFont, MODULE_ID_VIRTUAL, type MidButton, OUTPUT_NAME, type Options, PageContext, type PageMetaDatum, type PagePath, type PagesConfig, type PreloadRule, RESOLVED_MODULE_ID_VIRTUAL, type ResolvedOptions, type SubPackage, type SubPageMetaDatum, type TabBar, type TabBarItem, type TheWindow, type UniIdRouter, type UserOptions, type UserPagesConfig, VitePluginUniPages, checkPagesJsonFile, debug, type debugType, VitePluginUniPages as default, defineUniPages, extsToGlob, getPageFiles, getRouteBlock, getRouteSfcBlock, invalidatePagesModule, isTargetFile, mergePageMetaDataArray, parseCustomBlock, parseSFC, resolveOptions, resolvePageDirs, useCachedPages, writeFileSync };

package/dist/index.d.ts

@@ -224,7 +224,7 @@ interface GlobalStyle {
     'app-plus'?: AppPlus;
     /**
      * 设置编译到 H5 平台的特定样式，配置项参考下方 H5
-     * @type H5
+     * @type {H5}
      * @desc H5
      */
     h5?: H5;
@@ -270,7 +270,7 @@ interface GlobalStyle {
     'mp-jd'?: object;
     /**
      * 引用小程序组件，参考 小程序组件
-     * @type Record<string, string>
+     * @type {Record<string, string>}
      * @desc
      */
     usingComponents?: Record<string, string>;
@@ -441,9 +441,9 @@ interface TabBar {
     blurEffect?: string;
     /**
      * tab 的列表，详见 list 属性说明，最少2个、最多5个 tab
-     * @type TabBarItem[]
+     * @type {TabBarItem[]}
      */
-    list?: TabBarItem[];
+    list: [TabBarItem, TabBarItem, TabBarItem?, TabBarItem?, TabBarItem?];
     /**
      * 可选值 bottom、top
      * @default "bottom"
@@ -639,6 +639,7 @@ declare function defineUniPages(config: UserPagesConfig): UserPagesConfig;
 declare class PageContext {
     private _server;
     pagesGlobConfig: PagesConfig | undefined;
+    pagesConfigSourcePaths: string[];
     pagesPath: PagePath[];
     subPagesPath: Record<string, PagePath[]>;
     pageMetaData: PageMetaDatum[];
@@ -665,6 +666,7 @@ declare class PageContext {
     virtualModule(): string;
     resolveRoutes(): string;
     resolveSubRoutes(): string;
+    generateDeclaration(): Promise<void> | undefined;
 }
 
 declare function invalidatePagesModule(server: ViteDevServer): void;
@@ -676,17 +678,16 @@ declare const debug: {
     subPages: Debug.Debugger;
     error: Debug.Debugger;
     cache: Debug.Debugger;
+    declaration: Debug.Debugger;
 };
 declare function extsToGlob(extensions: string[]): string;
 declare function isTargetFile(path: string): boolean;
-declare function isConfigFile(path: string): boolean;
 /**
  * merge page meta data array by path and assign style
  * @param pageMetaData  page meta data array
  * TODO: support merge middleware
  */
 declare function mergePageMetaDataArray(pageMetaData: PageMetaDatum[]): PageMetaDatum[];
-declare function getPagesConfigSourcePaths(configSource: LoadConfigSource<PagesConfig>[]): Promise<string[]>;
 declare function useCachedPages(): {
     setCache: (filePath: string, routeBlock?: SFCBlock) => void;
     hasChanged: (filePath: string, routeBlock?: SFCBlock) => Promise<boolean>;
@@ -699,6 +700,14 @@ interface CustomBlock {
 type debugType = keyof typeof debug;
 type ConfigSource = string | LoadConfigSource<PagesConfig> | LoadConfigSource<PagesConfig>[];
 interface Options {
+    /**
+     * Generate TypeScript declaration for pages path
+     *
+     * Accept boolean or a path related to project root
+     *
+     * @default true
+     */
+    dts?: boolean | string;
     /**
      * Load from configs files
      *
@@ -759,12 +768,13 @@ interface Options {
     onAfterWriteFile: (ctx: PageContext) => void;
 }
 type UserOptions = Partial<Options>;
-interface ResolvedOptions extends Omit<Options, 'dir' | 'homePage' | 'configSource'> {
+interface ResolvedOptions extends Omit<Options, 'dir' | 'homePage' | 'configSource' | 'dts'> {
     /**
      * Resolves to the `root` value from Vite config.
      * @default config.root
      */
     root: string;
+    dts: string | false;
     /**
      * Resolved page dirs
      */
@@ -801,7 +811,7 @@ interface SubPageMetaDatum {
 }
 
 declare const MODULE_ID_VIRTUAL = "virtual:uni-pages";
-declare const RESOLVED_MODULE_ID_VIRTUAL: string;
+declare const RESOLVED_MODULE_ID_VIRTUAL = "\0virtual:uni-pages";
 declare const OUTPUT_NAME = "pages.json";
 declare const FILE_EXTENSIONS: string[];
 
@@ -825,4 +835,4 @@ declare function getRouteBlock(path: string, blockStr: SFCBlock | undefined, opt
 
 declare function VitePluginUniPages(userOptions?: UserOptions): Plugin;
 
-export { type Condition, type ConditionItem, type ConfigSource, type CustomBlock, type EasyCom, FILE_EXTENSIONS, type GlobalStyle, type IconFont, MODULE_ID_VIRTUAL, type MidButton, OUTPUT_NAME, type Options, PageContext, type PageMetaDatum, type PagePath, type PagesConfig, type PreloadRule, RESOLVED_MODULE_ID_VIRTUAL, type ResolvedOptions, type SubPackage, type SubPageMetaDatum, type TabBar, type TabBarItem, type TheWindow, type UniIdRouter, type UserOptions, type UserPagesConfig, VitePluginUniPages, checkPagesJsonFile, debug, type debugType, VitePluginUniPages as default, defineUniPages, extsToGlob, getPageFiles, getPagesConfigSourcePaths, getRouteBlock, getRouteSfcBlock, invalidatePagesModule, isConfigFile, isTargetFile, mergePageMetaDataArray, parseCustomBlock, parseSFC, resolveOptions, resolvePageDirs, useCachedPages, writeFileSync };
+export { type Condition, type ConditionItem, type ConfigSource, type CustomBlock, type EasyCom, FILE_EXTENSIONS, type GlobalStyle, type IconFont, MODULE_ID_VIRTUAL, type MidButton, OUTPUT_NAME, type Options, PageContext, type PageMetaDatum, type PagePath, type PagesConfig, type PreloadRule, RESOLVED_MODULE_ID_VIRTUAL, type ResolvedOptions, type SubPackage, type SubPageMetaDatum, type TabBar, type TabBarItem, type TheWindow, type UniIdRouter, type UserOptions, type UserPagesConfig, VitePluginUniPages, checkPagesJsonFile, debug, type debugType, VitePluginUniPages as default, defineUniPages, extsToGlob, getPageFiles, getRouteBlock, getRouteSfcBlock, invalidatePagesModule, isTargetFile, mergePageMetaDataArray, parseCustomBlock, parseSFC, resolveOptions, resolvePageDirs, useCachedPages, writeFileSync };

package/dist/index.mjs

@@ -1,23 +1,69 @@
-import path from 'node:path';
+import path, { join, dirname, resolve } from 'node:path';
 import { spawn } from 'node:child_process';
+import process from 'node:process';
 import { normalizePath, createLogger } from 'vite';
 import MagicString from 'magic-string';
 import chokidar from 'chokidar';
-import process$1 from 'node:process';
 import { loadConfig } from 'unconfig';
-import { isH5 } from '@uni-helper/uni-env';
 import Debug from 'debug';
+import fs, { existsSync } from 'node:fs';
+import { readFile, mkdir, writeFile as writeFile$1 } from 'node:fs/promises';
 import { groupBy } from 'lodash-unified';
-import fg from 'fast-glob';
-import fs from 'node:fs';
 import JSON5 from 'json5';
 import { parse as parse$1 } from 'yaml';
 import { parse } from '@vue/compiler-sfc';
+import fg from 'fast-glob';
 
 function slash(str) {
   return str.replace(/\\/g, "/");
 }
 
+function getDeclaration(ctx) {
+  const subPagesPath = ctx.subPageMetaData.map((sub) => {
+    return sub.pages.map((v) => `"${normalizePath(join(sub.root, v.path))}"`);
+  }).flat();
+  const tabsPagesPath = ctx.pagesGlobConfig?.tabBar?.list?.map((v) => {
+    return `"${v.pagePath}"`;
+  }) ?? [];
+  const allPagesPath = [...ctx.pageMetaData.filter((page) => !tabsPagesPath.includes(page.path)).map((v) => `"${v.path}"`), ...subPagesPath];
+  const code = `/* eslint-disable */
+/* prettier-ignore */
+// @ts-nocheck
+// Generated by vite-plugin-uni-pages
+
+interface NavigateToOptions {
+  url: ${allPagesPath.join(" |\n       ")};
+}
+interface RedirectToOptions extends NavigateToOptions {}
+
+interface SwitchTabOptions {
+  ${tabsPagesPath.length ? `url: ${tabsPagesPath.join(" | ")}` : ""}
+}
+
+type ReLaunchOptions = NavigateToOptions | SwitchTabOptions;
+
+declare interface Uni {
+  navigateTo(options: UniNamespace.NavigateToOptions & NavigateToOptions): void;
+  redirectTo(options: UniNamespace.RedirectToOptions & RedirectToOptions): void;
+  switchTab(options: UniNamespace.SwitchTabOptions & SwitchTabOptions): void;
+  reLaunch(options: UniNamespace.ReLaunchOptions & ReLaunchOptions): void;
+}
+`;
+  return code;
+}
+async function writeFile(filePath, content) {
+  await mkdir(dirname(filePath), { recursive: true });
+  return await writeFile$1(filePath, content, "utf-8");
+}
+async function writeDeclaration(ctx, filepath) {
+  const originalContent = existsSync(filepath) ? await readFile(filepath, "utf-8") : "";
+  const code = getDeclaration(ctx);
+  if (!code)
+    return;
+  if (code !== originalContent)
+    await writeFile(filepath, code);
+}
+
 const MODULE_ID_VIRTUAL = "virtual:uni-pages";
 const RESOLVED_MODULE_ID_VIRTUAL = `\0${MODULE_ID_VIRTUAL}`;
 const OUTPUT_NAME = "pages.json";
@@ -106,7 +152,8 @@ const debug = {
   pages: Debug("vite-plugin-uni-pages:pages"),
   subPages: Debug("vite-plugin-uni-pages:subPages"),
   error: Debug("vite-plugin-uni-pages:error"),
-  cache: Debug("vite-plugin-uni-pages:cache")
+  cache: Debug("vite-plugin-uni-pages:cache"),
+  declaration: Debug("vite-plugin-uni-pages:declaration")
 };
 function extsToGlob(extensions) {
   return extensions.length > 1 ? `{${extensions.join(",")}}` : extensions[0] || "";
@@ -115,9 +162,6 @@ function isTargetFile(path) {
   const ext = path.split(".").pop();
   return FILE_EXTENSIONS.includes(ext);
 }
-function isConfigFile(path) {
-  return path.includes("pages.config");
-}
 function mergePageMetaDataArray(pageMetaData) {
   const pageMetaDataObj = groupBy(pageMetaData, "path");
   const result = [];
@@ -132,13 +176,6 @@ function mergePageMetaDataArray(pageMetaData) {
   }
   return result;
 }
-async function getPagesConfigSourcePaths(configSource) {
-  return await fg(configSource.map((v) => v.files).flat(), {
-    deep: 0,
-    onlyFiles: true,
-    absolute: true
-  });
-}
 function useCachedPages() {
   const pages = /* @__PURE__ */ new Map();
   function parseData(block) {
@@ -161,8 +198,9 @@ function useCachedPages() {
   };
 }
 
-function resolveOptions(userOptions, viteRoot) {
+function resolveOptions(userOptions, viteRoot = process.cwd()) {
   const {
+    dts = true,
     configSource = "pages.config",
     homePage = ["pages/index", "pages/index/index"],
     mergePages = true,
@@ -190,12 +228,14 @@ function resolveOptions(userOptions, viteRoot) {
     onAfterWriteFile = () => {
     }
   } = userOptions;
-  const root = viteRoot || slash(process$1.cwd());
+  const root = viteRoot || slash(process.cwd());
   const resolvedDirs = resolvePageDirs(dir, root, exclude);
   const resolvedSubDirs = subPackages.map((dir2) => slash(dir2));
   const resolvedHomePage = typeof homePage === "string" ? [homePage] : homePage;
   const resolvedConfigSource = typeof configSource === "string" ? [{ files: configSource }] : configSource;
+  const resolvedDts = !dts ? false : typeof dts === "string" ? dts : resolve(viteRoot, "uni-pages.d.ts");
   const resolvedOptions = {
+    dts: resolvedDts,
     configSource: Array.isArray(resolvedConfigSource) ? resolvedConfigSource : [resolvedConfigSource],
     homePage: resolvedHomePage,
     mergePages,
@@ -259,9 +299,10 @@ var __publicField = (obj, key, value) => {
 let lsatPagesJson = "";
 const { setCache, hasChanged } = useCachedPages();
 class PageContext {
-  constructor(userOptions, viteRoot = process$1.cwd()) {
+  constructor(userOptions, viteRoot = process.cwd()) {
     __publicField(this, "_server");
     __publicField(this, "pagesGlobConfig");
+    __publicField(this, "pagesConfigSourcePaths", []);
     __publicField(this, "pagesPath", []);
     __publicField(this, "subPagesPath", {});
     __publicField(this, "pageMetaData", []);
@@ -288,9 +329,10 @@ class PageContext {
     this.logger = logger;
   }
   async loadUserPagesConfig() {
-    const sources = this.options.configSource;
-    const { config } = await loadConfig({ cwd: this.root, sources, defaults: {} });
+    const configSource = this.options.configSource;
+    const { config, sources } = await loadConfig({ cwd: this.root, sources: configSource, defaults: {} });
     this.pagesGlobConfig = config;
+    this.pagesConfigSourcePaths = sources;
     debug.options(config);
   }
   async scanPages() {
@@ -316,12 +358,9 @@ class PageContext {
     this.setupWatcher(server.watcher);
   }
   async setupWatcher(watcher) {
-    if (!isH5) {
-      const configs = await getPagesConfigSourcePaths(this.options.configSource);
-      watcher.add(configs);
-    }
+    watcher.add(this.pagesConfigSourcePaths);
     const targetDirs = [...this.options.dirs, ...this.options.subPackages].map((v) => slash(path.resolve(this.root, v)));
-    const isInTargetDirs = (path2) => targetDirs.some((v) => path2.startsWith(v));
+    const isInTargetDirs = (filePath) => targetDirs.some((v) => slash(path.resolve(this.root, filePath)).startsWith(v));
     watcher.on("add", async (path2) => {
       path2 = slash(path2);
       if (!isTargetFile(path2))
@@ -334,7 +373,7 @@ class PageContext {
     });
     watcher.on("change", async (path2) => {
       path2 = slash(path2);
-      if (!isTargetFile(path2) && !isConfigFile(path2))
+      if (!isTargetFile(path2))
         return;
       if (!isInTargetDirs(path2))
         return;
@@ -344,6 +383,13 @@ class PageContext {
       if (await this.updatePagesJSON(path2))
         this.onUpdate();
     });
+    watcher.on("change", async (path2) => {
+      if (this.pagesConfigSourcePaths.includes(path2)) {
+        debug.pages(`Config source changed: ${path2}`);
+        if (await this.updatePagesJSON())
+          this.onUpdate();
+      }
+    });
     watcher.on("unlink", async (path2) => {
       path2 = slash(path2);
       if (!isTargetFile(path2))
@@ -461,6 +507,7 @@ class PageContext {
       subPackages: this.subPageMetaData
     };
     const pagesJson = JSON.stringify(data, null, this.options.minify ? void 0 : 2);
+    this.generateDeclaration();
     if (lsatPagesJson === pagesJson) {
       debug.pages("PagesJson Not have change");
       return false;
@@ -481,6 +528,12 @@ class PageContext {
   resolveSubRoutes() {
     return JSON.stringify(this.subPageMetaData, null, 2);
   }
+  generateDeclaration() {
+    if (!this.options.dts)
+      return;
+    debug.declaration("generating");
+    return writeDeclaration(this, this.options.dts);
+  }
 }
 function getPagePaths(dir, options) {
   const pagesDirPath = slash(path.resolve(options.root, dir));
@@ -579,4 +632,4 @@ function VitePluginUniPages(userOptions = {}) {
   };
 }
 
-export { FILE_EXTENSIONS, MODULE_ID_VIRTUAL, OUTPUT_NAME, PageContext, RESOLVED_MODULE_ID_VIRTUAL, VitePluginUniPages, checkPagesJsonFile, debug, VitePluginUniPages as default, defineUniPages, extsToGlob, getPageFiles, getPagesConfigSourcePaths, getRouteBlock, getRouteSfcBlock, invalidatePagesModule, isConfigFile, isTargetFile, mergePageMetaDataArray, parseCustomBlock, parseSFC, resolveOptions, resolvePageDirs, useCachedPages, writeFileSync };
+export { FILE_EXTENSIONS, MODULE_ID_VIRTUAL, OUTPUT_NAME, PageContext, RESOLVED_MODULE_ID_VIRTUAL, VitePluginUniPages, checkPagesJsonFile, debug, VitePluginUniPages as default, defineUniPages, extsToGlob, getPageFiles, getRouteBlock, getRouteSfcBlock, invalidatePagesModule, isTargetFile, mergePageMetaDataArray, parseCustomBlock, parseSFC, resolveOptions, resolvePageDirs, useCachedPages, writeFileSync };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@uni-helper/vite-plugin-uni-pages",
   "type": "module",
-  "version": "0.2.8",
+  "version": "0.2.10",
   "description": "File system based routing for uni-app applications using Vite",
   "author": "KeJun",
   "license": "MIT",
@@ -15,13 +15,13 @@
   "sideEffects": false,
   "exports": {
     ".": {
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      },
       "import": {
         "types": "./dist/index.d.mts",
         "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
       }
     },
     "./client": {
@@ -45,12 +45,12 @@
     "lodash-unified": "^1.0.3",
     "magic-string": "^0.30.3",
     "unconfig": "^0.3.10",
-    "yaml": "^2.3.1"
+    "yaml": "^2.3.2"
   },
   "devDependencies": {
     "@antfu/utils": "^0.7.6",
     "@types/debug": "^4.1.8",
-    "@types/node": "^18.17.9"
+    "@types/node": "^18.17.18"
   },
   "scripts": {
     "build": "unbuild",