For JavaScript & Friends
  • Introduction
  • Quickstart
  • Plugins
  • Handbook
  • Quickstart

    Install Stryker using npm.

    stryker-install

    1 Prepare

    Make sure you have npm and nodejs installed. Open a terminal / command prompt and cd to the root of your project you want to mutation test.

    $ cd my-project
    

    2 Install

    The easiest way to get started with Stryker is by installing the stryker-cli globally. It is a small package which forwards commands to your local stryker instance.

    $ npm install -g stryker-cli
    

    Optionally, you could also install stryker directly yourself.

    $ npm install --save-dev @stryker-mutator/core
    

    If you choose to not install the stryker-cli, use npx stryker (after installing @stryker-mutator/core locally) instead of stryker for the rest of the quickstart.


    3 Configure

    Run this command the configure stryker.

    $ stryker init
    

    If you're asked to install stryker, choose Yes. Follow the questionnaire.

    Please let us know if your option is missing here by opening an issue.

    After the init is done, inspect the stryker.conf.js file.

    For more information on what these options mean, take a look at the Stryker readme


    4 Let's kill some mutants

    Run stryker to mutation test your project

    $ stryker run
    

    5 What's next?

    Having troubles? Try enabling debug logging by adding logLevel: 'debug' to your stryker.conf.js. To also see output of your test runner, use logLevel: 'trace'. You can also have a look at the readme file of stryker for more information about the configuration. Please report any issues you have or let us know via gitter.

    Want to help the Stryker community? Awesome! You can help by writing plugins, document issues or simply writing docs. You can always drop us a line on gitter.

    Need help?