From 9c8ff9935358a51cd88dad9d6fbac330d620e6f8 Mon Sep 17 00:00:00 2001
From: edwinhuish <edwinhuish@gmail.com>
Date: Thu, 15 Aug 2024 23:57:30 +0800
Subject: [PATCH] move to @uni-ku/define-page

---
 .changeset/config.json                 |   2 +-
 README.md                              | 217 ++++++++++++++++++++++++-
 package.json                           |   4 +-
 packages/pages-json/CHANGELOG.md       |   2 +-
 packages/pages-json/README.md          |  18 +-
 packages/pages-json/package.json       |  10 +-
 packages/pages-json/src/declaration.ts |   2 +-
 packages/pages-json/src/file.ts        |   2 +-
 packages/pages-json/src/index.ts       |   4 -
 packages/pages-json/src/pagesJson.ts   |   2 +-
 packages/pages-json/src/utils/debug.ts |   2 +-
 packages/pages-json/src/vite/plugin.ts |   4 +-
 packages/playground/.gitignore         |   1 +
 packages/playground/package.json       |   2 +-
 packages/playground/src/pages.d.ts     |  33 ----
 packages/playground/src/pages.json.ts  |   4 +-
 packages/playground/tsconfig.json      |   2 +-
 packages/playground/vite.config.ts     |   4 +-
 pnpm-lock.yaml                         |   6 +-
 19 files changed, 247 insertions(+), 74 deletions(-)
 delete mode 100644 packages/playground/src/pages.d.ts

diff --git a/.changeset/config.json b/.changeset/config.json
index 41144ff..c6382d6 100644
--- a/.changeset/config.json
+++ b/.changeset/config.json
@@ -2,7 +2,7 @@
   "$schema": "https://unpkg.com/@changesets/config@3.0.0/schema.json",
   "changelog":  [
     "@changesets/changelog-github", 
-    { "repo": "edwinhuish/uni-macros" }
+    { "repo": "uni-ku/define-page" }
   ],
   "commit": true,
   "fixed": [],
diff --git a/README.md b/README.md
index 68559c6..e450690 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,216 @@
-# uni-macros
+# @uni-ku/define-page
 
-用于 `uniapp` vue文件 `<script setup>` 内的宏定义的vite插件。
+`definePage` 宏，用于动态生成 `pages.json`。
 
-## 功能
+- 支持类型提示、约束
+- 支持 json
+- 支持函数和异步函数
+- 支持从外部导入变量、函数
 
