Rename to enableTypeScriptLoader

symfony · Jun 26, 2017 · f6bc6e7 · f6bc6e7
1 parent facc132
commit f6bc6e7
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 12 deletions.
diff --git a/index.js b/index.js
@@ -344,7 +344,7 @@ module.exports = {
     /**
      * Call this if you plan on loading TypeScript files.
      *
-     * Encore.configureTypeScript(function(tsConfig) {
+     * Encore.enableTypeScriptLoader(function(tsConfig) {
      *      // change the tsConfig
      * });
      *
@@ -354,8 +354,8 @@ module.exports = {
      * @param {function} callback
      * @return {exports}
      */
-    configureTypeScript(callback) {
-        webpackConfig.configureTypeScript(callback);
+    enableTypeScriptLoader(callback) {
+        webpackConfig.enableTypeScriptLoader(callback);
 
         return this;
     },

diff --git a/lib/WebpackConfig.js b/lib/WebpackConfig.js
@@ -224,11 +224,11 @@ class WebpackConfig {
         this.useReact = true;
     }
 
-    configureTypeScript(callback) {
+    enableTypeScriptLoader(callback) {
         this.useTypeScriptLoader = true;
 
         if (typeof callback !== 'function') {
-            throw new Error('Argument 1 to configureTypeScript() must be a callback function.');
+            throw new Error('Argument 1 to enableTypeScriptLoader() must be a callback function.');
         }
 
         this.tsConfigurationCallback = callback;

diff --git a/lib/loader-features.js b/lib/loader-features.js
@@ -37,7 +37,7 @@ const loaderFeatures = {
         description: 'process React JS files'
     },
     typescript: {
-        method: 'configureTypeScript()',
+        method: 'enableTypeScriptLoader()',
         packages: ['typescript', 'ts-loader'],
         description: 'process TypeScript files'
     }

diff --git a/test/WebpackConfig.js b/test/WebpackConfig.js
@@ -278,19 +278,23 @@ describe('WebpackConfig object', () => {
         });
     });
 
-    describe('configureTypeScript', () => {
+    describe('enableTypeScriptLoader', () => {
         it('Calling method sets it', () => {
             const config = createConfig();
             const testCallback = () => {};
-            config.configureTypeScript(testCallback);
+            config.enableTypeScriptLoader(testCallback);
             expect(config.tsConfigurationCallback).to.equal(testCallback);
         });
 
         it('Calling with non-callback throws an error', () => {
             const config = createConfig();
 
             expect(() => {
-                config.configureTypeScript('FOO');
+                config.enableTypeScriptLoader('FOO');
+            }).to.throw('must be a callback function');
+
+            expect(() => {
+                config.enableTypeScriptLoader();
             }).to.throw('must be a callback function');
         });
     });

diff --git a/test/functional.js b/test/functional.js
@@ -588,7 +588,7 @@ module.exports = {
             config.setPublicPath('/build');
             config.addEntry('main', ['./js/render.ts', './js/index.ts']);
             const testCallback = () => {};
-            config.configureTypeScript(testCallback);
+            config.enableTypeScriptLoader(testCallback);
 
             testSetup.runWebpack(config, (webpackAssert) => {
                 // check that ts-loader transformed the ts file

diff --git a/test/loaders/typescript.js b/test/loaders/typescript.js
@@ -25,7 +25,7 @@ function createConfig() {
 describe('loaders/typescript', () => {
     it('getLoaders() basic usage', () => {
         const config = createConfig();
-        config.configureTypeScript(function(config) {
+        config.enableTypeScriptLoader(function(config) {
             config.foo = 'bar';
         });
 
@@ -37,7 +37,7 @@ describe('loaders/typescript', () => {
 
     it('getLoaders() check defaults configuration values', () => {
         const config = createConfig();
-        config.configureTypeScript(function(config) {
+        config.enableTypeScriptLoader(function(config) {
             config.foo = 'bar';
         });