Go Report Card: B grade
flowchartsman opened this issue · comments
Now that you've open-sourced it, consider addressing the issues raised by Go Report Card here: http://goreportcard.com/report/EverythingMe/vertex
This often one of the first things people look at when evaluating a new project, though of course you can take the value of some of its recommendations with as few or many grains of salt as you like :)
On a side note, this looks like a nice, clean little REST framework. I look forward to seeing where it goes 👍
Thanks. Most of the vet errors are false hits, some are addressable indeed.
Depends on what you mean by "false positive", I guess. It looks like this is by design and that this error doesn't look like it's going anywhere any time soon: golang/go#12294. If passing vet is important, it would probably be a matter of changing the directives to have an 'f' on the end. Hope this helps!
The problem is not in the logging package IMHO, it's just naive heuristics in go vet. I've been happily ignoring them for years :)
¯_(ツ)_/¯ Hope the issue is at least a useful place to hang other fixes off, then :)
I was referring only to those specific vet errors. The linter errors were right though, oversights on my part since I mostly do run a linter on my code (but not as a build stage). Vertex was a for-work project, done, as work prjects usually go, in somewhat of a rush to finish.
Anyway, currently I've just opened it so it might get a second life, and not actively using it since the company I developed it for shut down (we did use it in production for a few months and it worked great). I hope it gets some adoption, as it worked great for us, and I'll actually get to fixing those. Right now it feels like tidying up a house that no one ever visits.
That's fair. To give it some more legs, you might also give a brief nod at the top to what distinguishes the project from other RESTFul frameworks (e.g. performance or a little more on what you mean by "friendly"). You don't have to go out of your way or anything, but I ran across this framework while looking for Golang REST frameworks that automatically generate Swagger, and it wasn't until I saw ToSwagger, that I realized you actually did this. IMHO, that's a big win, and a great feature and you should tout it.
You are damn right about the swagger thing, I've added a line to the README, but it deserves a better explanation, that every API has its own swagger URL.