@heathenjs/taro-router-plugin 1.0.0

package/dist/generate-app-config/index.js

@@ -0,0 +1,39 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateAppConfig = void 0;
+const path_1 = __importDefault(require("path"));
+const generateAppConfig = ({ pages, config, mainPackageName }) => {
+    const subPackages = config.packages
+        .filter((pkg) => pkg.name !== mainPackageName)
+        .map((pkg) => {
+        return {
+            root: path_1.default.resolve(process.cwd(), pkg.pagePath),
+            pages: [],
+        };
+    });
+    const appConfig = { pages: [], subPackages };
+    pages.forEach((currentPage) => {
+        if (currentPage.packageName === mainPackageName) {
+            appConfig.pages.push(currentPage.path.slice(1));
+        }
+        else {
+            const targetSubPackage = appConfig.subPackages.find((pkg) => currentPage.path.startsWith(pkg.root));
+            if (targetSubPackage) {
+                targetSubPackage.pages.push(currentPage.path.replace(`${targetSubPackage.root}${path_1.default.sep}`, ''));
+            }
+        }
+    });
+    if (config.defaultPage) {
+        appConfig.pages.sort((left) => {
+            if (left === config.defaultPage)
+                return -1;
+            return 0;
+        });
+    }
+    return appConfig;
+};
+exports.generateAppConfig = generateAppConfig;
+//# sourceMappingURL=index.js.map

package/dist/generate-app-config/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/generate-app-config/index.ts"],"names":[],"mappings":";;;;;;AACA,gDAAwB;AASjB,MAAM,iBAAiB,GAAG,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,eAAe,EAA2B,EAAE,EAAE;IAC/F,MAAM,WAAW,GAAG,MAAM,CAAC,QAAQ;SAChC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,eAAe,CAAC;SAC7C,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACX,OAAO;YACL,IAAI,EAAE,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,CAAC,QAAQ,CAAC;YAC/C,KAAK,EAAE,EAAc;SACtB,CAAC;IACJ,CAAC,CAAC,CAAC;IAEL,MAAM,SAAS,GAAuD,EAAE,KAAK,EAAE,EAAE,EAAE,WAAW,EAAE,CAAC;IAEjG,KAAK,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;QAC5B,IAAI,WAAW,CAAC,WAAW,KAAK,eAAe,EAAE,CAAC;YAEhD,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAClD,CAAC;aAAM,CAAC;YAEN,MAAM,gBAAgB,GAAG,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;YACpG,IAAI,gBAAgB,EAAE,CAAC;gBACrB,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,gBAAgB,CAAC,IAAI,GAAG,cAAI,CAAC,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;YACnG,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;IAGH,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;QACvB,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;YAC5B,IAAI,IAAI,KAAK,MAAM,CAAC,WAAW;gBAAE,OAAO,CAAC,CAAC,CAAC;YAE3C,OAAO,CAAC,CAAC;QACX,CAAC,CAAC,CAAC;IACL,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAnCW,QAAA,iBAAiB,qBAmC5B"}

package/dist/index.js

