@sgohlke/stryker-log-ignorer 1.0.0 → 2.0.1

package/README.md

@@ -1,3 +1,63 @@
 # stryker-log-ignorer
 
-Log ignorer plugin for Stryker
+Log ignorer plugin for [Stryker][1] JS/TS. Provides functionality to ignore logger calls in Stryker if you do not want to mutation test these logger calls.
+
+## Install
+
+```sh
+npm i --save-dev @sgohlke/stryker-log-ignorer
+```
+
+TypeScript declarations are provided within the project.
+
+## Configuring
+
+In order to use the plugin you have to add it as **ignorer** and add both the **@stryker-mutator** and **@sgohlke/stryker-log-ignorer** plugins to the Stryker configuration file.
+
+In the optional **logignore** option you can define the object names (i.e. the name of the variable/constant, NOT the name of a Logger class or interface) to be ignored. If no **logignore** option is provided **console** calls will be ignored.
+
+```json
+{
+    "ignorers": ["log-ignore"],
+    "plugins": ["@stryker-mutator/*", "@sgohlke/stryker-log-ignorer"],
+    "logignore": {
+        "objectNames": ["console", "logger"]
+    }
+}
+```
+
+## Example
+
+Using the **logignore** options shown above we run Stryker. As both **console** and **logger** are defined in the **objectNames** option both lines in the code below will be ignored in the results of the stryker run.
+
+Example code:
+
+```typescript
+import { MyFavoriteLogger } from 'some-logger-module'
+export function doSomething(): void {
+    const logger = new MyFavoriteLogger('loggername')
+    console.log('We do something here!')
+    // Some imaginary code here!
+    logger.info('We finished doing something!')
+}
+```
+
+In the results you can identify these lines as **ignored**, for example
+
+```typescript
+logger.info('We finished doing something!')
+logger.info('')
+// StringLiteral Ignored
+// We are not interested in testing console,logger statements.
+```
+
+## Contact
+
+If you have questions or issues please visit our [Issue page](https://github.com/sgohlke/stryker-log-ignorer/issues)
+and open a new issue if there are no fitting issues for your topic yet.
+
+## License
+
+stryker-log-ignorer is under [CC0 1.0-License](./LICENSE).
+
+[1]: https://stryker-mutator.io/

package/build/index.cjs

@@ -1,25 +1,21 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } } function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; } var _class;// src/index.ts
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } } function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; } var _class;// src/index.ts
 
 
 
 
 
 var _plugin = require('@stryker-mutator/api/plugin');
