别再用JSON配置文件了
大家肯定都发现了,现在越来越多的前端工具支持用JavaScript来进行自定义配置了。(比如说Babel或ESLint)不管大家之前出于什么原因选择JSON来写配置信息,从现在开始不要这么干了,改用JavaScript吧。
为什么呢?
一开始 我犯了个错
前段时间,我为了模块化项目,把一些通用的代码抽象出来形成了单独的库,每个新的项目中都要把之前开发中配置的工具再配置一遍,Lint,Prettier等等。
一开始我想偷懒,每个新的项目都要配置一遍,那这些配置性的东西我想写的越少越好,所以我用了package.json
中的JSON配置。然后我把所有的配置文件放在一个单独的包中,基于我们使用的工具(比如Babel)提供的扩展机制,我们可以共享配置。就像这样:
{
"name": "nice-project",
"version": "1.0.0",
"babel": {
"extends": "awesome-config",
"plugins": ["lodash"]
}
}
简单吧?但是!并不是每个工具都实现这种extends
机制。
很巧的是,我还遇到了。发现缺少工具支持后,我在Github上寻找相关解决方案,肯定有大佬在我之前也遇到了这样的问题。果然还有很多小伙伴遇到了类似的问题。不过很快我也发现了,有的开发者没有考虑提供对所有可能的工具都提供扩展机制,因为已经存在一个天然的更好的选择了:使用JavaScript配置文件。
好吧,大佬就是大佬,我能怎么办呀,那我也只能用JavaScript来配置这些工具咯。当我用JavaScript重写了之前的JSON配置后,所有的问题都不是问题了,真香!
为什么要使用JavaScript配置
主要是因为JSON是一种数据格式,而JavaScript是编程语言。我们通过编程语言可以实现各种各样的计算与组合,不需要借助其它的工具就可以实现强大的配置功能。
而且,我们可以在JavaScript配置中写注释,甚至对它们做测试(虽然这看起来没多大意义)。
我们从几个方面展开来说说使用Javascript配置的好处:
轻松覆盖
我们如果require
了一个JavaScript配置文件,我们可以轻松地修改返回的对象并重新导出它。
就像这样,我们的包里需要另外一个Babel插件时,像修改普通的对象一样修改它就好了。
const base = require("../babel.config.js");
module.exports = {
...base,
plugins: [...base.plugins, "lodash"],
};
动态配置
我刚刚也说了,JSON是一种数据格式,缺乏动态性,我们喜欢用它来传数据,但是用来做配置其实不太行。如果使用JSON配置,哪怕有一丁点儿不同我们都要新建一个新的配置文件,如果换成JavaScript配置,我们可以通过一些编程技巧动态地返回需要的内容。
比如说我们只想在生产环境中使用某个插件,小菜一碟。
const base = require("../babel.config.js");
module.exports = {
...base,
plugins: process.env.NODE_ENV === "production"
? [...base.plugins, "lodash"]
: base.plugins,
};
共享配置
进入前端世界后,一个比较爽的点是什么代码都可以通过npm发布
,我们只需要创建一个恰当的package.json
,然后npm publish
就好了。
{
"name": "my-babel-config",
"version": "1.0.0",
"description": "My babel config. ",
"main": "babel.config.js",
"files": ["babel.config.js"]
}
发布后,我们只需要在需要用到的项目中require
即可:
const base = require("my-babel-config");
module.exports = {
...base,
plugins: [...base.plugins, "lodash"],
};
注释
JSON不支持注释。有人说我们可以使用某些奇特的技巧实现这一需求,但是它们并它们不是JSON规范的一部分。JavaScript作为编程语言天然支持注释。我们可以将它们放在任意位置,ide还会给我们做好高亮。
module.exports = {
"plugins": ["lodash"],
};
可测试
刚刚也提到了,我们可以测试Javascript配置文件,它们跟其它代码没有什么区别。 有没有这个必要大家可以根据自己的场景判断,如果有需要,我们可以使用任何我们熟悉的测试框架来测试,比如Jest。
describe("config", () => {
beforeEach(() => {
oldEnv = process.env.NODE_ENV;
});
afterEach(() => {
jest.resetModules();
process.env.NODE_ENV = oldEnv;
});
it("uses lodash plugin in production", () => {
process.env.NODE_ENV = "production";
const config = require("./babel.config.js");
expect(config.plugins.includes("lodash")).toBe(true);
});
it("does not use lodash plugin in other envs", () => {
process.env.NODE_ENV = "production";
const config = require("./babel.config.js");
expect(config.plugins.includes("lodash")).toBe(false);
});
});
总结
使用编程语言来配置工程可以轻松地实现很多JSON配置需要工具支持才能实现的功能,也让共享配置的门槛进一步降低,安卓很早就采用了Gradle来配置项目,就是看中了Gradle脚本使用groovy代码编写使得配置更加灵活方便,省了折腾那些花里胡哨的工具的时间多写两个BUG它不香么??
- 使用 Go 语言完成 HTTP 文件上传与下载
- 运维平台的建设思考-元数据管理(四)(r8笔记第16天)
- JavaWeb21-基础加强(注解;代理;类加载器;泛型反射
- MySQL迁移文件的小问题(r8笔记第18天)
- SpringMVC学习第一天
- 最近的几个技术问题总结和答疑 (r8笔记第19天)
- Hibernate_day04总结
- Hibernate_day03总结
- 服务器进程异常的原因分析(第二篇)(r8笔记第16天)
- 最近处理的几个小问题_20160311 (r8笔记第35天)
- Hibernate_day02总结
- Hibernate_day01总结
- ADG备库批量查询失败的原因分析(r8笔记第33天)
- 通过外部表改进一个繁琐的大查询 (r8笔记第32天)
- JavaScript 教程
- JavaScript 编辑工具
- JavaScript 与HTML
- JavaScript 与Java
- JavaScript 数据结构
- JavaScript 基本数据类型
- JavaScript 特殊数据类型
- JavaScript 运算符
- JavaScript typeof 运算符
- JavaScript 表达式
- JavaScript 类型转换
- JavaScript 基本语法
- JavaScript 注释
- Javascript 基本处理流程
- Javascript 选择结构
- Javascript if 语句
- Javascript if 语句的嵌套
- Javascript switch 语句
- Javascript 循环结构
- Javascript 循环结构实例
- Javascript 跳转语句
- Javascript 控制语句总结
- Javascript 函数介绍
- Javascript 函数的定义
- Javascript 函数调用
- Javascript 几种特殊的函数
- JavaScript 内置函数简介
- Javascript eval() 函数
- Javascript isFinite() 函数
- Javascript isNaN() 函数
- parseInt() 与 parseFloat()
- escape() 与 unescape()
- Javascript 字符串介绍
- Javascript length属性
- javascript 字符串函数
- Javascript 日期对象简介
- Javascript 日期对象用途
- Date 对象属性和方法
- Javascript 数组是什么
- Javascript 创建数组
- Javascript 数组赋值与取值
- Javascript 数组属性和方法
- Ubuntu 16.04无法切换root权限问题的解决
- leetcode栈之用队列实现栈
- 在Linux上识别同样内容的文件详解
- Ubuntu下pycharm无法导入类的解决方法
- leetcode栈之最小栈
- Linux基础学习之利用tcpdump抓包实例代码
- Linux/Unix关于时间和时间戳的命令行
- git文件管理心得分享
- Linux如何实现断点续传文件功能
- Xshell实现Windows上传文件到Linux主机的方法
- Linux中的EXT系列文件系统格式详解
- Linux中hexdump命令用法
- CentOS7挂载新数据盘的完整步骤
- Linux下安装Keepalived及原理分析
- centos6搭建gitlab的方法步骤