fec-builder

通用的前端构建工具，屏蔽业务无关的细节配置，开箱即用

为什么

背景：业界前端工程化方案的趋同

模块化方案的统一
样式 & 图片等非 Javascript 资源的引入手段有最佳实践
性能优化的最佳实践趋同

上述背景下，前端开发者不应该再需要去关心具体的工程化方案的细节与搭建，工程层面的性能优化措施等。fec-builder 的目标是，通过尽可能少的配置，引入包含业界最佳实践的工程化方案，让开发者得以专注于业务的实现。

长期来看，前端项目不再需要向项目中引入 dev dependencies，也不再需要自己搭建构建、部署 & 持续集成的环境，通过向项目添加一个 build-config.json 文件，即可使用通用的服务完成这些过程。

使用

npm 包（适合本地开发用）

# fec-builder 使用 npm-shrinkwrap.json 锁定依赖版本，yarn 不会识别 npm-shrinkwrap.json
# 这里请使用 npm 安装全局包
npm i fec-builder -g
# 项目目录下执行
fec-builder -p 8080

docker 镜像（适合持续集成环境使用）

最新的 builder image 不再在 hub.c.163.com 发布

docker pull hub.c.163.com/nighca/fec-builder:latest
# 项目目录下执行
docker run -v ${PWD}:/fec/input -e "BUILD_ENV=production" --rm fec-builder

npm 包与 docker 镜像的对比，优点：

不需要安装 docker，通过淘宝镜像源的话装起来应该也比 docker pull image 快
构建行为直接在宿主机运行，性能会比在容器中稍好，首次构建大约会快 20%

缺点：

没有那么可靠，安装时可能会出错（往往错在 node 构建二进制包的部分），构建行为也不能保证完全一致

build-config.json 的配置

见 build-config.md

VSCode 中可以通过安装插件 fec-builder-helper 完成配置获取辅助提示。

transformer 的配置

对于不同的 transformer，我们可以通过与 transformer 平级的 config 字段对 transformer 的行为进行配置，这里是不同 transformer 支持的配置项：

`ts`

transpileOnlyWhenDev: boolean = true

对于 ts 的转换，builder 会默认在开发模式跳过类型检查，提高构建效率，避免过严的限制；这个行为可以通过配置 transpileOnlyWhenDev 为 false 禁用，即，在开发时也进行类型检查
useProjectTypeScript: boolean = false

builder 默认使用内置的 typescript 进行类型检查，为了避免 typescript 升级导致的冲突和影响，可以开启该选项从而使用项目里的 typescript 进行类型检查

`tsx`

transpileOnlyWhenDev: boolean = true

同 ts 的 transpileOnlyWhenDev 配置
useProjectTypeScript: boolean = false

同 ts 的 useProjectTypeScript 配置

Contributing

1. Fork 并 clone 到本地

git clone --recurse-submodules <URL of your forked repo>

注意这里 clone 时需要指定 --recurse-submodules，以确保 repo 中的 samples/ 内容可以被正确地拉取。

2. 安装依赖

注意这里需要使用 npm —— builder 使用 npm shrinkwrap file 来锁定依赖，因此使用 yarn 或别的不支持 npm shrinkwrap 的包管理安装依赖可能会引入问题。

npm i

3. 本地执行 builder

npm run dev

通过 npm script dev，我们会使用当前的 builder 代码，基于 samples/typescript-react 项目启动开发服务器（监听 80 端口）。

每次修改 builder 本身的代码后，需要重新执行命令以运行最新的代码。

4. 指定项目或命令

参考 npm script dev 的内容（ts-node ./src/bin.ts -r ./samples/typescript-react），我们可以通过直接执行 ts-node 来指定项目的目录或 builder 的命令，如

npx ts-node ./src/bin.ts generate -r ./samples/hello-world

相当于在 ./samples/hello-world 目录下执行

fec-builder generate

CHANGELOG

v1.4.0 及以后后的 Changelog 见 Releases 页面

v1.4.0 前的 Changelog：

1.3.7

支持省略项目目录下的 postcss.config.js 文件

1.3.6

开发模式下避免类型检查（ts-loader 配置 transpileOnly）

1.3.5

修复 dev server 在 publicUrl 的 path 不为 / 时不能正确实现 history fallback 的 bug

1.3.4

升级 vue 构建依赖，修复 vue 构建的 bug

1.3.3

更新默认的 babel 配置

原先为 "presets": ["es2015"]

更新为 "presets": ["es2015", "es2016", "es2017", "stage-2"], "plugins": ["babel-plugin-transform-decorators-legacy"]

1.3.2

更新 README

1.3.1

完善 vue 支持，对 vue 文件内部资源（如 js）采用与外部（如 js）一致的转换（transform）策略

1.3.0

升级 typescript(2.3.4)

1.2.0

升级 webpack(2.6.1)、webpack-dev-server(2.4.5)、extract-text-webpack-plugin(2.1.2)

对于 css 内容，使用 contenthash 而不是 chunkhash（生成的 css 文件有独立的 hash）

1.1.2

debug babel 配置

1.1.1

支持对 vue-loader 进行配置

1.1.0

支持 vue

1.0.0

可用

liaoyu / builder Goto Github PK

builder's Introduction