navi-cli

• navi脚手架
  • 使用
  • 创建项目
  • 使用图形化界面
  • template
  • 添加命令
  • 创建更多模板

使用

npm i -g @navi-cli/cli

安装之后，你就可以在命令行中访问navi命令。你可以通过简单运行navi，看看是否展示出了一份所有可用命令的帮助信息，来验证它是否安装成功。

你也可以选择添加自己的命令，让navi更好的工作。

查看帮助:

navi
# OR
navi -h
# OR
navi --help

检查版本:

navi -v
# OR
navi --version

创建项目

你也可以选择vue-cli或者是create-react-app来创建。

navi init

运行以下命令来创建一个新项目：

navi init hello-world

vue-cli or create-react-app

运行以下命令来创建一个新项目：

navi vue hello-world
# OR
navi react hello-world

使用图形化界面

运行以下命令来启动ui：

navi ui

添加自己的模板

您需要将模板发布npm。

模板包应当有如下结构

|- package
|-- template
|-- package.json
|-- setting.json

template

模板内容需要放在template文件夹中，为了生成项目name与项目存放文件夹一致，package.json中name项的值应当为<%= projectName %>。

您可以在除html的任意文件中使用<%= key %>的指定渲染。

setting.json

setting.json:

{
  "installCommand": "npm install",
  "startCommand": "npm run serve",
  "buildCommand": "npm run build",
  "template": [{
    "name": "title",
    "message": "请输入 title:",
    "tip": "请输入 title"
  }],
  "ignore": ["**/public/**", "**.png"]
}

参数介绍:

• template:
  • name: 模板渲染位置字段。
  • message: 交互说明字段。
  • tip: 校验提示字段。
• ignore: 忽略文件，参考glob

导入模板

navi add -T

添加命令

function command(options) {

}

• options
• cmds: 命令参数
• args: 选项值
• command: command对象

导入命令

navi add 
# OR
navi add -C
# OR
navi add -T
# 参数T为命令添加本地调试路径

创建更多模板

开发中