@mpilk/mp-route 3.0.0 → 3.0.1

package/README.md

@@ -0,0 +1,76 @@
+# @mpilk/mp-route
+
+用于根据 route 和 tabbar 配置文件生成 uni-app 的 `pages.json` 路由配置。
+
+## 安装
+
+```bash
+npm install -D @mpilk/mp-route
+```
+
+`@mpilk/mp-route` 依赖 `@mpilk/mp-shared`，安装时会自动安装共享工具包。
+
+## CLI 用法
+
+```bash
+mp-route --help
+mp-route build
+mp-route watch
+```
+
+也可以使用别名命令：
+
+```bash
+uni-route --help
+urc --help
+```
+
+## Route 配置
+
+```ts
+import { defineMiniRouter } from '@mpilk/mp-route'
+
+export default defineMiniRouter({
+  title: '首页',
+  path: 'pages/home/index',
+  isIndex: true
+})
+```
+
+## TabBar 配置
+
+```ts
+import { defineMiniTabbar } from '@mpilk/mp-route'
+
+export default defineMiniTabbar({
+  color: '#666666',
+  selectedColor: '#007aff',
+  backgroundColor: '#ffffff',
+  list: [
+    {
+      pagePath: 'pages/home/index',
+      text: '首页'
+    }
+  ]
+})
+```
+
+## 库 API
+
+```ts
+import {
+  builder,
+  builderWithWatch,
+  defineMiniRouter,
+  defineMiniTabbar
+} from '@mpilk/mp-route'
+```
+
+## 包格式
+
+当前包同时提供 ESM 和 CommonJS 产物：
+
+- ESM：`dist/index.js`
+- CommonJS：`dist/index.cjs`
+- 类型声明：`dist/index.d.ts`
+- CLI 入口：`bin/cli.js`

package/bin/cli.js

@@ -1,3 +1,3 @@
 #!/usr/bin/env node
 'use strict'
-import '../dist/cli.js'
+require('../dist/cli.cjs')

package/dist/chunk-6MZ3UWKK.js

