jpaas-pms-web-project-create

Jpaas PMS 前端项目脚手架 CLI 工具，用于快速创建基于 Vue3 + Ant Design Vue 的前端项目。

安装

# 使用 npm create（推荐）
npm create jpaas-pms-web-project@latest my-project

# 使用 pnpm
pnpm create jpaas-pms-web-project my-project

# 使用 yarn
yarn create jpaas-pms-web-project my-project

# 或直接运行 npx
npx create-jpaas-pms-web-project@latest my-project

使用方式

交互式创建

npm create jpaas-pms-web-project@latest

按照提示输入项目名称、描述、作者等信息。

快速创建（非交互模式）

npm init jpaas-pms-web-project@latest my-project -y

指定 Git 分支

npm init jpaas-pms-web-project@latest my-project -y -b feature/f2.0.0.0

使用自定义 Git 仓库

npm init jpaas-pms-web-project@latest my-project -r https://github.com/your-org/your-template.git

命令选项

| 参数 | 说明 | 默认值 | |------|------|--------| | -r, --repo <repo> | Git 模板仓库地址 | https://cnb.cool/weaibot/jpaas-portal/jpaas-pms-web | | -b, --branch <branch> | Git 分支名称 | 默认分支 | | -y, --yes | 跳过交互式提示 | - | | -d, --description <desc> | 项目描述 | - | | -a, --author <author> | 作者名称 | - | | --skip-install | 跳过依赖安装 | - |

更新系统模块

创建的项目包含 __sys_modules 目录，可通过以下命令更新到最新版本：

npm run update:sys

该命令会从 Git 仓库拉取最新的 __sys_modules 代码并覆盖本地版本。

指定 Git 分支更新

支持通过命令行参数指定分支、tag 或 commit：

# 更新到指定分支
npm run update:sys -- --branch feature/new-module

# 简写形式
npm run update:sys -- -b feature/new-module

# 更新到指定 tag
npm run update:sys -- -b v1.2.0

注意：-- 是必须的，用于将参数传递给脚本。默认使用创建项目时指定的分支。

自动更新（可选）

如需在每次启动开发服务器前自动更新，可在项目的 package.json 中添加：

{
  "scripts": {
    "predev": "npm run update:sys"
  }
}

开发

本地开发

# 安装依赖
npm install

# 构建项目
npm run build

# 本地测试
node dist/index.js my-test-project -y

发布到 npm

# 登录 npm
npm login

# 发布
npm publish

模板占位符

在模板文件中可以使用以下占位符，CLI 会自动替换：

| 占位符 | 说明 | |--------|------| | {{projectName}} | 项目名称 | | {{description}} | 项目描述 | | {{author}} | 作者 |

示例 package.json:

{
  "name": "{{projectName}}",
  "description": "{{description}}",
  "author": "{{author}}"
}

License

MIT