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

package/dist/index.cjs

@@ -3,9 +3,10 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 const path = require('path');
+const child_process = require('child_process');
+const vite = require('vite');
 const MagicString = require('magic-string');
 const chokidar = require('chokidar');
-const vite = require('vite');
 const unconfig = require('unconfig');
 const Debug = require('debug');
 const lodash = require('lodash');
@@ -15,6 +16,16 @@ 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 = /*#__PURE__*/_interopDefaultCompat(path);
+const MagicString__default = /*#__PURE__*/_interopDefaultCompat(MagicString);
+const chokidar__default = /*#__PURE__*/_interopDefaultCompat(chokidar);
+const Debug__default = /*#__PURE__*/_interopDefaultCompat(Debug);
+const fg__default = /*#__PURE__*/_interopDefaultCompat(fg);
+const fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+const JSON5__default = /*#__PURE__*/_interopDefaultCompat(JSON5);
+
 function slash(str) {
   return str.replace(/\\/g, "/");
 }
@@ -35,11 +46,11 @@ function invalidatePagesModule(server) {
   }
 }
 const debug = {
-  hmr: Debug("vite-plugin-uni-pages:hmr"),
-  routeBlock: Debug("vite-plugin-uni-pages:routeBlock"),
-  options: Debug("vite-plugin-uni-pages:options"),
-  pages: Debug("vite-plugin-uni-pages:pages"),
-  error: Debug("vite-plugin-uni-pages:error")
+  hmr: Debug__default("vite-plugin-uni-pages:hmr"),
+  routeBlock: Debug__default("vite-plugin-uni-pages:routeBlock"),
+  options: Debug__default("vite-plugin-uni-pages:options"),
+  pages: Debug__default("vite-plugin-uni-pages:pages"),
+  error: Debug__default("vite-plugin-uni-pages:error")
 };
 function extsToGlob(extensions) {
   return extensions.length > 1 ? `{${extensions.join(",")}}` : extensions[0] || "";
@@ -66,7 +77,7 @@ function mergePageMetaDataArray(pageMetaData) {
   return result;
 }
 const getPagesConfigSourcePaths = async () => {
-  return await fg("pages.config.(ts|mts|cts|js|cjs|mjs|json)", {
+  return await fg__default("pages.config.(ts|mts|cts|js|cjs|mjs|json)", {
     deep: 0,
     onlyFiles: true,
     absolute: true
@@ -80,6 +91,7 @@ function resolveOptions(userOptions, viteRoot) {
     outDir = "src",
     exclude = ["node_modules", ".git", "**/__*__/**"],
     routeBlockLang = "json5",
+    minify = false,
     onBeforeLoadUserConfig = () => {
     },
     onAfterLoadUserConfig = () => {
@@ -106,6 +118,7 @@ function resolveOptions(userOptions, viteRoot) {
     exclude,
     routeBlockLang,
     root,
+    minify,
     onBeforeLoadUserConfig,
     onAfterLoadUserConfig,
     onBeforeScanPages,
@@ -118,7 +131,7 @@ function resolveOptions(userOptions, viteRoot) {
   return resolvedOptions;
 }
 function resolvePageDirs(dir, root, exclude) {
-  const dirs = fg.sync(slash(dir), {
+  const dirs = fg__default.sync(slash(dir), {
     ignore: exclude,
     onlyDirectories: true,
     dot: true,
@@ -131,7 +144,7 @@ function resolvePageDirs(dir, root, exclude) {
 function getPageFiles(path, options) {
   const { exclude } = options;
   const ext = extsToGlob(FILE_EXTENSIONS);
-  const files = fg.sync(`**/*.${ext}`, {
+  const files = fg__default.sync(`**/*.${ext}`, {
     ignore: exclude,
     onlyFiles: true,
     cwd: path
@@ -139,11 +152,14 @@ function getPageFiles(path, options) {
   return files;
 }
 function checkPagesJsonFile(path) {
-  if (!fs.existsSync(path))
+  if (!fs__default.existsSync(path)) {
     writeFileSync(path, JSON.stringify({ pages: [{ path: "" }] }, null, 2));
+    return false;
+  }
+  return true;
 }
 function writeFileSync(path, content) {
-  fs.writeFileSync(path, content, { encoding: "utf-8" });
+  fs__default.writeFileSync(path, content, { encoding: "utf-8" });
 }
 
 async function parseSFC(code) {
@@ -169,7 +185,7 @@ function parseCustomBlock(block, filePath, options) {
   debug.routeBlock(`use ${lang} parser`);
   if (lang === "json5") {
     try {
-      content = JSON5.parse(block.content);
+      content = JSON5__default.parse(block.content);
     } catch (err) {
       throw new Error(
         `Invalid JSON5 format of <${block.type}> content in ${filePath}
@@ -203,7 +219,7 @@ ${err.message}`
   }
 }
 async function getRouteBlock(path, options) {
-  const content = fs.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)
@@ -221,7 +237,7 @@ class PageContext {
     this.root = slash(viteRoot);
     debug.options("root", this.root);
     this.options = resolveOptions(userOptions, this.root);
-    this.resolvedPagesJSONPath = path.join(this.root, this.options.outDir, OUTPUT_NAME);
+    this.resolvedPagesJSONPath = path__default.join(this.root, this.options.outDir, OUTPUT_NAME);
     debug.options(this.options);
   }
   setLogger(logger) {
@@ -238,13 +254,13 @@ class PageContext {
   }
   async scanPages() {
     const pageDirFiles = this.options.dirs.map((dir) => {
-      const pagesDirPath = slash(path.resolve(this.options.root, dir));
-      const basePath = slash(path.join(this.options.root, this.options.outDir));
+      const pagesDirPath = slash(path__default.resolve(this.options.root, dir));
+      const basePath = slash(path__default.join(this.options.root, this.options.outDir));
       const files = getPageFiles(pagesDirPath, this.options);
       debug.pages(dir, files);
       const pagePaths = files.map((file) => slash(file)).map((file) => ({
-        relativePath: path.relative(basePath, slash(path.resolve(pagesDirPath, file))),
-        absolutePath: slash(path.resolve(pagesDirPath, file))
+        relativePath: path__default.relative(basePath, slash(path__default.resolve(pagesDirPath, file))),
+        absolutePath: slash(path__default.resolve(pagesDirPath, file))
       }));
       return { dir, files: pagePaths };
     });
@@ -299,7 +315,7 @@ class PageContext {
   async parsePage(page) {
     const { relativePath, absolutePath } = page;
     const routeBlock = await getRouteBlock(absolutePath, this.options);
-    const relativePathWithFileName = relativePath.replace(path.extname(relativePath), "");
+    const relativePathWithFileName = relativePath.replace(path__default.extname(relativePath), "");
     const pageMetaDatum = { path: vite.normalizePath(relativePathWithFileName), type: routeBlock?.attr.type ?? "page" };
     if (routeBlock)
       Object.assign(pageMetaDatum, routeBlock.content);
@@ -335,7 +351,7 @@ class PageContext {
     await this.mergePageMetaData();
     this.options.onAfterMergePageMetaData(this);
     this.options.onBeforeWriteFile(this);
-    const pagesJson = JSON.stringify({ ...this.pagesGlobConfig, pages: this.pageMetaData }, null, 2);
+    const pagesJson = JSON.stringify({ ...this.pagesGlobConfig, pages: this.pageMetaData }, null, this.options.minify ? void 0 : 2);
     writeFileSync(this.resolvedPagesJSONPath, pagesJson);
     this.options.onAfterWriteFile(this);
   }
@@ -351,25 +367,57 @@ function defineUniPages(config) {
   return config;
 }
 
+async function restart() {
+  return new Promise((resolve) => {
+    const build = child_process.spawn(process.argv.shift(), process.argv, {
+      cwd: process.cwd(),
+      detached: true,
+      env: process.env
+    });
+    build.stdout?.pipe(process.stdout);
+    build.stderr?.pipe(process.stderr);
+    build.on("close", (code) => {
+      resolve(process.exit(code));
+    });
+  });
+}
 const VitePluginUniPages = (userOptions = {}) => {
   let ctx;
-  const resolvedPagesJSONPath = path.join(process.cwd(), userOptions.outDir ?? "src", OUTPUT_NAME);
-  checkPagesJsonFile(resolvedPagesJSONPath);
+  const resolvedPagesJSONPath = path__default.join(
+    process.cwd(),
+    userOptions.outDir ?? "src",
+    OUTPUT_NAME
+  );
+  const isValidated = checkPagesJsonFile(resolvedPagesJSONPath);
   return {
     name: "vite-plugin-uni-pages",
     enforce: "pre",
     async configResolved(config) {
       ctx = new PageContext(userOptions, config.root);
-      ctx.setLogger(config.logger);
-      ctx.updatePagesJSON();
-      if (config.build.watch && config.command === "build")
-        ctx.setupWatcher(chokidar.watch(ctx.options.dirs));
+      const logger = vite.createLogger(void 0, {
+        prefix: "[vite-plugin-uni-pages]"
+      });
+      ctx.setLogger(logger);
+      await ctx.updatePagesJSON();
+      if (config.command === "build") {
+        if (!isValidated) {
+          ctx.logger?.warn("In build mode, if `pages.json` does not exist, the plugin cannot create the complete `pages.json` before the uni-app, so it restarts the build.", {
+            timestamp: true
+          });
+          await restart();
+        }
+        if (config.build.watch)
+          ctx.setupWatcher(chokidar__default.watch(ctx.options.dirs));
+      }
     },
+    // Applet do not support custom route block, so we need to remove the route block here
     async transform(code, id) {
       if (!/\.vue$/.test(id))
         return null;
-      const s = new MagicString(code.toString());
-      const routeBlockMatches = s.original.matchAll(/<route[^>]*>([\s\S]*?)<\/route>/g);
+      const s = new MagicString__default(code.toString());
+      const routeBlockMatches = s.original.matchAll(
+        /<route[^>]*>([\s\S]*?)<\/route>/g
+      );
       for (const match of routeBlockMatches) {
         const index = match.index;
         const length = match[0].length;

package/dist/index.d.ts

@@ -8,7 +8,11 @@ interface EasyCom {
     custom: Record<string, string>;
 }
 
+type RGBColor = `rgb(${number}, ${number}, ${number})`;
+type RGBAColor = `rgba(${number}, ${number}, ${number}, ${number})`;
 type HEXColor = `#${string}`;
+type ThemeColor = `@${string}`;
+type Color = RGBColor | RGBAColor | HEXColor;
 
 interface AppPlus {
     /**
@@ -123,7 +127,7 @@ interface GlobalStyle {
      * @default "#F7F7F7"
      * @desc APP与H5为#F7F7F7，小程序平台请参考相应小程序文档
      */
-    navigationBarBackgroundColor?: HEXColor;
+    navigationBarBackgroundColor?: HEXColor | ThemeColor;
     /**
      * 导航栏标题颜色及状态栏前景颜色，仅支持 black/white
      * @default "white"
@@ -146,7 +150,7 @@ interface GlobalStyle {
      * @default "#ffffff"
      * @desc 微信小程序
      */
-    backgroundColor?: HEXColor;
+    backgroundColor?: HEXColor | ThemeColor;
     /**
      * 下拉 loading 的样式，仅支持 dark / light
      * @default "dark"
@@ -170,13 +174,13 @@ interface GlobalStyle {
      * @default "#ffffff"
      * @desc 仅 iOS 平台
      */
-    backgroundColorTop?: HEXColor;
+    backgroundColorTop?: HEXColor | ThemeColor;
     /**
      * 底部窗口的背景色（bounce回弹区域）
      * @default "#ffffff"
      * @desc 仅 iOS 平台
      */
-    backgroundColorBottom?: HEXColor;
+    backgroundColorBottom?: HEXColor | ThemeColor;
     /**
      * 导航栏图片地址（替换当前文字标题），支付宝小程序内必须使用https的图片链接地址
      * @desc 支付宝小程序、H5、APP
@@ -413,15 +417,15 @@ interface TabBar {
     /**
      * tab 上的文字默认颜色
      */
-    color?: HEXColor;
+    color?: Color;
     /**
      * tab 上的文字选中时的颜色
      */
-    selectedColor?: HEXColor;
+    selectedColor?: Color;
     /**
      * tab 的背景色
      */
-    backgroundColor?: HEXColor;
+    backgroundColor?: Color;
     /**
      * tabbar 上边框的颜色，可选值 black/white，也支持其他颜色值
      * @default "black"
@@ -513,6 +517,22 @@ interface PreloadRule {
      */
     network?: string;
 }
+interface UniIdRouter {
+    /**
+     * 登录页面路径
+     */
+    loginPage: string;
+    /**
+     * 需要登录才可以访问的页面列表，可以使用正则语法
+     */
+    needLogin: string[];
+    /**
+     * 是否自动解析云对象及 clientDB 的错误码，如果是客户端 token 不正确或 token 过期则自动跳转配置的登录页面
+     *
+     * @default true
+     */
+    resToLogin?: boolean;
+}
 interface SubPackage {
     /**
      * 子包的根目录
@@ -577,7 +597,9 @@ interface PagesConfig {
      * 分包预下载规则
      * @desc 微信小程序
      */
-    preloadRule?: PreloadRule;
+    preloadRule?: {
+        [path: string]: PreloadRule;
+    };
     /**
      * `Worker` 代码放置的目录
      * @desc 微信小程序
@@ -599,9 +621,13 @@ interface PagesConfig {
      */
     rightWindow?: TheWindow;
     /**
-     * 自动跳转相关配置，新增于HBuilderX 3.5.0
+     * 自动跳转相关配置，新增于 HBuilderX 3.5.0
+     */
+    uniIdRouter?: UniIdRouter;
+    /**
+     * 默认启动首页，新增于 HBuilderX 3.7.0
      */
-    uniIdRouter?: any;
+    entryPagePath?: string;
     [x: string]: any;
 }
 interface UserPagesConfig extends PagesConfig {
@@ -663,6 +689,11 @@ interface Options {
      * @default 'json5'
      */
     routeBlockLang: 'json5' | 'json' | 'yaml' | 'yml';
+    /**
+     * minify the `pages.json`
+     * @default false
+     */
+    minify: boolean;
     onBeforeLoadUserConfig: (ctx: PageContext) => void;
     onAfterLoadUserConfig: (ctx: PageContext) => void;
     onBeforeScanPages: (ctx: PageContext) => void;
@@ -698,6 +729,10 @@ interface PageMetaDatum {
      * 配置页面窗口表现，配置项参考下方 pageStyle
      */
     style?: GlobalStyle;
+    /**
+     * 当前页面是否需要登录才可以访问，此配置优先级高于 uniIdRouter 下的 needLogin
+     */
+    needLogin?: boolean;
     [x: string]: any;
 }
 
@@ -729,7 +764,7 @@ declare const getPagesConfigSourcePaths: () => Promise<string[]>;
  * Resolves the files that are valid pages for the given context.
  */
 declare function getPageFiles(path: string, options: ResolvedOptions): string[];
-declare function checkPagesJsonFile(path: string): void;
+declare function checkPagesJsonFile(path: string): boolean;
 declare function writeFileSync(path: string, content: string): void;
 
 declare function resolveOptions(userOptions: UserOptions, viteRoot?: string): ResolvedOptions;
@@ -744,4 +779,4 @@ declare function getRouteBlock(path: string, options: ResolvedOptions): Promise<
 
 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, getPagesConfigSourcePaths, 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, UniIdRouter, 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

@@ -1,7 +1,8 @@
 import path from 'path';
+import { spawn } from 'child_process';
+import { normalizePath, createLogger } from 'vite';
 import MagicString from 'magic-string';
 import chokidar from 'chokidar';
-import { normalizePath } from 'vite';
 import { loadConfig } from 'unconfig';
 import Debug from 'debug';
 import { groupBy } from 'lodash';
@@ -76,6 +77,7 @@ function resolveOptions(userOptions, viteRoot) {
     outDir = "src",
     exclude = ["node_modules", ".git", "**/__*__/**"],
     routeBlockLang = "json5",
+    minify = false,
     onBeforeLoadUserConfig = () => {
     },
     onAfterLoadUserConfig = () => {
@@ -102,6 +104,7 @@ function resolveOptions(userOptions, viteRoot) {
     exclude,
     routeBlockLang,
     root,
+    minify,
     onBeforeLoadUserConfig,
     onAfterLoadUserConfig,
     onBeforeScanPages,
@@ -135,8 +138,11 @@ function getPageFiles(path, options) {
   return files;
 }
 function checkPagesJsonFile(path) {
-  if (!fs.existsSync(path))
+  if (!fs.existsSync(path)) {
     writeFileSync(path, JSON.stringify({ pages: [{ path: "" }] }, null, 2));
+    return false;
+  }
+  return true;
 }
 function writeFileSync(path, content) {
   fs.writeFileSync(path, content, { encoding: "utf-8" });
@@ -331,7 +337,7 @@ class PageContext {
     await this.mergePageMetaData();
     this.options.onAfterMergePageMetaData(this);
     this.options.onBeforeWriteFile(this);
-    const pagesJson = JSON.stringify({ ...this.pagesGlobConfig, pages: this.pageMetaData }, null, 2);
+    const pagesJson = JSON.stringify({ ...this.pagesGlobConfig, pages: this.pageMetaData }, null, this.options.minify ? void 0 : 2);
     writeFileSync(this.resolvedPagesJSONPath, pagesJson);
     this.options.onAfterWriteFile(this);
   }
@@ -347,25 +353,57 @@ function defineUniPages(config) {
   return config;
 }
 
+async function restart() {
+  return new Promise((resolve) => {
+    const build = spawn(process.argv.shift(), process.argv, {
+      cwd: process.cwd(),
+      detached: true,
+      env: process.env
+    });
+    build.stdout?.pipe(process.stdout);
+    build.stderr?.pipe(process.stderr);
+    build.on("close", (code) => {
+      resolve(process.exit(code));
+    });
+  });
+}
 const VitePluginUniPages = (userOptions = {}) => {
   let ctx;
-  const resolvedPagesJSONPath = path.join(process.cwd(), userOptions.outDir ?? "src", OUTPUT_NAME);
-  checkPagesJsonFile(resolvedPagesJSONPath);
+  const resolvedPagesJSONPath = path.join(
+    process.cwd(),
+    userOptions.outDir ?? "src",
+    OUTPUT_NAME
+  );
+  const isValidated = checkPagesJsonFile(resolvedPagesJSONPath);
   return {
     name: "vite-plugin-uni-pages",
     enforce: "pre",
     async configResolved(config) {
       ctx = new PageContext(userOptions, config.root);
-      ctx.setLogger(config.logger);
-      ctx.updatePagesJSON();
-      if (config.build.watch && config.command === "build")
-        ctx.setupWatcher(chokidar.watch(ctx.options.dirs));
+      const logger = createLogger(void 0, {
+        prefix: "[vite-plugin-uni-pages]"
+      });
+      ctx.setLogger(logger);
+      await ctx.updatePagesJSON();
+      if (config.command === "build") {
+        if (!isValidated) {
+          ctx.logger?.warn("In build mode, if `pages.json` does not exist, the plugin cannot create the complete `pages.json` before the uni-app, so it restarts the build.", {
+            timestamp: true
+          });
+          await restart();
+        }
+        if (config.build.watch)
+          ctx.setupWatcher(chokidar.watch(ctx.options.dirs));
+      }
     },
+    // Applet do not support custom route block, so we need to remove the route block here
     async transform(code, id) {
       if (!/\.vue$/.test(id))
         return null;
       const s = new MagicString(code.toString());
-      const routeBlockMatches = s.original.matchAll(/<route[^>]*>([\s\S]*?)<\/route>/g);
+      const routeBlockMatches = s.original.matchAll(
+        /<route[^>]*>([\s\S]*?)<\/route>/g
+      );
       for (const match of routeBlockMatches) {
         const index = match.index;
         const length = match[0].length;

package/package.json

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