Merge 23aebdd into b3b71d9

.eslintrc.js

@@ -7,6 +7,7 @@ module.exports = {
   ],
   parser: "@typescript-eslint/parser",
   parserOptions: {
+    extraFileExtensions: [".cjs"],
     warnOnUnsupportedTypeScriptVersion: false,
     project: "tsconfig.eslint.json",
   },

README.md

@@ -69,7 +69,7 @@ run the database only for suites which use it. Please see [advanced config](###A
 
 ## Config
 
-In your jest project root (next to your `jest.config.js`), create a `jest-dynalite-config.js` (or `.ts`) with the tables schemas,
+In your jest project root (next to your `jest.config.js`), create a `jest-dynalite-config.js` (or `.cjs` or `.ts`) with the tables schemas,
 and an optional `basePort` to run dynalite on:
 
 ```js

src/__snapshots__/environment.spec.ts.snap

@@ -2,7 +2,7 @@
 
 exports[`Environment should throw an error if config file could not be located 1`] = `
 "
-jest-dynalite could not find \\"jest-dynalite-config.js\\" or \\"jest-dynalite-config.ts\\" in the jest <rootDir> (somebaddirectory).
+jest-dynalite could not find \\"jest-dynalite-config.js\\" or \\"jest-dynalite-config.cjs\\" or \\"jest-dynalite-config.ts\\" in the jest <rootDir> (somebaddirectory).
 
 If you didn't intend to be using this directory for the config, please specify a custom
 directory: https://github.com/freshollie/jest-dynalite/#advanced-setup

src/config.ts

@@ -4,6 +4,7 @@ import { Config, TableConfig } from "./types";
 import { isFunction } from "./utils";
 
 export const CONFIG_FILE_NAME = "jest-dynalite-config.js";
+export const CONFIG_FILE_NAME_CJS = "jest-dynalite-config.cjs";
 export const CONFIG_FILE_NAME_TS = "jest-dynalite-config.ts";
 
 export class NotFoundError extends Error {
@@ -20,13 +21,16 @@ if (!process.env.JEST_DYNALITE_CONFIG_DIRECTORY) {
 
 const findConfigOrError = (
   directory: string
-): typeof CONFIG_FILE_NAME | typeof CONFIG_FILE_NAME_TS => {
-  const foundFile = ([CONFIG_FILE_NAME, CONFIG_FILE_NAME_TS] as const).find(
-    (config) => {
-      const file = resolve(directory, config);
-      return fs.existsSync(file);
-    }
-  );
+):
+  | typeof CONFIG_FILE_NAME
+  | typeof CONFIG_FILE_NAME_CJS
+  | typeof CONFIG_FILE_NAME_TS => {
+  const foundFile = (
+    [CONFIG_FILE_NAME, CONFIG_FILE_NAME_CJS, CONFIG_FILE_NAME_TS] as const
+  ).find((config) => {
+    const file = resolve(directory, config);
+    return fs.existsSync(file);
+  });
 
   if (!foundFile) {
     throw new NotFoundError(resolve(directory));

src/environment.ts

@@ -6,7 +6,12 @@ import type {
 } from "@jest/environment";
 import setup from "./setup";
 import { start, stop } from "./db";
-import { CONFIG_FILE_NAME, CONFIG_FILE_NAME_TS, NotFoundError } from "./config";
+import {
+  CONFIG_FILE_NAME,
+  CONFIG_FILE_NAME_CJS,
+  CONFIG_FILE_NAME_TS,
+  NotFoundError,
+} from "./config";
 
 class DynaliteEnvironment extends NodeEnvironment {
   constructor(config: JestEnvironmentConfig, _context: EnvironmentContext) {
@@ -27,7 +32,7 @@ class DynaliteEnvironment extends NodeEnvironment {
     } catch (e) {
       if (e instanceof NotFoundError) {
         throw new Error(`
-jest-dynalite could not find "${CONFIG_FILE_NAME}" or "${CONFIG_FILE_NAME_TS}" in the jest <rootDir> (${rootDir}).
+jest-dynalite could not find "${CONFIG_FILE_NAME}" or "${CONFIG_FILE_NAME_CJS}" or "${CONFIG_FILE_NAME_TS}" in the jest <rootDir> (${rootDir}).
 
 If you didn't intend to be using this directory for the config, please specify a custom
 directory: https://github.com/freshollie/jest-dynalite/#advanced-setup

tests/configs/cjs/jest-dynalite-config.cjs

@@ -0,0 +1,6 @@
+const tables = require("./tables");
+
+module.exports = {
+  tables: () => tables,
+  basePort: 10500,
+};

tests/configs/cjs/tables.js

@@ -0,0 +1,32 @@
+module.exports = [
+  {
+    TableName: "files",
+    KeySchema: [{ AttributeName: "id", KeyType: "HASH" }],
+    AttributeDefinitions: [{ AttributeName: "id", AttributeType: "S" }],
+    ProvisionedThroughput: {
+      ReadCapacityUnits: 1,
+      WriteCapacityUnits: 1,
+    },
+  },
+  {
+    TableName: "images",
+    KeySchema: [{ AttributeName: "url", KeyType: "HASH" }],
+    AttributeDefinitions: [{ AttributeName: "url", AttributeType: "S" }],
+    ProvisionedThroughput: {
+      ReadCapacityUnits: 1,
+      WriteCapacityUnits: 1,
+    },
+    data: [
+      {
+        url: "https://something.com/something/image.jpg",
+        width: 100,
+        height: 200,
+      },
+      {
+        url: "https://something.com/something/image2.jpg",
+        width: 150,
+        height: 250,
+      },
+    ],
+  },
+];

tests/jest-cjs.config.ts

@@ -0,0 +1,12 @@
+import { join } from "path";
+import base from "../jest.base";
+
+export default {
+  ...base,
+  setupFiles: [join(__dirname, "setups/setupCjs.ts")],
+  setupFilesAfterEnv: [join(__dirname, "setups/setupAdvancedEnv.ts")],
+  displayName: {
+    name: "cjs",
+    color: "yellow",
+  },
+};

tests/setups/setupCjs.ts

@@ -0,0 +1,5 @@
+import { join } from "path";
+import { setup } from "../../src";
+
+// Setup with the config dir
+setup(join(__dirname, "../configs/cjs"));

tsconfig.eslint.json

@@ -1,4 +1,4 @@
 {
   "extends": "./tsconfig.json",
-  "include": ["**/*.js", "**/*.ts", ".jest/**/*.js", ".eslintrc.js"]
+  "include": ["**/*.js", "**/*.ts", "**/*.cjs", ".jest/**/*.js", ".eslintrc.js"]
 }