start-envs

1.0.4 • Public • Published

多环境配置启动CLI

主要优化多环境多项目环境,把配置文件与项目代码分离,方便维护管理,开发运行尽量简单直接。

安装

pnpm i start-envs -D

使用

pnpm run start-envs

CLI配置文件

在项目根目录下新建配置文件,文件名为start-envs.config.json, 配置字段如下:

字段 类型 描述
configFolderName string 配置文件夹名称,默认为config
envFileName string 生成的配置文件,默认为src/envs/config.js
script string 项目中package.json中的 scripts 命令,默认为 serve

项目配置文件

项目配置文件是以yaml格式存储,文件名以.yaml结尾,文件名与环境名称一致,如:dev.yaml, test.yaml, prod.yaml,例如:

title: 项目名称  # 项目名称
env: dev  # 环境名称,dev, uat, sit, prod
name: project # 项目名称英文简称
description: 项目描述 # 项目描述
version: 1.0.0  # 项目版本
api: # 接口地址
  baseUrl: http://localhost:8080
  apiUrl: /api
  apiPrefix: /api
  apiVersion: v1
  ...

多个环境,在config目录下新增yaml文件即可。

配置文件生成

在envFileName 中配置的配置文件,会生成在src/envs/config.js中,代码如下:

 module.exports = {
  "title": "项目名称",
  "env": "dev",
  "name": "project",
  "description": "项目描述",
  "version": "1.0.0",
  "api": {
    "baseUrl": "http://localhost:8080",
    "apiUrl": "/api",
    "apiPrefix": "/api",
    "apiVersion": "v1"
  }
}

Package Sidebar

Install

npm i start-envs

Weekly Downloads

2

Version

1.0.4

License

ISC

Unpacked Size

133 kB

Total Files

4

Last publish

Collaborators

  • wginit