Adds a console config object to ignore methods

README.md

@@ -252,6 +252,18 @@ require("console-fail-test").cft({
   </tbody>
 </table>
 
+## Ignoring `console` methods
+
+By default, `console-fail-test` will error on _any_ called `console` method. If you'd like ignore certain methods, pass a `console` object to the `cft` API when you set it up:
+
+```js
+require("console-fail-test").cft({
+    console: {
+        warn: false, // won't error on any instance of console.warn
+    },
+});
+```
+
 ## Why?
 
 Logging to the console during tests can be a sign of

src/cft.ts

@@ -4,22 +4,25 @@ import { selectTestEnvironment } from "./environments/selectTestEnvironments";
 import { getSpyFactory } from "./spies/selectSpyFactory";
 import { MethodCall, MethodSpy } from "./spies/spyTypes";
 import { CftRequest } from "./types";
+import { setDefaults } from "./defaults";
 
-export const cft = (request: CftRequest = {}) => {
+export const cft = (_request: Partial<CftRequest>) => {
+    const request = setDefaults(_request);
     const spyFactory = getSpyFactory(request);
     const testEnvironment = selectTestEnvironment(request);
     const methodSpies: { [i: string]: MethodSpy } = {};
+    const relevantMethodNames = consoleMethodNames.filter((name) => !!request.console[name as keyof typeof request.console]);
 
     testEnvironment.before(() => {
-        for (const methodName of consoleMethodNames) {
+        for (const methodName of relevantMethodNames) {
             methodSpies[methodName] = spyFactory(console, methodName);
         }
     });
 
     testEnvironment.after(({ reportComplaint }) => {
         const methodsWithCalls: [keyof Console, MethodCall[]][] = [];
 
-        for (const methodName of consoleMethodNames) {
+        for (const methodName of relevantMethodNames) {
             const spy = methodSpies[methodName];
             const calls = testEnvironment.filterMethodCalls({
                 methodCalls: spy.getCalls(),

src/console.ts

@@ -1,5 +1,7 @@
+import { ConsoleObject } from "./types";
+
 const isValidMemberName = (methodName: string) => !methodName.startsWith("_") && methodName[0].toLowerCase() === methodName[0];
 
-export const consoleMethodNames = (Object.keys(console) as (keyof Console)[])
+export const consoleMethodNames: (keyof ConsoleObject)[] = (Object.keys(console) as (keyof Console)[])
     .filter((methodName) => isValidMemberName(methodName) && typeof console[methodName] === "function")
     .sort();

src/defaults.ts

@@ -0,0 +1,9 @@
+import { CftRequest } from "./types";
+
+const defaults = {
+    console: {},
+};
+
+export const setDefaults = (request: Partial<CftRequest> = {}) => {
+    return { ...defaults, ...request };
+};

src/types.ts

@@ -1,8 +1,11 @@
 export type CftRequest = {
+    console: ConsoleObject;
     spyLibrary?: SupportedSpyLibrary;
     testFramework?: SupportedTestFramework;
 };
 
 export type SupportedSpyLibrary = "fallback" | "jasmine" | "jest" | "sinon" | unknown;
 
 export type SupportedTestFramework = "mocha" | "jasmine" | "jest" | unknown;
+
+export type ConsoleObject = { [P in keyof Console]?: Console[P] extends Function ? boolean : never };