Add support to mock only specific interfaces

Author: ryanmcdermott

examples/example.ts

@@ -64,13 +64,26 @@
 //   favoriteNumber: GreatNumbers;
 // }
 
-interface Order {
-  id: string;
+// interface Order {
+//   id: string;
+
+//   /** !mockType {lorem.words} */
+//   name: string;
+// }
+
+// interface User {
+//   orders: Order[];
+// }
 
-  /** !mockType {lorem.words} */
+
+interface User {
   name: string;
 }
 
-interface User {
-  orders: Order[];
+interface Person {
+  age: number;
+}
+
+interface Order {
+  id: string;
 }

package.json

@@ -40,7 +40,7 @@
     "clean": "rimraf coverage build tmp",
     "coverage": "nyc --reporter=html --reporter=text mocha --reporter mocha-multi-reporters --reporter-options configFile=mocha-config.json --no-colors -r ts-node/register test/**/*.spec.ts",
     "ci": "npm run format-check && npm run lint && npm run test",
-    "cli": "npm run build && node ./build/src/cli/index.js --fixed --files ./examples/example.ts",
+    "cli": "npm run build && node ./build/src/cli/index.js --fixed --files ./examples/example.ts --interfaces 'Person' 'User'",
     "build": "tsc -p tsconfig.json",
     "dist": "tsc -p tsconfig.json --outDir ./bin",
     "watch": "tsc -w -p tsconfig.json",

src/cli/index.ts

@@ -12,6 +12,7 @@ const optionDefinitions = [
     multiple: true,
     defaultOption: true
   },
+  {name: 'interfaces', alias: 'i', type: String, multiple: true},
   {name: 'outFile', alias: 'o', type: String},
   {name: 'lang', alias: 'l', type: String},
   {name: 'help', alias: 'h', type: Boolean},
@@ -83,7 +84,8 @@ function main() {
   const isFixedMode = options.fixed;
 
   if (lang === 'typescript') {
-    const intermock = new IntermockTS({files: options.files, isFixedMode});
+    const intermock = new IntermockTS(
+        {files: options.files, interfaces: options.interfaces, isFixedMode});
 
     intermock.generate().then((output: any) => {
       console.log(JSON.stringify(output));

src/lang/ts/intermock.ts

@@ -10,6 +10,7 @@ import {FileTuple, FileTuples} from '../../lib/types';
 
 export interface Options {
   files: string[];
+  interfaces?: string[];
   isFixedMode?: boolean;
   isOptionalAlwaysEnabled?: boolean;
 }
@@ -33,7 +34,7 @@ export class Intermock {
   }
 
   mock(property: string, syntaxType: ts.SyntaxKind, mockType: string) {
-    const smartMockType = _.get(smartProps, property);
+    const smartMockType = smartProps[property];
     const isFixedMode =
         this.options.isFixedMode ? this.options.isFixedMode : false;
 
@@ -226,6 +227,18 @@ export class Intermock {
         child => this.traverseInterfaceMembers(child, output, sourceFile));
   }
 
+  isSpecificInterface(name: string) {
+    if (!this.options.interfaces) {
+      return true;
+    }
+
+    if (!_.includes(this.options.interfaces, name)) {
+      return false;
+    }
+
+    return true;
+  }
+
   processFile(sourceFile: ts.SourceFile, output: any, propToTraverse?: string) {
     const processNode = (node: ts.Node) => {
       switch (node.kind) {
@@ -234,9 +247,12 @@ export class Intermock {
            * TODO: Handle interfaces that extend others, via checking hertiage
            * clauses
            */
+          const p = (node as ts.InterfaceDeclaration).name.text;
+          if (!this.isSpecificInterface(p)) {
+            return;
+          }
           if (propToTraverse) {
-            const path = (node as ts.InterfaceDeclaration).name.text;
-            if (path === propToTraverse) {
+            if (p === propToTraverse) {
               this.traverseInterface(node, output, sourceFile, propToTraverse);
             }
           } else {
@@ -247,6 +263,10 @@ export class Intermock {
           const type = (node as ts.TypeAliasDeclaration).type;
           const path = (node as ts.TypeAliasDeclaration).name.text;
 
+          if (!this.isSpecificInterface(path)) {
+            return;
+          }
+
           if (propToTraverse) {
             if (path === propToTraverse) {
               this.traverseInterface(type, output, sourceFile, propToTraverse);
@@ -278,6 +298,7 @@ export class Intermock {
 
     processNode(sourceFile);
   }
+
   async generate() {
     const output: any = {};
     const fileContents = await this.readFiles();

src/lib/smart-props.ts

@@ -1,4 +1,4 @@
-export const smartProps = {
+export const smartProps: {[index: string]: string} = {
   firstName: 'name.firstName',
   middleName: 'name.firstName',
   lastName: 'name.lastName',

test/ts/generate.spec.ts

@@ -12,6 +12,7 @@ import {expectedFlat} from './test-data/flat';
 import {expectedMockType} from './test-data/mockType';
 import {expectedNested} from './test-data/nestedSingle';
 import {expectedOptional1, expectedOptional2} from './test-data/optional';
+import {expectedSpecificInterface} from './test-data/specificInterfaces';
 import {expectedTypeAlias} from './test-data/typeAlias';
 
 function runTestCase(
@@ -20,7 +21,11 @@ function runTestCase(
   const im = new Intermock(imOptions);
 
   return im.generate().then((output: any) => {
-    expect(_.get(output, outputProp)).to.deep.equal(expected);
+    if (outputProp) {
+      expect(_.get(output, outputProp)).to.deep.equal(expected);
+    } else {
+      expect(output).to.deep.equal(expected);
+    }
   });
 }
 
@@ -75,4 +80,10 @@ describe('', () => {
     return runTestCase(
         `${__dirname}/test-data/array.ts`, 'User', expectedArray1.User);
   });
+
+  it('should generate mock for specific interfaces', () => {
+    return runTestCase(
+        `${__dirname}/test-data/specificInterfaces.ts`, '',
+        expectedSpecificInterface, {interfaces: ['Person', 'User']});
+  });
 });

test/ts/test-data/specificInterfaces.ts

@@ -0,0 +1,19 @@
+interface User {
+  name: string;
+}
+
+interface Person {
+  age: number;
+}
+
+interface Order {
+  id: string;
+}
+
+export const expectedSpecificInterface = {
+  'User': {
+    'name':
+        'Animi repellat eveniet eveniet dolores quo ullam rerum reiciendis ipsam. Corrupti voluptatem ipsa illum veritatis eligendi sit autem ut quia. Ea sint voluptas impedit ducimus dolores possimus.'
+  },
+  'Person': {'age': 86924}
+};