@uni-helper/vite-plugin-uni-pages 0.1.8 → 0.2.0

package/README.md

@@ -75,6 +75,7 @@ Import the virtual module to access the metadata of all pages
 ```ts
 /// <reference types="@uni-helper/vite-plugin-uni-pages/client" />
 import { pages } from 'virtual:uni-pages'
+
 console.log(pages)
 ```
 

package/dist/index.cjs

@@ -2,33 +2,29 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-const path$1 = require('path');
-const child_process = require('child_process');
+const path = require('node:path');
+const node_child_process = require('node:child_process');
 const vite = require('vite');
 const MagicString = require('magic-string');
 const chokidar = require('chokidar');
-const path = require('node:path');
 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('fs');
-const fs$1 = require('node:fs');
+const fs = require('node:fs');
 const JSON5 = require('json5');
 const yaml = require('yaml');
 const compilerSfc = require('@vue/compiler-sfc');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
 
-const path__default$1 = /*#__PURE__*/_interopDefaultCompat(path$1);
+const path__default = /*#__PURE__*/_interopDefaultCompat(path);
 const MagicString__default = /*#__PURE__*/_interopDefaultCompat(MagicString);
 const chokidar__default = /*#__PURE__*/_interopDefaultCompat(chokidar);
-const path__default = /*#__PURE__*/_interopDefaultCompat(path);
 const Debug__default = /*#__PURE__*/_interopDefaultCompat(Debug);
 const fg__default = /*#__PURE__*/_interopDefaultCompat(fg);
 const fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
