stryker-api - npm Package Compare versions

Comparing version 0.14.0 to 0.15.0

CHANGELOG.md

@@ -6,2 +6,23 @@ # Change Log
 
+<a name="0.15.0"></a>
+# [0.15.0](https://github.com/stryker-mutator/stryker/compare/stryker-api@0.14.0...stryker-api@0.15.0) (2018-04-04)
+
+
+### Features
+
+* **Detect files:** create `File` class ([1a89c10](https://github.com/stryker-mutator/stryker/commit/1a89c10))
+* **test runner:** add hooks file to test run api ([97be399](https://github.com/stryker-mutator/stryker/commit/97be399))
+* **Transpiler api:** change return type of `transpile` to a file array ([e713416](https://github.com/stryker-mutator/stryker/commit/e713416))
+
+
+### BREAKING CHANGES
+
+* **test runner:** * Promises return types should be `Promise<void>` instead
+of `Promise<any>` (typescript compiler error).
+* **Detect files:** Remove the `InputFileDescriptor`
+interface (breaking for typescript compiler)
+
+
+
+
 <a name="0.14.0"></a>
@@ -8,0 +29,0 @@ # [0.14.0](https://github.com/stryker-mutator/stryker/compare/stryker-api@0.13.1...stryker-api@0.14.0) (2018-03-22)

config.d.ts

 export { default as Config } from './src/config/Config';
 export { default as ConfigEditor } from './src/config/ConfigEditor';
 export { default as ConfigEditorFactory } from './src/config/ConfigEditorFactory';

config.js

@@ -0,0 +0,0 @@ "use strict";

core.d.ts

 export { default as StrykerOptions } from './src/core/StrykerOptions';
 export { default as Factory } from './src/core/Factory';
-export { BinaryFile, WebFile, TextFile, File, FileKind, FileDescriptor } from './src/core/File';
+export { default as File } from './src/core/File';
 export { default as Position } from './src/core/Position';
 export { default as Location } from './src/core/Location';
 export { default as Range } from './src/core/Range';
-export { default as InputFileDescriptor } from './src/core/InputFileDescriptor';
 export { default as MutatorDescriptor } from './src/core/MutatorDescriptor';
 export { default as MutationScoreThresholds } from './src/core/MutationScoreThresholds';

core.js

@@ -6,3 +6,3 @@ "use strict";
 var File_1 = require("./src/core/File");
-exports.FileKind = File_1.FileKind;
+exports.File = File_1.default;
 //# sourceMappingURL=core.js.map

mutant.d.ts

 export { default as Mutant } from './src/mutant/Mutant';
 export { default as Mutator } from './src/mutant/Mutator';
 export { default as MutatorFactory } from './src/mutant/MutatorFactory';

mutant.js

@@ -0,0 +0,0 @@ "use strict";

package.json

 {
   "name": "stryker-api",
-  "version": "0.14.0",
+  "version": "0.15.0",
   "description": "The api for the extendable JavaScript mutation testing framework Stryker",
@@ -42,3 +42,6 @@ "scripts": {
     "tslib": "^1.6.0"
+  },
+  "devDependencies": {
+    "surrial": "^0.1.1"
   }
 }

README.md

@@ -0,0 +0,0 @@ [![Build Status](https://travis-ci.org/stryker-mutator/stryker.svg?branch=master)](https://travis-ci.org/stryker-mutator/stryker)

report.d.ts

@@ -0,0 +0,0 @@ export { default as Reporter } from './src/report/Reporter';

report.js

@@ -0,0 +0,0 @@ "use strict";

src/config/Config.d.ts

@@ -1,5 +0,5 @@
-import { StrykerOptions, InputFileDescriptor, MutatorDescriptor, MutationScoreThresholds } from '../../core';
+import { StrykerOptions, MutatorDescriptor, MutationScoreThresholds } from '../../core';
 export default class Config implements StrykerOptions {
     [customConfig: string]: any;
-    files: Array<string | InputFileDescriptor>;
+    files: string[];
     mutate: string[];
@@ -6,0 +6,0 @@ logLevel: string;

src/config/Config.js

@@ -0,0 +0,0 @@ "use strict";

src/config/ConfigEditor.d.ts

@@ -0,0 +0,0 @@ import Config from './Config';

src/config/ConfigEditor.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=ConfigEditor.js.map

src/config/ConfigEditorFactory.d.ts

@@ -0,0 +0,0 @@ import { Factory } from '../../core';

src/config/ConfigEditorFactory.js

@@ -0,0 +0,0 @@ "use strict";

src/core/Factory.d.ts

@@ -0,0 +0,0 @@ /**

src/core/Factory.js

@@ -0,0 +0,0 @@ "use strict";

src/core/File.d.ts

 /// <reference types="node" />
-export declare enum FileKind {
-    'Binary' = 0,
-    'Text' = 1,
-    'Web' = 2,
+/**
+ * Represents a file within Stryker. Could be a strictly in-memory file.
+*/
+export default class File {
+    readonly name: string;
+    private _textContent;
+    private _content;
+    /**
+     * Creates a new File to be used within Stryker.
+     * @param name The full name of the file (inc path)
+     * @param content The buffered or string content of the file
+     */
+    constructor(name: string, content: Buffer | string);
+    /**
+     * Gets the underlying content as buffer.
+     */
+    readonly content: Buffer;
+    /**
+     * Gets the underlying content as string using utf8 encoding.
+     */
+    readonly textContent: string;
 }
-export declare type File = BinaryFile | TextFile | WebFile;
-export interface FileDescriptor {
-    name: string;
-    included: boolean;
-    mutated: boolean;
-    transpiled: boolean;
-    kind: FileKind;
-}
-export interface TextFile extends FileDescriptor {
-    content: string;
-    kind: FileKind.Text;
-}
-export interface WebFile extends FileDescriptor {
-    kind: FileKind.Web;
-}
-export interface BinaryFile extends FileDescriptor {
-    content: Buffer;
-    kind: FileKind.Binary;
-}

src/core/File.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var FileKind;
-(function (FileKind) {
-    FileKind[FileKind["Binary"] = 0] = "Binary";
-    FileKind[FileKind["Text"] = 1] = "Text";
-    FileKind[FileKind["Web"] = 2] = "Web";
-})(FileKind = exports.FileKind || (exports.FileKind = {}));
+/**
+ * Represents a file within Stryker. Could be a strictly in-memory file.
+*/
+var File = /** @class */ (function () {
+    /**
+     * Creates a new File to be used within Stryker.
+     * @param name The full name of the file (inc path)
+     * @param content The buffered or string content of the file
+     */
+    function File(name, content) {
+        this.name = name;
+        if (typeof content === 'string') {
+            this._content = Buffer.from(content);
+            this._textContent = content;
+        }
+        else {
+            this._content = content;
+        }
+    }
+    Object.defineProperty(File.prototype, "content", {
+        /**
+         * Gets the underlying content as buffer.
+         */
+        get: function () {
+            return this._content;
+        },
+        enumerable: true,
+        configurable: true
+    });
+    Object.defineProperty(File.prototype, "textContent", {
+        /**
+         * Gets the underlying content as string using utf8 encoding.
+         */
+        get: function () {
+            if (!this._textContent) {
+                this._textContent = this.content.toString();
+            }
+            return this._textContent;
+        },
+        enumerable: true,
+        configurable: true
+    });
+    return File;
+}());
+exports.default = File;
 //# sourceMappingURL=File.js.map

src/core/Location.d.ts

@@ -0,0 +0,0 @@ import Position from './Position';

src/core/Location.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=Location.js.map

src/core/MutationScoreThresholds.d.ts

@@ -0,0 +0,0 @@ /**

src/core/MutationScoreThresholds.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=MutationScoreThresholds.js.map

src/core/MutatorDescriptor.d.ts

@@ -0,0 +0,0 @@ interface MutatorDescriptor {

src/core/MutatorDescriptor.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=MutatorDescriptor.js.map

src/core/Position.d.ts

@@ -0,0 +0,0 @@ /**

src/core/Position.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=Position.js.map

src/core/Range.d.ts

@@ -0,0 +0,0 @@ /**

src/core/Range.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=Range.js.map

src/core/StrykerOptions.d.ts

@@ -1,2 +0,1 @@
-import InputFileDescriptor from './InputFileDescriptor';
 import MutationScoreThresholds from './MutationScoreThresholds';
@@ -20,3 +19,3 @@ import MutatorDescriptor from './MutatorDescriptor';
      */
-    files?: Array<string | InputFileDescriptor>;
+    files?: string[];
     /**
@@ -23,0 +22,0 @@ * A list of globbing expression used for selecting the files that should be mutated.

src/core/StrykerOptions.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=StrykerOptions.js.map

src/mutant/Mutant.d.ts

@@ -0,0 +0,0 @@ import { Range } from '../../core';

src/mutant/Mutant.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=Mutant.js.map

src/mutant/Mutator.d.ts

 import { File } from '../../core';
 import Mutant from './Mutant';
 export default interface Mutator {
-    mutate(inputFiles: File[]): Mutant[];
+    mutate(inputFiles: ReadonlyArray<File>): ReadonlyArray<Mutant>;
 }

src/mutant/Mutator.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=Mutator.js.map

src/mutant/MutatorFactory.d.ts

@@ -0,0 +0,0 @@ import Mutator from './Mutator';

src/mutant/MutatorFactory.js

@@ -0,0 +0,0 @@ "use strict";

src/report/MatchedMutant.d.ts

@@ -0,0 +0,0 @@ interface MatchedMutant {

src/report/MatchedMutant.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=MatchedMutant.js.map

src/report/MutantResult.d.ts

@@ -0,0 +0,0 @@ import MutantStatus from './MutantStatus';

src/report/MutantResult.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=MutantResult.js.map

src/report/MutantStatus.d.ts

@@ -0,0 +0,0 @@ declare enum MutantStatus {

src/report/MutantStatus.js

@@ -0,0 +0,0 @@ "use strict";

src/report/Reporter.d.ts

@@ -0,0 +0,0 @@ import ScoreResult from './ScoreResult';

src/report/Reporter.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=Reporter.js.map

src/report/ReporterFactory.d.ts

@@ -0,0 +0,0 @@ import { Factory, StrykerOptions } from '../../core';

src/report/ReporterFactory.js

@@ -0,0 +0,0 @@ "use strict";

src/report/ScoreResult.d.ts

@@ -0,0 +0,0 @@ /**

src/report/ScoreResult.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=ScoreResult.js.map

src/report/SourceFile.d.ts

@@ -0,0 +0,0 @@ interface SourceFile {

src/report/SourceFile.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=SourceFile.js.map

src/test_framework/TestFramework.d.ts

@@ -0,0 +0,0 @@ import TestSelection from './TestSelection';

src/test_framework/TestFramework.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=TestFramework.js.map

src/test_framework/TestFrameworkFactory.d.ts

@@ -0,0 +0,0 @@ import { Factory } from '../../core';

src/test_framework/TestFrameworkFactory.js

@@ -0,0 +0,0 @@ "use strict";

src/test_framework/TestFrameworkSettings.d.ts

@@ -0,0 +0,0 @@ import { StrykerOptions } from '../../core';

src/test_framework/TestFrameworkSettings.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=TestFrameworkSettings.js.map

src/test_framework/TestSelection.d.ts

@@ -0,0 +0,0 @@ export default interface TestSelection {

src/test_framework/TestSelection.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=TestSelection.js.map

src/test_runner/Coverage.d.ts

@@ -0,0 +0,0 @@ import { Location } from '../../core';

src/test_runner/Coverage.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=Coverage.js.map

src/test_runner/RunnerOptions.d.ts

@@ -1,2 +0,2 @@
-import { StrykerOptions, FileDescriptor } from '../../core';
+import { StrykerOptions } from '../../core';
 /**
@@ -7,5 +7,5 @@ * Represents an options object to configure a TestRunner.
     /**
-     * The collection of files to load into the test runner in that exact order.
+     * The names of the files loaded in the sandbox.
      */
-    files: FileDescriptor[];
+    fileNames: string[];
     /**
@@ -12,0 +12,0 @@ * Represents a free port which the test runner can choose to use

src/test_runner/RunnerOptions.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=RunnerOptions.js.map

src/test_runner/RunOptions.d.ts

@@ -9,3 +9,8 @@ /**
     timeout: number;
+    /**
+     * The hooks JavaScript code that has to be loaded in the testing environment.
+     * It should be loaded right after the test framework but right before any tests can run.
+     */
+    testHooks?: string;
 }
 export default RunOptions;

src/test_runner/RunOptions.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=RunOptions.js.map

src/test_runner/RunResult.d.ts

@@ -0,0 +0,0 @@ import TestResult from './TestResult';

src/test_runner/RunResult.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=RunResult.js.map

src/test_runner/RunStatus.d.ts

@@ -0,0 +0,0 @@ declare enum RunStatus {

src/test_runner/RunStatus.js

@@ -0,0 +0,0 @@ "use strict";

src/test_runner/TestResult.d.ts

@@ -0,0 +0,0 @@ import TestStatus from './TestStatus';

src/test_runner/TestResult.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=TestResult.js.map

src/test_runner/TestRunner.d.ts

@@ -1,5 +0,3 @@
-/// <reference types="node" />
 import RunResult from './RunResult';
 import RunOptions from './RunOptions';
-import { EventEmitter } from 'events';
 /**
@@ -9,4 +7,3 @@ * Represents a TestRunner which can execute tests, resulting in a RunResult.
  * A test runner should:
- *  - Report per a `testResult` per test. See `TestResult` interface to know what is expected.
- *  - Emit a `'test_done'` event with a TestResult as an argument every time a test is executed (for reporting purposes).
+ *  - Report a `testResult` per test. See `TestResult` interface to know what is expected.
  *  - Report on code coverage after the initial test run (maybe, see below).
@@ -38,3 +35,3 @@ *
  */
-interface TestRunner extends EventEmitter {
+interface TestRunner {
     /**
@@ -45,3 +42,3 @@ * Optional. When implemented, will be called before runs are done on this test runner.
      */
-    init?(): Promise<any> | void;
+    init?(): Promise<void> | void;
     /**
@@ -58,4 +55,4 @@ * Executes a test run.
      */
-    dispose?(): Promise<any> | void;
+    dispose?(): Promise<void> | void;
 }
 export default TestRunner;

src/test_runner/TestRunner.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=TestRunner.js.map

src/test_runner/TestRunnerFactory.d.ts

@@ -0,0 +0,0 @@ import { Factory } from '../../core';

src/test_runner/TestRunnerFactory.js

@@ -0,0 +0,0 @@ "use strict";

src/test_runner/TestStatus.d.ts

@@ -0,0 +0,0 @@ /**

src/test_runner/TestStatus.js

@@ -0,0 +0,0 @@ "use strict";

src/transpile/Transpiler.d.ts

@@ -1,2 +0,1 @@
-import TranspileResult from './TranspileResult';
 import { File } from '../../core';
@@ -24,3 +23,3 @@ /**
      *
-     *      call 1: [foo.es6, bar.es6, fooSpec.es6, barSpec.es6, image.png, http://example.com]
+     *      call 1: [foo.es6, bar.es6, fooSpec.es6, barSpec.es6, image.png]
      *      call 2: [foo.es6 (mutated)]
@@ -31,5 +30,5 @@ *      call 3: [foo.es6 (mutated)]
      *
-     * @returns an error message (if transpiling failed) or the output files to be used in the next transpiler
+     * @returns an rejection (if transpiling failed) or the output files to be used as input for the next transpiler
      */
-    transpile(files: File[]): Promise<TranspileResult>;
+    transpile(files: ReadonlyArray<File>): Promise<ReadonlyArray<File>>;
 }

src/transpile/Transpiler.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=Transpiler.js.map

src/transpile/TranspilerFactory.d.ts

@@ -0,0 +0,0 @@ import { Factory } from '../../core';

src/transpile/TranspilerFactory.js

@@ -0,0 +0,0 @@ "use strict";

src/transpile/TranspilerOptions.d.ts

@@ -0,0 +0,0 @@ import { Config } from '../../config';

src/transpile/TranspilerOptions.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=TranspilerOptions.js.map

test_framework.d.ts

@@ -0,0 +0,0 @@ export { default as TestFramework } from './src/test_framework/TestFramework';

test_framework.js

@@ -0,0 +0,0 @@ "use strict";

test_runner.d.ts

@@ -0,0 +0,0 @@ export * from './src/test_runner/Coverage';

test_runner.js

@@ -0,0 +0,0 @@ "use strict";

transpile.d.ts

 export { default as Transpiler } from './src/transpile/Transpiler';
-export { default as TranspileResult } from './src/transpile/TranspileResult';
 export { default as TranspilerFactory } from './src/transpile/TranspilerFactory';
 export { default as TranspilerOptions } from './src/transpile/TranspilerOptions';

transpile.js

@@ -0,0 +0,0 @@ "use strict";

No alert changes

Improved metrics

Total package byte prevSize

77223

increased by3.92%

Lines of code

1336

increased by1.52%

Worsened metrics

Dev dependency count

1

increased byInfinity%

Number of package files

92

decreased by-4.17%

No dependency changes