feat(transformer): error when running tests with no transformer installation

Pmyl · Pmyl · commit 16506e5ae72d · 2020-06-27T18:02:43.000+01:00
diff --git a/config/karma/base/karma.config.base.js b/config/karma/base/karma.config.base.js
@@ -1,7 +1,6 @@
-const webpackConfig = require('../test/webpack.js');
 process.env.CHROME_BIN = require('puppeteer').executablePath();
 
-module.exports = function(config, url) {
+module.exports = function(config, url, webpackConfig) {
     return {
         basePath: '',
         frameworks: ['jasmine'],
diff --git a/config/karma/base/karma.config.noTransformer.base.js b/config/karma/base/karma.config.noTransformer.base.js
@@ -0,0 +1,6 @@
+const webpackConfig = require('../../test/noTransformer/webpack.js');
+const karmaBase = require('./karma.config.base');
+
+module.exports = function(config, url) {
+    return karmaBase(config, url, webpackConfig);
+};
diff --git a/config/karma/base/karma.config.transformer.base.js b/config/karma/base/karma.config.transformer.base.js
@@ -0,0 +1,6 @@
+const webpackConfig = require('../../test/transformer/webpack.js');
+const karmaBase = require('./karma.config.base');
+
+module.exports = function(config, url) {
+    return karmaBase(config, url, webpackConfig);
+};
diff --git a/config/karma/karma.config.features.js b/config/karma/karma.config.features.js
@@ -1,4 +1,4 @@
-const karmaBaseConfig = require('./karma.config.base');
+const karmaBaseConfig = require('./base/karma.config.transformer.base');
 
 module.exports = function(config) {
     const karmaConfig = karmaBaseConfig(config, '../../test/features/context.ts');
diff --git a/config/karma/karma.config.framework.context.js b/config/karma/karma.config.framework.context.js
@@ -1,4 +1,4 @@
-const karmaBaseConfig = require('./karma.config.base');
+const karmaBaseConfig = require('./base/karma.config.transformer.base');
 
 module.exports = function(config) {
     const karmaConfig = karmaBaseConfig(config, "../../test/frameworkContext/context.ts");
diff --git a/config/karma/karma.config.framework.deprecated.js b/config/karma/karma.config.framework.deprecated.js
@@ -1,4 +1,4 @@
-const karmaBaseConfig = require('./karma.config.base');
+const karmaBaseConfig = require('./base/karma.config.transformer.base');
 
 module.exports = function(config) {
     const karmaConfig = karmaBaseConfig(config, "../../test/frameworkContext/contextDeprecated.ts");
diff --git a/config/karma/karma.config.framework.js b/config/karma/karma.config.framework.js
@@ -1,4 +1,4 @@
-const karmaBaseConfig = require('./karma.config.base');
+const karmaBaseConfig = require('./base/karma.config.transformer.base');
 
 module.exports = function(config) {
     const karmaConfig = karmaBaseConfig(config, "../../test/framework/**/*.test.ts");
diff --git a/config/karma/karma.config.noTransformer.js b/config/karma/karma.config.noTransformer.js
@@ -0,0 +1,7 @@
+const karmaBaseConfig = require('./base/karma.config.noTransformer.base');
+
+module.exports = function(config) {
+    const karmaConfig = karmaBaseConfig(config, "../../test/noTransformer/**/*.test.ts");
+
+    config.set(karmaConfig);
+};
diff --git a/config/karma/karma.config.registerMock.js b/config/karma/karma.config.registerMock.js
@@ -1,4 +1,4 @@
-const karmaBaseConfig = require('./karma.config.base');
+const karmaBaseConfig = require('./base/karma.config.transformer.base');
 
 module.exports = function(config) {
     const karmaConfig = karmaBaseConfig(config, '../../test/registerMock/context.ts');
diff --git a/config/karma/karma.config.transformer.js b/config/karma/karma.config.transformer.js
@@ -1,4 +1,4 @@
-const karmaBaseConfig = require('./karma.config.base');
+const karmaBaseConfig = require('./base/karma.config.transformer.base');
 
 module.exports = function(config) {
     const karmaConfig = karmaBaseConfig(config, '../../test/transformer/context.ts');
diff --git a/config/karma/karma.config.transformer.playground.build.js b/config/karma/karma.config.transformer.playground.build.js
@@ -1,4 +1,4 @@
-const karmaBaseConfig = require('./karma.config.base');
+const karmaBaseConfig = require('./base/karma.config.transformer.base');
 
 module.exports = function(config) {
     const karmaConfig = karmaBaseConfig(config, '../../test/playground/**/*.test.js');
diff --git a/config/karma/karma.config.transformer.playground.js b/config/karma/karma.config.transformer.playground.js
@@ -1,4 +1,4 @@
-const karmaBaseConfig = require('./karma.config.base');
+const karmaBaseConfig = require('./base/karma.config.transformer.base');
 
 module.exports = function(config) {
     const karmaConfig = karmaBaseConfig(config, '../../test/playground/**/*.test.ts');
diff --git a/config/karma/karma.config.unit.js b/config/karma/karma.config.unit.js
@@ -1,4 +1,4 @@
-const karmaBaseConfig = require('./karma.config.base');
+const karmaBaseConfig = require('./base/karma.config.transformer.base');
 
 module.exports = function(config) {
     const karmaConfig = karmaBaseConfig(config, '../../test/unit/**/*.test.ts');
diff --git a/config/test/noTransformer/webpack.js b/config/test/noTransformer/webpack.js
@@ -0,0 +1 @@
+module.exports = require('../webpack.base.js');
diff --git a/config/test/transformer/webpack.js b/config/test/transformer/webpack.js
@@ -1,26 +1,13 @@
-const transformer = require('../../dist/transformer');
-const path = require('path');
-const DetermineCacheBetweenTestsFromDebugEnvironment = require('./../utils/cache');
-const DetermineFeaturesFromEnvironment = require('./../utils/features');
+const transformer = require('../../../dist/transformer');
+const merge = require('webpack-merge');
+const base = require('../webpack.base.js');
+const DetermineCacheBetweenTestsFromDebugEnvironment = require('./../../utils/cache');
+const DetermineFeaturesFromEnvironment = require('./../../utils/features');
 
 module.exports = function () {
-    return {
-        mode: "development",
-        resolve: {
-            extensions: ['.ts', '.js'],
-            alias: {
-                ['ts-auto-mock']: path.join(__dirname, '../../dist'),
-                ['ts-auto-mock/repository']: path.join(__dirname, '../../dist/repository'),
-                ['ts-auto-mock/extension']: path.join(__dirname, '../../dist/extension'),
-            }
-        },
+    return merge.smart(base(), {
         module: {
             rules: [
-                {
-                    test: /\.ts$/,
-                    enforce: 'pre',
-                    loader: 'eslint-loader'
-                },
                 {
                     test: /\.ts$/,
                     loader: 'awesome-typescript-loader',
@@ -36,5 +23,5 @@ module.exports = function () {
                 }
             ]
         }
-    }
+    });
 };
diff --git a/config/test/webpack.base.js b/config/test/webpack.base.js
@@ -0,0 +1,28 @@
+const path = require('path');
+
+module.exports = function () {
+    return {
+        mode: "development",
+        resolve: {
+            extensions: ['.ts', '.js'],
+            alias: {
+                ['ts-auto-mock']: path.join(__dirname, '../../dist'),
+                ['ts-auto-mock/repository']: path.join(__dirname, '../../dist/repository'),
+                ['ts-auto-mock/extension']: path.join(__dirname, '../../dist/extension'),
+            }
+        },
+        module: {
+            rules: [
+                {
+                    test: /\.ts$/,
+                    enforce: 'pre',
+                    loader: 'eslint-loader'
+                },
+                {
+                    test: /\.ts$/,
+                    loader: 'awesome-typescript-loader'
+                }
+            ]
+        }
+    }
+};
diff --git a/package.json b/package.json
@@ -11,9 +11,10 @@
     "build:modules:debug": "cross-env DEBUG=true webpack --config config/modules/webpack.js",
     "build:transformer:definitelyTyped": "webpack --config config/modules/definitelyTypedTransformer/webpack.functions.js && webpack --config config/modules/definitelyTypedTransformer/webpack.js",
     "build:playground": "ttsc --project tsconfig.playground.json",
-    "test": "npm run test:transformer && npm run test:framework:context && npm run test:framework && npm run test:frameworkDeprecated && npm run test:registerMock && npm run test:features && npm run test:unit",
+    "test": "npm run test:transformer && npm run test:noTransformer && npm run test:framework:context && npm run test:framework && npm run test:frameworkDeprecated && npm run test:registerMock && npm run test:features && npm run test:unit",
     "test:unit": "karma start config/karma/karma.config.unit.js",
     "test:transformer": "cross-env CACHE=true karma start config/karma/karma.config.transformer.js",
+    "test:noTransformer": "cross-env CACHE=true karma start config/karma/karma.config.noTransformer.js",
     "test:registerMock": "cross-env CACHE=true karma start config/karma/karma.config.registerMock.js",
     "test:framework:context": "cross-env CACHE=true karma start config/karma/karma.config.framework.context.js",
     "test:frameworkDeprecated": "cross-env CACHE=true karma start config/karma/karma.config.framework.deprecated.js",
diff --git a/src/create-mock-list.ts b/src/create-mock-list.ts
@@ -1,2 +1,9 @@
 import { DeepPartial } from './partial/deepPartial';
-export declare function createMockList<T extends object>(quantity: number, iterator?: (index: number) => DeepPartial<T>): T[];
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export function createMockList<T extends object>(quantity: number, iterator?: (index: number) => DeepPartial<T>): T[] {
+  throw new Error(`
+    ts-auto-mock is not been configured as a transformer. Please follow the instructions in https://typescript-tdd.github.io/ts-auto-mock/installation
+    If help is required you can find us on https://typescript-tdd.github.io
+  `);
+}
diff --git a/src/create-mock.ts b/src/create-mock.ts
@@ -1,3 +1,9 @@
 import { DeepPartial } from './partial/deepPartial';
 
-export declare function createMock<T extends object>(values?: DeepPartial<T>): T;
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export function createMock<T extends object>(values?: DeepPartial<T>): T {
+  throw new Error(`
+    ts-auto-mock is not been configured as a transformer. Please follow the instructions in https://typescript-tdd.github.io/ts-auto-mock/installation
+    If help is required you can find us on https://typescript-tdd.github.io
+  `);
+}
diff --git a/src/register-mock.ts b/src/register-mock.ts
@@ -1 +1,7 @@
-export declare function registerMock<T extends object>(factory: () => T): void;
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export function registerMock<T extends object>(factory: () => T): void {
+  throw new Error(`
+    ts-auto-mock is not been configured as a transformer. Please follow the instructions in https://typescript-tdd.github.io/ts-auto-mock/installation
+    If help is required you can find us on https://typescript-tdd.github.io
+  `);
+}
diff --git a/test/noTransformer/noTransformer.test.ts b/test/noTransformer/noTransformer.test.ts
@@ -0,0 +1,14 @@
+import { createMock, createMockList, registerMock } from 'ts-auto-mock';
+
+interface MyInterface {
+  a: string;
+  b: number;
+}
+
+describe('when using placeholder functions without installing the transformer', () => {
+  it('should throw an error linking the installation guide', () => {
+    expect(() => createMock<MyInterface>()).toThrowError(/https:\/\/typescript-tdd.github.io\/ts-auto-mock\/installation/);
+    expect(() => createMockList<MyInterface>(2)).toThrowError(/https:\/\/typescript-tdd.github.io\/ts-auto-mock\/installation/);
+    expect(() => registerMock<MyInterface>(() => ({ a: '', b: 4 }))).toThrowError(/https:\/\/typescript-tdd.github.io\/ts-auto-mock\/installation/);
+  });
+});

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-const karmaBaseConfig = require('./karma.config.base');`
	`1`	`+const karmaBaseConfig = require('./base/karma.config.transformer.base');`
`2`	`2`
`3`	`3`	`module.exports = function(config) {`
`4`	`4`	`const karmaConfig = karmaBaseConfig(config, '../../test/features/context.ts');`