feat(tests): adds basic testing support

.circleci/config.yml

@@ -2,12 +2,15 @@ version: 2
 jobs:
   build:
     docker:
-      - image: 'circleci/node:latest'
+      - image: "circleci/node:latest"
     steps:
       - checkout
       - run:
           name: install
           command: npm install
+      - run:
+          name: test
+          command: npm test
       - run:
           name: release
           command: npm run semantic-release || true

__mocks__/fs.ts

@@ -0,0 +1,5 @@
+const fs = jest.genMockFromModule<any>("fs");
+
+fs.existsSync = () => true;
+
+module.exports = fs;

package.json

@@ -19,10 +19,13 @@
     "@semantic-release/git": "^7.0.17",
     "@semantic-release/npm": "^5.3.2",
     "@types/node": "^12.12.3",
+    "@types/jest": "^24.0.21",
     "globby": "^10",
+    "jest": "^24.9.0",
     "semantic-release": "^15.13.28",
+    "ts-jest": "^24.1.0",
     "ts-node": "^8",
-    "typescript": "^3.3"
+    "typescript": "^3.6.4"
   },
   "engines": {
     "node": ">=8.0.0"
@@ -50,7 +53,7 @@
   "scripts": {
     "postpack": "rm -f oclif.manifest.json",
     "prepack": "rm -rf lib && tsc -b && oclif-dev manifest && oclif-dev readme",
-    "test": "echo NO TESTS",
+    "test": "jest",
     "version": "oclif-dev readme && git add README.md",
     "gen": "hygen",
     "semantic-release": "semantic-release"
@@ -69,5 +72,9 @@
         }
       ]
     ]
+  },
+  "jest": {
+    "preset": "ts-jest",
+    "testEnvironment": "node"
   }
 }

src/commands/generate.ts

@@ -1,19 +1,10 @@
 import { Command, flags } from "@oclif/command";
 import { execSync } from "child_process";
-import * as path from "path";
-import * as fs from "fs";
-
-// The root of our package, so that we can leverage the scripts in the `package.json`
-const rootDirectory = path.join(__dirname, "..");
-const defaultTemplatePath = `${rootDirectory}/_templates`;
-// Grab the path of the user's project
-const pathWhereScriptIsRunning = process.cwd();
-
-// This is where their templates are (at least we assume so)
-const theirTemplatePath = pathWhereScriptIsRunning + "/_templates";
-
-// Check if they have a template directory
-const hasTemplates = fs.existsSync(theirTemplatePath);
+import {
+  getTemplateLocation,
+  pathWhereScriptIsRunning,
+  rootDirectory
+} from "../utils/getTemplateLocation";
 
 const DEFAULT_COMPONENT_NAME = "MyNewComponent";
 const DEFAULT_TEMPLATE_NAME = "react-component";
@@ -56,23 +47,16 @@ export default class Generate extends Command {
     const { flags } = this.parse(Generate);
     const template = flags.template || DEFAULT_TEMPLATE_NAME;
     const name = flags.name || DEFAULT_COMPONENT_NAME;
-    let templateLocation = "";
+    const templateLocation = getTemplateLocation();
+    const templatePath = `HYGEN_TMPLS=${templateLocation}`;
 
     this.log(
       `Generating new component using template ${template} at ./src/components/${name}.js`
     );
 
-    // If they do have templates, use theirs
-    if (hasTemplates) {
-      templateLocation = `HYGEN_TMPLS=${theirTemplatePath}`;
-    } else {
-      // Otherwise, use ours
-      templateLocation = `HYGEN_TMPLS=${defaultTemplatePath}`;
-    }
-
     // Generate template
     execSync(
-      `${templateLocation} yarn gen ${template} new ${name} --path=${pathWhereScriptIsRunning}`,
+      `${templatePath} yarn gen ${template} new ${name} --path=${pathWhereScriptIsRunning}`,
       { cwd: rootDirectory, stdio: "inherit" }
     );
   }

src/index.ts

@@ -1 +1 @@
-export {run} from '@oclif/command'
+export { run } from "@oclif/command";

src/utils/getTemplateLocation.test.ts

@@ -0,0 +1,27 @@
+afterEach(() => {
+  jest.resetModules();
+});
+
+test("uses default template if dev does not have custom ones", () => {
+  jest.dontMock("fs");
+
+  const {
+    DEFAULT_TEMPLATE_PATH,
+    getTemplateLocation
+  } = require("./getTemplateLocation");
+
+  const templateLocation = getTemplateLocation();
+
+  expect(templateLocation).toEqual(DEFAULT_TEMPLATE_PATH);
+});
+
+test("uses developer custom templates if defined", () => {
+  jest.mock("fs");
+  jest.spyOn(process, "cwd").mockImplementation(() => "/custom/path/to");
+
+  const { getTemplateLocation } = require("./getTemplateLocation");
+
+  const templateLocation = getTemplateLocation();
+
+  expect(templateLocation).toEqual("/custom/path/to/_templates");
+});

src/utils/getTemplateLocation.ts

@@ -0,0 +1,18 @@
+import * as fs from "fs";
+import * as path from "path";
+
+// The root of our package, so that we can leverage the scripts in the `package.json`
+export const rootDirectory = path.join(__dirname, "..");
+
+export const DEFAULT_TEMPLATE_PATH = `${rootDirectory}/_templates`;
+
+// Grab the path of the user's project
+export const pathWhereScriptIsRunning = process.cwd();
+
+// This is where their templates are (at least we assume so)
+const theirTemplatePath = pathWhereScriptIsRunning + "/_templates";
+
+const hasTemplates = fs.existsSync(theirTemplatePath);
+
+export const getTemplateLocation = (): string =>
+  hasTemplates ? theirTemplatePath : DEFAULT_TEMPLATE_PATH;