go packages which are fine
Go to file
2019-05-18 12:50:04 -06:00
cmd/totp-proxy m: rename Start to StartWaitStop, Start is a different function which only populates config and runs start hooks 2019-02-24 17:23:38 -05:00
jstream mtest->mrand: move rand functionality from mtest into its own package 2018-07-03 00:20:00 +00:00
m m: have log level depend on the kind of Context is being used (process or service) 2019-04-06 16:30:55 -04:00
mcfg mcfg: update docs 2019-05-18 12:50:04 -06:00
mcrypto merr: refactor Wrap/WrapSkip/New to take multiple contexts rather than annotations 2019-02-27 13:05:51 -05:00
mctx mctx: add Annotated and polish documentation 2019-05-18 12:15:35 -06:00
mdb mtest/massert: rename a bunch of functions 2019-03-10 19:23:37 -04:00
merr mtest/massert: rename a bunch of functions 2019-03-10 19:23:37 -04:00
mhttp mtest/massert: rename a bunch of functions 2019-03-10 19:23:37 -04:00
mlog mtest/massert: rename a bunch of functions 2019-03-10 19:23:37 -04:00
mnet mtest/massert: rename a bunch of functions 2019-03-10 19:23:37 -04:00
mrand mrand: fix bug in Hex with it not outputting correct number of characters for odd number inputs 2018-08-13 19:40:15 -04:00
mrpc mtest->mrand: move rand functionality from mtest into its own package 2018-07-03 00:20:00 +00:00
mrun mrun: update docs 2019-05-18 12:36:53 -06:00
mtest mcfg: implement WithCLISubCommand 2019-04-04 16:25:02 -04:00
mtime mtime: fix older package doc not having been deleted 2018-05-27 07:57:23 +00:00
env.test mtest/massert: rename a bunch of functions 2019-03-10 19:23:37 -04:00
go.mod mdb/msql: implement basic MySQL connector 2019-02-24 16:30:53 -05:00
go.sum mdb/msql: implement basic MySQL connector 2019-02-24 16:30:53 -05:00
LICENSE Initial commit 2018-01-11 15:47:01 +00:00
README.md refactor everything to use context's annotation system, making some significant changes to annotations themselves along the way 2019-02-24 15:36:07 -05:00
TODO refactor everything to use context's annotation system, making some significant changes to annotations themselves along the way 2019-02-24 15:36:07 -05:00

mediocre-go-lib

This is a collection of packages which I use across many of my personal projects. All packages intended to be used start with an m, packages not starting with m are for internal use within this set of packages.

Usage notes

  • In general, all checking of equality of errors, e.g. err == io.EOF, done on errors returned from the packages in this project should be done using merr.Equal, e.g. merr.Equal(err, io.EOF). The merr package is used to wrap errors and embed further metadata in them, like stack traces and so forth.

Styleguide

Here are general guidelines I use when making decisions about how code in this repo should be written. Most of the guidelines I have come up with myself have to do with package design, since packages are the only thing which have any rigidity and therefore need any rigid rules.

Everything here are guidelines, not actual rules.

  • gofmt -s

  • https://golang.org/doc/effective_go.html

  • https://github.com/golang/go/wiki/CodeReviewComments

  • Package names may be abbreviations of a concept, but types, functions, and methods should all be full words.

  • When deciding if a package should initialize a struct as a value or pointer, a good rule is: If it's used as an immutable value it should be a value, otherwise it's a pointer. Even if the immutable value implementation has internal caching, locks, etc..., that can be hidden as pointers inside the struct, but the struct itself can remain a value type.

  • A function which takes in a context.Context and returns a modified copy of that same context.Context should have a name prefixed with With, e.g. WithValue or WithLogger. Exceptions like Annotate do exist.