create-component-template-cli
v1.0.3
Published
create-vue-component-template-cli,A CLI tool for creating standardized Vue 3 + TypeScript + Sass public component templates.
Downloads
492
Readme
create-component-template-cli
一个用于快速创建 Vue 3 + TypeScript + Sass 组件骨架的 CLI 工具。
使用方式
# 通过包名直接执行(适合 npm / npx 用户)
npx create-component-template-cli --version
npx create-component-template-cli
# 通过短命令执行
npx cctc --version
npx cctc
# 本地开发调试
node bin/cli.mjs
# 非交互模式
node bin/cli.mjs --name=MyComponent --rootPath=src/components/platform
# 指定业务模板类型
node bin/cli.mjs --name=MyComponent --rootPath=src/components/platform --templateType=single-pick
# 指定 index.vue 的 Vue 写法
node bin/cli.mjs --name=MyComponent --rootPath=src/components/platform --templateType=multiple-pick --vueTemplateType=normal参数说明
| 参数 | 必填 | 默认值 | 说明 |
| --- | --- | --- | --- |
| --name | 是(非交互) | - | 组件名称,PascalCase |
| --rootPath | 是(非交互) | - | 输出目录 |
| --templateType | 否 | general | 业务模板类型:general / single-pick / multiple-pick |
| --vueTemplateType | 否 | setup | index.vue 的 Vue 风格:setup / normal |
| --collisionStrategy | 否 | skip | 目录冲突策略:skip / overwrite |
| --nonInteractive | 否 | false | 缺少必填参数时直接报错,不进入交互模式 |
模板规则
templateType只控制业务模板类型。vueTemplateType只控制index.vue的 Vue 写法。- 无论选择哪种 Vue 风格,最终生成的文件名始终是
src/index.vue。
生成目录结构
{rootPath}/{ComponentName}/
├── index.ts
└── src/
├── index.vue
├── index.scss
├── typing.ts
├── hook.ts
└── data.ts