介绍

苦于一直当业务牛马，在前端已死的2024年，趁还能学想写点自己的东西。早期写过一点比较简单且功能单一的cli工具，如 @mr.mikey/create-husky ，某天机缘巧合之下在 Github 上刷到Sam老师的 imooc-cli 脚手架，觉得非常符合我当下需要，于是找了一些零零散散的教程和视频尝试复刻一个属于自己的前端脚手架，在这个背景下 cjp-cli-dev 诞生了。

以下内容由AI生成，人工微调，随便看看就好。

AI：？

直接查看 快速上手 。

脚手架介绍

为前端开发设计的多功能开发工具，旨在简化日常开发工作流程，提高开发效率和代码质量。脚手架集成了从项目初始化、发布、回滚、版本管理、代码质量校验、git提交规范校验等一系列功能，让开发者能够专注于编写高质量代码，而不是花费大量时间在繁琐的项目配置上。

痛点分析

• 创建项目/组件库时，存在大量重复代码拷贝
• 协同开发时，由于git操作不规范导致分支混乱，操作耗时
• 发布上线流程复杂又耗时，且人工操作容易出现各种错误
• 人工回滚版本操作复杂耗时

痛点解决：实现通用的研发脚手架

• 通用的项目、组件库创建能力，快速复用已有沉淀

  • 模板支持快速接入，极低的接入成本
  • 模板支持定制，定制后能够快速接入

• 通用的项目、组件库发布能力，制定标准的上线流程和规范并集成到脚手架

  • 发布过程自动完成标准的git操作
  • 发布成功后自动删除开发分支并创建发布版本tag
  • 发布后自动完成云构建、OSS上传、CDN上传、域名绑定
  • 发布过程支持测试、正式发布

• 通用的项目、组件库回滚能力，快速回滚版本

  • 快速回滚生产版本，备份master分支代码

核心命令介绍

• init：

快速创建模板：支持默认项目模板、自定义项目模板和组件库模板的快速创建。

自动安装与启动：模板创建后，自动安装依赖并启动项目，让开发者立即进入开发状态。

• publish：

一键发布：支持测试发布和正式发布，简化发布流程。

云构建与发布：支持云端构建项目，采用Redis管理构建任务，发布完成后自动清除缓存，提升发布效率。

Git Flow自动化：自动管理Git Flow分支，包括创建仓库、构建、发布等。

• add：

快速添加模板：支持组件代码片段、标准页面和自定义页面模板的快速添加。

自动代码写入：组件代码自动写入指定位置，并自动导入注册局部组件。

• rollback：

快速回滚：支持生产版本快速回滚，确保项目稳定性。

本地构建回滚版本：自动构建并回滚到指定版本。

提示

查看 核心命令使用说明

更多命令介绍

• husky：

Git Hooks配置：快速为项目安装Git Hooks配置工具，确保代码提交前进行必要的检查。

• codelint：

代码规范校验：支持eslint、prettier、lint-staged等工具，确保代码风格统一。

仅校验暂存文件：提高校验效率，仅针对暂存文件进行校验。

• commitlint：

提交信息规范：采用Angular提交规范，确保提交信息清晰明了。

汉化版终端交互：提供汉化版终端交互工具，方便中文用户操作。

• release：

自动升级版本：快速自动升级项目版本，减少手动操作。

生成变更记录：自动生成git变更记录文档，方便版本管理。

• gitflow：

创建Git Flow模型：快速为项目创建Git Flow分支模型，提升团队协作效率。

工具检查与帮助：自动检查系统是否安装对应工具，并提供帮助文档。

• delete-branch：

快速删除分支：支持多选删除本地和远端分支，简化分支管理。

• clean：

清除缓存：支持清除脚手架依赖缓存或全部缓存文件，保持开发环境整洁。

• resume：

创建简历：提供前端markdown简历模板，支持导出one-light主题样式PDF，方便快速制作专业简历。

• server：

本地页面预览服务：启动本地页面预览服务，支持http请求代理，支持代理多个服务器。

提示

查看 其他命令使用说明

愿景

打造一个功能全面、高效便捷、易于上手的前端脚手架工具，成为前端开发者不可或缺的开发助手。未来将持续优化现有功能，提升用户体验，并不断探索和引入新的开发技术和工具，以满足日益增长的前端开发需求。同时也欢迎广大开发者提出宝贵的意见和建议，共同推动脚手架工具不断向前发展，为前端开发领域贡献更多的力量。