fet-cli
v2.2.1
Published
基于webpack的构建工具,解决开发时多项目时需要同时启动多个server的情况
Downloads
27
Readme
fet
fet是为了解决快速开发,调试,上线用的前端开发工具,基于webpack开发。核心功能是解决了本地开发,线上调试带来的不便,启用了fet server
,开发者就能安枕无忧的对应开发,测试,线上线下问题,我们在浏览器看到的代码,都是同一套源码,可以方便解决问题。fet除了支持多页应用外,还支持单页应用。只要是遵循fet规范的任何单页应用,都可以用fet支持。fet默认内置了json-loader
,html-loader
,详细配置请看下文。
fet解决了如下问题:
- 线上源码与本地源码映射关系(本地代理,类似
fiddler
的匹配替换功能),方便调试 - 多项目并行开发需要切换启用不同服务不同端口问题
- 代码快速部署开发机
fet设计核心说明
目前fet支持两种模式:多页面和单页面模式,核心引擎是webpack.单页模式采用的是代理的方式,fet只做转发。多页应用模式,fet支持编译,打包。
单页模式
fet对单页应用采用的是代理的方式进行支持,也就是说只要单页应用遵循fet的规范,可以让开发者随便配置。fet目前提供了脚手架,支持生成vue
的单页模板,以及多页应用模板。
多页模式
项目当中避免不了多页应用,尤其对于2b系统,几十个页面,有时候多达200个页面(这种系统设计本身就不合理)。webpack如果要配置多页应用,还是挺麻烦的,而且编译的时候很慢。fet进
行了特殊处理,让开发者在配置多页应用的时候简单方便,同时采用缓存式中间件,以及多进程编译,提升编译速度。
安装
npm 安装方式安装
npm i -g fet-cli
yarn 方式安装
yarn global add fet-cli
命令说明
请安装fet之后,在命令行运行fet
查看命令说明,如果对某个命令感兴趣请运行fet commandName -h
查看。
server
用于启动服务器,支持多项目并行开发。
-p
:设置服务端口,默认是80-w
:设置需要监听的文件,默认是监听fet.config.js
以及build
文件夹。如果要新增可以用逗号隔开,例如:'src/home,base'。-s
:开启HTTPS服务,如果没有配置全局的证书,那么会启用默认证书,默认证书是没有经过认证的,在目前的浏览器,会引起不可预知的错误。因此,建议不要用默认证书。如果需要配置经过认证的证书,请执行fet config https-key <path-to-your-key>
,以及fet config https-crt <path-to-your-crt>
。-v
:提示server是否显示详细的编译信息,默认不开启。-c
:单页应用的代理配置路径,默认是服务器启动目录下的fet.proxy.conf
单页应用如果要用上fet server
,必须在fet server
的执行目录下面新建代理文件fet.proxy.conf,代理格式请看下面的代理文件配置
pack
对代码进行打包,但是不进行编译,可为不同的环境打包代码。
-e
:设置要打包的环境,对应的值,是配置文件里面servers
这个字段对应的配置。可能由于一个项目同时有多个迭代,因此会有多个开发机以及其对应的域名,因此经常需要配置这个环境变量。-m
:打包并压缩代码,与执行fet build
效果是一样的-c
:编译特殊文件,默认编译html。fet
支持include
标签,用户引入公共部分代码,类似jsp
里面的include
。
build
对代码进行打包并且压缩,同时支持打包分析,给使用者提供代码优化思路。
-a
:启用分析,对打包结果进行分析。-c
:开启缓存,默认开启,当值为false时,关闭缓存。-e
:设置要打包的环境,对应的值,是配置文件里面servers
这个字段对应的配置。可能由于一个项目同时有多个迭代,因此会有多个开发机以及其对应的域名,因此经常需要配置这个环境变量。默认是指向全局的global配置的domain
配置,如果全局配置也没有,那么默认空。
sync
将代码发送到相应的机器上,必须支持rsync
。env
的值是和配置文件里面的servers
这个字段的配置有关的。
config [key] [value]
配置全局变量,目前提供的全局变量配置有如下:
https-key
&https-crt
:这两个配置主要是用于server
开启HTTPS。user
: 配置sync
命令中默认的用户名。只要配置了这个,对项目执行sync
命令,fet
首先会去匹配servers
这个配置字段里面对应服务器的user
字段,如果没有设置,直接使用全局的配置。domain
:配置默认的域名。在pack
和build
的时候会用到。主要是用于设置publicPath
的时候要用。
lint
基于standard的代码检测命令。对应配置文件里面的lint
字段。
init
生成项目脚手架
fet init [projectName]
-t
:设置模板类型,默认是vue-m
:下载多页面模板,默认是否,设置后-type设置的类型无效。-c
:开启clone方式下载模板
配置说明
{
lint: { // 基于standard的
cwd: 'src/js', // 选择需要校验的文件路径,默认是src
opts: {
ignore: [], // glob 形式的排除列表 (一般无须配置)
fix: false, // 是否自动修复问题
globals: [], // 声明需要跳过检测的定义全局变量
plugins: [], // eslint 插件列表
envs: [], // eslint 环境
parser: '' // js 解析器(例如 babel-eslint)
}
},
servers: { // 配置同步到哪台机器
dev1: {
host: '127.0.0.1',
domain: '//dev1.example.com',
port: 63501,
local: './', // 默认当前目录
path: '/usr/local/src/abc', //服务器端要存放的地址
sudo: false,
include: ['dev']
},
dev2: {
host: '127.0.0.1',
domain: '//beta1.example.com',
port: 63501,
path: '/usr/local/src/dec',
sudo: false,
include: ['dev']
}
},
entryExtNames: { // 告诉`fet`哪些后缀是属于js或者css,fet才能根据这些来选择编译配置
css: ['.css', '.scss', '.sass', '.less'],
js: ['.js', '.jsx', '.vue']
},
config: {
exports: [ // 要编译压缩的文件
"js/module/home/index.js",
"css/index.css",
"css/base.css",
"css/module/index.less"
],
webpackConfig: function(jsConfig, cssConfig, options, context) {
// webpackConfig: function(config, options, context) { // 根据不同的模式,有不同的选择,单页模式,没有cssConfig
// do what you want todo
// 当对样式没有特殊配置时,可以直接返回jsConfig就行,否则就要两者都返回。
return jsConfig; // return {jsConfig: jsConfig, cssConfig: cssConfig};
}
}
}
代理文件配置
{
"projectName": { // 项目名称要和package.json的name一样
"port": "8080" // fet server 要代理的webpack server端口
}
}
其他
如果需要用到数据模拟,可以使用yapi或者easy-mock,如果需要更复杂的数据模拟,可以使用mockajax
TODO
[] 添加自动化测试 [] 将es6改成typescript