README

文档

freedom-cli简介
- 特点
使用说明
freedom.yml配置说明
工具远程配置说明
freedom cli配套模板
freedom cli配套中间件
- 中间件开发说明
发布日志

freedom-cli简介

freedom-cli是前端开发人员用于构建以及工程化的一个脚手架工具。

它通过流程配置的方式(每个项目存在的.freedom/freedom.yml文件)，把前端开发的整个流程分解为一个一个单一功能组件，然后通过配置赋予开发人员自己想要的构建流程，简化并统一了开发人员日常构建与开发相关的工作，同时每个常用功能组件(middleware)可单独维护，单独使用。

工具预览

特点

扩展性强，配置灵活
将常用的功能组件，比如：webpack构建、mock、publish等封装成一个个独立的middleware，易于维护与复用。
提供统一的几个命令，即可完成从开发、调试、检查、发布等的流程，且可通过配置来自由控制。
使用gitlab管理相关配置，以及私服cnpm管理中间件。
freedom使用可插拔式的设计(化零为整，化整为零)，可自由选择中间件，使得团队统一管理前端所有项目，并且又不失灵活性。

使用说明

安装

cnpm install -g @51npm/freedom-cli

远程仓储配置

freedom-cli 相关配置存储于远程仓储github/gitlab、npm，工具依赖于以下配置信息

配置名称	配置说明
repository	git仓储，默认值为：github，若是公司git仓库，需要设置为gitlab
reposGroup	git仓储项目组，工具以来的所有配置项目、工程模板均位于此项目组下默认值为：https://github.com/51talk-design
project	工具在git上的配置项目名，默认值为：freedom-cli-config
registry	npm/cnpm镜像地址，默认值为:https://registry.npm.taobao.org
command	工具依赖的包管理工具，默认为cnpm

若需要更改这几项配置的，可执行以下命令进行修改:

fm config set registry=https://registry.npmjs.org
fm config set repository=gitlab
fm config set reposGroup=https://github.com/51talk-design
fm config set project=freedom-cli-config
fm config set command=npm

常用命令

fm login 登录,若将整个方案迁移到公司gitlab时使用，具体迁移方案请查阅......
fm init -p fe-demo 项目初始化
fm dev 开发
fm mock 启动mock服务
fm test 启动eslint语法校验以及测试
fm serve 对build后的文件，提供预览服务。
fm publish 项目资源发布
fm clean 清除freedom cli本地所有的cache记录，若远程配置有变更时，可执行fm clean来清除本地cache重新更新
fm middleware show工具支持的中间件列表信息
fm show show工具支持的工程模板列表信息
fm update 更新远程配置

freedom.yml配置说明

freedom.yml为管控工具流程配置文件，配置的是开发的几个阶段(比如：dev、build、serve、publish)，对应使用的运行中间件。

开发者可按照中间件、freedom.yml配置中间件的约束，替换自己的开发的中间件。

freedom.yml对于中间件配置的参数约定

参数名称	参数说明
name	中间件的名称，可为空
script	中间件要执行的脚本，比如：cnpm install
version	中间件的版本
before	中间件是否再执行之前才进行安装(工具在执行命令的时候就会进行安装中间件)，默认为false，可空
args	传递给中间件的参数，object类型，即：中间件设定的参数形式必须为object

freedom.yml标准的流程配置如下：

dev:
  - name:
    script:
      - cnpm install
  - name: '@51npm/freedom-middleware-mock2easy'
    version: 
    before: 
    args:
      port: 8080
  - name: '@51npm/freedom-middleware-webpack4'
    version: 
    before: 
    args:
      port: 3333
      env: dev
      publicPath: //localhost:3333
      build:  
      proxy:
        context:
          - /wap
          - /api
        options:
          target: http://localhost:8080
build:
  - name: 
    script: 
      - cnpm install
  - name: '@51npm/freedom-middleware-webpack4'
    version: 
    before: 
    args:
      projectID: ${projectID}
      env: prod
      publicPath: //freedom.demo.com/apollo/${projectName}/
      build: build/apollo/${projectName}/
      bundleAnalyzerReportPort: 
      specialVersion: 
serve:
  - name: 
    script:
      - fm build
  - name: '@51npm/freedom-middleware-mock2easy'
    version: 
    before: 
    args:
      port: 8080
  - name: '@51npm/freedom-middleware-serve'
    version: 1.0.10
    before: 
    args:
      port: 8888
      build: build
      proxy:
        context:
          - /api
        options:
          target: http://localhost:8080
publish:
  - name: '@51npm/freedom-middleware-publish'
    version: 
    before: 
    args:
      projectID: ${projectID}
      path: build

工具远程配置说明

freedom cli远程配置，是为了让工具具备更好的扩展性，详情请点击

freedom.yml — freedom cli 默认流程配置文件(项目中可自行修改)
freedom-corepkg.yml — 工程核心npm包配置文件
middleware.yml — freedom cli 支持的中间件列表配置
template.yml — freedom cli 支持的模板配置文件

freedom cli配套模板

模板名称	模板描述
freedom-template-tsKoa	基于TypeScript+Koa开发的node服务端项目工程模板
freedom-template-tsExpress	基于TypeScript+Express开发的node服务端项目工程模板
freedom-template-react	基于React框架的移动端多页面工程模板
freedom-template-mobileVue	基于Vue框架的移动端多页面工程模板
freedom-template-zeptoMobile	zepto移动端多页面工程模板

备注:开发者可自行定制工程模板，让团队使用，定制好模板后，需要在远程配置template.yml该模板信息(工具远程配置说明)

本地执行命令fm clean，清除cache后，可正常选择定制的工程模板

freedom cli配套中间件

中间件名称	中间件描述
freedom-middleware-webpack4	webpack4用于前端开发环境的搭建，前端项目的构建
freedom-middleware-mock2easy	用于管理后端数据接口，提供mock数据
freedom-middleware-serve	提供本地前端项目预览环境中间件
freedom-middleware-makefile	创建标准项目工程开发文件中间件
freedom-middleware-eslint	源码规范校验中间件
freedom-middleware-webpack2	webpack2用于前端开发环境的搭建，前端项目的构建
freedom-middleware-tstypedi	提供ts开发的前端项目，依赖注入的文件扫描能力
freedom-middleware-ossupload	oss文件上传

**注意：**工具配套的中间件名称，工具会对某些中间件的功能有特殊处理，所以想要替换中间件的时候，npm包名称不要跟配套中间件名称冲突，配套中间件在npm仓储中包的命名格式为 : @51npm/freedom-middleware-xx

中间件开发说明

中间件为通过module.exports 导出的一个异步函数，返回一个boolean值，约束如下：

module.exports = async function(params) {
  // todo some thing
  return true;
};

备注: 传递给中间件的参数(params)，必须以object形式存在

{
  env:"prod",
  build:"/build"  
}

开发一个中间件，在远程配置文件middleware.yml增加上(工具远程配置说明)，本地执行命令fm clean，清除cache，后执行命令fm mw进行查看工具支持的中间件

发布日志

发布时间	发布版本	功能描述
2020-06-16	1.0.0	工具上线

Usage no npm install needed!