Merge branch 'make'

Author: nhooyr

.github/CONTRIBUTING.md

@@ -31,25 +31,18 @@ CI will ensure your code is formatted, lints and passes tests.
 It will collect coverage and report it to [codecov](https://codecov.io/gh/nhooyr/websocket)
 and also upload a html `coverage` artifact that you can download to browse coverage.
 
-You can run CI locally. You only need [Go](https://golang.org), [nodejs](https://nodejs.org/en/) and [yarn](https://yarnpkg.com).
+You can run CI locally.
 
-See the scripts in [package.json](../package.json).
-
-1. `yarn fmt` performs code generation and formatting.
-1. `yarn lint` performs linting.
-1. `yarn test` runs tests.
-1. `yarn all` runs the above scripts in parallel.
+See [ci/image/Dockerfile](../ci/image/Dockerfile) for the installation of the CI dependencies on Ubuntu.
 
-For coverage details locally, see `ci/out/coverage.html` after running `yarn test`.
+1. `make fmt` performs code generation and formatting.
+1. `make lint` performs linting.
+1. `make test` runs tests.
+1. `make` runs the above targets.
 
-CI is written with nodejs to enable running as much as possible concurrently.
+For coverage details locally, see `ci/out/coverage.html` after running `make test`.
 
-See [ci/image/Dockerfile](../ci/image/Dockerfile) for the installation of the CI dependencies on Ubuntu.
-
-You can also run tests normally with `go test`. `yarn test` just passes a default set of flags to
+You can also run tests normally with `go test`. `make test` just passes a default set of flags to
 `go test` to collect coverage and runs the WASM tests.
 
-You can pass flags to `yarn test` if you want to run a specific test or otherwise
-control the behaviour of `go test` but also get coverage.
-
 Coverage percentage from codecov and the CI scripts will be different because they are calculated differently.

.github/workflows/ci.yml

@@ -4,22 +4,22 @@ on: [push]
 jobs:
   fmt:
     runs-on: ubuntu-latest
-    container: nhooyr/websocket-ci@sha256:13f9b8cc2f901e98c253595c4070254ece08543f6e100b4fa6682f87de4388eb
+    container: nhooyr/websocket-ci@sha256:54a12b52be98d2d1588a054cfce35d17705c9b45546478d8bcdbac2a89a90001
     steps:
       - uses: actions/checkout@v1
-      - run: yarn --frozen-lockfile && yarn fmt
+      - run: make fmt
   lint:
     runs-on: ubuntu-latest
-    container: nhooyr/websocket-ci@sha256:13f9b8cc2f901e98c253595c4070254ece08543f6e100b4fa6682f87de4388eb
+    container: nhooyr/websocket-ci@sha256:54a12b52be98d2d1588a054cfce35d17705c9b45546478d8bcdbac2a89a90001
     steps:
       - uses: actions/checkout@v1
-      - run: yarn --frozen-lockfile && yarn lint
+      - run: make lint
   test:
     runs-on: ubuntu-latest
-    container: nhooyr/websocket-ci@sha256:13f9b8cc2f901e98c253595c4070254ece08543f6e100b4fa6682f87de4388eb
+    container: nhooyr/websocket-ci@sha256:54a12b52be98d2d1588a054cfce35d17705c9b45546478d8bcdbac2a89a90001
     steps:
       - uses: actions/checkout@v1
-      - run: yarn --frozen-lockfile && yarn test
+      - run: make test
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
       - name: Upload coverage.html

Makefile

@@ -0,0 +1,13 @@
+all: fmt lint test
+
+.SILENT:
+
+.PHONY: *
+
+include ci/fmt.mk
+include ci/lint.mk
+include ci/test.mk
+
+ci-image:
+	docker build -f ./ci/image/Dockerfile -t nhooyr/websocket-ci .
+	docker push nhooyr/websocket-ci

ci/.eslintrc.yaml

@@ -0,0 +1,22 @@
+fmt: modtidy gofmt goimports prettier
+ifdef CI
+	./ci/fmtcheck.sh
+endif
+
+modtidy: gen
+	go mod tidy
+
+gofmt: gen
+	gofmt -w -s .
+
+goimports: gen
+	goimports -w "-local=$$(go list -m)" .
+
+prettier: gen
+	prettier --write --print-width=120 --no-semi --trailing-comma=all --loglevel=warn $$(git ls-files "*.yaml" "*.yml" "*.md" "*.ts")
+
+shfmt: gen
+	shfmt -i 2 -w -s -sr .
+
+gen:
+	go generate ./...

ci/all.ts

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+if [[ $(git ls-files --other --modified --exclude-standard) != "" ]]; then
+  echo "Files need generation or are formatted incorrectly."
+  git status
+  echo "Please run the following locally:"
+  echo "  make fmt"
+  exit 1
+fi

ci/fmt.mk

@@ -1,24 +1,34 @@
 FROM golang:1
 
-RUN curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - && \
-  echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list
-
-RUN curl -sL https://deb.nodesource.com/setup_12.x | bash -
-RUN apt-get install -y nodejs chromium yarn
-
-COPY ./ci/image/gitignore /etc/git/ignore
-RUN git config --system color.ui always
-# Need to set set this explicitly for the system since github uses HOME=/home/github.
-RUN git config --system core.excludesfile /etc/git/ignore
+RUN apt-get update
+RUN apt-get install -y chromium
+RUN apt-get install -y npm
+RUN apt-get install -y shellcheck
 
 ENV GOPATH=/root/gopath
 ENV PATH=$GOPATH/bin:$PATH
 ENV GOFLAGS="-mod=readonly"
 ENV PAGER=cat
 ENV CI=true
+ENV MAKEFLAGS="-j --output-sync target"
 
-# Cache go modules, build cache and yarn cache.
+COPY ./ci/image/gitignore /root/.config/git/ignore
+RUN git config --system color.ui always
+
+RUN npm install -g prettier
+RUN go get golang.org/x/tools/cmd/stringer
+RUN go get golang.org/x/tools/cmd/goimports
+RUN go get mvdan.cc/sh/cmd/shfmt
+RUN go get golang.org/x/lint/golint
+RUN go get github.com/agnivade/wasmbrowsertest
+
+# Cache go modules and build cache.
 COPY . /tmp/websocket
 RUN cd /tmp/websocket && \
-  yarn && CI= yarn ci && \
+  CI= make && \
   rm -rf /tmp/websocket
+
+# GitHub actions tries to override HOME to /github/home and then
+# mounts a temp directory into there. We do not want this behaviour.
+# I assume it is so that $HOME is preserved between steps in a job.
+ENTRYPOINT ["env", "HOME=/root"]