@stryker-mutator/api

What is @stryker-mutator/api?

@stryker-mutator/api is a part of the Stryker Mutator framework, which is used for mutation testing in JavaScript and TypeScript projects. It provides a set of APIs that allow developers to integrate and extend the mutation testing capabilities of Stryker.

What are @stryker-mutator/api's main functionalities?

Mutator API

The Mutator API allows developers to create custom mutators that define how code should be mutated during testing. This is useful for extending the mutation testing capabilities to cover more specific or custom scenarios.

const { Mutator } = require('@stryker-mutator/api/mutant');

class MyMutator extends Mutator {
  mutate(node) {
    // Custom mutation logic
  }
}

Reporter API

The Reporter API provides a way to create custom reporters that can handle and display the results of mutation testing. This allows for customized reporting formats and integration with other tools.

const { Reporter } = require('@stryker-mutator/api/report');

class MyReporter extends Reporter {
  onMutantTested(result) {
    console.log(`Mutant ${result.id} tested with status ${result.status}`);
  }
}

Test Framework API

The Test Framework API allows developers to integrate custom test frameworks with Stryker. This is useful for supporting additional testing frameworks that are not natively supported by Stryker.

const { TestFramework } = require('@stryker-mutator/api/test_framework');

class MyTestFramework extends TestFramework {
  constructor() {
    super();
    // Custom test framework initialization
  }
}

Other packages similar to @stryker-mutator/api

jest

Jest is a popular JavaScript testing framework with built-in support for snapshot testing, mocking, and more. While it does not focus on mutation testing like Stryker, it provides a comprehensive testing solution that can be used alongside Stryker for a complete testing strategy.

mocha

Mocha is a flexible JavaScript test framework for Node.js programs. It provides a simple and extensible interface for writing tests, but does not include mutation testing capabilities. Mocha can be used with Stryker to perform mutation testing on tests written in Mocha.

karma

Karma is a test runner that allows you to execute JavaScript code in multiple real browsers. It is often used in conjunction with other testing frameworks like Jasmine or Mocha. While Karma itself does not provide mutation testing, it can be integrated with Stryker to run mutation tests in a browser environment.

README

Stryker API

This is the repository for maintaining the API of the Stryker JavaScript mutation testing framework. Plugin creators should depend on this API rather than on the main Stryker repository directly.

Extension use cases

You can extend Stryker in a number of ways.

1. Create your own Mutator
2. Create a custom Reporter
3. Create a TestFramework for a test framework
4. Create a TestRunner to bridge the gap between your test runner and Stryker
5. Create a custom way of configuring Stryker by creating an OptionsEditor

All extension points work in the same basic way.

1. Create a constructor function (or class)
2. Register the constructor function to the correct Factory.

For more info, please take a look at the Stryker handbook.

Changelog

4.0.0-beta.0 (2020-07-10)

Bug Fixes

• buildCommand: allow for a single command string in posix (77b6a20)
• instrumenter: don't mutate require (963e289)
• jasmine-runner: update deprecated api calls (#2250) (b6d6dfd)
• karma-runner: mocha filtering with / (#2290) (3918633)
• reporter: report event order (#2311) (ceb73a8)
• sandbox: exec build command before symlink (bd25cd6)
• typescript-checker: support empty files (#2310) (284a28c)

Features

• api: add id to Mutant interface (#2255) (cfc9053)
• api: add new test runner api (#2249) (bbbc308)
• api: remove support for options editors (5e56d0e)
• checker: add checker api (#2240) (d463f86), closes #1514 #1980
• core: add support for checker plugins (#2285) (69358e1)
• core: support build command (f71ba87)
• html-parser: add // [@ts-nocheck](https://github.com/ts-nocheck) to scripts (8ceff31)
• instrumenter: add mutant placers (#2224) (0e05025)
• instrumenter: add parsers (#2222) (3b57ef2)
• instrumenter: add the mutation testing instrumenter (#2212) (197e177)
• instrumenter: add transformers (#2234) (61c8fe6)
• instrumenter: allow override of babel plugins (8758cfd)
• instrumenter: implement Instrumenter class (8df9172)
• jasmine-runner: implement new test runner api (#2256) (871db8c), closes #2249
• mutator: remove Mutator API (3ca89cf)
• mutators: add mutators to instrumenter package (#2266) (3b87743)
• sandbox: add ignore header to js files (#2291) (3adde83), closes #2276
• test-framework: remove TestFramework API (fe5e200)
• transpiler: remove Transpiler API (06f668b)
• tsconfig: rewrite tsconfig references (#2292) (4ee4950), closes #2276
• typescript-checker: a typescript type checker plugin (#2241) (42adb95), closes /github.com/stryker-mutator/stryker/blob/f44008993a543dc3f38ca99516f56d315fdcb735/packages/typescript/src/transpiler/TranspilingLanguageService.ts#L23 #391

BREAKING CHANGES

• core: * --maxConcurrentTestRunners is now deprecated. Please use --concurrency instead.