Skip to content
文章目录

项目模板cli

项目地址

源码仓库: @pzy915/front-template-cli

npm 地址: @pzy915/front-template-cli

作用

解决常见的项目搭建问题,以模板方式快速完成项目初始创建,用最短的时间进入项目功能开发状态

解决以下项目搭建的常见问题

  • 整合了 eslint 进行静态代码检查,再也不用在网上到处找 eslint 的配置方式了
  • 整合了 perttier 统一项目成员之间的代码格式化风格,同时和 eslint 进行了整合,再也不用为 eslint 与 pretter 整合而烦恼了
  • 项目成员之间 git commit 的风格各种各样,项目模板中整合了 commitlint 强制了 git commit 风格,大家就能很快的抓住 commit 中的重点了
  • changelog 让大家都知道我们这个版本做了哪些变更,拒绝懵逼,从有 changelog 开始
  • pc 端开发常用的 element-plus,移动端开发常用的 vant,统统分模板整合进来了,再也不用花大量的时间去解决没什么实际收益的框架整合问题了
  • mock 数据不求人,后端接口数据导致前端报错,但让后端再弄一份同样的数据过来,可能很难。前端界面开发完毕之后,需要后端数据验证验证前端逻辑是否通畅,可后端大佬正在忙别的或接口还在火速开发中。以上场景都需要 mock,mock,mock,所有项目模板中都整合了 mock 功能,让 mock 不再是痛点而是爽点。
  • 组件开发,组件打包, 组件发布怎么做? 这些在项目模板中也都给你解决了,你只要关注功能开发,最后稍微改点配置就能愉快的进行组件发布了
  • 有组件无文档?这个组件确定是给人用的?文档库怎么搭建?项目模板也贴心的为你解决了,只要你会写 markdown 文档就行。

安装

npm uninstall -g @pzy915/front-template-cli
npm install -g @pzy915/front-template-cli

使用

  1. 全局安装完毕后,命令行输入ftc
  2. 然后按提示输入项目名
  3. 然后在列表中选择项目模板
  4. 完成项目创建

原理

  1. 使用inquirer,获取用户输入的项目名
  2. 使用inquirer,获取用户选择的模板类型
  3. 使用download-git-repo, 从开源仓库中下载项目模板到指定目录