@koa_web/boot


简介

> ne 前端基础工程

安装&配置

全局安装该模块 $ npm install @koa_web/boot -g 或 $ npm install @koa_web/boot -g --production

使用

$3

通过ne -h或ne --help查看使用帮助

``bash
$ ne -h
Usage: ne run [command] [option]

Options:

-v, --version output the version number
-e --env [env] what env do you want set
--senv [senv] what egg environment do you want
-h, --help output usage information

Commands:

dev [options] run project in dev mode
build [options] Only effective in dashboard or h5.
lint lint project code follow your eslint file
packageName echo project name
packageVersion echo project version
startup:docker startup. Only effective in docker container
test Only effective in service(egg.js)
cov Only effective in service(egg.js)
ci Only effective in service(egg.js)
`

$3


通过ne -v或ne --version查看版本号
`bash
$ ne-create-project -v

v1.4.1
`

$3


#### 3.1 dev
开发模式启动当前工程
`bash
$ ne run dev
`

#### 3.2 build
编译当前工程
`bash
$ ne run build
`

#### 3.3 lint
对当前工程进行语法检测
`bash
$ ne run lint
`

#### 3.4 packageName
输出当前工程的名称
`bash
$ ne run packageName
`
#### 3.5 packageVersion
输出当前工程的版本号
`bash
$ ne run packageVersion
`
#### 3.6 startup:docker
容器中启动该工程的命令
`bash
$ ne run startup:docker
`
#### 3.7 test
对当前工程进行单元测试，只在eggjs为基础的后端工程中有效
`bash
$ ne run test
`
#### 3.8 cov
生成当前工程的测试覆盖率报告，只在eggjs为基础的后端工程中有效
`bash
$ ne run cov
`
#### 3.9 ci
对当前工程进行语法检测并生成当前工程的测试覆盖率报告，只在eggjs为基础的后端工程中有效
`bash
$ ne run ci
`


$3


优先读取第一种方式设定的环境变量
#### 4.1 运行时注入
##### 4.1.1 -e --env
注入环境变量，可以用 process.env.k1 获取到
`bash
$ ne run dev -e k1=v1,k2=v2
$ ne run dev --env k1=v1,k2=v2
`
##### 4.1.2 senv
注入eggjs启动参数，只在eggjs为基础的后端工程中有效
`bash
$ ne run dev --senv port=7002
`
#### 4.2 在当前工程的package.json中写入
在当前工程的package.json中写入，格式为
默认在dev指令中注入了NODE_ENV=development
`bash
"ne-env-[command]": {
"k1": "v1",
"k2": "v2"
},
"ne-senv-[command]": {
"k1": "v1",
"k2": "v2"
}
`
其中 ne-senv-[command] 只在以eggjs为基础的后端工程中有效 \
例如
`bash
"ne-env-dev": {
"NODE_SYS": "dealer"
},
"ne-senv-dev": {
"port": "7002"
}
`

本地安装

工程目类下安装该模块 $ npm install @koa_web/boot --save-dev` \
提供基于githook的相关语法检查与commit信息检查

相关功能基于yorkie和lint-staged进行修改

测试相关

请参照yorkie和lint-staged