search

stryker-mutator / stryker-handbook

A comprehensive guide to the stryker ecosystem
Apache License 2.0
71 stars 11 forks source link

Rename PluginKind to PluginType #25

Closed dance-cmdr closed 4 years ago

dance-cmdr commented 4 years ago

Hi there.

First, I want to thank you for the amazing work you've done.

I'm making a stryker-json-reporter in order to dump the report in a json file and then consume it from another app for historical purposes.

Reading about plugins I came across the term PluginKind. This is probably a neat but, would you be alright if I rename all of it's singular and plural occurrences to PluginType instead?

https://github.com/stryker-mutator/stryker-handbook/blob/master/stryker/api/plugins.md

Cheers

nicojs commented 4 years ago

Hi @dance-cmdr. Your help would be much appreciated, but we like PluginKind more than PluginType. In general, everything in TypeScript is a type, so I try to avoid the type postfix whenever possible.

It would be awesome if the json reporter could be generic for more people to use. If you want, you can add it to our standard reporters: https://github.com/stryker-mutator/stryker/tree/master/packages/core/src/reporters

If you're interested in adding this, we would be grateful 💗! The JSON format should be in sync with mutation-testing-report-schema, which is exactly what is delivered in the onMutationTestReportReady event. So it should be straightforward to add.

dance-cmdr commented 4 years ago

Fair enough about the kind!

Yes, the json reporter will simply drop a json file in ./reports/mutation/json/*.json and then you do whatever you want with it. We will just copy it somewhere else and consume it from there, s,o that is not the concern of stryker or the reporter.

Thanks for the tips btw.

dance-cmdr commented 4 years ago

I'm going to close the issue as it is not relevant anymore.

nicojs commented 4 years ago

Thanks! Let's discus in #1814 :+1: