快速上手

1. 使用环境

Feflow 从 v0.16.0 版本开始，不再支持 Node 8 以下的版本。

1.1 安装 Node.js

要求8.x版本以上，请直接前往Node.js官网传送门、或者使用 nvm安装。

1.2 安装 CLI

$ npm install @feflow/cli -g

1.3 命令行推荐

Mac OSX 用户推荐使用 item2，windows 用户推荐使用 cmder

安装完成后，可以输入 $ fef 看看是否安装成功，安装成功可能会如下显示：

2. 开始使用

初次使用 Feflow 时，比如使用 Feflow 创建一个项目，这个时候会检测本地安装的包管理器，包括：npm, tnpm, yarn 等，并提示用户进行选择。

通过上下箭头(↑↓) 进行选择，然后按回车键确认（腾讯内部员工建议选择 tnpm）。

后续如果希望手动更改包管理器，可以通过：$ fef config set packageManager tnpm 的命令去进行修改

2.1 安装模板或者插件

在 Feflow 中，使用 install 命令去安装一个一个模板（基于 Yeoman）或者插件。比如：

$ fef install @feflow/generator-example

输入这行命令，Feflow即会开始安装，示例脚手架源码：@feflow/generator-example，安装的模板和插件会由 Feflow 统一管理，并且放在 ~/.fef 文件夹下（windows 在用户目录下的 .fef 文件夹）。

2.2 创建项目

安装完模板后，再次运行 fef init 命令，这个时候 Feflow 会把所有通过 Feflow 安装的模板显示出来供用户选择，同样使用上下箭头选择，回车确认。

之后，便走到脚手架的创建项目逻辑中了，比如：

2.3 进行本地开发

项目创建完成后，可以进入到 my-project。可以发现每个由 Feflow 创建的项目都会有一个 .feflowrc.json (或者 .feflowrc.js、.feflowrc.yml、.feflowrc.yaml) 配置文件。这个配置文件指定了这个项目可以使用的套件命令。比如：

.feflowrc.json

{
    "devkit": {
        "commands": {
            "dev": {
                "builder": "@feflow/feflow-devkit-example:dev",
                "options": {}
            },
            "build": {
                "builder": "@feflow/feflow-devkit-example:build",
                "options": {}
            }
        }
    }
  }

这个项目配置文件中表示当前项目使用 @feflow/feflow-devkit-example 这个开发套件，该套件提供了 dev 和 build 命令。

本地调试:

生产环境打包：

当然，可以根据业务实际需要去在开发套件里面实现 lint、deploy 等项目维度的命令。

备注：开发套件的最大优势是将构建脚本、部署脚本等逻辑完全对普通业务开发者进行屏蔽，统一团队构建和部署