-const fs__default$1 = /*#__PURE__*/_interopDefaultCompat(fs$1);
 const JSON5__default = /*#__PURE__*/_interopDefaultCompat(JSON5);
 
 function slash(str) {
@@ -92,6 +88,7 @@ async function getPagesConfigSourcePaths() {
 
 function resolveOptions(userOptions, viteRoot) {
   const {
+    homePage = ["pages/index", "pages/index/index"],
     mergePages = true,
     dir = "src/pages",
     subPackages = [],
@@ -120,7 +117,9 @@ function resolveOptions(userOptions, viteRoot) {
   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 resolvedOptions = {
+    homePage: ResolvedHomePage,
     mergePages,
     dirs: resolvedDirs,
     subPackages: resolvedSubDirs,
@@ -230,7 +229,7 @@ ${err.message}`
   }
 }
 async function getRouteBlock(path, options) {
-  const content = fs__default$1.readFileSync(path, "utf8");
+  const content = fs__default.readFileSync(path, "utf8");
   const parsedSFC = await parseSFC(content);
   const blockStr = parsedSFC?.customBlocks.find((b) => b.type === "route");
   if (!blockStr)
@@ -336,20 +335,47 @@ class PageContext {
     const { relativePath, absolutePath } = page;
     const routeBlock = await getRouteBlock(absolutePath, this.options);
     const relativePathWithFileName = relativePath.replace(path__default.extname(relativePath), "");
-    const pageMetaDatum = { path: vite.normalizePath(relativePathWithFileName), type: routeBlock?.attr.type ?? "page" };
+    const pageMetaDatum = {
+      path: vite.normalizePath(relativePathWithFileName),
+      type: routeBlock?.attr.type ?? "page"
+    };
     if (routeBlock)
       Object.assign(pageMetaDatum, routeBlock.content);
     return pageMetaDatum;
   }
   async parsePages(pages, overrides) {
-    const generatedPageMetaData = await Promise.all(
-      pages.map(async (page) => await this.parsePage(page))
-    );
+    const generatedPageMetaData = await Promise.all(pages.map(async (page) => await this.parsePage(page)));
     const customPageMetaData = overrides || [];
     const result = customPageMetaData.length ? mergePageMetaDataArray(generatedPageMetaData.concat(customPageMetaData)) : generatedPageMetaData;
+    this.setHomePage(result);
     result.sort((page) => page.type === "home" ? -1 : 0);
     return result;
   }
+  setHomePage(result) {
+    const hasHome = result.some((page) => {
+      if (page.type === "home")
+        return true;
+      const base = page.path.split("/")[0];
+      if (this.options.subPackages.includes(`src/${base}`))
+        return true;
+      return false;
+    });
+    if (hasHome)
+      return true;
+    const isFoundHome = result.some((item) => {
+      if (this.options.homePage.includes(item.path)) {
+        item.type = "home";
+        return true;
+      } else {
+        return false;
+      }
+    });
+    if (isFoundHome)
+      return true;
+    this.logger?.warn('No home page found, check the configuration of pages.config.ts, or add the `homePage` option to UniPages in vite.config.js, or add `type="home"` to the routeBlock of your vue page.', {
+      timestamp: true
+    });
+  }
   async mergePageMetaData() {
     const pageMetaData = await this.parsePages(this.pagesPath, this.pagesGlobConfig?.pages);
     this.pageMetaData = pageMetaData;
@@ -422,7 +448,7 @@ function defineUniPages(config) {
 
 async function restart() {
   return new Promise((resolve) => {
-    const build = child_process.spawn(process.argv.shift(), process.argv, {
+    const build = node_child_process.spawn(process.argv.shift(), process.argv, {
       cwd: process.cwd(),
       detached: true,
       env: process.env
@@ -434,9 +460,9 @@ async function restart() {
     });
   });
 }
-const VitePluginUniPages = (userOptions = {}) => {
+function VitePluginUniPages(userOptions = {}) {
   let ctx;
-  const resolvedPagesJSONPath = path__default$1.join(
+  const resolvedPagesJSONPath = path__default.join(
     process.cwd(),
     userOptions.outDir ?? "src",
     OUTPUT_NAME
@@ -490,7 +516,7 @@ const VitePluginUniPages = (userOptions = {}) => {
         return ctx.virtualModule();
     }
   };
-};
+}
 
 exports.FILE_EXTENSIONS = FILE_EXTENSIONS;
 exports.MODULE_ID_VIRTUAL = MODULE_ID_VIRTUAL;

package/dist/index.d.ts

@@ -22,10 +22,10 @@ interface AppPlus {
      */
     background?: HEXColor;
     /**
-     * 导航栏 ，详见?:导航栏
+     * 导航栏 ，详见?:导航栏; 设置为 false 不显示默认导航栏
      * @desc App、H5
      */
-    titleNView?: object;
+    titleNView?: object | false;
     /**
      * 原生子窗体，详见?:原生子窗体
      * @desc App 1.9.10+
@@ -657,6 +657,7 @@ declare class PageContext {
     onUpdate(): void;
     parsePage(page: PagePath): Promise<PageMetaDatum>;
     parsePages(pages: PagePath[], overrides?: PageMetaDatum[]): Promise<PageMetaDatum[]>;
+    setHomePage(result: PageMetaDatum[]): true | undefined;
     mergePageMetaData(): Promise<void>;
     mergeSubPageMetaData(): Promise<void>;
     updatePagesJSON(): Promise<void>;
@@ -690,6 +691,11 @@ interface CustomBlock {
 }
 type debugType = keyof typeof debug;
 interface Options {
+    /**
+     * The default application entry page is the home page
+     * @default 'pages/index' or 'pages/index/index'
+     */
+    homePage: string;
     /**
      * Whether to merge pages in pages.json
      * @default true
@@ -739,7 +745,7 @@ interface Options {
     onAfterWriteFile: (ctx: PageContext) => void;
 }
 type UserOptions = Partial<Options>;
-interface ResolvedOptions extends Omit<Options, 'dir'> {
+interface ResolvedOptions extends Omit<Options, 'dir' | 'homePage'> {
     /**
      * Resolves to the `root` value from Vite config.
      * @default config.root
@@ -749,6 +755,10 @@ interface ResolvedOptions extends Omit<Options, 'dir'> {
      * Resolved page dirs
      */
     dirs: string[];
+    /**
+     * Resolved entry page
+     */
+    homePage: string[];
 }
 interface PagePath {
     relativePath: string;
@@ -797,6 +807,6 @@ declare function parseSFC(code: string): Promise<SFCDescriptor>;
 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;
+declare function 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, SubPageMetaDatum, TabBar, TabBarItem, TheWindow, UniIdRouter, UserOptions, UserPagesConfig, VitePluginUniPages, checkPagesJsonFile, debug, debugType, VitePluginUniPages as default, defineUniPages, extsToGlob, getPageFiles, getPagesConfigSourcePaths, getRouteBlock, invalidatePagesModule, isConfigFile, isTargetFile, mergePageMetaDataArray, parseCustomBlock, parseSFC, resolveOptions, resolvePageDirs, writeFileSync };

package/dist/index.mjs

@@ -1,16 +1,14 @@
-import path$1 from 'path';
-import { spawn } from 'child_process';
+import path from 'node:path';
+import { spawn } from 'node:child_process';
 import { normalizePath, createLogger } from 'vite';
 import MagicString from 'magic-string';
 import chokidar from 'chokidar';
-import path from 'node:path';
 import { loadConfig } from 'unconfig';
 import { isH5 } from '@uni-helper/uni-env';
 import Debug from 'debug';
 import { groupBy } from 'lodash-unified';
 import fg from 'fast-glob';
-import fs from 'fs';
-import fs$1 from 'node:fs';
+import fs from 'node:fs';
 import JSON5 from 'json5';
 import { parse as parse$1 } from 'yaml';
 import { parse } from '@vue/compiler-sfc';
@@ -76,6 +74,7 @@ async function getPagesConfigSourcePaths() {
 
 function resolveOptions(userOptions, viteRoot) {
   const {
+    homePage = ["pages/index", "pages/index/index"],
     mergePages = true,
     dir = "src/pages",
     subPackages = [],
@@ -104,7 +103,9 @@ function resolveOptions(userOptions, viteRoot) {
   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 resolvedOptions = {
+    homePage: ResolvedHomePage,
     mergePages,
     dirs: resolvedDirs,
     subPackages: resolvedSubDirs,
@@ -214,7 +215,7 @@ ${err.message}`
   }
 }
 async function getRouteBlock(path, options) {
-  const content = fs$1.readFileSync(path, "utf8");
+  const content = fs.readFileSync(path, "utf8");
   const parsedSFC = await parseSFC(content);
   const blockStr = parsedSFC?.customBlocks.find((b) => b.type === "route");
   if (!blockStr)
@@ -320,20 +321,47 @@ 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: routeBlock?.attr.type ?? "page" };
+    const pageMetaDatum = {
+      path: normalizePath(relativePathWithFileName),
+      type: routeBlock?.attr.type ?? "page"
+    };
     if (routeBlock)
       Object.assign(pageMetaDatum, routeBlock.content);
     return pageMetaDatum;
   }
   async parsePages(pages, overrides) {
-    const generatedPageMetaData = await Promise.all(
-      pages.map(async (page) => await this.parsePage(page))
-    );
+    const generatedPageMetaData = await Promise.all(pages.map(async (page) => await this.parsePage(page)));
     const customPageMetaData = overrides || [];
     const result = customPageMetaData.length ? mergePageMetaDataArray(generatedPageMetaData.concat(customPageMetaData)) : generatedPageMetaData;
+    this.setHomePage(result);
     result.sort((page) => page.type === "home" ? -1 : 0);
     return result;
   }
+  setHomePage(result) {
+    const hasHome = result.some((page) => {
+      if (page.type === "home")
+        return true;
+      const base = page.path.split("/")[0];
+      if (this.options.subPackages.includes(`src/${base}`))
+        return true;
+      return false;
+    });
+    if (hasHome)
+      return true;
+    const isFoundHome = result.some((item) => {
+      if (this.options.homePage.includes(item.path)) {
+        item.type = "home";
+        return true;
+      } else {
+        return false;
+      }
+    });
+    if (isFoundHome)
+      return true;
+    this.logger?.warn('No home page found, check the configuration of pages.config.ts, or add the `homePage` option to UniPages in vite.config.js, or add `type="home"` to the routeBlock of your vue page.', {
+      timestamp: true
+    });
+  }
   async mergePageMetaData() {
     const pageMetaData = await this.parsePages(this.pagesPath, this.pagesGlobConfig?.pages);
     this.pageMetaData = pageMetaData;
@@ -418,9 +446,9 @@ async function restart() {
     });
   });
 }
