超好用项目代码模版管理脚手架~

2024-05-10 13:52

本文主要是介绍超好用项目代码模版管理脚手架~,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

introduction

最近开发并且开源了一款管理项目模板的脚手架cooker-cli,可以帮助你管理你的项目代码模版。

具体介绍如下,

cooker-cli

cooker-cli 能够快速生成你能想象得到的各种模版项目:

  • 前端:vue2, vue3, react, mini-program...

  • 客户端: iOSAndroid...

  • 后端:JavaPHPGo...

  • ...

Install

$ npm install -g cooker-cli

What

这个脚手架的用途是帮助你管理模版项目,模版项目需要你自己在模版库中DIY,从而在后续的使用中快速生成你要的模版项目。

Why

根据以往业务的经验,即使在这个脚手架中提供了模版,也满足不了大多数人的需求。因为对于日益更新的技术栈,项目可以有多种多样的库搭配组合,排列组合之下,产出的模版何其多也(^o^)/~

并且即使有提供了模版,如果不能持续迭代,要不了多久,也就废弃了。所以,不如将这个功能放给使用者,这样可以使用者可以DIY项目模版,方便随时调整和迭代,从而不被脚手架所限制。

Example

  • 创建项目-演示使用

$ cooker-cli create <project-name>
✔ 正在获取模版列表...
? 选择你要的模版 (Use arrow keys)
❯ h5-template-vue (h5的vue项目模版)h5-template-react (h5的react项目模版)pc-template-vue (pc的vue项目模版)pc-template-react (pc的react项目模版)minProgram-template (小程序项目模版)----------------------------------
? 选择你要的模版 h5-template-vue (h5的vue项目模版)
✔ 正在获取模版版本信息...
? 选择你要的模版版本 (Use arrow keys)
❯ vue2-jsvue2-vuex-jsvue3-jsvue3-ts----------------------------------⠏ 正在下载资源...----------------------------------
✔ 下载完成~
  • 配置你自己的模版

    1.如果你使用github或者gitee来存放你的模板库,可以按照以下流程配置

    2.如果你使用本地私有gitlab来存放你的模板库,可以在gitlab库中创建一个组(group),在这个组(group)中存放你的模板集合,跳过步骤1、步骤2.。

    Tip:组id(groupId)为作为脚手架配置项gitlabGroupId

    • 1.你需要拥有一个github/gitee账号

    • 2.注册组织机构账号,在github/gitee账号内即可免费注册完成

      • 步骤如下

      • create new... --> New Organizational --> 后面按照提示完成注册即可(该操作为github,gitee也有类似方方式创建)

      • 得到机构名称 => 为了方便,统一称作 org

    • 3.在你创建的机构下,创建你的模版,这个创建的模版你将在这里看到

      这里的模版可以理解为模版大类,比如pc的vue项目、pc的react项目、h5的vue项目、h5的react项目、小程序项目

      ✔ 正在获取模版列表...
      ? 选择你要的模版 (Use arrow keys)
      ❯ h5-template-vue (h5的vue项目模版)h5-template-react (h5的react项目模版)pc-template-vue (pc的vue项目模版)pc-template-react (pc的react项目模版)minProgram-template (小程序项目模版)
    • 4.按照你自己的分类创建完成多个模版以后,进入其中一个模版项目,

    • 5.此时,你可以通过分支(branches)或者标记(tags)来创建模版对应的多个版本,你将在这里看到

      这里的模版版本可以理解为模版大类下的细分,比如pc的vue项目大类下,分为:vue2项目、vue3项目、使用vuex的项目、使用ts的项目等等,可以更加实际业务场景自己去细分

      ? 选择你要的模版版本 (Use arrow keys)
      ❯ vue2-jsvue2-vuex-jsvue3-jsvue3-ts
    • 6.做完以后操作以后,你就可以去修改cooker-cli的配置文件了,在开始之前可以先了解一下内容

      查看配置信息: cooker-cli config -show 修改配置信息: cooker-cli config --set <key> <value>

      恢复默认配置信息: cooker-cli config --reset

    • 7.1如果你使用github/gitee,将配置中的组织名称,修改成你自己创建的org

      # organization-name 默认值: niu-fly,为演示项目
      $ cooker-cli config --set=org <your github organization-name>
    • 7.2如果你使用gitlab,将你的组(group)的id,配置到脚手架中

      # organization-name 默认值: niu-fly,为演示项目
      $ cooker-cli config --set=gitlabGroupId <your gitlab groupId>
    • 8.如果你在步骤5中采用tags来管理版本,那么你需要进行下面的配置

      # mode 默认值: branches
      $ cooker-cli config --set=mode tags
    • 9.如果你使用gitee,那么你需要在gitee界面,生成你的access-token,配置到脚手架中

      $ cooker-cli config --set=giteeToken <your gitee access-token>
    • 10.如果你使用github/gitee,做完以上操作,就已经完成了所有配置。你可以自由搭建的模版库了(^o^)/~

    • 11.如果你使用本地gitlab,还需要完成一下配置

      # 配置本地gitlab域名
      $ cooker-cli config --set=gitlabDomain <your gitlab Domain>
      # 配置本地gitlab域名
      $ cooker-cli config --set=gitlabDomain <your gitlab Domain>
      # 配置本地gitlab-token
      $ cooker-cli config --set=gitlabToken <your gitlab token>
    • 12.所有配置都已完成,恭喜(^o^)/~

