Skip to content

Commit ffe3054

Browse files
committed
Recommend null instead of false for the first parameter of configureBabel()
1 parent 644d1ac commit ffe3054

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

index.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -787,7 +787,7 @@ class Encore {
787787
* // change the babelConfig
788788
* // if you use an external Babel configuration
789789
* // this callback will NOT be used. In this case
790-
* // you can pass false as the first parameter to
790+
* // you can pass null as the first parameter to
791791
* // still be able to use some of the options below
792792
* // without a warning.
793793
* }, {
@@ -833,7 +833,7 @@ class Encore {
833833
* file for instance). In this case you can set the option directly into
834834
* that configuration file.
835835
*
836-
* @param {function|false} callback
836+
* @param {function|null} callback
837837
* @param {object} encoreOptions
838838
* @returns {Encore}
839839
*/

test/WebpackConfig.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -621,14 +621,14 @@ describe('WebpackConfig object', () => {
621621
it('Calling with a whitelisted option when .babelrc is present works fine', () => {
622622
const config = createConfig();
623623
config.runtimeConfig.babelRcFileExists = true;
624-
config.configureBabel(false, { includeNodeModules: ['foo'] });
624+
config.configureBabel(null, { includeNodeModules: ['foo'] });
625625
expect(logger.getMessages().warning).to.be.empty;
626626
});
627627

628628
it('Calling with a non-whitelisted option when .babelrc is present displays a warning', () => {
629629
const config = createConfig();
630630
config.runtimeConfig.babelRcFileExists = true;
631-
config.configureBabel(false, { useBuiltIns: 'foo' });
631+
config.configureBabel(null, { useBuiltIns: 'foo' });
632632

633633
const warnings = logger.getMessages().warning;
634634
expect(warnings).to.have.lengthOf(1);

0 commit comments

Comments
 (0)