-
-
Notifications
You must be signed in to change notification settings - Fork 4.4k
/
config.js
1409 lines (1156 loc) · 53.2 KB
/
config.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* @fileoverview Tests for config object.
* @author Seth McLaughlin
*/
/* eslint no-undefined: "off" */
"use strict";
//------------------------------------------------------------------------------
// Requirements
//------------------------------------------------------------------------------
const assert = require("chai").assert,
path = require("path"),
fs = require("fs"),
os = require("os"),
Config = require("../../lib/config"),
Linter = require("../../lib/linter"),
environments = require("../../conf/environments"),
sinon = require("sinon"),
mockFs = require("mock-fs");
const DIRECTORY_CONFIG_HIERARCHY = require("../fixtures/config-hierarchy/file-structure.json");
const linter = new Linter();
require("shelljs/global");
const proxyquire = require("proxyquire").noCallThru().noPreserveCache();
/* global mkdir, rm, cp */
/**
* Creates a stubbed Config object that will bypass normal require() to load
* plugins by name from the objects specified.
* @param {Object} plugins The keys are the package names, values are plugin objects.
* @returns {Config} The stubbed instance of Config.
* @private
*/
function createStubbedConfigWithPlugins(plugins) {
// stub out plugins
const StubbedPlugins = proxyquire("../../lib/config/plugins", plugins);
// stub out config file to use stubbed plugins
const StubbedConfigFile = proxyquire("../../lib/config/config-file", {
"./plugins": StubbedPlugins
});
// stub out Config to use stub config file
return proxyquire("../../lib/config", {
"./config/config-file": StubbedConfigFile,
"./config/plugins": StubbedPlugins
});
}
/**
* Asserts that two configs are equal. This is necessary because assert.deepEqual()
* gets confused when properties are in different orders.
* @param {Object} actual The config object to check.
* @param {Object} expected What the config object should look like.
* @returns {void}
* @private
*/
function assertConfigsEqual(actual, expected) {
if (actual.env && expected.env) {
assert.deepEqual(actual.env, expected.env);
}
if (actual.parserOptions && expected.parserOptions) {
assert.deepEqual(actual.parserOptions, expected.parserOptions);
}
if (actual.globals && expected.globals) {
assert.deepEqual(actual.globals, expected.globals);
}
if (actual.rules && expected.rules) {
assert.deepEqual(actual.rules, expected.rules);
}
if (actual.plugins && expected.plugins) {
assert.deepEqual(actual.plugins, expected.plugins);
}
}
//------------------------------------------------------------------------------
// Tests
//------------------------------------------------------------------------------
describe("Config", () => {
let fixtureDir,
sandbox;
/**
* Returns the path inside of the fixture directory.
* @returns {string} The path inside the fixture directory.
* @private
*/
function getFixturePath() {
const args = Array.prototype.slice.call(arguments);
args.unshift("config-hierarchy");
args.unshift(fixtureDir);
return path.join.apply(path, args);
}
/**
* Mocks the current CWD path
* @param {string} fakeCWDPath - fake CWD path
* @returns {void}
* @private
*/
function mockCWDResponse(fakeCWDPath) {
sandbox.stub(process, "cwd")
.returns(fakeCWDPath);
}
/**
* Mocks the current user's home path
* @param {string} fakeUserHomePath - fake user's home path
* @returns {void}
* @private
*/
function mockOsHomedir(fakeUserHomePath) {
sandbox.stub(os, "homedir")
.returns(fakeUserHomePath);
}
// copy into clean area so as not to get "infected" by this project's .eslintrc files
before(() => {
fixtureDir = `${os.tmpdir()}/eslint/fixtures`;
mkdir("-p", fixtureDir);
cp("-r", "./tests/fixtures/config-hierarchy", fixtureDir);
});
beforeEach(() => {
sandbox = sinon.sandbox.create();
});
afterEach(() => {
sandbox.verifyAndRestore();
});
after(() => {
rm("-r", fixtureDir);
});
describe("new Config()", () => {
// https://github.com/eslint/eslint/issues/2380
it("should not modify baseConfig when format is specified", () => {
const customBaseConfig = { foo: "bar" },
configHelper = new Config({ baseConfig: customBaseConfig, format: "foo" }, linter);
// at one point, customBaseConfig.format would end up equal to "foo"...that's bad
assert.deepEqual(customBaseConfig, { foo: "bar" });
assert.equal(configHelper.options.format, "foo");
});
it("should create config object when using baseConfig with extends", () => {
const customBaseConfig = {
extends: path.resolve(__dirname, "..", "fixtures", "config-extends", "array", ".eslintrc")
};
const configHelper = new Config({ baseConfig: customBaseConfig }, linter);
assert.deepEqual(configHelper.baseConfig.env, {
browser: false,
es6: true,
node: true
});
assert.deepEqual(configHelper.baseConfig.rules, {
"no-empty": 1,
"comma-dangle": 2,
"no-console": 2
});
});
});
describe("findLocalConfigFiles()", () => {
/**
* Returns the path inside of the fixture directory.
* @returns {string} The path inside the fixture directory.
* @private
*/
function getFakeFixturePath() {
const args = Array.prototype.slice.call(arguments);
args.unshift("config-hierarchy");
args.unshift("fixtures");
args.unshift("eslint");
args.unshift(process.cwd());
return path.join.apply(path, args);
}
before(() => {
mockFs({
eslint: {
fixtures: {
"config-hierarchy": DIRECTORY_CONFIG_HIERARCHY
}
}
});
});
after(() => {
mockFs.restore();
});
it("should return the path when an .eslintrc file is found", () => {
const configHelper = new Config({}, linter),
expected = getFakeFixturePath("broken", ".eslintrc"),
actual = Array.from(
configHelper.findLocalConfigFiles(getFakeFixturePath("broken")));
assert.equal(actual[0], expected);
});
it("should return an empty array when an .eslintrc file is not found", () => {
const configHelper = new Config({}, linter),
actual = Array.from(
configHelper.findLocalConfigFiles(getFakeFixturePath()));
assert.isArray(actual);
assert.lengthOf(actual, 0);
});
it("should return package.json only when no other config files are found", () => {
const configHelper = new Config({}, linter),
expected0 = getFakeFixturePath("packagejson", "subdir", "package.json"),
expected1 = getFakeFixturePath("packagejson", ".eslintrc"),
actual = Array.from(
configHelper.findLocalConfigFiles(getFakeFixturePath("packagejson", "subdir")));
assert.equal(actual[0], expected0);
assert.equal(actual[1], expected1);
});
it("should return the only one config file even if there are multiple found", () => {
const configHelper = new Config({}, linter),
expected = getFakeFixturePath("broken", ".eslintrc"),
// The first element of the array is the .eslintrc in the same directory.
actual = Array.from(
configHelper.findLocalConfigFiles(getFakeFixturePath("broken")));
assert.equal(actual.length, 1);
assert.equal(actual, expected);
});
it("should return all possible files when multiple are found", () => {
const configHelper = new Config({}, linter),
expected = [
getFakeFixturePath("fileexts/subdir/subsubdir/", ".eslintrc.json"),
getFakeFixturePath("fileexts/subdir/", ".eslintrc.yml"),
getFakeFixturePath("fileexts", ".eslintrc.js")
],
actual = Array.from(
configHelper.findLocalConfigFiles(getFakeFixturePath("fileexts/subdir/subsubdir")));
assert.deepEqual(actual.length, expected.length);
});
it("should return an empty array when a package.json file is not found", () => {
const configHelper = new Config({}, linter),
actual = Array.from(configHelper.findLocalConfigFiles(getFakeFixturePath()));
assert.isArray(actual);
assert.lengthOf(actual, 0);
});
});
describe("getConfig()", () => {
it("should return the project config when called in current working directory", () => {
const configHelper = new Config({ cwd: process.cwd() }, linter),
actual = configHelper.getConfig();
assert.equal(actual.rules.strict[1], "global");
});
it("should not retain configs from previous directories when called multiple times", () => {
const firstpath = path.resolve(__dirname, "..", "fixtures", "configurations", "single-quotes", "subdir", ".eslintrc");
const secondpath = path.resolve(__dirname, "..", "fixtures", "configurations", "single-quotes", ".eslintrc");
const configHelper = new Config({ cwd: process.cwd() }, linter);
let config;
config = configHelper.getConfig(firstpath);
assert.equal(config.rules["no-new"], 0);
config = configHelper.getConfig(secondpath);
assert.equal(config.rules["no-new"], 1);
});
it("should throw an error when an invalid path is given", () => {
const configPath = path.resolve(__dirname, "..", "fixtures", "configurations", "foobaz", ".eslintrc");
const homePath = "does-not-exist";
mockOsHomedir(homePath);
const StubbedConfig = proxyquire("../../lib/config", {});
const configHelper = new StubbedConfig({ cwd: process.cwd() }, linter);
sandbox.stub(fs, "readdirSync").throws(new Error());
assert.throws(() => {
configHelper.getConfig(configPath);
}, "No ESLint configuration found.");
});
it("should throw error when a configuration file doesn't exist", () => {
const configPath = path.resolve(__dirname, "..", "fixtures", "configurations", ".eslintrc");
const configHelper = new Config({ cwd: process.cwd() }, linter);
sandbox.stub(fs, "readFileSync").throws(new Error());
assert.throws(() => {
configHelper.getConfig(configPath);
}, "Cannot read config file");
});
it("should throw error when a configuration file is not require-able", () => {
const configPath = ".eslintrc";
const configHelper = new Config({ cwd: process.cwd() }, linter);
sandbox.stub(fs, "readFileSync").throws(new Error());
assert.throws(() => {
configHelper.getConfig(configPath);
}, "Cannot read config file");
});
it("should cache config when the same directory is passed twice", () => {
const configPath = path.resolve(__dirname, "..", "fixtures", "configurations", "single-quotes", ".eslintrc");
const configHelper = new Config({ cwd: process.cwd() }, linter);
sandbox.spy(configHelper, "findLocalConfigFiles");
// If cached this should be called only once
configHelper.getConfig(configPath);
const callcount = configHelper.findLocalConfigFiles.callcount;
configHelper.getConfig(configPath);
assert.equal(configHelper.findLocalConfigFiles.callcount, callcount);
});
// make sure JS-style comments don't throw an error
it("should load the config file when there are JS-style comments in the text", () => {
const configPath = path.resolve(__dirname, "..", "fixtures", "configurations", "comments.json"),
configHelper = new Config({ configFile: configPath }, linter),
semi = configHelper.specificConfig.rules.semi,
strict = configHelper.specificConfig.rules.strict;
assert.equal(semi, 1);
assert.equal(strict, 0);
});
// make sure YAML files work correctly
it("should load the config file when a YAML file is used", () => {
const configPath = path.resolve(__dirname, "..", "fixtures", "configurations", "env-browser.yaml"),
configHelper = new Config({ configFile: configPath }, linter),
noAlert = configHelper.specificConfig.rules["no-alert"],
noUndef = configHelper.specificConfig.rules["no-undef"];
assert.equal(noAlert, 0);
assert.equal(noUndef, 2);
});
it("should contain the correct value for parser when a custom parser is specified", () => {
const configPath = path.resolve(__dirname, "../fixtures/configurations/parser/.eslintrc.json"),
configHelper = new Config({ cwd: process.cwd() }, linter),
config = configHelper.getConfig(configPath);
assert.equal(config.parser, path.resolve(path.dirname(configPath), "./custom.js"));
});
// Configuration hierarchy ---------------------------------------------
// https://github.com/eslint/eslint/issues/3915
it("should correctly merge environment settings", () => {
const configHelper = new Config({ useEslintrc: true, cwd: process.cwd() }, linter),
file = getFixturePath("envs", "sub", "foo.js"),
expected = {
rules: {},
env: {
browser: true,
node: false
},
globals: environments.browser.globals
},
actual = configHelper.getConfig(file);
assertConfigsEqual(actual, expected);
});
// Default configuration - blank
it("should return a blank config when using no .eslintrc", () => {
const configHelper = new Config({ useEslintrc: false }, linter),
file = getFixturePath("broken", "console-wrong-quotes.js"),
expected = {
rules: {},
globals: {},
env: {}
},
actual = configHelper.getConfig(file);
assertConfigsEqual(actual, expected);
});
it("should return a blank config when baseConfig is set to false and no .eslintrc", () => {
const configHelper = new Config({ baseConfig: false, useEslintrc: false }, linter),
file = getFixturePath("broken", "console-wrong-quotes.js"),
expected = {
rules: {},
globals: {},
env: {}
},
actual = configHelper.getConfig(file);
assertConfigsEqual(actual, expected);
});
// No default configuration
it("should return an empty config when not using .eslintrc", () => {
const configHelper = new Config({ useEslintrc: false }, linter),
file = getFixturePath("broken", "console-wrong-quotes.js"),
actual = configHelper.getConfig(file);
assertConfigsEqual(actual, {});
});
it("should return a modified config when baseConfig is set to an object and no .eslintrc", () => {
const configHelper = new Config({
baseConfig: {
env: {
node: true
},
rules: {
quotes: [2, "single"]
}
},
useEslintrc: false
}, linter),
file = getFixturePath("broken", "console-wrong-quotes.js"),
expected = {
env: {
node: true
},
rules: {
quotes: [2, "single"]
}
},
actual = configHelper.getConfig(file);
assertConfigsEqual(actual, expected);
});
it("should return a modified config without plugin rules enabled when baseConfig is set to an object with plugin and no .eslintrc", () => {
const customRule = require("../fixtures/rules/custom-rule");
const examplePluginName = "eslint-plugin-example";
const requireStubs = {};
requireStubs[examplePluginName] = {
rules: { "example-rule": customRule },
// rulesConfig support removed in 2.0.0, so this should have no effect
rulesConfig: { "example-rule": 1 }
};
const StubbedConfig = proxyquire("../../lib/config", requireStubs);
const configHelper = new StubbedConfig({
baseConfig: {
env: {
node: true
},
rules: {
quotes: [2, "single"]
},
plugins: [examplePluginName]
},
useEslintrc: false
}, linter),
file = getFixturePath("broken", "plugins", "console-wrong-quotes.js"),
expected = {
env: {
node: true
},
rules: {
quotes: [2, "single"]
}
},
actual = configHelper.getConfig(file);
assertConfigsEqual(actual, expected);
});
// Project configuration - second level .eslintrc
it("should merge configs when local .eslintrc overrides parent .eslintrc", () => {
const configHelper = new Config({ cwd: process.cwd() }, linter),
file = getFixturePath("broken", "subbroken", "console-wrong-quotes.js"),
expected = {
env: {
node: true
},
rules: {
"no-console": 1,
quotes: [2, "single"]
}
},
actual = configHelper.getConfig(file);
expected.env.node = true;
assertConfigsEqual(actual, expected);
});
// Project configuration - third level .eslintrc
it("should merge configs when local .eslintrc overrides parent and grandparent .eslintrc", () => {
const configHelper = new Config({ cwd: process.cwd() }, linter),
file = getFixturePath("broken", "subbroken", "subsubbroken", "console-wrong-quotes.js"),
expected = {
env: {
node: true
},
rules: {
"no-console": 0,
quotes: [1, "double"]
}
},
actual = configHelper.getConfig(file);
expected.env.node = true;
assertConfigsEqual(actual, expected);
});
// Project configuration - root set in second level .eslintrc
it("should not return or traverse configurations in parents of config with root:true", () => {
const configHelper = new Config({ cwd: process.cwd() }, linter),
file = getFixturePath("root-true", "parent", "root", "wrong-semi.js"),
expected = {
rules: {
semi: [2, "never"]
}
},
actual = configHelper.getConfig(file);
assertConfigsEqual(actual, expected);
});
// Project configuration - root set in second level .eslintrc
it("should return project config when called with a relative path from a subdir", () => {
const configHelper = new Config({ cwd: getFixturePath("root-true", "parent", "root", "subdir") }, linter),
dir = ".",
expected = {
rules: {
semi: [2, "never"]
}
},
actual = configHelper.getConfig(dir);
assertConfigsEqual(actual, expected);
});
// Command line configuration - --config with first level .eslintrc
it("should merge command line config when config file adds to local .eslintrc", () => {
const configHelper = new Config({
configFile: getFixturePath("broken", "add-conf.yaml"),
cwd: process.cwd()
}, linter),
file = getFixturePath("broken", "console-wrong-quotes.js"),
expected = {
env: {
node: true
},
rules: {
quotes: [2, "double"],
semi: [1, "never"]
}
},
actual = configHelper.getConfig(file);
expected.env.node = true;
assertConfigsEqual(actual, expected);
});
// Command line configuration - --config with first level .eslintrc
it("should merge command line config when config file overrides local .eslintrc", () => {
const configHelper = new Config({
configFile: getFixturePath("broken", "override-conf.yaml"),
cwd: process.cwd()
}, linter),
file = getFixturePath("broken", "console-wrong-quotes.js"),
expected = {
env: {
node: true
},
rules: {
quotes: [0, "double"]
}
},
actual = configHelper.getConfig(file);
expected.env.node = true;
assertConfigsEqual(actual, expected);
});
// Command line configuration - --config with second level .eslintrc
it("should merge command line config when config file adds to local and parent .eslintrc", () => {
const configHelper = new Config({
configFile: getFixturePath("broken", "add-conf.yaml"),
cwd: process.cwd()
}, linter),
file = getFixturePath("broken", "subbroken", "console-wrong-quotes.js"),
expected = {
env: {
node: true
},
rules: {
quotes: [2, "single"],
"no-console": 1,
semi: [1, "never"]
}
},
actual = configHelper.getConfig(file);
expected.env.node = true;
assertConfigsEqual(actual, expected);
});
// Command line configuration - --config with second level .eslintrc
it("should merge command line config when config file overrides local and parent .eslintrc", () => {
const configHelper = new Config({
configFile: getFixturePath("broken", "override-conf.yaml"),
cwd: process.cwd()
}, linter),
file = getFixturePath("broken", "subbroken", "console-wrong-quotes.js"),
expected = {
env: {
node: true
},
rules: {
quotes: [0, "single"],
"no-console": 1
}
},
actual = configHelper.getConfig(file);
expected.env.node = true;
assertConfigsEqual(actual, expected);
});
// Command line configuration - --rule with --config and first level .eslintrc
it("should merge command line config and rule when rule and config file overrides local .eslintrc", () => {
const configHelper = new Config({
configFile: getFixturePath("broken", "override-conf.yaml"),
rules: {
quotes: [1, "double"]
},
cwd: process.cwd()
}, linter),
file = getFixturePath("broken", "console-wrong-quotes.js"),
expected = {
env: {
node: true
},
rules: {
quotes: [1, "double"]
}
},
actual = configHelper.getConfig(file);
expected.env.node = true;
assertConfigsEqual(actual, expected);
});
// Command line configuration - --plugin
it("should merge command line plugin with local .eslintrc", () => {
// stub out Config to use stub config file
const StubbedConfig = createStubbedConfigWithPlugins({
"eslint-plugin-example": {},
"eslint-plugin-another-plugin": {}
});
const configHelper = new StubbedConfig({
plugins: ["another-plugin"],
cwd: process.cwd()
}, linter),
file = getFixturePath("broken", "plugins", "console-wrong-quotes.js"),
expected = {
plugins: [
"example",
"another-plugin"
]
},
actual = configHelper.getConfig(file);
assertConfigsEqual(actual, expected);
});
it("should merge multiple different config file formats", () => {
const configHelper = new Config({ cwd: process.cwd() }, linter),
file = getFixturePath("fileexts/subdir/subsubdir/foo.js"),
expected = {
env: {
browser: true
},
rules: {
semi: [2, "always"],
eqeqeq: 2
}
},
actual = configHelper.getConfig(file);
assertConfigsEqual(actual, expected);
});
it("should load user config globals", () => {
const configPath = path.resolve(__dirname, "..", "fixtures", "globals", "conf.yaml"),
configHelper = new Config({ configFile: configPath, useEslintrc: false }, linter);
const expected = {
globals: {
foo: true
}
};
const actual = configHelper.getConfig(configPath);
assertConfigsEqual(actual, expected);
});
it("should not load disabled environments", () => {
const configPath = path.resolve(__dirname, "..", "fixtures", "environments", "disable.yaml");
const configHelper = new Config({ configFile: configPath, useEslintrc: false }, linter);
const config = configHelper.getConfig(configPath);
assert.isUndefined(config.globals.window);
});
it("should error on fake environments", () => {
const configPath = path.resolve(__dirname, "..", "fixtures", "environments", "fake.yaml");
assert.throw(() => {
new Config({ configFile: configPath, useEslintrc: false, cwd: process.cwd() }, linter); // eslint-disable-line no-new
});
});
it("should gracefully handle empty files", () => {
const configPath = path.resolve(__dirname, "..", "fixtures", "configurations", "env-node.json"),
configHelper = new Config({ configFile: configPath, cwd: process.cwd() }, linter);
configHelper.getConfig(path.resolve(__dirname, "..", "fixtures", "configurations", "empty", "empty.json"));
});
// Meaningful stack-traces
it("should include references to where an `extends` configuration was loaded from", () => {
const configPath = path.resolve(__dirname, "..", "fixtures", "config-extends", "error.json");
assert.throws(() => {
const configHelper = new Config({ useEslintrc: false, configFile: configPath }, linter);
configHelper.getConfig(configPath);
}, /Referenced from:.*?error\.json/);
});
// Keep order with the last array element taking highest precedence
it("should make the last element in an array take the highest precedence", () => {
const configPath = path.resolve(__dirname, "..", "fixtures", "config-extends", "array", ".eslintrc"),
configHelper = new Config({ useEslintrc: false, configFile: configPath }, linter),
expected = {
rules: { "no-empty": 1, "comma-dangle": 2, "no-console": 2 },
env: { browser: false, node: true, es6: true }
},
actual = configHelper.getConfig(configPath);
assertConfigsEqual(actual, expected);
});
describe("with env in a child configuration file", () => {
it("should not overwrite parserOptions of the parent with env of the child", () => {
const config = new Config({ cwd: process.cwd() }, linter);
const targetPath = getFixturePath("overwrite-ecmaFeatures", "child", "foo.js");
const expected = {
rules: {},
env: { commonjs: true },
parserOptions: { ecmaFeatures: { globalReturn: false } }
};
const actual = config.getConfig(targetPath);
assertConfigsEqual(actual, expected);
});
});
describe("personal config file within home directory", () => {
/**
* Returns the path inside of the fixture directory.
* @returns {string} The path inside the fixture directory.
* @private
*/
function getFakeFixturePath() {
const args = Array.prototype.slice.call(arguments);
args.unshift("config-hierarchy");
args.unshift("fixtures");
args.unshift("eslint");
args.unshift(process.cwd());
return path.join.apply(path, args);
}
/**
* Mocks the file system for personal-config files
* @returns {undefined}
* @private
*/
function mockPersonalConfigFileSystem() {
mockFs({
eslint: {
fixtures: {
"config-hierarchy": DIRECTORY_CONFIG_HIERARCHY
}
}
});
}
afterEach(() => {
mockFs.restore();
});
it("should load the personal config if no local config was found", () => {
const projectPath = getFakeFixturePath("personal-config", "project-without-config"),
homePath = getFakeFixturePath("personal-config", "home-folder"),
filePath = getFakeFixturePath("personal-config", "project-without-config", "foo.js");
mockOsHomedir(homePath);
const StubbedConfig = proxyquire("../../lib/config", {});
mockPersonalConfigFileSystem();
mockCWDResponse(projectPath);
const config = new StubbedConfig({ cwd: process.cwd() }, linter),
actual = config.getConfig(filePath),
expected = {
parserOptions: {},
env: {},
globals: {},
parser: undefined,
rules: {
"home-folder-rule": 2
}
};
assert.deepEqual(actual, expected);
});
it("should ignore the personal config if a local config was found", () => {
const projectPath = getFakeFixturePath("personal-config", "home-folder", "project"),
homePath = getFakeFixturePath("personal-config", "home-folder"),
filePath = getFakeFixturePath("personal-config", "home-folder", "project", "foo.js");
mockOsHomedir(homePath);
const StubbedConfig = proxyquire("../../lib/config", {});
mockPersonalConfigFileSystem();
mockCWDResponse(projectPath);
const config = new StubbedConfig({ cwd: process.cwd() }, linter),
actual = config.getConfig(filePath),
expected = {
parserOptions: {},
env: {},
globals: {},
parser: undefined,
rules: {
"project-level-rule": 2
}
};
assert.deepEqual(actual, expected);
});
it("should ignore the personal config if config is passed through cli", () => {
const configPath = getFakeFixturePath("quotes-error.json");
const projectPath = getFakeFixturePath("personal-config", "project-without-config"),
homePath = getFakeFixturePath("personal-config", "home-folder"),
filePath = getFakeFixturePath("personal-config", "project-without-config", "foo.js");
mockOsHomedir(homePath);
const StubbedConfig = proxyquire("../../lib/config", {});
mockPersonalConfigFileSystem();
mockCWDResponse(projectPath);
const config = new StubbedConfig({ configFile: configPath, cwd: process.cwd() }, linter),
actual = config.getConfig(filePath),
expected = {
parserOptions: {},
env: {},
globals: {},
parser: undefined,
rules: {
quotes: [2, "double"]
}
};
assert.deepEqual(actual, expected);
});
it("should still load the project config if the current working directory is the same as the home folder", () => {
const projectPath = getFakeFixturePath("personal-config", "project-with-config"),
filePath = getFakeFixturePath("personal-config", "project-with-config", "subfolder", "foo.js");
mockOsHomedir(projectPath);
const StubbedConfig = proxyquire("../../lib/config", {});
mockPersonalConfigFileSystem();
mockCWDResponse(projectPath);
const config = new StubbedConfig({ cwd: process.cwd() }, linter),
actual = config.getConfig(filePath),
expected = {
parserOptions: {},
env: {},
globals: {},
parser: undefined,
rules: {
"project-level-rule": 2,
"subfolder-level-rule": 2
}
};
assert.deepEqual(actual, expected);
});
});
describe("when no local or personal config is found", () => {
/**
* Returns the path inside of the fixture directory.
* @returns {string} The path inside the fixture directory.
* @private
*/
function getFakeFixturePath() {
const args = Array.prototype.slice.call(arguments);
args.unshift("config-hierarchy");
args.unshift("fixtures");
args.unshift("eslint");
args.unshift(process.cwd());
return path.join.apply(path, args);
}
/**
* Mocks the file system for personal-config files
* @returns {undefined}
* @private
*/
function mockPersonalConfigFileSystem() {
mockFs({
eslint: {
fixtures: {
"config-hierarchy": DIRECTORY_CONFIG_HIERARCHY
}
}
});
}
afterEach(() => {
mockFs.restore();