Usage

Usage: cooker-cli <command> [option]
​
用于创建一个模版前端项目
​
Options:-V, --version                output the version number-h, --help                   display help for command
​
Commands:create [options] <app-name>  开始创建项目,项目名称<app-name>config [options] [value]     添加、修改、删除配置项help [command]               display help for command
​
Run cooker-cli <command> --help 查看更多命令信息

Feat

  1. ✅ 支持github

  2. ✅ 支持gitee

  3. ✅ 支持gitlab

TODO

...

Resource

  • GitHub - super-Sun/cooker-cli: 脚手架,快速创建模版项目

LICENSE

MIT

[npm]  https://img.shields.io/npm/v/cooker-cli.svg 

[npm-url]  https://npmjs.com/package/cooker-cli 

[node]  https://img.shields.io/node/v/cooker-cli.svg 

[node-url]  https://nodejs.org 

这篇关于超好用项目代码模版管理脚手架~的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/976623

相关文章

Java的栈与队列实现代码解析

《Java的栈与队列实现代码解析》栈是常见的线性数据结构,栈的特点是以先进后出的形式,后进先出,先进后出,分为栈底和栈顶,栈应用于内存的分配,表达式求值,存储临时的数据和方法的调用等,本文给大家介绍J... 目录栈的概念(Stack)栈的实现代码队列(Queue)模拟实现队列(双链表实现)循环队列(循环数组

springboot项目如何开启https服务

《springboot项目如何开启https服务》:本文主要介绍springboot项目如何开启https服务方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录springboot项目开启https服务1. 生成SSL证书密钥库使用keytool生成自签名证书将

HTML5中的Microdata与历史记录管理详解

《HTML5中的Microdata与历史记录管理详解》Microdata作为HTML5新增的一个特性,它允许开发者在HTML文档中添加更多的语义信息,以便于搜索引擎和浏览器更好地理解页面内容,本文将探... 目录html5中的Mijscrodata与历史记录管理背景简介html5中的Microdata使用M

Spring 基于XML配置 bean管理 Bean-IOC的方法

《Spring基于XML配置bean管理Bean-IOC的方法》:本文主要介绍Spring基于XML配置bean管理Bean-IOC的方法,本文给大家介绍的非常详细,对大家的学习或工作具有一... 目录一. spring学习的核心内容二. 基于 XML 配置 bean1. 通过类型来获取 bean2. 通过

将Java项目提交到云服务器的流程步骤

《将Java项目提交到云服务器的流程步骤》所谓将项目提交到云服务器即将你的项目打成一个jar包然后提交到云服务器即可,因此我们需要准备服务器环境为:Linux+JDK+MariDB(MySQL)+Gi... 目录1. 安装 jdk1.1 查看 jdk 版本1.2 下载 jdk2. 安装 mariadb(my

使用Java将DOCX文档解析为Markdown文档的代码实现

《使用Java将DOCX文档解析为Markdown文档的代码实现》在现代文档处理中,Markdown(MD)因其简洁的语法和良好的可读性,逐渐成为开发者、技术写作者和内容创作者的首选格式,然而,许多文... 目录引言1. 工具和库介绍2. 安装依赖库3. 使用Apache POI解析DOCX文档4. 将解析

C++使用printf语句实现进制转换的示例代码

《C++使用printf语句实现进制转换的示例代码》在C语言中,printf函数可以直接实现部分进制转换功能,通过格式说明符(formatspecifier)快速输出不同进制的数值,下面给大家分享C+... 目录一、printf 原生支持的进制转换1. 十进制、八进制、十六进制转换2. 显示进制前缀3. 指

Node.js 数据库 CRUD 项目示例详解(完美解决方案)

《Node.js数据库CRUD项目示例详解(完美解决方案)》:本文主要介绍Node.js数据库CRUD项目示例详解(完美解决方案),本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考... 目录项目结构1. 初始化项目2. 配置数据库连接 (config/db.js)3. 创建模型 (models/

python uv包管理小结

《pythonuv包管理小结》uv是一个高性能的Python包管理工具,它不仅能够高效地处理包管理和依赖解析,还提供了对Python版本管理的支持,本文主要介绍了pythonuv包管理小结,具有一... 目录安装 uv使用 uv 管理 python 版本安装指定版本的 Python查看已安装的 Python

springboot项目中常用的工具类和api详解

《springboot项目中常用的工具类和api详解》在SpringBoot项目中,开发者通常会依赖一些工具类和API来简化开发、提高效率,以下是一些常用的工具类及其典型应用场景,涵盖Spring原生... 目录1. Spring Framework 自带工具类(1) StringUtils(2) Coll