search

dakrone / lein-bikeshed

A Leiningen plugin designed to tell you your code is bad, and that you should feel bad
176 stars 23 forks source link

Custom hooks to allow issue reporting somewhere else than stdout ? #37

Open voytech opened 6 years ago

voytech commented 6 years ago

I think it would be great to allow emiting of issues found by bikeshed using some listener passed to bikeshed func. Actually I would require it to create some custom reporting possibility out of bikeshed. Would You accept such PR ? or maybe this is something which is totally not in line with Your primary idea ?

dakrone commented 6 years ago

@voytech I think that sounds reasonable, I understand it might be useful to be able to apply bikeshed and return just the failures so you can do whatever reporting you want with it. I'd definitely take a PR

voytech commented 6 years ago

@dakrone I have created PR for this. My only concern is that the bikeshed function return type has changed. So I do not know - maybe we should worry about compability. It now returns {:failures '(list of failed check functions), :details {here goes record containing all reporting details to be used by 3rd party apps}}. Please let me know If You want to change this approach or if it is ok? Another approach would be to pass e.g. additional optional arg to the function arglist. Such function would be e.g. called each time error is found.