Merge pull request #158 from nhooyr/ts

Switch CI to Typescript

Author: nhooyr

.github/CONTRIBUTING.md

@@ -27,25 +27,29 @@ CI must pass on your changes for them to be merged.
 
 ### CI
 
-CI will ensure your code is formatted correctly, passes linting and tests.
+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 `coverage` artifact that you can download to inspect browse coverage.
+and also upload a html `coverage` artifact that you can download to browse coverage.
 
-You can run CI locally. The various steps are located in [ci/\*.sh](../ci).
+You can run CI locally. You only need [Go](https://golang.org), [nodejs](https://nodejs.org/en/) and [yarn](https://yarnpkg.com).
 
-1. [fmt.sh](../ci/fmt.sh) which requires node (specifically prettier).
-1. [lint.sh](../ci/lint.sh) which requires [shellcheck](https://github.com/koalaman/shellcheck#installing).
-1. [test.sh](../ci/test.sh)
-1. [run.sh](../ci/run.sh) which runs the above scripts in order.
+See the scripts in [package.json](../package.json).
 
-For coverage details locally, see `ci/out/coverage.html` after running [test.sh](../ci/test.sh).
+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.
+
+For coverage details locally, see `ci/out/coverage.html` after running `yarn test`.
+
+CI is written with nodejs to enable running as much as possible concurrently.
 
 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`. [test.sh](../ci/test.sh) just passes a default set of flags to
-`go test` to collect coverage and also prettify the output.
+You can also run tests normally with `go test`. `yarn test` just passes a default set of flags to
+`go test` to collect coverage and runs the WASM tests.
 
-You can pass flags to [test.sh](../ci/test.sh) if you want to run a specific test or otherwise
+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,32 +4,26 @@ on: [push]
 jobs:
   fmt:
     runs-on: ubuntu-latest
-    container: docker://nhooyr/websocket-ci@sha256:b6331f8f64803c8b1bbd2a0ee9e2547317e0de2348bccd9c8dbcc1d88ff5747f
+    container: nhooyr/websocket-ci@sha256:f8b6e53a9fd256bcf6c90029276385b9ec730b76a0d7ccf3ff19084bce210c50
     steps:
       - uses: actions/checkout@v1
-      - run: ./ci/fmt.sh
+      - run: yarn --frozen-lockfile && yarn fmt
   lint:
     runs-on: ubuntu-latest
-    container: docker://nhooyr/websocket-ci@sha256:b6331f8f64803c8b1bbd2a0ee9e2547317e0de2348bccd9c8dbcc1d88ff5747f
+    container: nhooyr/websocket-ci@sha256:f8b6e53a9fd256bcf6c90029276385b9ec730b76a0d7ccf3ff19084bce210c50
     steps:
       - uses: actions/checkout@v1
-      - run: ./ci/lint.sh
+      - run: yarn --frozen-lockfile && yarn lint
   test:
     runs-on: ubuntu-latest
-    container: docker://nhooyr/websocket-ci@sha256:b6331f8f64803c8b1bbd2a0ee9e2547317e0de2348bccd9c8dbcc1d88ff5747f
+    container: nhooyr/websocket-ci@sha256:f8b6e53a9fd256bcf6c90029276385b9ec730b76a0d7ccf3ff19084bce210c50
     steps:
       - uses: actions/checkout@v1
-      - run: ./ci/test.sh
+      - run: yarn --frozen-lockfile && yarn test
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
       - name: Upload coverage.html
         uses: actions/upload-artifact@master
         with:
           name: coverage
           path: ci/out/coverage.html
-  wasm:
-    runs-on: ubuntu-latest
-    container: docker://nhooyr/websocket-ci@sha256:b6331f8f64803c8b1bbd2a0ee9e2547317e0de2348bccd9c8dbcc1d88ff5747f
-    steps:
-      - uses: actions/checkout@v1
-      - run: ./ci/wasm.sh

ci/.eslintrc.yaml

@@ -0,0 +1,23 @@
+parser: "@typescript-eslint/parser"
+env:
+  node: true
+
+parserOptions:
+  ecmaVersion: 2018
+  sourceType: module
+
+extends:
+  # https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin#usage
+  - eslint:recommended
+  - plugin:@typescript-eslint/eslint-recommended
+  - plugin:@typescript-eslint/recommended
+  # https://www.npmjs.com/package/eslint-plugin-import#typescript
+  - plugin:import/recommended
+  - plugin:import/typescript
+  #  https://dev.to/robertcoopercode/using-eslint-and-prettier-in-a-typescript-project-53jb
+  - prettier/@typescript-eslint
+
+rules:
+  "@typescript-eslint/no-use-before-define": off
+  "@typescript-eslint/explicit-function-return-type": off
+  "@typescript-eslint/no-non-null-assertion": off

ci/.gitignore

@@ -0,0 +1,18 @@
+#!/usr/bin/env -S npx ts-node -P ci/tsconfig.json
+
+import { fmt, gen } from "./fmt"
+import { main } from "./lib"
+import { lint } from "./lint"
+import { test } from "./test"
+
+main(run)
+
+async function run(ctx: Promise<unknown>) {
+  await gen(ctx)
+
+  await Promise.all([
+    fmt(ctx),
+    lint(ctx),
+    test(ctx),
+  ])
+}

ci/all.ts

@@ -0,0 +1,37 @@
+#!/usr/bin/env -S npx ts-node -P ci/tsconfig.json
+
+import { exec, main } from "./lib"
+
+if (require.main === module) {
+  main(async (ctx: Promise<unknown>) => {
+    await gen(ctx)
+    await fmt(ctx)
+  })
+}
+
+export async function fmt(ctx: Promise<unknown>) {
+  await Promise.all([
+      exec(ctx, "go mod tidy"),
+      exec(ctx, "gofmt -w -s ."),
+      exec(ctx, `go run go.coder.com/go-tools/cmd/goimports -w "-local=$(go list -m)" .`),
+      exec(ctx, `npx prettier --write --print-width=120 --no-semi --trailing-comma=all --loglevel=silent $(git ls-files "*.yaml" "*.yml" "*.md")`),
+    ],
+  )
+
+  if (process.env.CI) {
+    const r = await exec(ctx, "git ls-files --other --modified --exclude-standard")
+    const files = r.stdout.toString().trim()
+    if (files.length) {
+      console.log(`files need generation or are formatted incorrectly:
+${files}
+
+please run:
+  ./ci/fmt.js`)
+      process.exit(1)
+    }
+  }
+}
+
+export async function gen(ctx: Promise<unknown>) {
+  await exec(ctx, "go generate ./...")
+}

ci/fmt.sh

@@ -1,24 +1,24 @@
 FROM golang:1
 
-ENV DEBIAN_FRONTEND=noninteractive
+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
+
 ENV GOPATH=/root/gopath
 ENV PATH=$GOPATH/bin:$PATH
 ENV GOFLAGS="-mod=readonly"
 ENV PAGER=cat
 ENV CI=true
 
-RUN apt-get update && \
-  apt-get install -y shellcheck npm chromium && \
-  npm install -g prettier
-
-# https://github.com/golang/go/wiki/WebAssembly#running-tests-in-the-browser
-RUN go get github.com/agnivade/wasmbrowsertest && \
-  mv $GOPATH/bin/wasmbrowsertest $GOPATH/bin/go_js_wasm_exec
-
-RUN git config --global color.ui always
-
-# Cache go modules and build cache.
+# Cache go modules, build cache and yarn cache.
 COPY . /tmp/websocket
 RUN cd /tmp/websocket && \
-  CI= ./ci/run.sh && \
+  yarn && CI= yarn ci && \
   rm -rf /tmp/websocket

ci/fmt.ts

@@ -0,0 +1 @@
+node_modules

ci/image/Dockerfile

@@ -0,0 +1,5 @@
+node_modules
+.DS_Store
+.idea
+.gitignore
+.dockerignore