Skip to content

Commit 4b0694d

Browse files
authored
Update README.md
Added few more mods that are using mineunit. Removed Mapblock_lib as it does not use mineunit anymore. Added note about --coverage and --report arguments.
1 parent 7bf5aa2 commit 4b0694d

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

README.md

+22-2
Original file line numberDiff line numberDiff line change
@@ -238,6 +238,24 @@ For example core_root in project configuration will override core_root in user c
238238
Command line arguments will override all configuration file entries except for luacov excludes which will be merged.
239239
Table values (other than luacov excludes) are only supported in project configuration file.
240240

241+
### Using `--coverage` and `--report` cli args
242+
243+
Using `--coverage` and `--report` together wont work, with `--report` cli argument mineunit
244+
wont run any tests but just instructs luacv to format coverage data producing human readable
245+
test coverage report called `luacov.report.out`. File is placed in current working directory.
246+
247+
So basically to get code coverage report you have to run `mineunit` twice, example follows:
248+
249+
```
250+
$ mineunit --coverage
251+
$ mineunit --report
252+
```
253+
254+
First command executes tests, collects test coverage information and produces coverage data file.
255+
Second command does not execute tests but reads coverage data file and formats it with source
256+
code to produce human readable test coverage report file called `luacov.report.out`. Use any
257+
text editor to read this file.
258+
241259
### Known projects using mineunit
242260

243261
See following projects for more examples on how to use mineunit and what you can do with it
@@ -255,7 +273,9 @@ See following projects for more examples on how to use mineunit and what you can
255273
* GitHub workflow https://github.com/S-S-X/metatool/blob/master/.github/workflows/mineunit.yml
256274

257275
#### Other mods
258-
* QoS https://github.com/S-S-X/qos/tree/master/spec
276+
* QoS (basic unit testing and chat commands) https://github.com/S-S-X/qos/tree/master/spec
259277
* Machine_parts https://github.com/mt-mods/machine_parts/tree/master/spec
260278
* Beerchat (chat commands and message delivery) https://github.com/minetest-beerchat/beerchat/tree/master/spec
261-
* Mapblock_lib https://github.com/BuckarooBanzay/mapblock_lib/tree/master/spec
279+
* Geoip (HTTP API) https://github.com/mt-mods/geoip/tree/master/spec
280+
* Digistuff (very simple, only load mod) https://github.com/mt-mods/digistuff/tree/master/spec
281+
* spectator_mode (player API and chat) https://github.com/minetest-mods/spectator_mode/tree/master/spec

0 commit comments

Comments
 (0)