feat(checker): add checker api

stryker-mutator · Jun 1, 2020 · 8907f94 · 8907f94
1 parent 8df9172
commit 8907f94
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 0 deletions.
diff --git a/packages/api/check.ts b/packages/api/check.ts
@@ -0,0 +1,2 @@
+export * from './src/checker/Check';
+export * from './src/checker/CheckResult';
diff --git a/packages/api/src/checker/Check.ts b/packages/api/src/checker/Check.ts
@@ -0,0 +1,9 @@
+import { Mutant } from '../../mutant';
+
+import { CheckResult } from './CheckResult';
+
+export interface Checker {
+  initialize(): Promise<void>;
+
+  check(mutant: Mutant): Promise<CheckResult>;
+}
diff --git a/packages/api/src/checker/CheckResult.ts b/packages/api/src/checker/CheckResult.ts
@@ -0,0 +1,6 @@
+import MutantStatus from '../report/MutantStatus';
+
+export interface CheckResult {
+  reason?: string;
+  mutantResult: MutantStatus;
+}
diff --git a/packages/api/src/plugin/Contexts.ts b/packages/api/src/plugin/Contexts.ts
@@ -48,4 +48,5 @@ export interface PluginContexts {
   [PluginKind.TestFramework]: OptionsContext;
   [PluginKind.TestRunner]: TestRunnerPluginContext;
   [PluginKind.Transpiler]: TranspilerPluginContext;
+  [PluginKind.Checker]: OptionsContext;
 }
diff --git a/packages/api/src/plugin/PluginKind.ts b/packages/api/src/plugin/PluginKind.ts
@@ -7,6 +7,7 @@ export enum PluginKind {
    */
   ConfigEditor = 'ConfigEditor',
   OptionsEditor = 'OptionsEditor',
+  Checker = 'Checker',
   TestRunner = 'TestRunner',
   TestFramework = 'TestFramework',
   Transpiler = 'Transpiler',

diff --git a/packages/api/src/plugin/Plugins.ts b/packages/api/src/plugin/Plugins.ts
@@ -7,6 +7,7 @@ import { TestFramework } from '../../test_framework';
 import { TestRunner } from '../../test_runner';
 import { Transpiler } from '../../transpile';
 import { OptionsEditor } from '../core/OptionsEditor';
+import { Checker } from '../../check';
 
 import { PluginContexts } from './Contexts';
 import { PluginKind } from './PluginKind';
@@ -90,6 +91,7 @@ export interface PluginInterfaces {
   [PluginKind.TestFramework]: TestFramework;
   [PluginKind.TestRunner]: TestRunner;
   [PluginKind.Transpiler]: Transpiler;
+  [PluginKind.Checker]: Checker;
 }
 
 /**

diff --git a/packages/api/tsconfig.src.json b/packages/api/tsconfig.src.json
@@ -7,6 +7,7 @@
     "src",
     "src-generated",
     "schema/*.json",
+    "check.ts",
     "config.ts",
     "core.ts",
     "logging.ts",
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		export * from './src/checker/Check';
		export * from './src/checker/CheckResult';