@@ -0,0 +1,34 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const taro_router_generator_1 = require("@heathen/taro-router-generator");
+const generate_app_config_1 = require("./generate-app-config");
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const CONFIG_FILE_NAME = 'router.config.json';
+exports.default = (ctx) => {
+    var _a, _b;
+    const configFilePath = path_1.default.resolve(process.cwd(), `./${CONFIG_FILE_NAME}`);
+    const isConfigFileExist = fs_1.default.existsSync(configFilePath);
+    let config = {};
+    if (isConfigFileExist) {
+        const configSource = fs_1.default.readFileSync(configFilePath, { encoding: 'utf8' });
+        config = JSON.parse(configSource);
+    }
+    else {
+        throw `找不到 ${configFilePath}，请检查配置文件及执行路径。`;
+    }
+    config.packages = (_a = config.packages) !== null && _a !== void 0 ? _a : [];
+    config.ignore = (_b = config.ignore) !== null && _b !== void 0 ? _b : ['.DS_Store'];
+    ctx.onBuildStart(() => {
+        const generator = new taro_router_generator_1.Generator(config);
+        generator.generateRouter();
+        ctx.modifyAppConfig(({ appConfig }) => {
+            Object.assign(appConfig, (0, generate_app_config_1.generateAppConfig)({ config, pages: generator.getPages(), mainPackageName: generator.getMainPackageName() }));
+        });
+        console.log();
+    });
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;AAAA,0EAA2D;AAE3D,+DAA0D;AAE1D,gDAAwB;AACxB,4CAAoB;AAEpB,MAAM,gBAAgB,GAAG,oBAAoB,CAAC;AAE9C,kBAAe,CAAC,GAAmB,EAAE,EAAE;;IACrC,MAAM,cAAc,GAAG,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,KAAK,gBAAgB,EAAE,CAAC,CAAC;IAE5E,MAAM,iBAAiB,GAAG,YAAE,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;IAExD,IAAI,MAAM,GAAW,EAAY,CAAC;IAClC,IAAI,iBAAiB,EAAE,CAAC;QACtB,MAAM,YAAY,GAAG,YAAE,CAAC,YAAY,CAAC,cAAc,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;QAE3E,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IACpC,CAAC;SAAM,CAAC;QACN,MAAM,OAAO,cAAc,gBAAgB,CAAC;IAC9C,CAAC;IAED,MAAM,CAAC,QAAQ,GAAG,MAAA,MAAM,CAAC,QAAQ,mCAAI,EAAE,CAAC;IACxC,MAAM,CAAC,MAAM,GAAG,MAAA,MAAM,CAAC,MAAM,mCAAI,CAAC,WAAW,CAAC,CAAC;IAE/C,GAAG,CAAC,YAAY,CAAC,GAAG,EAAE;QACpB,MAAM,SAAS,GAAG,IAAI,iCAAS,CAAC,MAAM,CAAC,CAAC;QACxC,SAAS,CAAC,cAAc,EAAE,CAAC;QAE3B,GAAG,CAAC,eAAe,CAAC,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE;YACpC,MAAM,CAAC,MAAM,CACX,SAAS,EACT,IAAA,uCAAiB,EAAC,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,QAAQ,EAAE,EAAE,eAAe,EAAE,SAAS,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAC5G,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,OAAO,CAAC,GAAG,EAAE,CAAC;IAChB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC"}

package/dist/type.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=type.js.map

package/dist/type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.js","sourceRoot":"","sources":["../src/type.ts"],"names":[],"mappings":""}

package/index.js

@@ -0,0 +1,5 @@
+/* eslint-disable @typescript-eslint/no-require-imports */
+
+module.exports = require('./dist/index.js').default;
+
+module.exports.default = module.exports;

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@heathenjs/taro-router-plugin",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "prod": "tsc -p ./tsconfig.json",
+    "clean": "rimraf dist",
+    "build": "pnpm run clean && pnpm run prod",
+    "tsc": "tsc -p ./tsconfig.json --noEmit",
+    "lint": "eslint --ext .ts  --max-warnings 0 \"./src\" "
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "peerDependencies": {
+    "@heathenjs/taro-router-generator": "workspace:*",
+    "@tarojs/service": "^3.6.35",
+    "@tarojs/taro": "^3.6.35"
+  }
+}

package/src/generate-app-config/index.ts

