@heathenjs/taro-router-plugin 1.1.5

package/README.md

@@ -0,0 +1,94 @@
+# @heathenjs/taro-router-plugin
+
+[![](https://img.shields.io/npm/v/%40heathenjs%2Ftaro-router-plugin)](https://www.npmjs.com/package/@heathenjs/taro-router-plugin)
+[![](https://img.shields.io/npm/dm/%40heathenjs%2Ftaro-router-plugin)](https://www.npmjs.com/package/@heathenjs/taro-router-plugin)
+
+在Taro构建时自动生成 [@heathenjs/taro-router](https://www.npmjs.com/package/@heathenjs/taro-router) 所需的路由，并自动配置路由信息到app.config
+
+## 特性
+<ol>
+<li>约定式路由生成；</li>
+<li>自动生成路由跳转方法，可按页面的 route.config.ts 配置 进行跳转参数校验；</li>
+<li>自动配置路由信息到 app.config，免去繁杂的页面及分包配置；</li>
+</ol>
+
+## 使用
+### Step 1
+安装
+#### pnpm
+```bash
+pnpm add @heathenjs/taro-router-plugin --save-dev
+pnpm add @heathenjs/taro-router
+```
+
+#### yarn
+```bash
+yarn add @heathenjs/taro-router-plugin --dev
+yarn add @heathenjs/taro-router
+```
+
+#### npm
+```bash
+npm install @heathenjs/taro-router-plugin --save-dev
+npm install @heathenjs/taro-router --save
+```
+
+### Step 2
+在项目根目录创建配置文件 router.config.json ，参考配置信息如下：
+```json
+{
+  "ignore": [
+    "components",
+  ],
+  "defaultPage": "pages/default/index/index",
+  "packages": [
+    {
+      "name": "package1",
+      "pagePath": "./src/pages/package1"
+    },
+    {
+      "name": "package2",
+      "pagePath": "./src/pages/package2"
+    },
+    {
+      "name": "default",
+      "pagePath": "./src/pages/default",
+      "isMainPackage": true
+    }
+  ]
+}
+```
+详见[配置参数说明](#配置参数说明)
+
+### Step 3
+taro构建配置中增加插件
+```typescript
+export default {
+    plugins: [
+      '@heathenjs/taro-router-plugin',
+    ],
+}
+```
+
+完成！此时你不需要在 app.config 中再编写任何路由/页面相关的配置，插件会自动生成。
+
+## 配置参数说明
+
+### ignore
+不参与路由构建的目录，例如在页面中临时使用的一些组件。配置语法参考[ignore](https://www.npmjs.com/package/ignore)
+> 默认情况下，会将 pagePath 目录下所有 `index.js`/`index.jsx`/`index.jsx`/`index.tsx` 识别为页面文件
+
+### defaultPage
+进入小程序时的初始页面。必须是主包的页面。
+
+### packages
+分包配置
+
+#### name
+分包名
+
+#### pagePath
+包页面路径
+
+#### isMainPackage
+是否为主包。必须有且仅有一个 package 的 isMainPackage 为true

package/dist/index.js

@@ -0,0 +1 @@
+"use strict";var h=Object.create;var i=Object.defineProperty;var d=Object.getOwnPropertyDescriptor;var k=Object.getOwnPropertyNames;var A=Object.getPrototypeOf,S=Object.prototype.hasOwnProperty;var N=(e,o)=>{for(var t in o)i(e,t,{get:o[t],enumerable:!0})},c=(e,o,t,r)=>{if(o&&typeof o=="object"||typeof o=="function")for(let a of k(o))!S.call(e,a)&&a!==t&&i(e,a,{get:()=>o[a],enumerable:!(r=d(o,a))||r.enumerable});return e};var g=(e,o,t)=>(t=e!=null?h(A(e)):{},c(o||!e||!e.__esModule?i(t,"default",{value:e,enumerable:!0}):t,e)),$=e=>c(i({},"__esModule",{value:!0}),e);var y={};N(y,{default:()=>x});module.exports=$(y);var C=require("@heathenjs/taro-router-generator"),f=g(require("fs-extra")),u=g(require("path"));var p=g(require("path")),m=process.cwd(),E=p.default.resolve(m,"./src"),l=({pages:e,config:o,mainPackageName:t})=>{let r=o.packages.filter(s=>s.name!==t).map(s=>({root:p.default.resolve(m,s.pagePath).replace(E,"").slice(1),pages:[]})),a={pages:[],subPackages:r};return e.forEach(s=>{if(s.packageName===t)a.pages.push(s.path.slice(1));else{let n=a.subPackages.find(P=>s.path.startsWith(`${p.default.sep}${P.root}`));n&&n.pages.push(s.path.replace(`${p.default.sep}${n.root}${p.default.sep}`,""))}}),o.defaultPage&&a.pages.sort(s=>s===o.defaultPage?-1:0),a};var b="router.config.json",x=e=>{let o=u.default.resolve(process.cwd(),`./${b}`),t=f.default.existsSync(o),r={};if(t){let a=f.default.readFileSync(o,{encoding:"utf8"});r=JSON.parse(a)}else throw`\u627E\u4E0D\u5230 ${o}\uFF0C\u8BF7\u68C0\u67E5\u914D\u7F6E\u6587\u4EF6\u53CA\u6267\u884C\u8DEF\u5F84\u3002`;r.packages=r.packages??[],r.ignore=r.ignore??[".DS_Store"],e.onBuildStart(()=>{let a=new C.Generator(r);a.generateRouter(),e.modifyAppConfig(({appConfig:s})=>{Object.assign(s,l({config:r,pages:a.getPages(),mainPackageName:a.getMainPackageName()}))}),console.log()})};

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@heathenjs/taro-router-plugin",
+  "version": "1.1.5",
+  "description": "在Taro构建时自动生成路由方法及页面路由配置",
+  "main": "./dist/index.js",
+  "files": [
+    "dist",
+    "package.json",
+    "README.md"
+  ],
+  "keywords": [
+    "taro",
+    "router",
+    "plugin",
+    "miniprogram"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "author": "heathen1998",
+  "license": "MIT",
+  "peerDependencies": {
+    "@tarojs/service": "^3.6.35",
+    "@tarojs/taro": "^3.6.35"
+  },
+  "dependencies": {
+    "fs-extra": "^11.3.3",
+    "@heathenjs/taro-router-generator": "1.1.5"
+  },
+  "scripts": {
+    "clean": "rimraf dist",
+    "build:script": "tsx build.ts",
+    "build": "npm run clean && npm run build:script",
+    "tsc": "tsc -p ./tsconfig.json --noEmit",
+    "lint": "eslint --ext .ts  --max-warnings 0 \"./src\" "
+  }
+}