umi-project-utils
v0.2.0
Published
Umi 项目工具库,提供解析 Umi 运行时生成文件等实用功能。
Readme
umi-project-utils
Umi 项目工具库,提供解析 Umi 运行时生成文件等实用功能。
安装
npm install umi-project-utils使用
parseUmiRoute
解析 Umi 生成的 src/.umi/core/route.tsx 文件,提取 routes 和 routeComponents 并合并为完整的路由信息。
import { parseUmiRoute } from 'umi-project-utils';
const routes = await parseUmiRoute({ cwd: '/path/to/umi-project' });
// 输出示例:
// {
// '1': { path: '/', id: '1', component: '@/layout/index.tsx' },
// '2': { path: '/foo', id: '2', name: 'Foo', parentId: '1', component: '@/pages/Foo/index.tsx' },
// }参数
| 参数 | 类型 | 默认值 | 说明 |
| ---- | ---- | ------ | ---- |
| cwd | string | process.cwd() | Umi 项目根目录 |
返回值
Promise<Record<string, UmiRoute>>,其中 UmiRoute 类型定义:
interface UmiRoute {
path: string;
id: string;
name?: string;
parentId?: string;
component?: string; // 从 React.lazy(() => import('...')) 中提取的导入路径
}开发
# 运行测试
npm test
# 构建
npm run buildLicense
MIT
