CN116204199B - 基于命令行的项目管理方法、系统、设备及存储介质 - Google Patents

Abstract

本申请公开了项目模板管理方法、系统、设备及计算机可读存储介质。根据本申请的技术方案，该方法包括：依据收到的命令行，进行项目新建、项目运行、项目构建或项目升级；项目新建包括：判断本地是否存在可用模板，不存在则先下载模板到本地，读取模板信息，根据用户的输入和选择，配置项目，执行依赖库安装，完成项目新建；所述模板为项目镜像；项目运行包括：读取配置文件，匹配技术栈配置和构建工具配置，执行项目运行；项目构建包括：读取配置文件，匹配技术栈配置和构建工具配置，执行项目构建；项目升级包括：对现有项目的依赖库升级或重写配置文件，实现对旧模板创建的项目进行升级。

Description

基于命令行的项目管理方法、系统、设备及存储介质

技术领域

本申请涉及软件项目管理领域，更具体地说，涉及基于命令行的项目管理方法、系统、设备及存储介质。

背景技术

随着业务规模的扩大，技术项目的数量越来越多，为了更方便的创建模板化的工程，脚手架工具的产生显得尤为重要。每个公司技术团队的技术选型，代码标准以及部署策略都不同，开源的工具虽然可以直接使用，却无法兼顾团队和业务的特点，最终导致每个团队都有自己的一套命令行工具，无法形成内部的统一标准。

在现有的技术实现中，每个技术栈的命令行工具，都维护了当前技术栈的一套或多套项目模板，提供用户从当前模板新建技术项目的功能。对新建的技术项目的操作一般包括：开发模式下的运行功能、发布前的构建功能、基于eslint标准配置的代码校验功能和自定义项目配置功能。普遍存在以下问题：

1.只提供了新建项目功能，对现有项目接入需要改造。

2.对已创建项目缺少维护功能，多个项目更新成为重复工作量问题。

3.只针对特定技术栈提供模板项目，不能跨技术栈运行和管理项目。

4.调用方式一般是项目内安装或者全局安装，使用方式欠灵活。

5.构建方式单一，使用者无法自主选择构建工具。

因此，如何克服上述技术缺陷成为本领域需要解决的技术问题。

发明内容

有鉴于此，本申请提出了项目模板管理方法、系统、设备及计算机可读存储介质，以实现通用的项目管理。

根据本申请，提出了一种基于命令行的项目管理方法，所述方法包括：依据收到的命令行，进行项目新建、项目运行、项目构建或项目升级；其中，

所述项目新建包括：判断本地是否存在可用模板，不存在则先下载模板到本地，读取模板信息，根据用户的输入和选择，配置项目，执行依赖库安装，完成项目新建；所述模板为项目镜像；

所述项目运行包括：读取配置文件，匹配技术栈配置和构建工具配置，执行项目运行；

所述项目构建包括：读取配置文件，匹配技术栈配置和构建工具配置，执行项目构建；

所述项目升级包括：对现有项目的依赖库升级或重写配置文件，实现对旧模板创建的项目进行升级。

优选的，所述项目新建的处理过程具体包括：

当收到init命令时，根据目录+文件名的方式判断本地是否存在可用模板，不存在则先下载模板到本地；

读取本地的模板信息，接收用户输入的项目名称，提供配置项目信息和包管理工具选择列表，根据用户的选择结合项目名称，将模板及配置项目信息拷贝到当前目录的项目名称路径下；

执行依赖库安装，完成项目新建。

优选的，所述配置文件包括构建方式参数build字段和技术栈类型参数view字段。

优选的，所述配置文件还包括自定义配置信息。

优选的，所述项目运行的处理过程具体包括：

当收到dev命令时，读取项目本地的配置文件的信息并和自定义配置信息进行合并，根据view字段确定技术栈，根据build字段确定构建工具，完成运行项目运行，启动本地服务实现页面访问。

优选的，所述项目构建的处理过程具体包括：

当收到pub命令时，读取项目本地的配置文件并和项目中自定义配置信息进行合并，根据view字段确定技术栈，根据build字段确定构建工具，生成静态资源文件夹，用于部署后访问。

优选的，所述项目升级的处理过程具体包括：

当收到fix命令时，读取命令中的参数，如果读取到-c参数，从项目镜像中获取配置文件，并对本地的配置文件重写；如果读取到-p参数，从项目镜像中获取依赖库，重写本地的描述文件并重新安装依赖库。

