别再用JSON配置文件了

大家肯定都发现了,现在越来越多的前端工具支持用JavaScript来进行自定义配置了。(比如说BabelESLint)不管大家之前出于什么原因选择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它不香么???

?著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,128评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,316评论 3 388
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事?!?“怎么了?”我有些...
    开封第一讲书人阅读 159,737评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,283评论 1 287
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,384评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,458评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,467评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,251评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,688评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,980评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,155评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,818评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,492评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,142评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,382评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,020评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,044评论 2 352