Skip to content

Commit

Permalink
chore: bump to v0.1.3
Browse files Browse the repository at this point in the history
  • Loading branch information
lbtoma committed Oct 26, 2021
1 parent f5ceaa5 commit 6fbd516
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 4 deletions.
32 changes: 29 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ Future work:
- [ ] Add mutation testing;
- [ ] Configure CI/CD;
- [ ] Options to set branches and commits to be compared;
- [ ] Make it work in a simple Typescript project;
- [ ] Make it work in a complex Typescript + React project;
- [ ] Make it work in Windows 😬;
- [x] Make it work on a simple Typescript project;
- [ ] Make it work on a complex Typescript + React project;
- [ ] Make it work on Windows 😬;

🚧 `Please note`: This is quite experimental yet, things can not work as expected.

Expand Down Expand Up @@ -60,4 +60,30 @@ module.exports = {
};
```

Using Typescript:

```js
/**
* Example of `stryker.conf.js` file.
*
* @type {import('@stryker-mutator/api/core').StrykerOptions}
*/
module.exports = {
packageManager: "yarn",
reporters: ["html", "clear-text", "progress"],
testRunner: "jest",
coverageAnalysis: "perTest",
// Add `git-checker` to the `checkers` list.
checkers: ["typescript", "git-checker"],
tsconfigFile: "tsconfig.json",
mutate: ["src/**/*.ts"],
// Add all plugins being used including the `stryker-git-checker`.
plugins: [
"@stryker-mutator/jest-runner",
"@stryker-mutator/typescript-checker",
"stryker-git-checker",
],
};
```

`Note`: remember that when you use custom plugins you need to explicitly add all plugins in the plugins list.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "stryker-git-checker",
"version": "0.1.2",
"version": "0.1.3",
"description": "Git Checker for Stryker Mutator Javascript testing framework",
"main": "dist/index.js",
"typings": "dist/index.d.ts",
Expand Down

0 comments on commit 6fbd516

Please sign in to comment.