Repository Stutter

Question

Repository Stutter

GrimTheReaper opened this issue 5 years ago · 8 comments

I've noticed that all of the client library repositories start with fusionauth. In languages like go, this leads to package stuttering (fusionauth/fusionauth-go-client). Any reason why it shouldn't just be {language}-client?

Answer 1 · 2019-12-02T20:29:06.000Z

@GrimTheReaper this is just our pattern thus far.

@matthew-altman Any potential issues you see with a change such as this?

Answer 2 · 2019-12-02T20:31:36.000Z

@robotdan It's a matter of renaming every client repo. Not hard, but there would be a lot of downstream repo changes as well...maven, npm, etc

Answer 3 · 2019-12-02T20:39:02.000Z

@matthew-altman what about just for Go, is the package stuttering an issue with Go?

Answer 4 · 2019-12-02T20:40:09.000Z

@robotdan No problem changing it for Go. It's not an issue, per se, but isn't idiomatic. I'll see what I can do.

Answer 5 · 2019-12-02T22:01:14.000Z

This has been resolved. Github automatically creates redirects for renamed repos, so existing usages should still be fine.
The README in the go-client repo has an updated example that shows it cleaned up as well.

Answer 6 · 2019-12-03T00:45:33.000Z

@matthew-altman just in case... make sure you also update the Go doc page.
https://fusionauth.io/docs/v1/tech/client-libraries/go

Answer 7 · 2019-12-03T14:08:39.000Z

Neat. The only other weird oddity for the Go package is that everything is under pkg. Usually, if a repo is just a library and not an application, the resources are under root. A good(ish) example can be found here, although I wouldn't say that it is important enough to break existing changes.

Also while I was glancing about, I noticed that the README example has invalid go syntax, so I fixed that for you FusionAuth/go-client#10

Answer 8 · 2019-12-03T19:13:59.000Z

Thanks @GrimTheReaper the help is appreciated!

@matthew-altman can you take a look at these issues, perhaps open another issue to track.