-- [vite-plugin-pages-json](./packages/pages-json/README.md) 可使用 `json`、 `function` 动态生成 `pages.json` 的宏（`definePage`）
+## 安装
+
+```shell
+pnpm i -D @uni-ku/define-page
+```
+
+## 配置
+
+### vite 配置
+```ts
+import uni from '@dcloudio/vite-plugin-uni';
+import { viteUniPagesJson } from '@uni-ku/define-page';
+import { defineConfig } from 'vite';
+
+export default defineConfig({
+  plugins: [
+    viteUniPagesJson(), // 详细配置请看下面的详细描述
+    uni(), // 添加在 viteUniPagesJson() 之后
+    // 其他plugins
+  ],
+});
+```
+
+### `definePage` 全局类型声明
+
+将类型添加到 `tsconfig.json` 中的 `compilerOptions.types` 下
+
+```json
+{
+  "compilerOptions": {
+    "types": ["@uni-ku/define-page"]
+  }
+}
+```
+
+### vite 详细配置
+
+```ts
+export interface UserConfig {
+
+  /**
+   * 项目根目录
+   * @default vite 的 `root` 属性
+   */
+  root?: string;
+
+  /**
+   * pages.json 的相对目录
+   * @default "src"
+   */
+  basePath?: string;
+
+  /**
+   * 为页面路径生成 TypeScript 声明
+   * 接受相对项目根目录的路径
+   * null 则取消生成
+   * @default basePath
+   */
+  dts?: string | null;
+
+  /**
+   * pages的相对路径
+   * @default 'src/pages'
+   */
+  pages?: string;
+
+  /**
+   * subPackages的相对路径
+   * @default []
+   */
+  subPackages?: string[];
+
+  /**
+   * 排除条件，应用于 pages 和 subPackages 的文件
+   * @default ['node_modules', '.git', '** /__*__/ **']
+   */
+  exclude?: string[];
+
+  /**
+   * pages和subPages的文件扫描深度
+   * @default 3
+   */
+  fileDeep?: number;
+
+  /**
+   * 显示调试
+   * @default false
+   */
+  debug?: boolean | DebugType;
+}
+```
+
+### 全局 `pages.json.(ts|mts|cts|js|cjs|mjs)` 配置
+
+动态配置文件，和 `pages.json` 同级目录。
+
+将与 `definePage` 合并，生成最终的 `pages.json`
+
+```ts
+import { UniPagesJson } from '@uni-ku/define-page';
+
+export default UniPagesJson({
+  globalStyle: {
+    navigationBarTextStyle: 'black',
+    navigationBarTitleText: 'uni-app',
+    navigationBarBackgroundColor: '#F8F8F8',
+    backgroundColor: '#F8F8F8',
+  },
+  pages: [
+    // pages数组中第一项表示应用启动页，参考：https://uniapp.dcloud.io/collocation/pages
+    // {
+    //   path: 'pages/index/index',
+    //   style: {
+    //     navigationBarTitleText: 'uni-app',
+    //   },
+    // },
+  ],
+});
+```
+
+## 使用
+
+### vue SFC文件内 `definePage` 宏使用方式
+
+更多使用方式请参考 [playground/pages/define-page](../playground/src/pages/define-page/)
+
+**注意：**
+- 以下代码需要写在 `script setup` 内
+- `definePage` 宏和当前 SFC 不同域，且先于 SFC 生成，SFC 内部变量无法使用。
+- 页面 path url 将会自动根据文件路径生成，如无须配置其他项目，`definePage`可省略
+- 同一个 `script setup` 内仅可使用一个 `definePage`
+
+JSON 对象
+```ts
+definePage({
+  style: {
+    navigationBarTitleText: 'hello world',
+  },
+  middlewares: [
+    'auth',
+  ],
+});
+```
+
+函数
+```ts
+definePage(() => {
+  const hello = 'hello';
+  const world = 'world';
+
+  return {
+    style: {
+      navigationBarTitleText: [hello, world].join(' '),
+    },
+    middlewares: [
+      'auth',
+    ],
+  };
+});
+```
+
+嵌套函数
+```ts
+definePage(() => {
+  function getTitle(): string {
+    const hello = 'hello';
+    const world = 'world';
+
+    return [hello, world].join(' ');
+  }
+
+  return {
+    style: {
+      navigationBarTitleText: getTitle(),
+    },
+    middlewares: [
+      'auth',
+    ],
+  };
+});
+```
+
+引入外部函数、变量
+```ts
+import { randamText } from './utils';
+
+definePage(() => {
+  return {
+    style: {
+      navigationBarTitleText: randamText(),
+    },
+  };
+});
+```
+
+### 获取当前上下文的数据
+
+```ts
+import { ctx } from '@uni-ku/define-page';
+
+console.log(ctx.files);
+console.log(ctx.pages);
+console.log(ctx.subPackages);
+```
+
+## 感谢
+- [vite-plugin-uni-pages](https://github.com/uni-helper/vite-plugin-uni-pages)
diff --git a/package.json b/package.json
index 315aa22..52ecb9a 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
 {
-  "name": "uni-macros",
+  "name": "@uni-ku/macros",
   "type": "module",
-  "version": "0.0.2",
+  "version": "0.1.0",
   "description": "",
   "author": "Edwin Xu",
   "license": "MIT",
diff --git a/packages/pages-json/CHANGELOG.md b/packages/pages-json/CHANGELOG.md
index e3fa8e2..30bb34f 100644
--- a/packages/pages-json/CHANGELOG.md
+++ b/packages/pages-json/CHANGELOG.md
@@ -1,4 +1,4 @@
-# vite-plugin-pages-json
+# @uni-ku/define-page
 
 ## 0.0.10
 
diff --git a/packages/pages-json/README.md b/packages/pages-json/README.md
index 9f69311..e450690 100644
--- a/packages/pages-json/README.md
+++ b/packages/pages-json/README.md
@@ -1,4 +1,4 @@
-# vite-plugin-pages-json
+# @uni-ku/define-page
 
 `definePage` 宏，用于动态生成 `pages.json`。
 
@@ -10,7 +10,7 @@
 ## 安装
 
 ```shell
-pnpm i -D vite-plugin-pages-json
+pnpm i -D @uni-ku/define-page
 ```
 
 ## 配置
@@ -18,13 +18,13 @@ pnpm i -D vite-plugin-pages-json
 ### vite 配置
 ```ts
 import uni from '@dcloudio/vite-plugin-uni';
+import { viteUniPagesJson } from '@uni-ku/define-page';
 import { defineConfig } from 'vite';
-import VitePagesJson from 'vite-plugin-pages-json';
 
 export default defineConfig({
   plugins: [
-    VitePagesJson(), // 详细配置请看下面的详细描述
-    uni(), // 添加在 VitePagesJson() 之后
+    viteUniPagesJson(), // 详细配置请看下面的详细描述
+    uni(), // 添加在 viteUniPagesJson() 之后
     // 其他plugins
   ],
 });
@@ -37,7 +37,7 @@ export default defineConfig({
 ```json
 {
   "compilerOptions": {
-    "types": ["vite-plugin-pages-json"]
+    "types": ["@uni-ku/define-page"]
   }
 }
 ```
@@ -106,9 +106,9 @@ export interface UserConfig {
 将与 `definePage` 合并，生成最终的 `pages.json`
 
 ```ts
-import { definePagesJson } from 'vite-plugin-pages-json';
+import { UniPagesJson } from '@uni-ku/define-page';
 
-export default definePagesJson({
+export default UniPagesJson({
   globalStyle: {
     navigationBarTextStyle: 'black',
     navigationBarTitleText: 'uni-app',
@@ -205,7 +205,7 @@ definePage(() => {
 ### 获取当前上下文的数据
 
 ```ts
-import { ctx } from 'vite-plugin-pages-json';
+import { ctx } from '@uni-ku/define-page';
 
 console.log(ctx.files);
 console.log(ctx.pages);
diff --git a/packages/pages-json/package.json b/packages/pages-json/package.json
index 4defd6d..ad1e788 100644
--- a/packages/pages-json/package.json
+++ b/packages/pages-json/package.json
@@ -1,16 +1,16 @@
 {
-  "name": "vite-plugin-pages-json",
+  "name": "@uni-ku/define-page",
   "type": "module",
-  "version": "0.0.11",
+  "version": "0.1.0",
   "description": "Define uniapp pages.json dynamically.",
   "author": "Edwin Xu <edwinhuish@gmail.com>",
   "license": "MIT",
-  "homepage": "https://github.com/edwinhuish/uni-macros",
+  "homepage": "https://github.com/uni-ku/define-page",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/edwinhuish/uni-macros.git"
+    "url": "git+https://github.com/uni-ku/define-page.git"
   },
-  "bugs": "https://github.com/edwinhuish/uni-macros/issues",
+  "bugs": "https://github.com/uni-ku/define-page/issues",
   "keywords": [
     "uniapp",
     "uni-app",
diff --git a/packages/pages-json/src/declaration.ts b/packages/pages-json/src/declaration.ts
index e049046..2c80c1e 100644
--- a/packages/pages-json/src/declaration.ts
+++ b/packages/pages-json/src/declaration.ts
@@ -15,7 +15,7 @@ export function getDeclaration(pagesJSON: PagesJson) {
   const code = `/* eslint-disable */
 /* prettier-ignore */
 // @ts-nocheck
-// Generated by vite-plugin-pages-json
+// Generated by @uni-ku/define-page
 
 interface NavigateToOptions {
   url: ${allPagesPath.join(' |\n       ')};
diff --git a/packages/pages-json/src/file.ts b/packages/pages-json/src/file.ts
index ceab266..afadb0b 100644
--- a/packages/pages-json/src/file.ts
+++ b/packages/pages-json/src/file.ts
@@ -198,7 +198,7 @@ async function exec<R = any>(file: string, exp: t.Expression, imports: t.ImportD
   }
 
   if (!fs.existsSync(tsx)) {
-    throw new Error(`[vite-plugin-pages-json] "tsx" is required parse macro expression value`);
+    throw new Error(`[@uni-ku/define-page] "tsx" is required parse macro expression value`);
   }
 
   const ast = t.file(t.program([
diff --git a/packages/pages-json/src/index.ts b/packages/pages-json/src/index.ts
index 472b8ee..f89ed63 100644
--- a/packages/pages-json/src/index.ts
+++ b/packages/pages-json/src/index.ts
@@ -1,5 +1,3 @@
-import { viteDefinePagesJson } from './vite/plugin';
-
 export * from './config';
 export * from './constant';
 export * from './context';
@@ -7,5 +5,3 @@ export * from './page';
 export * from './pagesJson';
 export * from './types';
 export * from './vite/plugin';
-
-export default viteDefinePagesJson;
diff --git a/packages/pages-json/src/pagesJson.ts b/packages/pages-json/src/pagesJson.ts
index 4e47caf..f7861ed 100644
--- a/packages/pages-json/src/pagesJson.ts
+++ b/packages/pages-json/src/pagesJson.ts
@@ -5,7 +5,7 @@ import { getConfig } from './config';
 import { PAGES_CONFIG_EXT, PAGES_CONFIG_FILE } from './constant';
 import { debug } from './utils/debug';
 
-export function definePagesJson(userConfig: Partial<PagesJson>) {
+export function UniPagesJson(userConfig: Partial<PagesJson>) {
   return userConfig;
 }
 
diff --git a/packages/pages-json/src/utils/debug.ts b/packages/pages-json/src/utils/debug.ts
index 4aa6f67..0db3cfe 100644
--- a/packages/pages-json/src/utils/debug.ts
+++ b/packages/pages-json/src/utils/debug.ts
@@ -1,6 +1,6 @@
 import Debug from 'debug';
 
-const PREFIX = 'define-pages-json:';
+const PREFIX = 'define-page:';
 
 const DEBUG_TYPES = [
   'loadPagesConfig',
diff --git a/packages/pages-json/src/vite/plugin.ts b/packages/pages-json/src/vite/plugin.ts
index 85c4eed..f5b654b 100644
--- a/packages/pages-json/src/vite/plugin.ts
+++ b/packages/pages-json/src/vite/plugin.ts
@@ -25,13 +25,13 @@ async function restart() {
   });
 }
 
-export function viteDefinePagesJson(userConfig: UserConfig = {}): Plugin {
+export function viteUniPagesJson(userConfig: UserConfig = {}): Plugin {
   ctx.init(userConfig);
 
   checkPagesJsonFile();
 
   return {
-    name: 'vite-plugin-pages-json',
+    name: '@uni-ku/define-page',
     enforce: 'pre',
     async configResolved(viteConf) {
       if (!userConfig.root) {
diff --git a/packages/playground/.gitignore b/packages/playground/.gitignore
index be2d0cf..9ebe438 100644
--- a/packages/playground/.gitignore
+++ b/packages/playground/.gitignore
@@ -21,3 +21,4 @@ dist
 *.sw?
 
 src/pages.json
+src/pages.d.ts
diff --git a/packages/playground/package.json b/packages/playground/package.json
index d3a5f5d..08362e6 100644
--- a/packages/playground/package.json
+++ b/packages/playground/package.json
@@ -68,11 +68,11 @@
     "@dcloudio/uni-cli-shared": "3.0.0-4020420240722002",
     "@dcloudio/uni-stacktracey": "3.0.0-4020420240722002",
     "@dcloudio/vite-plugin-uni": "3.0.0-4020420240722002",
+    "@uni-ku/define-page": "workspace:^",
     "@vue/runtime-core": "^3.4.21",
     "@vue/tsconfig": "^0.1.3",
     "typescript": "^4.9.4",
     "vite": "5.2.8",
-    "vite-plugin-pages-json": "workspace:^",
     "vue-tsc": "^1.0.24",
     "yaml": "^2.5.0"
   }
diff --git a/packages/playground/src/pages.d.ts b/packages/playground/src/pages.d.ts
deleted file mode 100644
index 7f5c0fc..0000000
--- a/packages/playground/src/pages.d.ts
+++ /dev/null
@@ -1,33 +0,0 @@
-/* eslint-disable */
-/* prettier-ignore */
-// @ts-nocheck
-// Generated by vite-plugin-pages-json
-
-interface NavigateToOptions {
-  url: "/pages/define-page/async-function" |
-       "/pages/define-page/function" |
-       "/pages/define-page/import" |
-       "/pages/define-page/nested-function" |
-       "/pages/define-page/object" |
-       "/pages/define-page/remove-console" |
-       "/pages/define-page/yaml" |
-       "/pages/index/index" |
-       "/pages-sub/index" |
-       "/pages-sub/about/index" |
-       "/pages-sub/about/your";
-}
-interface RedirectToOptions extends NavigateToOptions {}
-
-interface SwitchTabOptions {
-  url: "/pages/define-page/import" |
-       "/pages/define-page/object";
-}
-
-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;
-}
diff --git a/packages/playground/src/pages.json.ts b/packages/playground/src/pages.json.ts
index 66d3ab7..215b605 100644
--- a/packages/playground/src/pages.json.ts
+++ b/packages/playground/src/pages.json.ts
@@ -1,6 +1,6 @@
-import { definePagesJson } from 'vite-plugin-pages-json';
+import { UniPagesJson } from '@uni-ku/define-page';
 
-export default definePagesJson({
+export default UniPagesJson({
   globalStyle: {
     navigationBarTextStyle: 'black',
     navigationBarTitleText: 'uni-app',
diff --git a/packages/playground/tsconfig.json b/packages/playground/tsconfig.json
index d78303e..3ebf7ad 100644
--- a/packages/playground/tsconfig.json
+++ b/packages/playground/tsconfig.json
@@ -7,7 +7,7 @@
     "paths": {
       "@/*": ["./src/*"]
     },
-    "types": ["@dcloudio/types", "vite-plugin-pages-json"],
+    "types": ["@dcloudio/types", "@uni-ku/define-page"],
     "sourceMap": true
   },
   "include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.tsx", "src/**/*.vue"]
diff --git a/packages/playground/vite.config.ts b/packages/playground/vite.config.ts
index 1e3cb05..7ec6bee 100644
--- a/packages/playground/vite.config.ts
+++ b/packages/playground/vite.config.ts
@@ -1,11 +1,11 @@
 import uni from '@dcloudio/vite-plugin-uni';
+import { viteUniPagesJson } from '@uni-ku/define-page';
 import { defineConfig } from 'vite';
-import VitePageJson from 'vite-plugin-pages-json';
 
 // https://vitejs.dev/config/
 export default defineConfig({
   plugins: [
-    VitePageJson({
+    viteUniPagesJson({
       pages: 'src/pages',
       subPackages: ['src/pages-sub'],
       debug: true,
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index f245cb0..1b4c81e 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -202,6 +202,9 @@ importers:
       '@dcloudio/vite-plugin-uni':
         specifier: 3.0.0-4020420240722002
         version: 3.0.0-4020420240722002(postcss@8.4.38)(rollup@3.29.4)(vite@5.2.8)(vue@3.4.21)
+      '@uni-ku/define-page':
+        specifier: workspace:^
+        version: link:../pages-json
       '@vue/runtime-core':
         specifier: ^3.4.21
         version: 3.4.21
@@ -214,9 +217,6 @@ importers:
       vite:
         specifier: 5.2.8
         version: 5.2.8(@types/node@20.12.7)(terser@5.30.3)
-      vite-plugin-pages-json:
-        specifier: workspace:^
-        version: link:../pages-json
       vue-tsc:
         specifier: ^1.0.24
         version: 1.8.27(typescript@4.9.5)