# go

These scripts are for working with Go.

## The individual scripts

<!-- [[[cog

# This adds the root of the repo to the PATH, which has cog_helpers.py
from os.path import abspath, dirname
import sys

sys.path.append(abspath(dirname(dirname("."))))

import cog_helpers

folder_name = "go"

scripts = [
    {
        "usage": "gobench PACKAGE -bench=$BENCHMARK_NAME",
        "description": "compare benchmark results between a local branch and main",
    },
    {
        "usage": "gocover PACKAGE",
        "description": "run tests and report test coverage for the package"
    },
    {
        "usage": "gostress PACKAGE TEST_NAME",
        "description": "run a test with Go’s stress utility",
    },
]

cog_helpers.create_description_table(folder_name=folder_name, scripts=scripts)

]]]-->
<dl>
  <dt>
    <a href="https://github.com/alexwlchan/scripts/blob/main/go/gobench">
      <code>gobench PACKAGE -bench=$BENCHMARK_NAME</code>
    </a>
  </dt>
  <dd>
    compare benchmark results between a local branch and main
  </dd>

  <dt>
    <a href="https://github.com/alexwlchan/scripts/blob/main/go/gocover">
      <code>gocover PACKAGE</code>
    </a>
  </dt>
  <dd>
    run tests and report test coverage for the package
  </dd>

  <dt>
    <a href="https://github.com/alexwlchan/scripts/blob/main/go/gostress">
      <code>gostress PACKAGE TEST_NAME</code>
    </a>
  </dt>
  <dd>
    run a test with Go’s stress utility
  </dd>
</dl>
<!-- [[[end]]] (sum: eCNO30UwC4) -->