https://github.com/raphaelkieling/jest-mutator

https://github.com/raphaelkieling/jest-mutator

Last synced: 2 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/raphaelkieling/jest-mutator
• Owner: raphaelkieling
• License: mit
• Created: 2023-10-07T18:45:39.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-10T02:47:36.000Z (about 1 year ago)
• Last Synced: 2023-10-11T00:17:40.706Z (about 1 year ago)
• Language: TypeScript
• Size: 79.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## Jest Mutator

> Project inspired on [Stryker Mutator](https://stryker-mutator.io/) but more focused and simpler for easy adoption.

It mutates in a simple way to try to catch simple bugs inside the statements. It should be used inside the `describe` block to mutate all the possible scenarios within the scope of this describe.

Why? To democratize mutation tests. Today, you need to run some mutators for hours and also allocate some time to understand and integrate them into your pipeline. Here, it's easy. Just use .mutate and gain all the advantages.

Design idea:

- be able to use a simple `.mutate` with all the reference function to mutate using the typescript's AST

- integrate Jest coverage report

- generate simple report to check the remaining mutates that werent covered or killed

```ts

describe.mutate([sum])("my sum func", () => {

  it("should return x", () => {

    const result = sum(1, 1);

    expect(result).toBe(2);

  });

});

```

### Roadmap:

Based on the current supported mutators: https://stryker-mutator.io/docs/mutation-testing-elements/supported-mutators/#arithmetic-operator

MVP scope:

- Arithmetic Operator

- Equality Operator

- Conditional Expression

- Jest plugin to extends

- Performance checking

- Files with `extends`, `default`, `imports` and `classes`

Scope:

- Arithmetic Operator

- Array Declaration

- Assignment Expression

- Boolean Literal

- Conditional Expression

- Equality Operator

- Logical Operator

- Optional chaining

- Object literal

- Static mutants, only for current fn, ignore global ones