工具简介

    • 根据 NEI 平台定义的工程规范，生成工程的初始化目录结构
    • 自动集成在 NEI 上定义的资源: 页面、异步接口、数据模型、页面模板、业务分组等
    • 本地模拟容器

    NEI 工程规范介绍

    教程

    工具使用

    构建工具基于 平台，因此需要先安装 Node.js 环境，Node.js 在各平台上的安装配置请参阅官方说明。

    安装

    提示1: 如果安装不成功, 可以尝试命令

    提示2: 如果已经安装过 nei, 请使用更新命令 npm update nei -g

    提示3: 也可以安装某个分支，比如安装 dev 分支的命令如下:

    1. sudo npm install "NEYouFan/nei-toolkit#dev" -g
    1. sudo npm install nei -g --registry=https://registry.npm.taobao.org

    指令说明

    本工具使用时在终端或者命令行输入以下格式指令运行

    1. nei [指令] [参数]

    其中可用的指令包括：

    根据在 NEI 平台上定义的工程规范，生成工程的初始化目录结构，指令的运行格式为：

      其中 [key] 是 NEI 平台上的项目的唯一标识，可以在项目的”工具(设置)”中查看

      针对 nei build 指令可用的参数包括：

      使用范例：

      规范也可以独立于项目生成脚手架文件, 在当前目录下构建 key 为 xyz 的规范：

      1. nei build -sk xyz

      注意: 如果 k 和 sk 参数同时存在, 系统会优先考虑 sk 参数

      update

      更新通过 nei build 构建的项目，指令的运行格式为：

      1. nei update [参数]

      nei update 指令可用的参数包括：

      使用范例：

      更新当前目录下通过 nei build 生成的项目

      启动内置的本地模拟容器

      1. nei server [参数]

      nei server 指令可用的参数包括：

      使用范例

      启动目录为 ./mypro 下的项目:

      OS X 下如果有异常请使用 sudo nei server 命令启动

      template

      1. nei template [参数]

      nei template 指令可用的参数包括:

      用户可以指定数据文件，如data.json的文件内容如下:

      1. {
      2.   "project":{
      3.     "name" : "test",
      4.     "version" : "0.0.1"
      5.   },
      7.     "Netease"
      8.   }
      9. }

      然后用户就可以在模板文件中访问到数据中的数据，如{{project.name}}就能够解析为test。用户同样可以指定本地handlebars辅助文件，如果用户有多个辅助函数，需要将这些都写到一个文件中，自定义辅助函数的写法与上文一致，参照此链接相同。 另外用户也可以不通过指定数据json文件来传入数据，可以通过命令行直接传入数据参数，如：

      1. nei template -ProductName Test -Prefix HT [其他参数]

      ProductName和Prefix这两个参数就会作为数据传入到模板中，其等同于

      1. {
      2.   "args":{
      3.     "ProductName" : "Test",
      4.     "Prefix":  "HT"
      5.   }
      6. }

      如果同时指定了数据文件，将会执行merge操作，其中命令行参数指定的方式优先于数据json文件方式。

      共设有”all”、”debug”、”info”、”warn”、”error”、”off”等日志级别，级别顺序由大到小，通过--logLevel指定一个级别之后，比该级别小的日志级别信息都将会显示出来，比如：

      那么所有info以下级别(即warn、error)级别的信息都将会显示出来。当指定为off的时候，所有日志信息都将关闭。

      [更新说明]

      Licence

      [MIT]

      感谢

      感谢提供的云服务, 目前 NEI 已经托管在网易云上。

      NEI 用户交流 QQ 群(453281988):

      来源(书栈小编注)