@stryker-mutator/typescript-checker - npm Package Compare versions

Comparing version 4.0.0-beta.1 to 4.0.0-beta.2

CHANGELOG.md

@@ -6,2 +6,10 @@ # Change Log
 
+# [4.0.0-beta.2](https://github.com/stryker-mutator/stryker/compare/v4.0.0-beta.1...v4.0.0-beta.2) (2020-08-07)
+
+**Note:** Version bump only for package @stryker-mutator/typescript-checker
+
+
+
+
+
 # [4.0.0-beta.1](https://github.com/stryker-mutator/stryker/compare/v4.0.0-beta.0...v4.0.0-beta.1) (2020-07-17)
@@ -8,0 +16,0 @@

dist/src/fs/hybrid-file-system.d.ts

 import ts from 'typescript';
 import { Mutant } from '@stryker-mutator/api/core';
+import { Logger } from '@stryker-mutator/api/logging';
 import { ScriptFile } from './script-file';
@@ -12,4 +13,7 @@ /**
 export declare class HybridFileSystem {
+    private readonly log;
     private readonly files;
     private mutatedFile;
+    static inject: ["logger"];
+    constructor(log: Logger);
     writeFile(fileName: string, data: string): void;
@@ -16,0 +20,0 @@ mutate(mutant: Pick<Mutant, 'fileName' | 'range' | 'replacement'>): void;

dist/src/fs/hybrid-file-system.js

@@ -6,2 +6,3 @@ "use strict";
 const typescript_1 = tslib_1.__importDefault(require("typescript"));
+const plugin_1 = require("@stryker-mutator/api/plugin");
 const script_file_1 = require("./script-file");
@@ -19,3 +20,4 @@ function toTSFileName(fileName) {
 class HybridFileSystem {
-    constructor() {
+    constructor(log) {
+        this.log = log;
         this.files = new Map();
@@ -30,2 +32,3 @@ }
         else {
+            this.log.trace('Writing to file "%s"', fileName);
             this.files.set(fileName, new script_file_1.ScriptFile(data, fileName));
@@ -51,2 +54,3 @@ }
         }
+        this.log.trace('Registering watcher for file "%s"', fileName);
         file.watcher = watcher;
@@ -73,2 +77,3 @@ }
 exports.HybridFileSystem = HybridFileSystem;
+HybridFileSystem.inject = plugin_1.tokens(plugin_1.commonTokens.logger);
 //# sourceMappingURL=hybrid-file-system.js.map

dist/src/fs/script-file.js

@@ -29,3 +29,3 @@ "use strict";
         if (!this.watcher) {
-            throw new Error(`No watcher registered for ${this.fileName}. Changes would go unnoticed`);
+            throw new Error(`Tried to check file "${this.fileName}" (which is part of your typescript project), but no watcher is registered for it. Changes would go unnoticed. This probably means that you need to expand the files that are included in your project.`);
         }
@@ -32,0 +32,0 @@ }

dist/src/index.d.ts

 import { PluginKind } from '@stryker-mutator/api/plugin';
-import { TypescriptChecker } from './typescript-checker';
-export declare const strykerPlugins: import("@stryker-mutator/api/plugin").ClassPlugin<PluginKind.Checker, ["logger", "options"]>[];
-export { TypescriptChecker };
+import { create } from './typescript-checker';
+export declare const strykerPlugins: import("@stryker-mutator/api/plugin").FactoryPlugin<PluginKind.Checker, ["$injector"]>[];
+export declare const createTypescriptChecker: typeof create;
 //# sourceMappingURL=index.d.ts.map

dist/src/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TypescriptChecker = exports.strykerPlugins = void 0;
+exports.createTypescriptChecker = exports.strykerPlugins = void 0;
 const plugin_1 = require("@stryker-mutator/api/plugin");
 const typescript_checker_1 = require("./typescript-checker");
-Object.defineProperty(exports, "TypescriptChecker", { enumerable: true, get: function () { return typescript_checker_1.TypescriptChecker; } });
-exports.strykerPlugins = [plugin_1.declareClassPlugin(plugin_1.PluginKind.Checker, 'typescript', typescript_checker_1.TypescriptChecker)];
+exports.strykerPlugins = [plugin_1.declareFactoryPlugin(plugin_1.PluginKind.Checker, 'typescript', typescript_checker_1.create)];
+exports.createTypescriptChecker = typescript_checker_1.create;
 //# sourceMappingURL=index.js.map

dist/src/typescript-checker.d.ts

 import { Checker, CheckResult } from '@stryker-mutator/api/check';
+import { OptionsContext, Injector } from '@stryker-mutator/api/plugin';
 import { Logger } from '@stryker-mutator/api/logging';
 import { Mutant, StrykerOptions } from '@stryker-mutator/api/core';
+import { HybridFileSystem } from './fs';
+export declare function create(injector: Injector<OptionsContext>): TypescriptChecker;
+export declare namespace create {
+    var inject: ["$injector"];
+}
 /**
@@ -16,5 +22,5 @@ * An in-memory type checker implementation which validates type errors of mutants.
     private readonly allTSConfigFiles;
-    static inject: ["logger", "options"];
+    static inject: ["logger", "options", "fs"];
     private readonly tsconfigFile;
-    constructor(logger: Logger, options: StrykerOptions);
+    constructor(logger: Logger, options: StrykerOptions, fs: HybridFileSystem);
     /**
@@ -21,0 +27,0 @@ * Starts the typescript compiler and does a dry run

dist/src/typescript-checker.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TypescriptChecker = void 0;
+exports.TypescriptChecker = exports.create = void 0;
 const tslib_1 = require("tslib");
@@ -13,2 +13,3 @@ const os_1 = require("os");
 const tsconfig_helpers_1 = require("./tsconfig-helpers");
+const pluginTokens = tslib_1.__importStar(require("./plugin-tokens"));
 const diagnosticsHost = {
@@ -20,2 +21,18 @@ getCanonicalFileName: (fileName) => fileName,
 const FILE_CHANGE_DETECTED_DIAGNOSTIC_CODE = 6032;
+typescriptCheckerLoggerFactory.inject = plugin_1.tokens(plugin_1.commonTokens.getLogger, plugin_1.commonTokens.target);
+// eslint-disable-next-line @typescript-eslint/ban-types
+function typescriptCheckerLoggerFactory(loggerFactory, target) {
+    var _a;
+    const targetName = (_a = target === null || target === void 0 ? void 0 : target.name) !== null && _a !== void 0 ? _a : TypescriptChecker.name;
+    const category = targetName === TypescriptChecker.name ? TypescriptChecker.name : `${TypescriptChecker.name}.${targetName}`;
+    return loggerFactory(category);
+}
+create.inject = plugin_1.tokens(plugin_1.commonTokens.injector);
+function create(injector) {
+    return injector
+        .provideFactory(plugin_1.commonTokens.logger, typescriptCheckerLoggerFactory, plugin_1.Scope.Transient)
+        .provideClass(pluginTokens.fs, fs_1.HybridFileSystem)
+        .injectClass(TypescriptChecker);
+}
+exports.create = create;
 /**
@@ -25,5 +42,5 @@ * An in-memory type checker implementation which validates type errors of mutants.
 class TypescriptChecker {
-    constructor(logger, options) {
+    constructor(logger, options, fs) {
         this.logger = logger;
-        this.fs = new fs_1.HybridFileSystem();
+        this.fs = fs;
         this.currentErrors = [];
@@ -54,3 +71,3 @@ this.logDiagnostic = (label) => {
             }, watchFile: (path, callback) => {
-                this.fs.getFile(path).watcher = callback;
+                this.fs.watchFile(path, callback);
                 return {
@@ -153,3 +170,3 @@ close: () => {
 exports.TypescriptChecker = TypescriptChecker;
-TypescriptChecker.inject = plugin_1.tokens(plugin_1.commonTokens.logger, plugin_1.commonTokens.options);
+TypescriptChecker.inject = plugin_1.tokens(plugin_1.commonTokens.logger, plugin_1.commonTokens.options, pluginTokens.fs);
 //# sourceMappingURL=typescript-checker.js.map

package.json

 {
   "name": "@stryker-mutator/typescript-checker",
-  "version": "4.0.0-beta.1",
+  "version": "4.0.0-beta.2",
   "description": "A typescript type checker plugin to be used in Stryker, the JavaScript mutation testing framework",
@@ -33,15 +33,15 @@ "main": "dist/src/index.js",
   "dependencies": {
-    "@stryker-mutator/api": "4.0.0-beta.1",
-    "@stryker-mutator/util": "4.0.0-beta.1",
+    "@stryker-mutator/api": "4.0.0-beta.2",
+    "@stryker-mutator/util": "4.0.0-beta.2",
     "semver": "^7.3.2"
   },
   "devDependencies": {
-    "@stryker-mutator/test-helpers": "4.0.0-beta.1",
+    "@stryker-mutator/test-helpers": "4.0.0-beta.2",
     "@types/semver": "^7.2.0"
   },
   "peerDependencies": {
-    "@stryker-mutator/core": "3.2.4",
+    "@stryker-mutator/core": "4.0.0-beta.1",
     "typescript": ">=3.6"
   },
-  "gitHead": "2973eef59afb41e8ee2da8d08501c6cf3d086e8e"
+  "gitHead": "7095548fe9157367b77e69f301a1259222983c89"
 }

README.md

@@ -73,2 +73,6 @@ **NOTE:** This readme describes a checker plugin set to release in Stryker v4. It is not usable yet!
 
+## Troubleshooting
+
+
+
 ## Load the plugin
@@ -75,0 +79,0 @@

src/fs/hybrid-file-system.ts

 import ts from 'typescript';
 import { Mutant } from '@stryker-mutator/api/core';
+import { Logger } from '@stryker-mutator/api/logging';
+import { tokens, commonTokens } from '@stryker-mutator/api/plugin';
 
@@ -21,2 +23,5 @@ import { ScriptFile } from './script-file';
 
+  public static inject = tokens(commonTokens.logger);
+  constructor(private readonly log: Logger) {}
+
   public writeFile(fileName: string, data: string) {
@@ -28,2 +33,3 @@ fileName = toTSFileName(fileName);
     } else {
+      this.log.trace('Writing to file "%s"', fileName);
       this.files.set(fileName, new ScriptFile(data, fileName));
@@ -51,2 +57,3 @@ }
     }
+    this.log.trace('Registering watcher for file "%s"', fileName);
     file.watcher = watcher;
@@ -53,0 +60,0 @@ }

src/fs/script-file.ts

@@ -32,3 +32,5 @@ import ts from 'typescript';
     if (!this.watcher) {
-      throw new Error(`No watcher registered for ${this.fileName}. Changes would go unnoticed`);
+      throw new Error(
+        `Tried to check file "${this.fileName}" (which is part of your typescript project), but no watcher is registered for it. Changes would go unnoticed. This probably means that you need to expand the files that are included in your project.`
+      );
     }
@@ -35,0 +37,0 @@ }

src/index.ts

@@ -1,7 +0,7 @@
-import { PluginKind, declareClassPlugin } from '@stryker-mutator/api/plugin';
+import { PluginKind, declareFactoryPlugin } from '@stryker-mutator/api/plugin';
 
-import { TypescriptChecker } from './typescript-checker';
+import { create } from './typescript-checker';
 
-export const strykerPlugins = [declareClassPlugin(PluginKind.Checker, 'typescript', TypescriptChecker)];
+export const strykerPlugins = [declareFactoryPlugin(PluginKind.Checker, 'typescript', create)];
 
-export { TypescriptChecker };
+export const createTypescriptChecker = create;

src/typescript-checker.ts

@@ -6,4 +6,4 @@ import { EOL } from 'os';
 import { Checker, CheckResult, CheckStatus } from '@stryker-mutator/api/check';
-import { tokens, commonTokens } from '@stryker-mutator/api/plugin';
-import { Logger } from '@stryker-mutator/api/logging';
+import { tokens, commonTokens, OptionsContext, Injector, Scope } from '@stryker-mutator/api/plugin';
+import { Logger, LoggerFactoryMethod } from '@stryker-mutator/api/logging';
 import { Task, propertyPath } from '@stryker-mutator/util';
@@ -14,2 +14,3 @@ import { Mutant, StrykerOptions } from '@stryker-mutator/api/core';
 import { determineBuildModeEnabled, overrideOptions, retrieveReferencedProjects, guardTSVersion } from './tsconfig-helpers';
+import * as pluginTokens from './plugin-tokens';
 
@@ -24,2 +25,18 @@ const diagnosticsHost: ts.FormatDiagnosticsHost = {
 
+typescriptCheckerLoggerFactory.inject = tokens(commonTokens.getLogger, commonTokens.target);
+// eslint-disable-next-line @typescript-eslint/ban-types
+function typescriptCheckerLoggerFactory(loggerFactory: LoggerFactoryMethod, target: Function | undefined) {
+  const targetName = target?.name ?? TypescriptChecker.name;
+  const category = targetName === TypescriptChecker.name ? TypescriptChecker.name : `${TypescriptChecker.name}.${targetName}`;
+  return loggerFactory(category);
+}
+
+create.inject = tokens(commonTokens.injector);
+export function create(injector: Injector<OptionsContext>): TypescriptChecker {
+  return injector
+    .provideFactory(commonTokens.logger, typescriptCheckerLoggerFactory, Scope.Transient)
+    .provideClass(pluginTokens.fs, HybridFileSystem)
+    .injectClass(TypescriptChecker);
+}
+
 /**
@@ -29,3 +46,2 @@ * An in-memory type checker implementation which validates type errors of mutants.
 export class TypescriptChecker implements Checker {
-  private readonly fs = new HybridFileSystem();
   private currentTask: Task<CheckResult>;
@@ -38,6 +54,6 @@ private readonly currentErrors: ts.Diagnostic[] = [];
 
-  public static inject = tokens(commonTokens.logger, commonTokens.options);
+  public static inject = tokens(commonTokens.logger, commonTokens.options, pluginTokens.fs);
   private readonly tsconfigFile: string;
 
-  constructor(private readonly logger: Logger, options: StrykerOptions) {
+  constructor(private readonly logger: Logger, options: StrykerOptions, private readonly fs: HybridFileSystem) {
     this.tsconfigFile = options.tsconfigFile;
@@ -67,3 +83,3 @@ this.allTSConfigFiles = new Set([path.resolve(this.tsconfigFile)]);
           watchFile: (path: string, callback: ts.FileWatcherCallback) => {
-            this.fs.getFile(path)!.watcher = callback;
+            this.fs.watchFile(path, callback);
             return {
@@ -70,0 +86,0 @@ close: () => {

No alert changes

Improved metrics

Total package byte prevSize

68846

increased by8.35%

Number of package files

40

increased by14.29%

Lines of code

860

increased by7.5%

Number of lines in readme file

83

increased by5.06%

Dependency changes

• + Added@ampproject/remapping@2.3.0(transitive)

• + Added@babel/compat-data@7.24.7(transitive)

• + Added@babel/core@7.24.7(transitive)

• + Added@babel/helper-annotate-as-pure@7.24.7(transitive)

• + Added@babel/helper-compilation-targets@7.24.7(transitive)

• + Added@babel/helper-create-class-features-plugin@7.24.7(transitive)

• + Added@babel/helper-member-expression-to-functions@7.24.7(transitive)

• + Added@babel/helper-module-imports@7.24.7(transitive)

• + Added@babel/helper-module-transforms@7.24.7(transitive)

• + Added@babel/helper-optimise-call-expression@7.24.7(transitive)

• + Added@babel/helper-plugin-utils@7.24.7(transitive)

• + Added@babel/helper-replace-supers@7.24.7(transitive)

• + Added@babel/helper-simple-access@7.24.7(transitive)

• + Added@babel/helper-skip-transparent-expression-wrappers@7.24.7(transitive)

• + Added@babel/helper-validator-option@7.24.7(transitive)

• + Added@babel/plugin-proposal-decorators@7.24.7(transitive)

• + Added@babel/plugin-syntax-decorators@7.24.7(transitive)

• + Added@babel/plugin-syntax-jsx@7.24.7(transitive)

• + Added@babel/plugin-transform-modules-commonjs@7.24.7(transitive)

• + Added@babel/plugin-transform-typescript@7.24.7(transitive)

• + Added@babel/preset-typescript@7.24.7(transitive)

• + Added@stryker-mutator/api@4.0.0-beta.2(transitive)

• + Added@stryker-mutator/core@4.0.0-beta.1(transitive)

• + Added@stryker-mutator/instrumenter@4.0.0-beta.1(transitive)

• + Added@stryker-mutator/util@4.0.0-beta.2(transitive)

• + Addedangular-html-parser@1.8.0(transitive)

• + Addedbrowserslist@4.23.0(transitive)

• + Addedcaniuse-lite@1.0.30001628(transitive)

• + Addedchalk@4.1.2(transitive)

• + Addedconvert-source-map@2.0.0(transitive)

• + Addedcross-spawn@7.0.3(transitive)

• + Addedelectron-to-chromium@1.4.790(transitive)

• + Addedend-of-stream@1.4.4(transitive)

• + Addedescalade@3.1.2(transitive)

• + Addedexeca@4.1.0(transitive)

• + Addedgensync@1.0.0-beta.2(transitive)

• + Addedget-stream@5.2.0(transitive)

• + Addedhuman-signals@1.1.1(transitive)

• + Addedinquirer@7.2.0(transitive)

• + Addedis-stream@2.0.1(transitive)

• + Addedisexe@2.0.0(transitive)

• + Addedjson5@2.2.3(transitive)

• + Addedlru-cache@5.1.1(transitive)

• + Addedmerge-stream@2.0.0(transitive)

• + Addednode-releases@2.0.14(transitive)

• + Addednpm-run-path@4.0.1(transitive)

• + Addedpath-key@3.1.1(transitive)

• + Addedpicocolors@1.0.1(transitive)

• + Addedpump@3.0.0(transitive)

• + Addedrxjs@6.6.7(transitive)

• + Addedshebang-command@2.0.0(transitive)

• + Addedshebang-regex@3.0.0(transitive)

• + Addedstrip-final-newline@2.0.0(transitive)

• + Addedupdate-browserslist-db@1.0.16(transitive)

• + Addedwhich@2.0.2(transitive)

• + Addedyallist@3.1.1(transitive)

• - Removed@stryker-mutator/api@3.3.14.0.0-beta.1(transitive)

• - Removed@stryker-mutator/core@3.2.4(transitive)

• - Removed@stryker-mutator/util@3.3.14.0.0-beta.1(transitive)

• - Removedchalk@4.0.0(transitive)

• - Removedinquirer@7.1.0(transitive)

• - Removedistanbul-lib-coverage@2.0.5(transitive)

• - Removedistanbul-lib-instrument@3.3.0(transitive)

• - Removedrxjs@6.5.5(transitive)

• Updated@stryker-mutator/api@4.0.0-beta.2

• Updated@stryker-mutator/util@4.0.0-beta.2