根据本申请的再一方面，提供了一种基于命令行的项目管理系统，所述系统包括：项目新建模块、项目运行模块、项目构建模块和项目升级模块；其中，

所述项目新建模块，用于判断本地是否存在可用模板，不存在则先下载模板到本地，读取模板信息，根据用户的输入和选择，配置项目，执行依赖库安装，完成项目新建；

所述项目运行模块，用于读取配置文件，匹配技术栈配置和构建工具配置，执行项目运行；

所述项目构建模块，用于读取配置文件，匹配技术栈配置和构建工具配置，执行项目构建；

所述项目升级模块，用于对现有项目的依赖库升级或重写配置文件，实现对旧模板创建的项目进行升级。

本申请还提供了一种计算机设备，包括存储器、处理器及存储在所述存储器上并可在所述处理器上运行的计算机程序，其特征在于，所述处理器执行所述计算机程序时实现上述项目模板管理方法。

本申请还提供了一种计算机可读存储介质，其特征在于，所述计算机可读存储介质存储有计算机程序，所述计算机程序当被处理器执行时使所述处理器执行项目模板管理方法。

根据本申请的技术方案，通过统一的命令，可以启动所有项目，不必关注使用的技术栈和构建工具，均可使用同样的命令进行运行和构建。可以方便的添加自定义模板，只需要提供模板地址和本地别名。可以快速对现有进行升级更新，无需关注依赖兼容性和升级细节。本申请的技术方案集成了常用的开发工具，可以直接使用。

本申请的其它特征和优点将在随后的具体实施方式部分予以详细说明。

附图说明

构成本申请的一部分的附图用来提供对本申请的进一步理解，本申请的示意性实施方式及其说明用于解释本申请。在附图中：

图1为本申请的项目模板管理方法组成框图；

图2为根据本申请优选实施方式的项目新建流程图；

图3为根据本申请优选实施方式的项目构建流程图；

图4为配置文件目录结构示意图；

图5为自定义模板命令功能列表；

图6为根据本申请优选实施方式的项目升级流程图；

图7为项目升级命令功能列表；

图8为项目升级命令配置示意图；

图9为本申请的项目模板管理方法命令功能列表。

具体实施方式

名词解释：

命令行界面(command-line interface，缩写：CLI)是在图形用户界面得到普及之前使用最为广泛的用户界面，它通常不支持鼠标，用户通过键盘输入指令，计算机接收到指令后，予以执行。也有人称之为字符用户界面(CUI)，在前端也叫脚手架工具。

Node.js：基于Chrome V8引擎的javascript运行环境，发布于2009年5月，由RyanDahl开发，是一个基于引擎的JavaScript运行环境，使用了一个事件驱动、非阻塞式I/O模型，基于Chrome JavaScript运行时建立的平台，用于方便地搭建响应速度快、易于扩展的网络应用

NPM：Node Package Manager，是一个NodeJS包管理和分发工具，已经成为了非官方的发布Node模块(包)的标准。为防止包重名，一般使用私有域前缀，如：@xxx/packageName

技术栈：IT术语，某项工作或某个职位需要掌握的一系列技能组合的统称。

本方案的主要思路：通过每个项目中定制配置文件，在命令行工具中进行读取。根据配置的不同技术栈类型和不同构建工具，调用不同的配置文件和项目中自定义的配置进行合并，从而进行项目管理。

因为项目固有的配置文件方式和依赖库文件的固定命名，可以读取这些文件和项目模板中的文件进行对比，快速应用到项目中，做到快速接入和依赖维护。

通过维护本地的配置文件，可拓展支持模板种类。模板项目只需要拥有符合要求的配置文件即可接入工具使用。相当于默认模板，自定义模板需要提供一个私有域前缀，以防止模板重名。

下面将参考附图并结合实施方式来详细说明本申请的技术方案。

实施例1

如图1所示，本发明的实施例1提供了一种基于命令行的项目管理方法，该方法包括：依据收到的命令行，进行项目新建、项目运行、项目构建或项目升级等；其中，

项目新建包括：判断本地是否存在可用模板，不存在则先下载模板到本地，读取模板信息，根据用户的输入和选择，配置项目，执行依赖库安装，完成项目新建；所述模板为项目镜像；

如图2所示，通过init命令新建项目，会判断本地是否存在可用的模板，如果不存在则会先下载模板到本地，再读取本地可用模板作为列表显示以供选择。本申请所述的模板即项目镜像。

