golang_layout

golang_layout.sh.md

#!/bin/bash

module_dir=$HOME/dev/mymodule

echo
echo module_dir=$module_dir

die() {
    echo >&2 $(basename $0): $*
    exit 1
}

cd $module_dir 2>/dev/null || die "please create the dir module_dir=$module_dir"

#
# Don't confuse modules with packages.
# One module might hold many packages.
# Like this:
# module_dir/package1_dir
# module_dir/package2_dir
#

go mod init github.com/me/mymodule

mkdir -p mypkg || die "could not create dir: mypkg"

cat > mypkg/mypkg.go <<EOF
package mypkg

// Add is our function that sums two integers
func Add(x, y int) (res int) {
    return x + y
}

// Subtract subtracts two integers
func Subtract(x, y int) (res int) {
    return x - y
}
EOF

#
# Put executable at 'cmd/program'
#

cat > mypkg/mypkg_test.go <<EOF
package mypkg

import "testing"

func TestAdd(t *testing.T){

    got := Add(4, 6)
    want := 10

    if got != want {
        t.Errorf("got %q, wanted %q", got, want)
    }
}
EOF

echo
echo layout created:

find $module_dir

echo
echo running tests: go test -v ./...

go test -v ./...