diff options
| author |  tobi <31960611+tsmethurst@users.noreply.github.com> | 2021-12-07 13:31:39 +0100 |
|---|---|---|
| committer |  GitHub <noreply@github.com> | 2021-12-07 13:31:39 +0100 |
| commit | 0884f89431cd26bcc9674b3b7ab628b090f5881e (patch) | |
| tree | cdd3b3f77f780a8b59d075dbcc3d4d013811e405 /CONTRIBUTING.md | |
| parent | Update dependencies (#333) (diff) | |
| download | gotosocial-0884f89431cd26bcc9674b3b7ab628b090f5881e.tar.xz | |
Implement Cobra CLI tooling, Viper config tooling (#336)
* start pulling out + replacing urfave and config
* replace many many instances of config
* move more stuff => viper
* properly remove urfave
* move some flags to root command
* add testrig commands to root
* alias config file keys
* start adding cli parsing tests
* reorder viper init
* remove config path alias
* fmt
* change config file keys to non-nested
* we're more or less in business now
* tidy up the common func
* go fmt
* get tests passing again
* add note about the cliparsing tests
* reorganize
* update docs with changes
* structure cmd dir better
* rename + move some files around
* fix dangling comma
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dc03a1eae..0c19dd987 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -181,6 +181,12 @@ Finally, to run tests against both database types one after the other, use: ./scripts/test.sh ``` +### CLI Tests + +In [./test/cliparsing.sh](./test/cliparsing.sh) there are a bunch of tests for making sure that CLI flags, config, and environment variables get parsed as expected. + +Although these tests *are* part of the CI/CD testing process, you probably won't need to worry too much about running them yourself. That is, unless you're messing about with code inside the `main` package in `cmd/gotosocial`, or inside the `config` package in `internal/config`. + ## Project Structure For project structure, GoToSocial follows a standard and widely-accepted project layout [defined here](https://github.com/golang-standards/project-layout). As the author writes: |