feat: add import endpoint (#172)

Author: peterdeme

.github/workflows/go.yml renamed to .github/workflows/ci.yml

@@ -16,19 +16,17 @@ jobs:
     strategy:
       max-parallel: 1
       matrix:
-        goVer: [1.16, 1.17]
+        goVer: ["^1.16", "^1.17"]
     steps:
       - name: Set up Go ${{ matrix.goVer }}
-        uses: actions/setup-go@v1
+        uses: actions/setup-go@v2
         with:
           go-version: ${{ matrix.goVer }}
-        id: go
 
-      - name: Check out code into the Go module directory
-        uses: actions/checkout@v2
+      - uses: actions/checkout@v2
 
       - name: Test via ${{ matrix.goVer }}
         env:
-          STREAM_CHAT_API_KEY: ${{ secrets.STREAM_CHAT_API_KEY }}
-          STREAM_CHAT_API_SECRET: ${{ secrets.STREAM_CHAT_API_SECRET }}
+          STREAM_KEY: ${{ secrets.STREAM_CHAT_API_KEY }}
+          STREAM_SECRET: ${{ secrets.STREAM_CHAT_API_SECRET }}
         run: go test -v -race ./...

.github/workflows/lint.yml

@@ -26,6 +26,3 @@ jobs:
 
       - name: Tidy
         run: go mod tidy -v && git diff --no-patch --exit-code || { git status;  echo 'Unchecked diff, did you forget go mod tidy again?' ; false ; };
-
-      - name: Run Lint
-        run: ./run-lint.sh

.github/workflows/reviewdog.yml

@@ -0,0 +1,33 @@
+name: reviewdog
+on:
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref }}
+  cancel-in-progress: true
+
+jobs:
+  reviewdog:
+    name: 🐶 Reviewdog
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: reviewdog/action-setup@v1
+        with:
+          reviewdog_version: latest
+
+      - name: Setup Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: "^1.17.0"
+
+      - name: Install golangci-lint
+        run:
+          curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.44.0
+
+      - name: Reviewdog
+        env:
+          REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run:
+          $(go env GOPATH)/bin/golangci-lint run --out-format line-number | reviewdog -f=golangci-lint -name=golangci-lint -reporter=github-pr-review

.golangci.yml

@@ -36,37 +36,38 @@ run:
   tests: true
 
 linters:
-  disable-all: true
-  enable:
-    - asciicheck
-    - bodyclose
-    - deadcode
-    - dogsled
-    - dupl
-    - errcheck
-    - gci
-    - goconst
-    - gocritic
-    - gocyclo
-    - godot
-    - gofmt
-    - gofumpt
-    - goimports
-    - goprintffuncname
-    - gosec
-    - gosimple
-    - govet
-    - ineffassign
-    - misspell
-    - prealloc
-    - revive
-    - staticcheck
-    - structcheck
-    - unconvert
-    - unparam
-    - unused
-    - varcheck
+  enable-all: true
+  disable:
+   - wrapcheck
+   - varnamelen
+   - thelper
+   - tagliatelle
+   - paralleltest
+   - nlreturn
+   - exhaustivestruct
+   - wsl
+   - goerr113
+   - golint
+   - gochecknoglobals
+   - scopelint
+   - funlen
+   - lll
+   - maligned
+   - gomnd
+   - godox
+   - interfacer
 issues:
-  exclude:
-    - 'G404:' # math/rand usage
-    - "don't use an underscore in package name"
+  exclude-rules:
+    - linters:
+        - stylecheck
+      text: "ST1003:" # should not use underscores in package names
+    - linters:
+        - revive
+      text: "don't use an underscore in package name"
+    - linters:
+      - gocritic
+      text: "commentFormatting"
+    - path: _test\.go
+      linters:
+       - gosec
+       - testpackage # makes you use a separate _test package

CONTRIBUTING.md

@@ -7,20 +7,24 @@ Go best-practices.
 
 ### Required environmental variables
 
-The tests require at least two environment variables: `STREAM_CHAT_API_KEY` and `STREAM_CHAT_API_SECRET`. There are multiple ways to provide that:
-- simply set it in your current shell (`export STREAM_CHAT_API_KEY=xyz`)
+The tests require at least two environment variables: `STREAM_KEY` and `STREAM_SECRET`. There are multiple ways to provide that:
+- simply set it in your current shell (`export STREAM_KEY=xyz`)
 - you could use [direnv](https://direnv.net/)
 - if you debug the tests in VS Code, you can set up an env file there as well: `"go.testEnvFile": "${workspaceFolder}/.env"`.
 
 ### Code formatting & linter
 
-We enforce code formatting with [`gufumpt`](https://github.com/mvdan/gofumpt) (a stricter `gofmt`). If you use VS Code, it's recommended to set this setting there for auto-formatting:
+We enforce code formatting with [`gofumpt`](https://github.com/mvdan/gofumpt) (a stricter `gofmt`). If you use VS Code, it's recommended to set this setting there for auto-formatting:
 
 ```json
 "editor.formatOnSave": true,
 "gopls": {
     "formatting.gofumpt": true
-}
+},
+"go.lintTool": "golangci-lint",
+"go.lintFlags": [
+    "--fast"
+]
 ```
 
 Gofumpt will mostly take care of your linting issues as well.

Makefile

@@ -0,0 +1,8 @@
+GOLANGCI_VERSION = 1.44.0
+GOLANGCI = vendor/golangci-lint/$(GOLANGCI_VERSION)/golangci-lint
+
+install-golangci:
+	test -s $(GOLANGCI) || curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(dir $(GOLANGCI)) v$(GOLANGCI_VERSION)
+
+lint: install-golangci
+	$(GOLANGCI) run

README.md

@@ -43,8 +43,8 @@ import (
 	stream "github.com/GetStream/stream-chat-go/v4"
 )
 
-var APIKey = os.Getenv("STREAM_CHAT_API_KEY")
-var APISecret = os.Getenv("STREAM_CHAT_API_SECRET")
+var APIKey = os.Getenv("STREAM_KEY")
+var APISecret = os.Getenv("STREAM_SECRET")
 var userID = "" // your server user id
 
 func main() {

app.go

@@ -1,4 +1,4 @@
-package stream_chat //nolint: golint
+package stream_chat
 
 import (
 	"context"

app_test.go

@@ -1,4 +1,4 @@
-package stream_chat //nolint: golint
+package stream_chat
 
 import (
 	"context"

async_tasks.go

@@ -1,4 +1,4 @@
-package stream_chat //nolint: golint
+package stream_chat
 
 import (
 	"context"