@uni-helper/vite-plugin-uni-pages 0.1.2 → 0.1.4

package/dist/index.cjs

@@ -65,6 +65,13 @@ function mergePageMetaDataArray(pageMetaData) {
   }
   return result;
 }
+const getPagesConfigSourcePaths = async () => {
+  return await fg("pages.config.(ts|mts|cts|js|cjs|mjs|json)", {
+    deep: 0,
+    onlyFiles: true,
+    absolute: true
+  });
+};
 
 function resolveOptions(userOptions, viteRoot) {
   const {
@@ -154,10 +161,15 @@ async function parseSFC(code) {
 }
 function parseCustomBlock(block, filePath, options) {
   const lang = block.lang ?? options.routeBlockLang;
+  const attr = {
+    type: "page",
+    ...block.attrs
+  };
+  let content;
   debug.routeBlock(`use ${lang} parser`);
   if (lang === "json5") {
     try {
-      return JSON5.parse(block.content);
+      content = JSON5.parse(block.content);
     } catch (err) {
       throw new Error(
         `Invalid JSON5 format of <${block.type}> content in ${filePath}
@@ -166,7 +178,7 @@ ${err.message}`
     }
   } else if (lang === "json") {
     try {
-      return JSON.parse(block.content);
+      content = JSON.parse(block.content);
     } catch (err) {
       throw new Error(
         `Invalid JSON format of <${block.type}> content in ${filePath}
@@ -175,7 +187,7 @@ ${err.message}`
     }
   } else if (lang === "yaml" || lang === "yml") {
     try {
-      return yaml.parse(block.content);
+      content = yaml.parse(block.content);
     } catch (err) {
       throw new Error(
         `Invalid YAML format of <${block.type}> content in ${filePath}
@@ -183,6 +195,12 @@ ${err.message}`
       );
     }
   }
+  if (content) {
+    return {
+      attr,
+      content
+    };
+  }
 }
 async function getRouteBlock(path, options) {
   const content = fs.readFileSync(path, "utf8");
@@ -239,7 +257,11 @@ class PageContext {
     this._server = server;
     this.setupWatcher(server.watcher);
   }
-  setupWatcher(watcher) {
+  async setupWatcher(watcher) {
+    if (process.env.UNI_PLATFORM !== "h5") {
+      const configs = await getPagesConfigSourcePaths();
+      watcher.add(configs);
+    }
     watcher.on("add", async (path2) => {
       path2 = slash(path2);
       if (!isTargetFile(path2))
@@ -278,9 +300,9 @@ class PageContext {
     const { relativePath, absolutePath } = page;
     const routeBlock = await getRouteBlock(absolutePath, this.options);
     const relativePathWithFileName = relativePath.replace(path.extname(relativePath), "");
-    const pageMetaDatum = { path: vite.normalizePath(relativePathWithFileName), type: "page" };
+    const pageMetaDatum = { path: vite.normalizePath(relativePathWithFileName), type: routeBlock?.attr.type ?? "page" };
     if (routeBlock)
-      Object.assign(pageMetaDatum, routeBlock);
+      Object.assign(pageMetaDatum, routeBlock.content);
     return pageMetaDatum;
   }
   async mergePageMetaData() {
@@ -296,6 +318,7 @@ class PageContext {
       else
         this.pageMetaData = generatedPageMetaData;
     }
+    this.pageMetaData.sort((page) => page.type === "home" ? -1 : 0);
     debug.pages(generatedPageMetaData);
   }
   async updatePagesJSON() {
@@ -380,6 +403,7 @@ exports.default = VitePluginUniPages;
 exports.defineUniPages = defineUniPages;
 exports.extsToGlob = extsToGlob;
 exports.getPageFiles = getPageFiles;
+exports.getPagesConfigSourcePaths = getPagesConfigSourcePaths;
 exports.getRouteBlock = getRouteBlock;
 exports.invalidatePagesModule = invalidatePagesModule;
 exports.isConfigFile = isConfigFile;

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { Logger, ViteDevServer, Plugin } from 'vite';
-import { FSWatcher } from 'fs';
+import { FSWatcher } from 'chokidar';
 import Debug from 'debug';
 import { SFCDescriptor, SFCBlock } from '@vue/compiler-sfc';
 
@@ -624,7 +624,7 @@ declare class PageContext {
     loadUserPagesConfig(): Promise<void>;
     scanPages(): Promise<void>;
     setupViteServer(server: ViteDevServer): void;
-    setupWatcher(watcher: FSWatcher): void;
+    setupWatcher(watcher: FSWatcher): Promise<void>;
     onUpdate(): void;
     parsePage(page: PagePath): Promise<PageMetaDatum>;
     mergePageMetaData(): Promise<void>;
@@ -633,7 +633,10 @@ declare class PageContext {
     resolveRoutes(): string;
 }
 
-type CustomBlock = Record<string, any>;
+interface CustomBlock {
+    attr: Record<string, any>;
+    content: Record<string, any>;
+}
 interface Options {
     /**
      * Whether to merge pages in pages.json
@@ -720,6 +723,7 @@ declare function isConfigFile(path: string): boolean;
  * TODO: support merge middleware
  */
 declare function mergePageMetaDataArray(pageMetaData: PageMetaDatum[]): PageMetaDatum[];
+declare const getPagesConfigSourcePaths: () => Promise<string[]>;
 
 /**
  * Resolves the files that are valid pages for the given context.
@@ -735,9 +739,9 @@ declare function resolveOptions(userOptions: UserOptions, viteRoot?: string): Re
 declare function resolvePageDirs(dir: string, root: string, exclude: string[]): string[];
 
 declare function parseSFC(code: string): Promise<SFCDescriptor>;
-declare function parseCustomBlock(block: SFCBlock, filePath: string, options: ResolvedOptions): any;
+declare function parseCustomBlock(block: SFCBlock, filePath: string, options: ResolvedOptions): CustomBlock | undefined;
 declare function getRouteBlock(path: string, options: ResolvedOptions): Promise<CustomBlock | undefined>;
 
 declare const VitePluginUniPages: (userOptions?: UserOptions) => Plugin;
 
-export { Condition, ConditionItem, CustomBlock, EasyCom, FILE_EXTENSIONS, GlobalStyle, IconFont, MODULE_ID_VIRTUAL, MidButton, OUTPUT_NAME, Options, PageContext, PageMetaDatum, PagePath, PagesConfig, PreloadRule, RESOLVED_MODULE_ID_VIRTUAL, ResolvedOptions, SubPackage, TabBar, TabBarItem, TheWindow, UserOptions, UserPagesConfig, VitePluginUniPages, checkPagesJsonFile, debug, VitePluginUniPages as default, defineUniPages, extsToGlob, getPageFiles, getRouteBlock, invalidatePagesModule, isConfigFile, isTargetFile, mergePageMetaDataArray, parseCustomBlock, parseSFC, resolveOptions, resolvePageDirs, writeFileSync };
+export { Condition, ConditionItem, CustomBlock, EasyCom, FILE_EXTENSIONS, GlobalStyle, IconFont, MODULE_ID_VIRTUAL, MidButton, OUTPUT_NAME, Options, PageContext, PageMetaDatum, PagePath, PagesConfig, PreloadRule, RESOLVED_MODULE_ID_VIRTUAL, ResolvedOptions, SubPackage, TabBar, TabBarItem, TheWindow, UserOptions, UserPagesConfig, VitePluginUniPages, checkPagesJsonFile, debug, VitePluginUniPages as default, defineUniPages, extsToGlob, getPageFiles, getPagesConfigSourcePaths, getRouteBlock, invalidatePagesModule, isConfigFile, isTargetFile, mergePageMetaDataArray, parseCustomBlock, parseSFC, resolveOptions, resolvePageDirs, writeFileSync };

package/dist/index.mjs

@@ -61,6 +61,13 @@ function mergePageMetaDataArray(pageMetaData) {
   }
   return result;
 }
+const getPagesConfigSourcePaths = async () => {
+  return await fg("pages.config.(ts|mts|cts|js|cjs|mjs|json)", {
+    deep: 0,
+    onlyFiles: true,
+    absolute: true
+  });
+};
 
 function resolveOptions(userOptions, viteRoot) {
   const {
@@ -150,10 +157,15 @@ async function parseSFC(code) {
 }
 function parseCustomBlock(block, filePath, options) {
   const lang = block.lang ?? options.routeBlockLang;
+  const attr = {
+    type: "page",
+    ...block.attrs
+  };
+  let content;
   debug.routeBlock(`use ${lang} parser`);
   if (lang === "json5") {
     try {
-      return JSON5.parse(block.content);
+      content = JSON5.parse(block.content);
     } catch (err) {
       throw new Error(
         `Invalid JSON5 format of <${block.type}> content in ${filePath}
@@ -162,7 +174,7 @@ ${err.message}`
     }
   } else if (lang === "json") {
     try {
-      return JSON.parse(block.content);
+      content = JSON.parse(block.content);
     } catch (err) {
       throw new Error(
         `Invalid JSON format of <${block.type}> content in ${filePath}
@@ -171,7 +183,7 @@ ${err.message}`
     }
   } else if (lang === "yaml" || lang === "yml") {
     try {
-      return parse$1(block.content);
+      content = parse$1(block.content);
     } catch (err) {
       throw new Error(
         `Invalid YAML format of <${block.type}> content in ${filePath}
@@ -179,6 +191,12 @@ ${err.message}`
       );
     }
   }
+  if (content) {
+    return {
+      attr,
+      content
+    };
+  }
 }
 async function getRouteBlock(path, options) {
   const content = fs.readFileSync(path, "utf8");
@@ -235,7 +253,11 @@ class PageContext {
     this._server = server;
     this.setupWatcher(server.watcher);
   }
-  setupWatcher(watcher) {
+  async setupWatcher(watcher) {
+    if (process.env.UNI_PLATFORM !== "h5") {
+      const configs = await getPagesConfigSourcePaths();
+      watcher.add(configs);
+    }
     watcher.on("add", async (path2) => {
       path2 = slash(path2);
       if (!isTargetFile(path2))
@@ -274,9 +296,9 @@ class PageContext {
     const { relativePath, absolutePath } = page;
     const routeBlock = await getRouteBlock(absolutePath, this.options);
     const relativePathWithFileName = relativePath.replace(path.extname(relativePath), "");
-    const pageMetaDatum = { path: normalizePath(relativePathWithFileName), type: "page" };
+    const pageMetaDatum = { path: normalizePath(relativePathWithFileName), type: routeBlock?.attr.type ?? "page" };
     if (routeBlock)
-      Object.assign(pageMetaDatum, routeBlock);
+      Object.assign(pageMetaDatum, routeBlock.content);
     return pageMetaDatum;
   }
   async mergePageMetaData() {
@@ -292,6 +314,7 @@ class PageContext {
       else
         this.pageMetaData = generatedPageMetaData;
     }
+    this.pageMetaData.sort((page) => page.type === "home" ? -1 : 0);
     debug.pages(generatedPageMetaData);
   }
   async updatePagesJSON() {
@@ -364,4 +387,4 @@ const VitePluginUniPages = (userOptions = {}) => {
   };
 };
 
-export { FILE_EXTENSIONS, MODULE_ID_VIRTUAL, OUTPUT_NAME, PageContext, RESOLVED_MODULE_ID_VIRTUAL, VitePluginUniPages, checkPagesJsonFile, debug, VitePluginUniPages as default, defineUniPages, extsToGlob, getPageFiles, getRouteBlock, invalidatePagesModule, isConfigFile, isTargetFile, mergePageMetaDataArray, parseCustomBlock, parseSFC, resolveOptions, resolvePageDirs, writeFileSync };
+export { FILE_EXTENSIONS, MODULE_ID_VIRTUAL, OUTPUT_NAME, PageContext, RESOLVED_MODULE_ID_VIRTUAL, VitePluginUniPages, checkPagesJsonFile, debug, VitePluginUniPages as default, defineUniPages, extsToGlob, getPageFiles, getPagesConfigSourcePaths, getRouteBlock, invalidatePagesModule, isConfigFile, isTargetFile, mergePageMetaDataArray, parseCustomBlock, parseSFC, resolveOptions, resolvePageDirs, writeFileSync };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@uni-helper/vite-plugin-uni-pages",
   "type": "module",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "packageManager": "pnpm@7.16.1",
   "description": "File system based routing for uni-app applications using Vite",
   "author": "KeJun",