@@ -0,0 +1,46 @@
+import type { AppConfig } from '@tarojs/taro';
+import path from 'path';
+import { Config, Page } from '../type';
+
+type GenerateAppConfigParams = {
+  pages: Page[];
+  config: Config;
+  mainPackageName: string;
+};
+
+export const generateAppConfig = ({ pages, config, mainPackageName }: GenerateAppConfigParams) => {
+  const subPackages = config.packages
+    .filter((pkg) => pkg.name !== mainPackageName)
+    .map((pkg) => {
+      return {
+        root: path.resolve(process.cwd(), pkg.pagePath),
+        pages: [] as string[],
+      };
+    });
+
+  const appConfig: Required<Pick<AppConfig, 'pages' | 'subPackages'>> = { pages: [], subPackages };
+
+  pages.forEach((currentPage) => {
+    if (currentPage.packageName === mainPackageName) {
+      // 主包的页面去除头部的 /
+      appConfig.pages.push(currentPage.path.slice(1));
+    } else {
+      // 对于分包，判断所属的分包并加入
+      const targetSubPackage = appConfig.subPackages.find((pkg) => currentPage.path.startsWith(pkg.root));
+      if (targetSubPackage) {
+        targetSubPackage.pages.push(currentPage.path.replace(`${targetSubPackage.root}${path.sep}`, ''));
+      }
+    }
+  });
+
+  // 配置了默认页面时，调整主包页面顺序
+  if (config.defaultPage) {
+    appConfig.pages.sort((left) => {
+      if (left === config.defaultPage) return -1;
+
+      return 0;
+    });
+  }
+
+  return appConfig;
+};

package/src/index.ts

@@ -0,0 +1,40 @@
+import { Generator } from '@heathenjs/taro-router-generator';
+import { IPluginContext } from '@tarojs/service';
+import { generateAppConfig } from './generate-app-config';
+import { Config } from './type';
+import path from 'path';
+import fs from 'fs';
+
+const CONFIG_FILE_NAME = 'router.config.json';
+
+export default (ctx: IPluginContext) => {
+  const configFilePath = path.resolve(process.cwd(), `./${CONFIG_FILE_NAME}`);
+
+  const isConfigFileExist = fs.existsSync(configFilePath);
+
+  let config: Config = {} as Config;
+  if (isConfigFileExist) {
+    const configSource = fs.readFileSync(configFilePath, { encoding: 'utf8' });
+
+    config = JSON.parse(configSource);
+  } else {
+    throw `找不到 ${configFilePath}，请检查配置文件及执行路径。`;
+  }
+
+  config.packages = config.packages ?? [];
+  config.ignore = config.ignore ?? ['.DS_Store'];
+
+  ctx.onBuildStart(() => {
+    const generator = new Generator(config);
+    generator.generateRouter();
+
+    ctx.modifyAppConfig(({ appConfig }) => {
+      Object.assign(
+        appConfig,
+        generateAppConfig({ config, pages: generator.getPages(), mainPackageName: generator.getMainPackageName() }),
+      );
+    });
+
+    console.log();
+  });
+};

package/src/type.ts

@@ -0,0 +1,31 @@
+export interface ConfigPackage {
+  /** 包名 */
+  name: string;
+  /** 包页面根路径 */
+  pagePath: string;
+}
+
+export type Config = {
+  /** 排除的文件 */
+  ignore: string[];
+  /**
+   * 应用的默认页面，不指定时使用 pages 的第一项
+   * - 注意 pages 是自动生成的，默认按字典序
+   */
+  defaultPage?: string;
+  /** 包配置 */
+  packages: [ConfigPackage & { isMainPackage: true }, ...(ConfigPackage & { isMainPackage?: false })[]];
+};
+
+export type Page = {
+  dirName: string;
+  dirPath: string;
+  path: string;
+  pageFileName: string;
+  packageName: string;
+  routeConfig?: {
+    params?: string;
+    backData?: string;
+    ext?: string;
+  };
+};

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "extends": "../../tsconfig",
+  "compilerOptions": {
+    "target": "es2015",
+    "module": "CommonJS",
+    "experimentalDecorators": false,
+    "outDir": "dist",
+    "rootDir": "./src",
+    "baseUrl": ".",
+    "removeComments": true,
+    "downlevelIteration": true,
+    "sourceMap": true,
+    "isolatedModules": false,
+    "noEmit": false
+  },
+  "include": ["./**/*.ts", "./**/*.tsx"],
+  "exclude": ["node_modules", "dist"]
+}