+var _fs = require('fs'); var _fs2 = _interopRequireDefault(_fs);
 var LogIgnorer = (_class = class {
-  constructor(log, options) {
-    this.log = log;
-    this.options = options;
-  }
-  static __initStatic() {this.inject = [_plugin.commonTokens.logger, _plugin.commonTokens.options]}
+  static __initStatic() {this.inject = [_plugin.commonTokens.options]}
   
+  constructor(options) {
+    this.options = _optionalChain([options, 'optionalAccess', _ => _.logignore]);
+  }
   shouldIgnore(path) {
-    const loggerClass = _nullishCoalesce(_optionalChain([this, 'access', _ => _.options, 'optionalAccess', _2 => _2.loggerClass]), () => ( "console"));
-    _optionalChain([this, 'access', _3 => _3.log, 'optionalAccess', _4 => _4.debug, 'call', _5 => _5(
-      "LogIgnore Plugin. Path is: ",
-      JSON.stringify(path.node)
-    )]);
-    if (path.isExpressionStatement() && path.node.expression.type === "CallExpression" && path.node.expression.callee.type === "MemberExpression" && path.node.expression.callee.object.type === "Identifier" && path.node.expression.callee.object.name === loggerClass) {
-      return `We are not interested in testing ${loggerClass} statements.`;
+    const loggerObjectNames = _nullishCoalesce(_optionalChain([this, 'access', _2 => _2.options, 'optionalAccess', _3 => _3.objectNames]), () => ( ["console"]));
+    if (path.isExpressionStatement() && path.node.expression.type === "CallExpression" && path.node.expression.callee.type === "MemberExpression" && path.node.expression.callee.object.type === "Identifier" && loggerObjectNames.includes(path.node.expression.callee.object.name)) {
+      return `We are not interested in testing ${loggerObjectNames} statements.`;
     }
   }
 }, _class.__initStatic(), _class);
@@ -30,14 +26,25 @@ function logIgnorerFactory(injector) {
 function createLogIgnorerFactory() {
   return logIgnorerFactory;
 }
-var createLogIgnorer = createLogIgnorerFactory();
 var strykerPlugins = [
-  _plugin.declareFactoryPlugin.call(void 0, _plugin.PluginKind.Ignore, "log-ignore", createLogIgnorer)
+  _plugin.declareFactoryPlugin.call(void 0, 
+    _plugin.PluginKind.Ignore,
+    "log-ignore",
+    createLogIgnorerFactory()
+  )
 ];
+var strykerValidationSchema = JSON.parse(
+  // eslint-disable-next-line security/detect-non-literal-fs-filename
+  _fs2.default.readFileSync(
+    new URL("../schema/log-ignorer-options.json", import.meta.url),
+    "utf8"
+  )
+);
+
 
 
 
 
 
-exports.LogIgnorer = LogIgnorer; exports.createLogIgnorerFactory = createLogIgnorerFactory; exports.logIgnorerFactory = logIgnorerFactory; exports.strykerPlugins = strykerPlugins;
+exports.LogIgnorer = LogIgnorer; exports.createLogIgnorerFactory = createLogIgnorerFactory; exports.logIgnorerFactory = logIgnorerFactory; exports.strykerPlugins = strykerPlugins; exports.strykerValidationSchema = strykerValidationSchema;
 //# sourceMappingURL=index.cjs.map

package/build/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";AAGA;AAAA,EACI;AAAA,EACA;AAAA,EAGA;AAAA,EACA;AAAA,OACG;AAsBA,IAAM,aAAN,MAAoC;AAAA,EAIvC,YAEqB,KACjB,SACF;AAFmB;AAGjB,SAAK,UAAU;AAAA,EACnB;AAAA,EATA,OAAc,SAAS,CAAC,aAAa,QAAQ,aAAa,OAAO;AAAA,EAChD;AAAA,EAUjB,aAAa,MAAoC;AAC7C,UAAM,cAAc,KAAK,SAAS,eAAe;AACjD,SAAK,KAAK;AAAA,MACN;AAAA,MACA,KAAK,UAAU,KAAK,IAAI;AAAA,IAC5B;AACA,QACI,KAAK,sBAAsB,KAC3B,KAAK,KAAK,WAAW,SAAS,oBAC9B,KAAK,KAAK,WAAW,OAAO,SAAS,sBACrC,KAAK,KAAK,WAAW,OAAO,OAAO,SAAS,gBAC5C,KAAK,KAAK,WAAW,OAAO,OAAO,SAAS,aAC9C;AACE,aAAO,oCAAoC,WAAW;AAAA,IAC1D;AAAA,EACJ;AACJ;AAEA,kBAAkB,SAAS,OAAO,aAAa,QAAQ;AAEhD,SAAS,kBACZ,UACU;AACV,SAAO,SAAS,YAAY,UAAU;AAC1C;AAEO,SAAS,0BAGd;AACE,SAAO;AACX;AAEA,IAAM,mBAAmB,wBAAwB;AAC1C,IAAM,iBAAiB;AAAA,EAC1B,qBAAqB,WAAW,QAAQ,cAAc,gBAAgB;AAC1E","sourcesContent":["import { StrykerOptions } from '@stryker-mutator/api/core'\nimport { Ignorer } from '@stryker-mutator/api/ignore'\nimport { Logger } from '@stryker-mutator/api/logging'\nimport {\n    commonTokens,\n    declareFactoryPlugin,\n    Injector,\n    PluginContext,\n    PluginKind,\n    tokens,\n} from '@stryker-mutator/api/plugin'\n\nexport interface NodePath {\n    isExpressionStatement(): boolean\n    node: {\n        expression: {\n            type: string\n            callee: {\n                type: string\n                object: {\n                    type: string\n                    name: string\n                }\n            }\n        }\n    }\n}\n\nexport interface LogIgnorerOptions extends StrykerOptions {\n    loggerClass?: string\n}\n\nexport class LogIgnorer implements Ignorer {\n    public static inject = [commonTokens.logger, commonTokens.options] as const\n    private readonly options: LogIgnorerOptions\n\n    constructor(\n        // eslint-disable-next-line @typescript-eslint/parameter-properties\n        private readonly log?: Logger,\n        options?: StrykerOptions,\n    ) {\n        this.options = options as LogIgnorerOptions\n    }\n\n    shouldIgnore(path: NodePath): string | undefined {\n        const loggerClass = this.options?.loggerClass ?? 'console'\n        this.log?.debug(\n            'LogIgnore Plugin. Path is: ',\n            JSON.stringify(path.node),\n        )\n        if (\n            path.isExpressionStatement() &&\n            path.node.expression.type === 'CallExpression' &&\n            path.node.expression.callee.type === 'MemberExpression' &&\n            path.node.expression.callee.object.type === 'Identifier' &&\n            path.node.expression.callee.object.name === loggerClass\n        ) {\n            return `We are not interested in testing ${loggerClass} statements.`\n        }\n    }\n}\n\nlogIgnorerFactory.inject = tokens(commonTokens.injector)\n\nexport function logIgnorerFactory(\n    injector: Injector<PluginContext>,\n): LogIgnorer {\n    return injector.injectClass(LogIgnorer)\n}\n\nexport function createLogIgnorerFactory(): {\n    (injector: Injector<PluginContext>): LogIgnorer\n    inject: ['$injector']\n} {\n    return logIgnorerFactory\n}\n\nconst createLogIgnorer = createLogIgnorerFactory()\nexport const strykerPlugins = [\n    declareFactoryPlugin(PluginKind.Ignore, 'log-ignore', createLogIgnorer),\n]\n"]}
+{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";AAEA;AAAA,EACI;AAAA,EACA;AAAA,EAGA;AAAA,EACA;AAAA,OACG;AACP,OAAO,QAAQ;AAuCR,IAAM,aAAN,MAAoC;AAAA,EACvC,OAAc,SAAS,CAAC,aAAa,OAAO;AAAA,EACzB;AAAA,EAEnB,YAAY,SAAsC;AAC9C,SAAK,UAAU,SAAS;AAAA,EAC5B;AAAA,EAEA,aAAa,MAAoC;AAC7C,UAAM,oBAAoB,KAAK,SAAS,eAAe,CAAC,SAAS;AACjE,QACI,KAAK,sBAAsB,KAC3B,KAAK,KAAK,WAAW,SAAS,oBAC9B,KAAK,KAAK,WAAW,OAAO,SAAS,sBACrC,KAAK,KAAK,WAAW,OAAO,OAAO,SAAS,gBAC5C,kBAAkB,SAAS,KAAK,KAAK,WAAW,OAAO,OAAO,IAAI,GACpE;AACE,aAAO,oCAAoC,iBAAiB;AAAA,IAChE;AAAA,EACJ;AACJ;AAEA,kBAAkB,SAAS,OAAO,aAAa,QAAQ;AAEhD,SAAS,kBACZ,UACU;AACV,SAAO,SAAS,YAAY,UAAU;AAC1C;AAEO,SAAS,0BAGd;AACE,SAAO;AACX;AAEO,IAAM,iBAAiB;AAAA,EAC1B;AAAA,IACI,WAAW;AAAA,IACX;AAAA,IACA,wBAAwB;AAAA,EAC5B;AACJ;AAEO,IAAM,0BACT,KAAK;AAAA;AAAA,EAED,GAAG;AAAA,IACC,IAAI,IAAI,sCAAsC,YAAY,GAAG;AAAA,IAC7D;AAAA,EACJ;AACJ","sourcesContent":["import { StrykerOptions } from '@stryker-mutator/api/core'\nimport { Ignorer } from '@stryker-mutator/api/ignore'\nimport {\n    commonTokens,\n    declareFactoryPlugin,\n    Injector,\n    PluginContext,\n    PluginKind,\n    tokens,\n} from '@stryker-mutator/api/plugin'\nimport fs from 'node:fs'\n\n/**\n * We define the necessary functions and fields for NodePath to be able to provide type safety\n * in our code.\n */\nexport interface NodePath {\n    isExpressionStatement(): boolean\n    node: {\n        expression: {\n            type: string\n            callee: {\n                type: string\n                object: {\n                    type: string\n                    name: string\n                }\n            }\n        }\n    }\n}\n\n/**\n * Configuration for @sgohlke/stryker-log-ignorer\n */\nexport interface IgnorerOptions {\n    /**\n     * Specify the object names of the logger objects to be ignored. Defaults to [\"console\"]\n     */\n    objectNames?: string[]\n}\n\nexport interface LogIgnorerOptions extends StrykerOptions {\n    logignore?: IgnorerOptions\n}\n\n/*\n * LogIgnorer provides functionality to ignore log calls for provided logger object names.\n */\nexport class LogIgnorer implements Ignorer {\n    public static inject = [commonTokens.options] as const\n    protected readonly options?: IgnorerOptions\n\n    constructor(options?: Partial<LogIgnorerOptions>) {\n        this.options = options?.logignore\n    }\n\n    shouldIgnore(path: NodePath): string | undefined {\n        const loggerObjectNames = this.options?.objectNames ?? ['console']\n        if (\n            path.isExpressionStatement() &&\n            path.node.expression.type === 'CallExpression' &&\n            path.node.expression.callee.type === 'MemberExpression' &&\n            path.node.expression.callee.object.type === 'Identifier' &&\n            loggerObjectNames.includes(path.node.expression.callee.object.name)\n        ) {\n            return `We are not interested in testing ${loggerObjectNames} statements.`\n        }\n    }\n}\n\nlogIgnorerFactory.inject = tokens(commonTokens.injector)\n\nexport function logIgnorerFactory(\n    injector: Injector<PluginContext>,\n): LogIgnorer {\n    return injector.injectClass(LogIgnorer)\n}\n\nexport function createLogIgnorerFactory(): {\n    (injector: Injector<PluginContext>): LogIgnorer\n    inject: ['$injector']\n} {\n    return logIgnorerFactory\n}\n\nexport const strykerPlugins = [\n    declareFactoryPlugin(\n        PluginKind.Ignore,\n        'log-ignore',\n        createLogIgnorerFactory(),\n    ),\n]\n\nexport const strykerValidationSchema: typeof import('../schema/log-ignorer-options.json') =\n    JSON.parse(\n        // eslint-disable-next-line security/detect-non-literal-fs-filename\n        fs.readFileSync(\n            new URL('../schema/log-ignorer-options.json', import.meta.url),\n            'utf8',\n        ),\n    )\n"]}

package/build/index.d.cts

@@ -2,8 +2,54 @@ import * as _stryker_mutator_api_plugin from '@stryker-mutator/api/plugin';
 import { Injector, PluginContext, PluginKind } from '@stryker-mutator/api/plugin';
 import { StrykerOptions } from '@stryker-mutator/api/core';
 import { Ignorer } from '@stryker-mutator/api/ignore';
-import { Logger } from '@stryker-mutator/api/logging';
 
+var $schema = "http://json-schema.org/draft-07/schema";
+var type = "object";
+var title = "LogIgnorerOptions";
+var additionalProperties = false;
+var properties = {
+	logignore: {
+		description: "Configuration for @sgohlke/stryker-log-ignorer",
+		title: "IgnorerOptions",
+		additionalProperties: false,
+		type: "object",
+		"default": {
+		},
+		properties: {
+			objectNames: {
+				description: "Specify the object names of the logger objects to be ignored. Defaults to [\"console\"]",
+				type: "array",
+				items: {
+					type: "string"
+				},
+				"default": [
+					"console"
+				]
+			}
+		}
+	}
+};
+var logIgnorerOptions = {
+	$schema: $schema,
+	type: type,
+	title: title,
+	additionalProperties: additionalProperties,
+	properties: properties
+};
+
+declare const ___schema_log_ignorer_options_json_$schema: typeof $schema;
+declare const ___schema_log_ignorer_options_json_additionalProperties: typeof additionalProperties;
+declare const ___schema_log_ignorer_options_json_properties: typeof properties;
+declare const ___schema_log_ignorer_options_json_title: typeof title;
+declare const ___schema_log_ignorer_options_json_type: typeof type;
+declare namespace ___schema_log_ignorer_options_json {
+  export { ___schema_log_ignorer_options_json_$schema as $schema, ___schema_log_ignorer_options_json_additionalProperties as additionalProperties, logIgnorerOptions as default, ___schema_log_ignorer_options_json_properties as properties, ___schema_log_ignorer_options_json_title as title, ___schema_log_ignorer_options_json_type as type };
+}
+
+/**
+ * We define the necessary functions and fields for NodePath to be able to provide type safety
+ * in our code.
+ */
 interface NodePath {
     isExpressionStatement(): boolean;
     node: {
@@ -19,14 +65,22 @@ interface NodePath {
         };
     };
 }
+/**
+ * Configuration for @sgohlke/stryker-log-ignorer
+ */
+interface IgnorerOptions {
+    /**
+     * Specify the object names of the logger objects to be ignored. Defaults to ["console"]
+     */
+    objectNames?: string[];
+}
 interface LogIgnorerOptions extends StrykerOptions {
-    loggerClass?: string;
+    logignore?: IgnorerOptions;
 }
 declare class LogIgnorer implements Ignorer {
-    private readonly log?;
-    static inject: readonly ["logger", "options"];
-    private readonly options;
-    constructor(log?: Logger | undefined, options?: StrykerOptions);
+    static inject: readonly ["options"];
+    protected readonly options?: IgnorerOptions;
+    constructor(options?: Partial<LogIgnorerOptions>);
     shouldIgnore(path: NodePath): string | undefined;
 }
 declare function logIgnorerFactory(injector: Injector<PluginContext>): LogIgnorer;
@@ -38,5 +92,6 @@ declare function createLogIgnorerFactory(): {
     inject: ['$injector'];
 };
 declare const strykerPlugins: _stryker_mutator_api_plugin.FactoryPlugin<PluginKind.Ignore, ["$injector"]>[];
+declare const strykerValidationSchema: typeof ___schema_log_ignorer_options_json;
 
-export { LogIgnorer, type LogIgnorerOptions, type NodePath, createLogIgnorerFactory, logIgnorerFactory, strykerPlugins };
+export { type IgnorerOptions, LogIgnorer, type LogIgnorerOptions, type NodePath, createLogIgnorerFactory, logIgnorerFactory, strykerPlugins, strykerValidationSchema };

package/build/index.d.ts

@@ -2,8 +2,54 @@ import * as _stryker_mutator_api_plugin from '@stryker-mutator/api/plugin';
 import { Injector, PluginContext, PluginKind } from '@stryker-mutator/api/plugin';
 import { StrykerOptions } from '@stryker-mutator/api/core';
 import { Ignorer } from '@stryker-mutator/api/ignore';
-import { Logger } from '@stryker-mutator/api/logging';
 
+var $schema = "http://json-schema.org/draft-07/schema";
+var type = "object";
+var title = "LogIgnorerOptions";
+var additionalProperties = false;
+var properties = {
+	logignore: {
+		description: "Configuration for @sgohlke/stryker-log-ignorer",
+		title: "IgnorerOptions",
+		additionalProperties: false,
+		type: "object",
+		"default": {
+		},
+		properties: {
+			objectNames: {
+				description: "Specify the object names of the logger objects to be ignored. Defaults to [\"console\"]",
+				type: "array",
+				items: {
+					type: "string"
+				},
+				"default": [
+					"console"
+				]
+			}
+		}
+	}
+};
+var logIgnorerOptions = {
+	$schema: $schema,
+	type: type,
+	title: title,
+	additionalProperties: additionalProperties,
+	properties: properties
+};
+
+declare const ___schema_log_ignorer_options_json_$schema: typeof $schema;
+declare const ___schema_log_ignorer_options_json_additionalProperties: typeof additionalProperties;
+declare const ___schema_log_ignorer_options_json_properties: typeof properties;
+declare const ___schema_log_ignorer_options_json_title: typeof title;
+declare const ___schema_log_ignorer_options_json_type: typeof type;
+declare namespace ___schema_log_ignorer_options_json {
+  export { ___schema_log_ignorer_options_json_$schema as $schema, ___schema_log_ignorer_options_json_additionalProperties as additionalProperties, logIgnorerOptions as default, ___schema_log_ignorer_options_json_properties as properties, ___schema_log_ignorer_options_json_title as title, ___schema_log_ignorer_options_json_type as type };
+}
+
+/**
+ * We define the necessary functions and fields for NodePath to be able to provide type safety
+ * in our code.
+ */
 interface NodePath {
     isExpressionStatement(): boolean;
     node: {
@@ -19,14 +65,22 @@ interface NodePath {
         };
     };
 }
+/**
+ * Configuration for @sgohlke/stryker-log-ignorer
+ */
+interface IgnorerOptions {
+    /**
+     * Specify the object names of the logger objects to be ignored. Defaults to ["console"]
+     */
+    objectNames?: string[];
+}
 interface LogIgnorerOptions extends StrykerOptions {
-    loggerClass?: string;
+    logignore?: IgnorerOptions;
 }
 declare class LogIgnorer implements Ignorer {
-    private readonly log?;
-    static inject: readonly ["logger", "options"];
-    private readonly options;
-    constructor(log?: Logger | undefined, options?: StrykerOptions);
+    static inject: readonly ["options"];
+    protected readonly options?: IgnorerOptions;
+    constructor(options?: Partial<LogIgnorerOptions>);
     shouldIgnore(path: NodePath): string | undefined;
 }
 declare function logIgnorerFactory(injector: Injector<PluginContext>): LogIgnorer;
@@ -38,5 +92,6 @@ declare function createLogIgnorerFactory(): {
     inject: ['$injector'];
 };
 declare const strykerPlugins: _stryker_mutator_api_plugin.FactoryPlugin<PluginKind.Ignore, ["$injector"]>[];
+declare const strykerValidationSchema: typeof ___schema_log_ignorer_options_json;
 
-export { LogIgnorer, type LogIgnorerOptions, type NodePath, createLogIgnorerFactory, logIgnorerFactory, strykerPlugins };
+export { type IgnorerOptions, LogIgnorer, type LogIgnorerOptions, type NodePath, createLogIgnorerFactory, logIgnorerFactory, strykerPlugins, strykerValidationSchema };

package/build/index.js

@@ -5,21 +5,17 @@ import {
   PluginKind,
   tokens
 } from "@stryker-mutator/api/plugin";
+import fs from "node:fs";
 var LogIgnorer = class {
-  constructor(log, options) {
-    this.log = log;
-    this.options = options;
-  }
-  static inject = [commonTokens.logger, commonTokens.options];
+  static inject = [commonTokens.options];
   options;
+  constructor(options) {
+    this.options = options?.logignore;
+  }
   shouldIgnore(path) {
-    const loggerClass = this.options?.loggerClass ?? "console";
-    this.log?.debug(
-      "LogIgnore Plugin. Path is: ",
-      JSON.stringify(path.node)
-    );
-    if (path.isExpressionStatement() && path.node.expression.type === "CallExpression" && path.node.expression.callee.type === "MemberExpression" && path.node.expression.callee.object.type === "Identifier" && path.node.expression.callee.object.name === loggerClass) {
-      return `We are not interested in testing ${loggerClass} statements.`;
+    const loggerObjectNames = this.options?.objectNames ?? ["console"];
+    if (path.isExpressionStatement() && path.node.expression.type === "CallExpression" && path.node.expression.callee.type === "MemberExpression" && path.node.expression.callee.object.type === "Identifier" && loggerObjectNames.includes(path.node.expression.callee.object.name)) {
+      return `We are not interested in testing ${loggerObjectNames} statements.`;
     }
   }
 };
@@ -30,14 +26,25 @@ function logIgnorerFactory(injector) {
 function createLogIgnorerFactory() {
   return logIgnorerFactory;
 }
-var createLogIgnorer = createLogIgnorerFactory();
 var strykerPlugins = [
-  declareFactoryPlugin(PluginKind.Ignore, "log-ignore", createLogIgnorer)
+  declareFactoryPlugin(
+    PluginKind.Ignore,
+    "log-ignore",
+    createLogIgnorerFactory()
+  )
 ];
+var strykerValidationSchema = JSON.parse(
+  // eslint-disable-next-line security/detect-non-literal-fs-filename
+  fs.readFileSync(
+    new URL("../schema/log-ignorer-options.json", import.meta.url),
+    "utf8"
+  )
+);
 export {
   LogIgnorer,
   createLogIgnorerFactory,
   logIgnorerFactory,
-  strykerPlugins
+  strykerPlugins,
+  strykerValidationSchema
 };
 //# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { StrykerOptions } from '@stryker-mutator/api/core'\nimport { Ignorer } from '@stryker-mutator/api/ignore'\nimport { Logger } from '@stryker-mutator/api/logging'\nimport {\n    commonTokens,\n    declareFactoryPlugin,\n    Injector,\n    PluginContext,\n    PluginKind,\n    tokens,\n} from '@stryker-mutator/api/plugin'\n\nexport interface NodePath {\n    isExpressionStatement(): boolean\n    node: {\n        expression: {\n            type: string\n            callee: {\n                type: string\n                object: {\n                    type: string\n                    name: string\n                }\n            }\n        }\n    }\n}\n\nexport interface LogIgnorerOptions extends StrykerOptions {\n    loggerClass?: string\n}\n\nexport class LogIgnorer implements Ignorer {\n    public static inject = [commonTokens.logger, commonTokens.options] as const\n    private readonly options: LogIgnorerOptions\n\n    constructor(\n        // eslint-disable-next-line @typescript-eslint/parameter-properties\n        private readonly log?: Logger,\n        options?: StrykerOptions,\n    ) {\n        this.options = options as LogIgnorerOptions\n    }\n\n    shouldIgnore(path: NodePath): string | undefined {\n        const loggerClass = this.options?.loggerClass ?? 'console'\n        this.log?.debug(\n            'LogIgnore Plugin. Path is: ',\n            JSON.stringify(path.node),\n        )\n        if (\n            path.isExpressionStatement() &&\n            path.node.expression.type === 'CallExpression' &&\n            path.node.expression.callee.type === 'MemberExpression' &&\n            path.node.expression.callee.object.type === 'Identifier' &&\n            path.node.expression.callee.object.name === loggerClass\n        ) {\n            return `We are not interested in testing ${loggerClass} statements.`\n        }\n    }\n}\n\nlogIgnorerFactory.inject = tokens(commonTokens.injector)\n\nexport function logIgnorerFactory(\n    injector: Injector<PluginContext>,\n): LogIgnorer {\n    return injector.injectClass(LogIgnorer)\n}\n\nexport function createLogIgnorerFactory(): {\n    (injector: Injector<PluginContext>): LogIgnorer\n    inject: ['$injector']\n} {\n    return logIgnorerFactory\n}\n\nconst createLogIgnorer = createLogIgnorerFactory()\nexport const strykerPlugins = [\n    declareFactoryPlugin(PluginKind.Ignore, 'log-ignore', createLogIgnorer),\n]\n"],"mappings":";AAGA;AAAA,EACI;AAAA,EACA;AAAA,EAGA;AAAA,EACA;AAAA,OACG;AAsBA,IAAM,aAAN,MAAoC;AAAA,EAIvC,YAEqB,KACjB,SACF;AAFmB;AAGjB,SAAK,UAAU;AAAA,EACnB;AAAA,EATA,OAAc,SAAS,CAAC,aAAa,QAAQ,aAAa,OAAO;AAAA,EAChD;AAAA,EAUjB,aAAa,MAAoC;AAC7C,UAAM,cAAc,KAAK,SAAS,eAAe;AACjD,SAAK,KAAK;AAAA,MACN;AAAA,MACA,KAAK,UAAU,KAAK,IAAI;AAAA,IAC5B;AACA,QACI,KAAK,sBAAsB,KAC3B,KAAK,KAAK,WAAW,SAAS,oBAC9B,KAAK,KAAK,WAAW,OAAO,SAAS,sBACrC,KAAK,KAAK,WAAW,OAAO,OAAO,SAAS,gBAC5C,KAAK,KAAK,WAAW,OAAO,OAAO,SAAS,aAC9C;AACE,aAAO,oCAAoC,WAAW;AAAA,IAC1D;AAAA,EACJ;AACJ;AAEA,kBAAkB,SAAS,OAAO,aAAa,QAAQ;AAEhD,SAAS,kBACZ,UACU;AACV,SAAO,SAAS,YAAY,UAAU;AAC1C;AAEO,SAAS,0BAGd;AACE,SAAO;AACX;AAEA,IAAM,mBAAmB,wBAAwB;AAC1C,IAAM,iBAAiB;AAAA,EAC1B,qBAAqB,WAAW,QAAQ,cAAc,gBAAgB;AAC1E;","names":[]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { StrykerOptions } from '@stryker-mutator/api/core'\nimport { Ignorer } from '@stryker-mutator/api/ignore'\nimport {\n    commonTokens,\n    declareFactoryPlugin,\n    Injector,\n    PluginContext,\n    PluginKind,\n    tokens,\n} from '@stryker-mutator/api/plugin'\nimport fs from 'node:fs'\n\n/**\n * We define the necessary functions and fields for NodePath to be able to provide type safety\n * in our code.\n */\nexport interface NodePath {\n    isExpressionStatement(): boolean\n    node: {\n        expression: {\n            type: string\n            callee: {\n                type: string\n                object: {\n                    type: string\n                    name: string\n                }\n            }\n        }\n    }\n}\n\n/**\n * Configuration for @sgohlke/stryker-log-ignorer\n */\nexport interface IgnorerOptions {\n    /**\n     * Specify the object names of the logger objects to be ignored. Defaults to [\"console\"]\n     */\n    objectNames?: string[]\n}\n\nexport interface LogIgnorerOptions extends StrykerOptions {\n    logignore?: IgnorerOptions\n}\n\n/*\n * LogIgnorer provides functionality to ignore log calls for provided logger object names.\n */\nexport class LogIgnorer implements Ignorer {\n    public static inject = [commonTokens.options] as const\n    protected readonly options?: IgnorerOptions\n\n    constructor(options?: Partial<LogIgnorerOptions>) {\n        this.options = options?.logignore\n    }\n\n    shouldIgnore(path: NodePath): string | undefined {\n        const loggerObjectNames = this.options?.objectNames ?? ['console']\n        if (\n            path.isExpressionStatement() &&\n            path.node.expression.type === 'CallExpression' &&\n            path.node.expression.callee.type === 'MemberExpression' &&\n            path.node.expression.callee.object.type === 'Identifier' &&\n            loggerObjectNames.includes(path.node.expression.callee.object.name)\n        ) {\n            return `We are not interested in testing ${loggerObjectNames} statements.`\n        }\n    }\n}\n\nlogIgnorerFactory.inject = tokens(commonTokens.injector)\n\nexport function logIgnorerFactory(\n    injector: Injector<PluginContext>,\n): LogIgnorer {\n    return injector.injectClass(LogIgnorer)\n}\n\nexport function createLogIgnorerFactory(): {\n    (injector: Injector<PluginContext>): LogIgnorer\n    inject: ['$injector']\n} {\n    return logIgnorerFactory\n}\n\nexport const strykerPlugins = [\n    declareFactoryPlugin(\n        PluginKind.Ignore,\n        'log-ignore',\n        createLogIgnorerFactory(),\n    ),\n]\n\nexport const strykerValidationSchema: typeof import('../schema/log-ignorer-options.json') =\n    JSON.parse(\n        // eslint-disable-next-line security/detect-non-literal-fs-filename\n        fs.readFileSync(\n            new URL('../schema/log-ignorer-options.json', import.meta.url),\n            'utf8',\n        ),\n    )\n"],"mappings":";AAEA;AAAA,EACI;AAAA,EACA;AAAA,EAGA;AAAA,EACA;AAAA,OACG;AACP,OAAO,QAAQ;AAuCR,IAAM,aAAN,MAAoC;AAAA,EACvC,OAAc,SAAS,CAAC,aAAa,OAAO;AAAA,EACzB;AAAA,EAEnB,YAAY,SAAsC;AAC9C,SAAK,UAAU,SAAS;AAAA,EAC5B;AAAA,EAEA,aAAa,MAAoC;AAC7C,UAAM,oBAAoB,KAAK,SAAS,eAAe,CAAC,SAAS;AACjE,QACI,KAAK,sBAAsB,KAC3B,KAAK,KAAK,WAAW,SAAS,oBAC9B,KAAK,KAAK,WAAW,OAAO,SAAS,sBACrC,KAAK,KAAK,WAAW,OAAO,OAAO,SAAS,gBAC5C,kBAAkB,SAAS,KAAK,KAAK,WAAW,OAAO,OAAO,IAAI,GACpE;AACE,aAAO,oCAAoC,iBAAiB;AAAA,IAChE;AAAA,EACJ;AACJ;AAEA,kBAAkB,SAAS,OAAO,aAAa,QAAQ;AAEhD,SAAS,kBACZ,UACU;AACV,SAAO,SAAS,YAAY,UAAU;AAC1C;AAEO,SAAS,0BAGd;AACE,SAAO;AACX;AAEO,IAAM,iBAAiB;AAAA,EAC1B;AAAA,IACI,WAAW;AAAA,IACX;AAAA,IACA,wBAAwB;AAAA,EAC5B;AACJ;AAEO,IAAM,0BACT,KAAK;AAAA;AAAA,EAED,GAAG;AAAA,IACC,IAAI,IAAI,sCAAsC,YAAY,GAAG;AAAA,IAC7D;AAAA,EACJ;AACJ;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sgohlke/stryker-log-ignorer",
-    "version": "1.0.0",
+    "version": "2.0.1",
     "description": "Log Ignorer for Stryker",
     "scripts": {
         "build": "tsup-node",
@@ -42,7 +42,7 @@
     "homepage": "https://github.com/sgohlke/stryker-log-ignorer#readme",
     "devDependencies": {
         "@types/node": "20.12.7",
-        "@vitest/coverage-v8": "1.5.0",
+        "@vitest/coverage-v8": "1.5.2",
         "eslint-plugin-deprecation": "2.0.0",
         "eslint-plugin-import": "2.29.1",
         "eslint-plugin-security": "3.0.0",
@@ -53,7 +53,7 @@
         "typescript": "5.4.5",
         "typescript-eslint": "7.7.1",
         "vite-tsconfig-paths": "4.3.2",
-        "vitest": "1.5.0"
+        "vitest": "1.5.2"
     },
     "dependencies": {
         "@stryker-mutator/api": "8.2.6"

package/schema/log-ignorer-options.json

@@ -0,0 +1,25 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema",
+    "type": "object",
+    "title": "LogIgnorerOptions",
+    "additionalProperties": false,
+    "properties": {
+        "logignore": {
+            "description": "Configuration for @sgohlke/stryker-log-ignorer",
+            "title": "IgnorerOptions",
+            "additionalProperties": false,
+            "type": "object",
+            "default": {},
+            "properties": {
+                "objectNames": {
+                    "description": "Specify the object names of the logger objects to be ignored. Defaults to [\"console\"]",
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    },
+                    "default": ["console"]
+                }
+            }
+        }
+    }
+}

package/.prettierrc.json

@@ -1,16 +0,0 @@
-{
-    "plugins": ["prettier-plugin-organize-imports"],
-    "semi": false,
-    "singleQuote": true,
-    "tabWidth": 4,
-    "trailingComma": "all",
-    "overrides": [
-        {
-            "files": ["*.yml", "*.yaml"],
-            "options": {
-                "singleQuote": false,
-                "tabWidth": 2
-            }
-        }
-    ]
-}

package/stryker.config.json

@@ -1,12 +0,0 @@
-{
-    "$schema": "./node_modules/@stryker-mutator/core/schema/stryker-schema.json",
-    "_comment": "This config was generated using 'stryker init'. Please take a look at: https://stryker-mutator.io/docs/stryker-js/configuration/ for more information.",
-    "packageManager": "npm",
-    "reporters": ["html", "clear-text", "progress"],
-    "testRunner": "vitest",
-    "testRunner_comment": "Take a look at https://stryker-mutator.io/docs/stryker-js/vitest-runner for information about the vitest plugin.",
-    "coverageAnalysis": "perTest",
-    "buildCommand": "npm run build",
-    "ignorers": ["log-ignore"],
-    "plugins": ["@stryker-mutator/*", "./build/index.js"]
-}

package/tsup.config.ts

@@ -1,13 +0,0 @@
-import { defineConfig } from 'tsup'
-
-export default defineConfig({
-    entry: ['src/index.ts'],
-    outDir: 'build',
-    clean: true,
-    target: ['es2022', 'node18'],
-    format: ['cjs', 'esm'],
-    dts: true,
-    minify: false,
-    sourcemap: true,
-    splitting: true,
-})

package/vitest.config.ts

@@ -1,14 +0,0 @@
-import tsconfigPaths from 'vite-tsconfig-paths'
-import { defineConfig } from 'vitest/config'
-
-export default defineConfig({
-    plugins: [tsconfigPaths()],
-    test: {
-        coverage: {
-            exclude: ['build', 'tests'],
-            provider: 'v8',
-            reporter: ['text'],
-        },
-        exclude: ['node_modules', 'build', '.idea', '.git', '.cache'],
-    },
-})