create-hkust-demo-vue3
v0.1.4
Published
CLI to scaffold a Vue 3 + Vite demo with optional dependencies (ECharts, moment, dayjs)
Maintainers
Readme
create-hkust-demo-vue3
一个可交互的脚手架,用于创建 Vue3 + Vite Demo 项目,并在初始化时可选择安装第三方依赖(ECharts、moment、dayjs)。
使用方式
发布到 npm 后,直接使用:
npx create-hkust-demo-vue3
# 或:
npm init hkust-demo-vue3支持参数:
--pm指定包管理器(npm、yarn、pnpm),默认自动检测- 第一个无标签参数作为项目名,例如:
npx create-hkust-demo-vue3 my-app -y/--yes自动安装依赖,但仍保留“可选依赖”交互选择;若希望完全无交互,请搭配--features指定依赖
运行后会出现交互式选项:
- 项目名称
- 可选依赖(勾选 ECharts / moment / dayjs)
- 是否自动安装依赖
示例
- 交互选择依赖并自动安装:
npx create-hkust-demo-vue3 my-app -y - 非交互指定依赖并自动安装:
npx create-hkust-demo-vue3 my-app --features echarts,dayjs -y - 指定包管理器(自动检测不满足时):
npx create-hkust-demo-vue3 my-app --pm pnpm -y - 交互选择依赖但跳过自动安装:
npx create-hkust-demo-vue3 my-app --yes=false
模板说明
模板使用 TypeScript、Vite、Vue3,包含基础页面:
src/App.vue:预留占位符,若你在初始化时选择 ECharts,CLI 会自动在此插入ChartDemo组件导入与使用。src/components/ChartDemo.vue:ECharts 示例组件。
若你选择安装 moment 或 dayjs,CLI 会帮你安装依赖,但默认模板不强制引用它们,你可以按需在代码中引入。
开发本 CLI
在本地测试(开发者):
# 进入脚手架包目录
cd create-hkust-demo-vue3
# 链接到全局,便于调试
npm link
# 测试使用
create-hkust-demo-vue3 my-test-app发布到 npm:
# 修改 package.json 的版本号
npm version patch
# 登录并发布
npm login
npm publish --access public许可证
MIT
