Ignore spec files to allow for co-located tests (#2309)

* Ignore spec files to allow for co-located tests

* Add tests

__tests__/modules/utils/ensureNoTsHeaderOrSpecFiles.ts

@@ -0,0 +1,24 @@
+import { ensureNoTsHeaderOrSpecFiles } from "../../../src/modules/utils/ensureNoTsHeaderOrSpecFiles";
+
+describe("ensureNoTsHeaderOrSpecFiles", () => {
+  it("filters header files", () => {
+    const filtered = ensureNoTsHeaderOrSpecFiles([
+      "afdasf.d.ts",
+      "some-file.ts",
+    ]);
+    expect(filtered).toEqual(["some-file.ts"]);
+  });
+
+  it("filters test/spec files", () => {
+    const filtered = ensureNoTsHeaderOrSpecFiles([
+      "afdasf.spec.ts",
+      "afdasfsdfa.spec.js",
+      "spec.js",
+      "test-my-api.js",
+      "afdasfsdfa.test.js",
+      "afdasfsdfa.test.ts",
+      "some-file.ts",
+    ]);
+    expect(filtered).toEqual(["spec.js", "test-my-api.js", "some-file.ts"]);
+  });
+});

src/bin/actionhero.ts

@@ -5,7 +5,7 @@ import * as fs from "fs";
 import { program, InvalidArgumentError } from "commander";
 import { typescript } from "../classes/process/typescript";
 import { projectRoot } from "../classes/process/projectRoot";
-import { ensureNoTsHeaderFiles } from "../modules/utils/ensureNoTsHeaderFiles";
+import { ensureNoTsHeaderOrSpecFiles } from "../modules/utils/ensureNoTsHeaderOrSpecFiles";
 import { CLI } from "../classes/cli";
 import { PackageJson } from "type-fest";
 
@@ -70,7 +70,7 @@ export namespace ActionheroCLIRunner {
     const matcher = `${realpath}/**/+(${
       typescript ? `${match}.js|*.ts` : `${match}.js`
     })`;
-    const files = ensureNoTsHeaderFiles(safeGlobSync(matcher));
+    const files = ensureNoTsHeaderOrSpecFiles(safeGlobSync(matcher));
     for (const i in files) {
       const collection = await import(files[i]);
       for (const j in collection) {

src/classes/process.ts

@@ -97,7 +97,7 @@ export class Process {
     }
 
     initializerFiles = utils.arrayUnique(initializerFiles);
-    initializerFiles = utils.ensureNoTsHeaderFiles(initializerFiles);
+    initializerFiles = utils.ensureNoTsHeaderOrSpecFiles(initializerFiles);
 
     for (const i in initializerFiles) {
       const f = initializerFiles[i];

src/initializers/actions.ts

@@ -94,7 +94,7 @@ export class ActionsInitializer extends Initializer {
 
     for (const p of config.general.paths.action) {
       let files = safeGlobSync(path.join(p, "**", "**/*(*.js|*.ts)"));
-      files = utils.ensureNoTsHeaderFiles(files);
+      files = utils.ensureNoTsHeaderOrSpecFiles(files);
       for (const j in files) {
         await api.actions.loadFile(files[j]);
       }
@@ -114,7 +114,7 @@ export class ActionsInitializer extends Initializer {
         );
 
         utils
-          .ensureNoTsHeaderFiles(files)
+          .ensureNoTsHeaderOrSpecFiles(files)
           .forEach((f) => api.actions.loadFile(f));
       }
     }

src/initializers/servers.ts

@@ -57,7 +57,7 @@ export class Servers extends Initializer {
       }
     }
 
-    files = utils.ensureNoTsHeaderFiles(files);
+    files = utils.ensureNoTsHeaderOrSpecFiles(files);
 
     let server: Server;
 

src/initializers/tasks.ts

@@ -138,7 +138,7 @@ export class TasksInitializer extends Initializer {
     for (const p of config.general.paths.task) {
       await Promise.all(
         utils
-          .ensureNoTsHeaderFiles(
+          .ensureNoTsHeaderOrSpecFiles(
             safeGlobSync(path.join(p, "**", "**/*(*.js|*.ts)"))
           )
           .map((f) => api.tasks.loadFile(f, reload))
@@ -156,7 +156,7 @@ export class TasksInitializer extends Initializer {
           safeGlobSync(path.join(pluginPath, "dist", "tasks", "**", "*.js"))
         );
 
-        utils.ensureNoTsHeaderFiles(files).forEach((f) => {
+        utils.ensureNoTsHeaderOrSpecFiles(files).forEach((f) => {
           api.tasks.loadFile(f, reload);
         });
       }

src/modules/config.ts

@@ -1,7 +1,7 @@
 import * as fs from "fs";
 import * as path from "path";
 import { utils } from "./utils";
-import { ensureNoTsHeaderFiles } from "./utils/ensureNoTsHeaderFiles";
+import { ensureNoTsHeaderOrSpecFiles } from "./utils/ensureNoTsHeaderOrSpecFiles";
 
 import { env, recalculateEnv } from "./../classes/process/env";
 import { id, recalcuateId } from "./../classes/process/id";
@@ -132,7 +132,7 @@ export function buildConfig() {
   };
 
   const loadConfigDirectory = (configPath: string, watch: boolean) => {
-    const configFiles = ensureNoTsHeaderFiles(
+    const configFiles = ensureNoTsHeaderOrSpecFiles(
       safeGlobSync(path.join(configPath, "**", "**/*(*.js|*.ts)"))
     );
 

src/modules/utils.ts

@@ -3,7 +3,7 @@ import { arrayStartingMatch } from "./utils/arrayStartingMatch";
 import { arrayUnique } from "./utils/arrayUnique";
 import { collapseObjectToArray } from "./utils/collapseObjectToArray";
 import { deepCopy } from "./utils/deepCopy";
-import { ensureNoTsHeaderFiles } from "./utils/ensureNoTsHeaderFiles";
+import { ensureNoTsHeaderOrSpecFiles } from "./utils/ensureNoTsHeaderOrSpecFiles";
 import { eventLoopDelay } from "./utils/eventLoopDelay";
 import { filterObjectForLogging } from "./utils/filterObjectForLogging";
 import { filterResponseForLogging } from "./utils/filterResponseForLogging";
@@ -38,7 +38,7 @@ export const utils = {
   arrayUnique,
   collapseObjectToArray,
   deepCopy,
-  ensureNoTsHeaderFiles,
+  ensureNoTsHeaderOrSpecFiles,
   eventLoopDelay,
   filterObjectForLogging,
   filterResponseForLogging,

src/modules/utils/ensureNoTsHeaderOrSpecFiles.ts

@@ -0,0 +1,19 @@
+/**
+ *swap out d.ts files for the JS versions when running with ts-node
+ * also filter out *.test. and *.spec. js|ts files
+ */
+export function ensureNoTsHeaderOrSpecFiles(
+  files: Array<string>
+): Array<string> {
+  return files.filter((f) => {
+    if (f.match(/.*\.d\.ts$/)) {
+      return false;
+    }
+
+    if (f.match(/.*\.(?:spec|test)\.[tj]s$/)) {
+      return false;
+    }
+
+    return true;
+  });
+}