Skip to content

Commit 3953f84

Browse files
docs: update multi-module project instructions
1 parent b1a4a50 commit 3953f84

2 files changed

Lines changed: 7 additions & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ After adding the plugin, Stryker4s can be used by running `sbt stryker` in the r
3232

3333
### Multi-module projects
3434

35-
Multi-module projects are not yet fully supported. However, there is a workaround you can use while we work on a better solution. Set the base-directory to the correct directory of the submodule with the [`base-dir` configuration setting](https://stryker-mutator.io/docs/stryker4s/configuration/#base-dir-string). Then you can run `sbt "project yourSubmoduleNameHere" stryker` to set the active project and run Stryker4s.
35+
Multi-module projects are fully supported. Run Stryker on the desired module by running `sbt <module-name>/stryker`.
3636

3737
## Maven plugin
3838

docs/getting-started.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@ Run Stryker4s to mutation test your project:
2828
sbt stryker
2929
```
3030

31+
Or on multi-module projects:
32+
33+
```shell
34+
sbt <module-name>/stryker
35+
```
36+
3137
## 4 Having trouble?
3238

3339
Are you having troubles? Try enabling debug logging. For more information on how to enable debug logging visit our [configuration page](./configuration.md#log-level-string).

0 commit comments

Comments
 (0)