@@ -1,262 +1,262 @@
-import path from 'node:path'
-import fs from 'node:fs'
-import pino from 'pino'
-import { loadFileContent, loadJson, outputFile } from '@mpilk/mp-shared'
-import { isEmpty, isArray, isPlainObject } from 'lodash-es'
-import chokidar from 'chokidar'
-
-// src/builder.ts
-var _indexPath = ''
-var logger = pino({
-  transport: {
-    target: 'pino-pretty',
-    options: {
-      colorize: true
-      // ignore: 'hostname,pid',
-    }
-  }
-})
-var verboseLogger = logger.child({ verbose: true })
-function builderWithWatch(options) {
-  let timer = null
-  function run() {
-    if (timer) clearTimeout(timer)
-    timer = setTimeout(() => {
-      timer = null
-      return builder(options)
-    }, options?.delay || 200)
-  }
-  return chokidar
-    .watch([
-      `src/**/${options?.routeName || 'route'}.{ts,js}`,
-      `src/${options?.tabbarName || 'tabbar'}.{ts,js}`
-    ])
-    .on('all', (eventName) => {
-      switch (eventName) {
-        case 'add':
-        case 'change':
-        case 'unlink':
-          run()
-          break
-      }
-    })
-}
-async function builder(options = {}) {
-  const {
-    input = './src',
-    routeName = 'route',
-    tabbarName = 'tabbar',
-    pagesPath = './src/pages.json',
-    verbose
-  } = options
-  logger.info('\u5F00\u59CB\u751F\u6210\u8DEF\u7531\u6587\u4EF6...')
-  const filePaths = loadDirFiles(input, routeName)
-  logger.info(
-    `\u6839\u636E ${routeName} \u627E\u5230 ${filePaths.length} \u4E2A\u6587\u4EF6`
-  )
-  const routeConfigs = []
-  for (const filePath of filePaths) {
-    verbose &&
-      verboseLogger.info(`\u5F00\u59CB\u89E3\u6790\u6587\u4EF6 ${filePath}`)
-    let content = await loadFileContent(filePath)
-    if (!content || typeof content !== 'object' || isEmpty(content)) {
-      verbose &&
-        verboseLogger.info(
-          `\u6587\u4EF6 ${filePath} \u4E3A\u7A7A\uFF0C\u8DF3\u8FC7`
-        )
-      continue
-    }
-    if (!isArray(content)) content = [content]
-    verbose &&
-      verboseLogger.info(
-        `\u6587\u4EF6 ${filePath} \u89E3\u6790\u5B8C\u6210\uFF1A${JSON.stringify(
-          content
-        )}`
-      )
-    routeConfigs.push(...content)
-  }
-  const rs = buildRoute(routeConfigs)
-  if (_indexPath) {
-    const idx2 = rs.pages.findIndex((page) => page.path === _indexPath)
-    if (idx2 !== -1) rs.pages.unshift(...rs.pages.splice(idx2, 1))
-  }
-  logger.info('\u8DEF\u7531\u6587\u4EF6\u89E3\u6790\u5B8C\u6210')
-  if (!rs.condition.list.length) rs.condition = void 0
-  else if (rs.condition.list.length && rs.condition.current === -1)
-    rs.condition.current = 0
-  const idx = rs.pages.findIndex((page) => page['_index'])
-  if (idx !== -1) rs.pages.unshift(...rs.pages.splice(idx, 1))
-  let tabbarObj
-  const [tabbarPath] = loadDirFiles('./src', tabbarName)
-  if (tabbarPath && !isEmpty(tabbarPath)) {
-    logger.info(`\u6839\u636E ${tabbarName} \u627E\u52301\u4E2A\u6587\u4EF6`)
-    tabbarObj = await loadFileContent(tabbarPath)
-    if (tabbarObj && !isEmpty(tabbarObj)) rs.tabBar = tabbarObj
-  }
-  const {
-    debug: _debug = false,
-    pages,
-    subPackages,
-    preloadRule,
-    condition,
-    tabBar,
-    ...otherProps
-  } = await loadJson(pagesPath)
-  const writeContent = {
-    debug: _debug,
-    pages: rs.pages || pages,
-    subPackages: rs.subPackages || subPackages,
-    preloadRule: rs.preloadRule || preloadRule,
-    condition: rs.condition || condition,
-    tabBar: tabbarObj || tabBar,
-    ...otherProps
-  }
-  await outputFile(pagesPath, JSON.stringify(writeContent, null, 2))
-  logger.info('\u8DEF\u7531\u6587\u4EF6\u751F\u6210\u5B8C\u6210\uFF01')
-}
-function buildRoute(content, ext = {}) {
-  const result = {
-    pages: [],
-    subPackages: [],
-    preloadRule: {},
-    condition: {
-      current: -1,
-      list: []
-    }
-  }
-  const { parentName = '', parentPath = '', subpackageRoot = '' } = ext
-  for (const route of content) {
-    const {
-      subPackages = false,
-      isSubpackage = subPackages,
-      path: path2,
-      title,
-      name,
-      children
-    } = route
-    const style = {
-      navigationBarTitleText: title || name || parentName,
-      ...route.style
-    }
-    const _path = pathJoin(parentPath, path2)
-    if (isSubpackage && !subpackageRoot) {
-      let { preLoadPath, preLoadNetwork } = route
-      const { pages, preloadRule, condition } = buildRoute(children ?? [], {
-        parentName: style.navigationBarTitleText,
-        subpackageRoot: _path
-      })
-      const subPackage = {
-        root: _path,
-        pages
-      }
-      result.preloadRule = deepMerge(result.preloadRule, preloadRule)
-      result.condition = deepMerge(result.condition, condition)
-      if (condition.current > -1)
-        result.condition.current = result.condition?.list?.indexOf(
-          condition.list[condition.current]
-        )
-      result.subPackages.push(subPackage)
-      if (preLoadPath) {
-        if (!isArray(preLoadPath)) preLoadPath = [preLoadPath]
-        const preLoadRule = preLoadPath.reduce((acc, cur) => {
-          acc[pathJoin(cur)] = {
-            network: preLoadNetwork,
-            packages: [_path]
-          }
-          return acc
-        }, {})
-        result.preloadRule = deepMerge(result.preloadRule, preLoadRule)
-      }
-      continue
-    }
-    if (children?.length) {
-      const {
-        pages,
-        subPackages: subPackages2,
-        preloadRule,
-        condition
-      } = buildRoute(children, {
-        parentName: style.navigationBarTitleText,
-        parentPath: _path,
-        subpackageRoot
-      })
-      result.pages = deepMerge(result.pages, pages)
-      result.subPackages = deepMerge(result.subPackages, subPackages2)
-      result.preloadRule = deepMerge(result.preloadRule, preloadRule)
-      result.condition = deepMerge(result.condition, condition)
-      if (condition.current > -1)
-        result.condition.current = result.condition?.list?.indexOf(
-          condition.list[condition.current]
-        )
-    } else {
-      const { conditionActive, conditionQuery } = route
-      const item = {
-        path: _path,
-        style
-      }
-      route.isIndex && (_indexPath = _path)
-      result.pages.push(item)
-      if (conditionQuery || conditionActive) {
-        const conditionItem = {
-          name: style.navigationBarTitleText,
-          path: _path,
-          query: conditionQuery
-        }
-        result.condition.list.push(conditionItem)
-        if (conditionActive)
-          result.condition.current =
-            result.condition.list?.indexOf(conditionItem)
-      }
-    }
-  }
-  return result
-}
-var extension = ['.ts', '.js', '.mjs', '.json']
-function loadDirFiles(roots, name, exitByFirst = false) {
-  if (!Array.isArray(roots)) roots = [roots]
-  const files = []
-  for (let root of roots) {
-    root = path.resolve(root)
-    if (!fs.existsSync(root)) continue
-    const stat = fs.statSync(root)
-    const regex = new RegExp(`${name}(${extension.join('|')})$`)
-    if (stat.isFile() && regex.test(root)) {
-      files.push(root)
-      if (exitByFirst) break
-    }
-    if (stat.isDirectory()) {
-      const dirents = fs.readdirSync(root).map((o) => path.resolve(root, o))
-      files.push(...loadDirFiles(dirents, name))
-    }
-  }
-  return files
-}
-function pathJoin(...paths) {
-  return paths.join('/').split('/').filter(Boolean).join('/')
-}
-function deepMerge(target, ...sources) {
-  if (typeof target !== 'object' || target === null) target = {}
-  if (!sources.length) return target
-  for (const source of sources) {
-    if (typeof source !== 'object' || source === null) continue
-    if (isArray(target) && isArray(source)) {
-      const set = /* @__PURE__ */ new Set([...target, ...source])
-      return [...set]
-    } else if (isPlainObject(target) && isPlainObject(source)) {
-      for (const key in source) {
-        if (
-          key in target &&
-          typeof target[key] === 'object' &&
-          typeof source[key] === 'object'
-        ) {
-          target[key] = deepMerge(target[key], source[key])
-        } else {
-          target[key] = source[key] || target[key]
-        }
-      }
-    }
-  }
-  return target
-}
-
-export { builder, builderWithWatch }
+import path from 'node:path'
+import fs from 'node:fs'
+import pino from 'pino'
+import { loadFileContent, loadJson, outputFile } from '@mpilk/mp-shared'
+import { isEmpty, isArray, isPlainObject } from 'lodash-es'
+import chokidar from 'chokidar'
+
+// src/builder.ts
+var _indexPath = ''
+var logger = pino({
+  transport: {
+    target: 'pino-pretty',
+    options: {
+      colorize: true
+      // ignore: 'hostname,pid',
+    }
+  }
+})
+var verboseLogger = logger.child({ verbose: true })
+function builderWithWatch(options) {
+  let timer = null
+  function run() {
+    if (timer) clearTimeout(timer)
+    timer = setTimeout(() => {
+      timer = null
+      return builder(options)
+    }, options?.delay || 200)
+  }
+  return chokidar
+    .watch([
+      `src/**/${options?.routeName || 'route'}.{ts,js}`,
+      `src/${options?.tabbarName || 'tabbar'}.{ts,js}`
+    ])
+    .on('all', (eventName) => {
+      switch (eventName) {
+        case 'add':
+        case 'change':
+        case 'unlink':
+          run()
+          break
+      }
+    })
+}
+async function builder(options = {}) {
+  const {
+    input = './src',
+    routeName = 'route',
+    tabbarName = 'tabbar',
+    pagesPath = './src/pages.json',
+    verbose
+  } = options
+  logger.info('\u5F00\u59CB\u751F\u6210\u8DEF\u7531\u6587\u4EF6...')
+  const filePaths = loadDirFiles(input, routeName)
+  logger.info(
+    `\u6839\u636E ${routeName} \u627E\u5230 ${filePaths.length} \u4E2A\u6587\u4EF6`
+  )
+  const routeConfigs = []
+  for (const filePath of filePaths) {
+    verbose &&
+      verboseLogger.info(`\u5F00\u59CB\u89E3\u6790\u6587\u4EF6 ${filePath}`)
+    let content = await loadFileContent(filePath)
+    if (!content || typeof content !== 'object' || isEmpty(content)) {
+      verbose &&
+        verboseLogger.info(
+          `\u6587\u4EF6 ${filePath} \u4E3A\u7A7A\uFF0C\u8DF3\u8FC7`
+        )
+      continue
+    }
+    if (!isArray(content)) content = [content]
+    verbose &&
+      verboseLogger.info(
+        `\u6587\u4EF6 ${filePath} \u89E3\u6790\u5B8C\u6210\uFF1A${JSON.stringify(
+          content
+        )}`
+      )
+    routeConfigs.push(...content)
+  }
+  const rs = buildRoute(routeConfigs)
+  if (_indexPath) {
+    const idx2 = rs.pages.findIndex((page) => page.path === _indexPath)
+    if (idx2 !== -1) rs.pages.unshift(...rs.pages.splice(idx2, 1))
+  }
+  logger.info('\u8DEF\u7531\u6587\u4EF6\u89E3\u6790\u5B8C\u6210')
+  if (!rs.condition.list.length) rs.condition = void 0
+  else if (rs.condition.list.length && rs.condition.current === -1)
+    rs.condition.current = 0
+  const idx = rs.pages.findIndex((page) => page['_index'])
+  if (idx !== -1) rs.pages.unshift(...rs.pages.splice(idx, 1))
+  let tabbarObj
+  const [tabbarPath] = loadDirFiles('./src', tabbarName)
+  if (tabbarPath && !isEmpty(tabbarPath)) {
+    logger.info(`\u6839\u636E ${tabbarName} \u627E\u52301\u4E2A\u6587\u4EF6`)
+    tabbarObj = await loadFileContent(tabbarPath)
+    if (tabbarObj && !isEmpty(tabbarObj)) rs.tabBar = tabbarObj
+  }
+  const {
+    debug: _debug = false,
+    pages,
+    subPackages,
+    preloadRule,
+    condition,
+    tabBar,
+    ...otherProps
+  } = await loadJson(pagesPath)
+  const writeContent = {
+    debug: _debug,
+    pages: rs.pages || pages,
+    subPackages: rs.subPackages || subPackages,
+    preloadRule: rs.preloadRule || preloadRule,
+    condition: rs.condition || condition,
+    tabBar: tabbarObj || tabBar,
+    ...otherProps
+  }
+  await outputFile(pagesPath, JSON.stringify(writeContent, null, 2))
+  logger.info('\u8DEF\u7531\u6587\u4EF6\u751F\u6210\u5B8C\u6210\uFF01')
+}
+function buildRoute(content, ext = {}) {
+  const result = {
+    pages: [],
+    subPackages: [],
+    preloadRule: {},
+    condition: {
+      current: -1,
+      list: []
+    }
+  }
+  const { parentName = '', parentPath = '', subpackageRoot = '' } = ext
+  for (const route of content) {
+    const {
+      subPackages = false,
+      isSubpackage = subPackages,
+      path: path2,
+      title,
+      name,
+      children
+    } = route
+    const style = {
+      navigationBarTitleText: title || name || parentName,
+      ...route.style
+    }
+    const _path = pathJoin(parentPath, path2)
+    if (isSubpackage && !subpackageRoot) {
+      let { preLoadPath, preLoadNetwork } = route
+      const { pages, preloadRule, condition } = buildRoute(children ?? [], {
+        parentName: style.navigationBarTitleText,
+        subpackageRoot: _path
+      })
+      const subPackage = {
+        root: _path,
+        pages
+      }
+      result.preloadRule = deepMerge(result.preloadRule, preloadRule)
+      result.condition = deepMerge(result.condition, condition)
+      if (condition.current > -1)
+        result.condition.current = result.condition?.list?.indexOf(
+          condition.list[condition.current]
+        )
+      result.subPackages.push(subPackage)
+      if (preLoadPath) {
+        if (!isArray(preLoadPath)) preLoadPath = [preLoadPath]
+        const preLoadRule = preLoadPath.reduce((acc, cur) => {
+          acc[pathJoin(cur)] = {
+            network: preLoadNetwork,
+            packages: [_path]
+          }
+          return acc
+        }, {})
+        result.preloadRule = deepMerge(result.preloadRule, preLoadRule)
+      }
+      continue
+    }
+    if (children?.length) {
+      const {
+        pages,
+        subPackages: subPackages2,
+        preloadRule,
+        condition
+      } = buildRoute(children, {
+        parentName: style.navigationBarTitleText,
+        parentPath: _path,
+        subpackageRoot
+      })
+      result.pages = deepMerge(result.pages, pages)
+      result.subPackages = deepMerge(result.subPackages, subPackages2)
+      result.preloadRule = deepMerge(result.preloadRule, preloadRule)
+      result.condition = deepMerge(result.condition, condition)
+      if (condition.current > -1)
+        result.condition.current = result.condition?.list?.indexOf(
+          condition.list[condition.current]
+        )
+    } else {
+      const { conditionActive, conditionQuery } = route
+      const item = {
+        path: _path,
+        style
+      }
+      route.isIndex && (_indexPath = _path)
+      result.pages.push(item)
+      if (conditionQuery || conditionActive) {
+        const conditionItem = {
+          name: style.navigationBarTitleText,
+          path: _path,
+          query: conditionQuery
+        }
+        result.condition.list.push(conditionItem)
+        if (conditionActive)
+          result.condition.current =
+            result.condition.list?.indexOf(conditionItem)
+      }
+    }
+  }
+  return result
+}
+var extension = ['.ts', '.js', '.mjs', '.json']
+function loadDirFiles(roots, name, exitByFirst = false) {
+  if (!Array.isArray(roots)) roots = [roots]
+  const files = []
+  for (let root of roots) {
+    root = path.resolve(root)
+    if (!fs.existsSync(root)) continue
+    const stat = fs.statSync(root)
+    const regex = new RegExp(`${name}(${extension.join('|')})$`)
+    if (stat.isFile() && regex.test(root)) {
+      files.push(root)
+      if (exitByFirst) break
+    }
+    if (stat.isDirectory()) {
+      const dirents = fs.readdirSync(root).map((o) => path.resolve(root, o))
+      files.push(...loadDirFiles(dirents, name))
+    }
+  }
+  return files
+}
+function pathJoin(...paths) {
+  return paths.join('/').split('/').filter(Boolean).join('/')
+}
+function deepMerge(target, ...sources) {
+  if (typeof target !== 'object' || target === null) target = {}
+  if (!sources.length) return target
+  for (const source of sources) {
+    if (typeof source !== 'object' || source === null) continue
+    if (isArray(target) && isArray(source)) {
+      const set = /* @__PURE__ */ new Set([...target, ...source])
+      return [...set]
+    } else if (isPlainObject(target) && isPlainObject(source)) {
+      for (const key in source) {
+        if (
+          key in target &&
+          typeof target[key] === 'object' &&
+          typeof source[key] === 'object'
+        ) {
+          target[key] = deepMerge(target[key], source[key])
+        } else {
+          target[key] = source[key] || target[key]
+        }
+      }
+    }
+  }
+  return target
+}
+
+export { builder, builderWithWatch }