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

package/dist/index.cjs

@@ -4,16 +4,17 @@ 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 fs = require('node:fs');
+const promises = require('node:fs/promises');
 const lodashUnified = require('lodash-unified');
 const fg = require('fast-glob');
-const fs = require('node:fs');
 const JSON5 = require('json5');
 const yaml = require('yaml');
 const compilerSfc = require('@vue/compiler-sfc');
@@ -21,18 +22,64 @@ 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 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 fg__default = /*#__PURE__*/_interopDefaultCompat(fg);
 const JSON5__default = /*#__PURE__*/_interopDefaultCompat(JSON5);
 
 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 +168,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] || "";
@@ -176,8 +224,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 +259,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,
@@ -336,7 +387,7 @@ class PageContext {
       watcher.add(configs);
     }
     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))
@@ -476,6 +527,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 +548,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 +573,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
   );

package/dist/index.d.cts

@@ -665,6 +665,7 @@ declare class PageContext {
     virtualModule(): string;
     resolveRoutes(): string;
     resolveSubRoutes(): string;
+    generateDeclaration(): Promise<void> | undefined;
 }
 
 declare function invalidatePagesModule(server: ViteDevServer): void;
@@ -676,6 +677,7 @@ 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;
@@ -699,6 +701,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 +769,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
      */

package/dist/index.d.mts

@@ -665,6 +665,7 @@ declare class PageContext {
     virtualModule(): string;
     resolveRoutes(): string;
     resolveSubRoutes(): string;
+    generateDeclaration(): Promise<void> | undefined;
 }
 
 declare function invalidatePagesModule(server: ViteDevServer): void;
@@ -676,6 +677,7 @@ 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;
@@ -699,6 +701,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 +769,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
      */

package/dist/index.d.ts

@@ -665,6 +665,7 @@ declare class PageContext {
     virtualModule(): string;
     resolveRoutes(): string;
     resolveSubRoutes(): string;
+    generateDeclaration(): Promise<void> | undefined;
 }
 
 declare function invalidatePagesModule(server: ViteDevServer): void;
@@ -676,6 +677,7 @@ 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;
@@ -699,6 +701,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 +769,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
      */

package/dist/index.mjs

@@ -1,15 +1,16 @@
-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';
@@ -18,6 +19,52 @@ 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 +153,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] || "";
@@ -161,8 +209,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 +239,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,7 +310,7 @@ 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, "pagesPath", []);
@@ -321,7 +372,7 @@ class PageContext {
       watcher.add(configs);
     }
     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))
@@ -461,6 +512,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 +533,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));

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@uni-helper/vite-plugin-uni-pages",
   "type": "module",
-  "version": "0.2.8",
+  "version": "0.2.9",
   "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": {