OpenCHAMI / ochami / 39440703493

93%

Build Type

push

github

Committed by web-flow

Commit Message

test: enforce project conventions with linters and source checks (#179)

* build(lint): enable linters that back conventions

Enable linters that enforce conventions the codebase already follows:

- forbidigo: commands use the runtime's streams rather than os.Stdin,
  os.Stdout, or os.Stderr; non-test code doesn't print with fmt.Print*;
  and only cmd/root.go calls os.Exit.
- depguard: pkg/ doesn't import the command tree, internal/cli, or
  internal/configfile, so it stays usable by external consumers without
  CLI state.
- paralleltest: command tests in cmd/ call t.Parallel().
- thelper, usetesting: test helpers call t.Helper() and tests use the
  testing package's own temp-directory, environment, and context helpers.
- nolintlint: every nolint directive names its linter, explains itself,
  and still suppresses something.

Comments in .golangci.yml say what each linter, setting, and exclusion
is for.

nolintlint flagged one directive that no longer suppresses anything, in
pkg/config's example; remove it.

Signed-off-by: Devon Bautista <17506592+synackd@users.noreply.github.com>

* style: end doc comments with periods and fix misspellings

Enable godot, misspell, and dupword, and fix what they report:

- End declaration comments with a period, and turn StringToType's
  one-line list of conversions into a sentence.
- Fix "containg", "posesses", "Subcomands", and a doubled "from".
- Use two different xnames in "smd rfe delete"'s example of deleting
  several endpoints; it deleted the same one twice.

godot checks the entries in import, const, and var blocks too, but a
short label for a group of them (// Subcommands) isn't a sentence, so an
exclusion rule exempts those labels. The endpoint tables in BSS's and
SMD's GetStatus docs and SetNestedField's example become godoc code
blocks, which godot doesn't check.

dupword ignores "y", which tests repeat as answers to confirmation
prompts.

Signed-off-by: Devon Bautista <17506592+synackd@users.noreply.githu... (continued)

Coverage Stats

5 of 5 new or added lines in 3 files covered. (100.0%)

14 existing lines in 2 files now uncovered.

12933 of 13974 relevant lines covered (92.55%)

540.55 hits per line