项目名称需要用户主动输入，配置项目信息和包管理工具选择都会以单选的形式提供给用户进行选择。

完成选择后，会拷贝模板项目到当前目录，并自动进入拷贝后的项目目录运行依赖安装命令，执行依赖库安装。安装完成后提示用用户进入项目目录运行dev命令启动项目。

项目运行包括：读取配置文件，匹配技术栈配置和构建工具配置，执行项目运行；兼容多技术栈和构建工具。

使用dev命令进行运行时，会读取项目本地的配置文件project.config.mjs，通过其中的view配置确定技术栈，通过build配置确定构建工具。

项目构建包括：读取配置文件，匹配技术栈配置和构建工具配置，执行项目构建；

使用pub命令进行构建时，会读取项目本地的配置文件project.config.mjs，通过其中的view配置确定技术栈，通过build配置确定构建工具，完成运行项目运行，启动本地服务实现页面访问。如图3所示。

在cli工具中找到对应的技术栈配置和构建工具配置，对项目进行运行或构建。构建前会合并project.config.mjs文件中的自定义构建配置。完成操作后会输出操作结果信息。运行模式启动本地服务可以访问页面；构建模式则生成静态资源文件夹，部署后方可访问。

配置文件目录结构图如图4所示：模板匹配方式为目录+文件名匹配。

配置文件包括构建方式参数build字段和技术栈类型参数view字段。通过读取配置文件的构建方式参数build，定位使用配置的件的磁盘目录在，如图4中的vite和webpack文件夹；通过读取配置文件的技术栈类型参数view，定位使用配置的文件目录，如图4中的react和vue3等。再根据启动方式，定位到文件夹内的prod或dev模式的配置文件，最终以prod或dev为主要入口程序，加载其他必要资源进行项目启动或构建。

自定义模板支持：如图5所示，@dks开头的模板为自定义模板。需要说明这里指示举例，不限于只有这样的表示方式。

使用temp add命令提供本地存储文件夹名字和远程仓库地址，可以添加远程仓库到自定义的模板列表。远程仓库的模板会下载到命令行工具本地，并修改本地的json文件进行信息记录。自定模板在init新建项目时和默认模板在一个列表，显示名为：本地存储文件夹名字/模板名。

如图6所示，项目升级包括：对现有项目的依赖库升级或重写配置文件，实现对旧模板创建的项目进行升级。图7为fix命令功能列表，具体参数包括-c参数，-p参数。

使用fix命令，可以指定-c参数，为项目添加一个project.config.mjs配置文件，针对文件入口、构建方式和技术栈配置稍作调整即可在现有项目中接入使用命令行工具。

使用fix命令，可以指定-p参数升级依赖库。读取项目本地描述文件package.json文件，完成后重写本地项目packages.json文件，重新安装依赖库。

fix配置文件目录如图8所示。

同样是根据不同的构建配置和框架进行文件匹配，定位到需要在当前项目修复的文件内容，进行内容合并或文件替换。文件缺失的使用文件复制，文件存在的进行内容合并。升级内容包括依赖库、构建策略优化、代码校验等通用性的能力。这也是本申请的一大特色，现有技术开源工具都只支持单一技术栈新建和运行，没有支持已创建项目升级的。即使工具升级了，新建的模板更新了也无法升级之前使用旧模板创建的项目，正是考虑到批量维护的问题本申请的技术方案设计实现了这个升级功能，通过对比新旧项目和依赖库文件自动处理配置文件合并和功能升级。

如图9所示为本申请的方法全功能列表，后续可以根据实际需要继续添加。

实施例2

本发明的实施例2提出了一种基于命令行的项目管理系统，基于实施例1的方法实现，该系统包括：项目新建模块、项目运行模块、项目构建模块和项目升级模块；其中，

项目新建模块，用于判断本地是否存在可用模板，不存在则先下载模板到本地，读取模板信息，根据用户的输入和选择，配置项目，执行依赖库安装，完成项目新建；

项目运行模块，用于读取配置文件，匹配技术栈配置和构建工具配置，执行项目运行；

项目构建模块，用于读取配置文件，匹配技术栈配置和构建工具配置，执行项目构建；

项目升级模块，用于对现有项目的依赖库升级或重写配置文件，实现对旧模板创建的项目进行升级。

实施例3