-const VitePluginUniPages = (userOptions = {}) => {
+function VitePluginUniPages(userOptions = {}) {
   let ctx;
-  const resolvedPagesJSONPath = path$1.join(
+  const resolvedPagesJSONPath = path.join(
     process.cwd(),
     userOptions.outDir ?? "src",
     OUTPUT_NAME
@@ -474,6 +502,6 @@ const VitePluginUniPages = (userOptions = {}) => {
         return ctx.virtualModule();
     }
   };
-};
+}
 
 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.8",
+  "version": "0.2.0",
   "description": "File system based routing for uni-app applications using Vite",
   "author": "KeJun",
   "license": "MIT",
@@ -31,8 +31,8 @@
     "client.d.ts"
   ],
   "dependencies": {
-    "@uni-helper/uni-env": "^0.0.2",
-    "@vue/compiler-sfc": "^3.2.47",
+    "@uni-helper/uni-env": "^0.0.3",
+    "@vue/compiler-sfc": "^3.3.1",
     "chokidar": "^3.5.3",
     "debug": "^4.3.4",
     "fast-glob": "^3.2.12",
@@ -40,13 +40,12 @@
     "lodash-unified": "^1.0.3",
     "magic-string": "^0.30.0",
     "unconfig": "^0.3.7",
-    "yaml": "^2.2.1"
+    "yaml": "^2.2.2"
   },
   "devDependencies": {
     "@antfu/utils": "^0.7.2",
     "@types/debug": "^4.1.7",
-    "@types/node": "^18.15.11",
-    "vite": "^4.2.1"
+    "@types/node": "^18.16.8"
   },
   "scripts": {
     "build": "unbuild",