初始化

终端执行 vue-pkg 命令进行初始化：

$ vue-pkg


 ██╗   ██╗ ██╗   ██╗ ███████╗        ██████╗  ██╗  ██╗  ██████╗
 ██║   ██║ ██║   ██║ ██╔════╝        ██╔══██╗ ██║ ██╔╝ ██╔════╝
 ██║   ██║ ██║   ██║ █████╗   █████╗ ██████╔╝ █████╔╝  ██║  ███╗
 ╚██╗ ██╔╝ ██║   ██║ ██╔══╝   ╚════╝ ██╔═══╝  ██╔═██╗  ██║   ██║
  ╚████╔╝  ╚██████╔╝ ███████╗        ██║      ██║  ██╗ ╚██████╔╝
   ╚═══╝    ╚═════╝  ╚══════╝        ╚═╝      ╚═╝  ╚═╝  ╚═════╝


版本: 0.0.6

? 选择模板: (Use arrow keys)
❯ Vue 组件库标准版      # 组件库 与 完备的文档
  Vue 组件库极简文档版   # 组件库 与 简版的文档
  敬请期待…

请输入安装路径: (默认当前目录 ./)pkg1-dir
请输入包名: pkg1
写入: /xxxx.cjs
# ...
写入: /xxx.js

安装成功

请执行:
cd /Users/xxx/pkg1-dir
npm install

内部会初始化 Git，并在项目写入 Git 用户信息，以及配置工程基座，包括：

• prettier
• eslint
• commitlint
• postcss
• husky
• lint staged
• vscode 配置

实现更精准的控制 lint 阶段的 git hook。

命令

TIP

以下命令适应于 Vue 组件开发。

• npm run dev：组件开发模式。脱离文档环境。
• npm run docs:dev：组件文档开发环境。推荐。
• npm run build：保证类型安全，并构建 esm/cjs 组件库产物。默认package.json 入口自动配置好。
• npm run docs:build：构建组件文档，产物可独立运行在浏览器。
• npm run format：手动格式化代码。默认会自动格式化，不需要手动触发。