本发明的实施例3还可提供的一种计算机设备，包括：至少一个处理器、存储器、至少一个网络接口和用户接口。该设备中的各个组件通过总线系统耦合在一起。可理解，总线系统用于实现这些组件之间的连接通信。总线系统除包括数据总线之外，还包括电源总线、控制总线和状态信号总线。

其中，用户接口可以包括显示器、键盘或者点击设备(例如，鼠标，轨迹球(trackball)、触感板或者触摸屏等。

可以理解，本申请公开实施例中的存储器可以是易失性存储器或非易失性存储器，或可包括易失性和非易失性存储器两者。其中，非易失性存储器可以是只读存储器(Read-Only Memory，ROM)、可编程只读存储器(Programmable ROM，PROM)、可擦除可编程只读存储器(Erasable PROM，EPROM)、电可擦除可编程只读存储器(Electrically EPROM，EEPROM)或闪存。易失性存储器可以是随机存取存储器(Random Access Memory，RAM)，其用作外部高速缓存。通过示例性但不是限制性说明，许多形式的RAM可用，例如静态随机存取存储器(Static RAM，SRAM)、动态随机存取存储器(Dynamic RAM，DRAM)、同步动态随机存取存储器(Synchronous DRAM，SDRAM)、双倍数据速率同步动态随机存取存储器(Double DataRate SDRAM，DDRSDRAM)、增强型同步动态随机存取存储器(Enhanced SDRAM，ESDRAM)、同步连接动态随机存取存储器(Synchlink DRAM，SLDRAM)和直接内存总线随机存取存储器(Direct Rambus RAM，DRRAM)。本文描述的存储器旨在包括但不限于这些和任意其它适合类型的存储器。

在一些实施方式中，存储器存储了如下的元素，可执行模块或者数据结构，或者他们的子集，或者他们的扩展集：操作系统和应用程序。

其中，操作系统，包含各种系统程序，例如框架层、核心库层、驱动层等，用于实现各种基础业务以及处理基于硬件的任务。应用程序，包含各种应用程序，例如媒体播放器(Media Player)、浏览器(Browser)等，用于实现各种应用业务。实现本公开实施例方法的程序可以包含在应用程序中。

在本上述的实施例中，还可通过调用存储器存储的程序或指令，具体的，可以是应用程序中存储的程序或指令，处理器用于：

执行实施例1的方法的步骤。

实施例1的方法可以应用于处理器中，或者由处理器实现。处理器可能是一种集成电路芯片，具有信号的处理能力。在实现过程中，上述方法的各步骤可以通过处理器中的硬件的集成逻辑电路或者软件形式的指令完成。上述的处理器可以是通用处理器、数字信号处理器(Digital Signal Processor，DSP)、专用集成电路(Application SpecificIntegrated Circuit，ASIC)、现场可编程门阵列(Field Programmable Gate Array，FPGA)或者其他可编程逻辑器件、分立门或者晶体管逻辑器件、分立硬件组件。可以实现或者执行实施例1中的公开的各方法、步骤及逻辑框图。通用处理器可以是微处理器或者该处理器也可以是任何常规的处理器等。结合实施例1所公开的方法的步骤可以直接体现为硬件译码处理器执行完成，或者用译码处理器中的硬件及软件模块组合执行完成。软件模块可以位于随机存储器，闪存、只读存储器，可编程只读存储器或者电可擦写可编程存储器、寄存器等本领域成熟的存储介质中。该存储介质位于存储器，处理器读取存储器中的信息，结合其硬件完成上述方法的步骤。

可以理解的是，本发明描述的这些实施例可以用硬件、软件、固件、中间件、微码或其组合来实现。对于硬件实现，处理单元可以实现在一个或多个专用集成电路(Application Specific Integrated Circuits，ASIC)、数字信号处理器(Digital SignalProcessing，DSP)、数字信号处理设备(DSP Device，DSPD)、可编程逻辑设备(ProgrammableLogic Device，PLD)、现场可编程门阵列(Field-Programmable Gate Array，FPGA)、通用处理器、控制器、微控制器、微处理器、用于执行本申请所述功能的其它电子单元或其组合中。

对于软件实现，可通过执行本发明的功能模块(例如过程、函数等)来实现本发明技术。软件代码可存储在存储器中并通过处理器执行。存储器可以在处理器中或在处理器外部实现。

实施例4

本发明实施例4还可提供一种非易失性存储介质，用于存储计算机程序。当该计算机程序被处理器执行时可以实现上述方法实施例中的各个步骤。

以上详细描述了本申请的优选实施方式，但是，本申请并不限于上述实施方式中的具体细节，在本申请的技术构思范围内，可以对本申请的技术方案进行多种简单变型，这些简单变型均属于本申请的保护范围。

另外需要说明的是，在上述具体实施方式中所描述的各个具体技术特征，在不矛盾的情况下，可以通过任何合适的方式进行组合，为了避免不必要的重复，本申请对各种可能的组合方式不再另行说明。

此外，本申请的各种不同的实施方式之间也可以进行任意组合，只要其不违背本申请的思想，其同样应当视为本发明所公开的内容。

Claims (9)

1.一种基于命令行的项目管理方法，所述方法包括：依据收到的命令行，进行项目新建、项目运行、项目构建或项目升级；其中，

所述项目新建包括：判断本地是否存在可用模板，不存在则先下载模板到本地，读取模板信息，根据用户的输入和选择，配置项目，执行依赖库安装，完成项目新建；所述模板为项目镜像；

所述项目运行包括：读取项目本地的配置文件并和项目中自定义配置信息进行合并，基于合并后的配置文件，匹配技术栈配置和构建工具配置，以执行项目运行；

所述项目构建包括：读取项目本地的配置文件并和项目中自定义配置信息进行合并，基于合并后的配置文件，匹配技术栈配置和构建工具配置，以执行项目构建；

所述项目升级包括：对现有项目的依赖库升级或重写配置文件，实现对旧模板创建的项目进行升级。

2.根据权利要求1所述的基于命令行的项目管理方法，所述项目新建的处理过程具体包括：

当收到init命令时，根据目录+文件名的方式判断本地是否存在可用模板，不存在则先下载模板到本地；

读取本地的模板信息，接收用户输入的项目名称，提供配置项目信息和包管理工具选择列表，根据用户的选择结合项目名称，将模板及配置项目信息拷贝到当前目录的项目名称路径下；

执行依赖库安装，完成项目新建。

3.根据权利要求1所述的基于命令行的项目管理方法，所述配置文件包括构建方式参数build字段和技术栈类型参数view字段。

4.根据权利要求3所述的基于命令行的项目管理方法，所述项目运行的处理过程具体包括：

当收到dev命令时，基于合并后的配置文件，根据view字段确定技术栈，根据build字段确定构建工具，完成运行项目运行，启动本地服务实现页面访问。

5.根据权利要求3所述的基于命令行的项目管理方法，所述项目构建的处理过程具体包括：

当收到pub命令时，基于合并后的配置文件，根据view字段确定技术栈，根据build字段确定构建工具，生成静态资源文件夹，用于部署后访问。

6.根据权利要求1所述的基于命令行的项目管理方法，所述项目升级的处理过程具体包括：

当收到fix命令时，读取命令中的参数，如果读取到-c参数，从项目镜像中获取配置文件，并对本地的配置文件重写；如果读取到-p参数，从项目镜像中获取依赖库，重写本地的描述文件并重新安装依赖库。

7.一种基于命令行的项目管理系统，其特征在于，所述系统包括：项目新建模块、项目运行模块、项目构建模块和项目升级模块；其中，

所述项目新建模块，用于判断本地是否存在可用模板，不存在则先下载模板到本地，读取模板信息，根据用户的输入和选择，配置项目，执行依赖库安装，完成项目新建；

所述项目运行模块，用于读取项目本地的配置文件并和项目中自定义配置信息进行合并，基于合并后的配置文件，匹配技术栈配置和构建工具配置，以执行项目运行；

所述项目构建模块，用于读取项目本地的配置文件并和项目中自定义配置信息进行合并，基于合并后的配置文件，匹配技术栈配置和构建工具配置，以执行项目构建；

所述项目升级模块，用于对现有项目的依赖库升级或重写配置文件，实现对旧模板创建的项目进行升级。

8.一种计算机设备，包括存储器、处理器及存储在所述存储器上并可在所述处理器上运行的计算机程序，其特征在于，所述处理器执行所述计算机程序时实现如权利要求1至6中任一项所述的方法。

9.一种计算机可读存储介质，其特征在于，所述计算机可读存储介质存储有计算机程序，所述计算机程序当被处理器执行时使所述处理器执行如权利要求1至6任一项所述的方法。