New API (#54)

Author: pellared

.github/workflows/build.yml

@@ -30,7 +30,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        go-version: [ '1.18' ]
+        go-version:
+          - '1.18'
+          - '1.19'
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

.golangci.yml

@@ -1,8 +1,8 @@
 linters-settings:
+  gocyclo:
+    min-complexity: 15
   goimports:
     local-prefixes: github.com/pellared/fluentassert
-  golint:
-    min-confidence: 0
   govet:
     check-shadowing: true
   misspell:
@@ -12,43 +12,38 @@ linters-settings:
     allow-unused: false # report any unused nolint directives
     require-explanation: true # require an explanation for nolint directives
     require-specific: false # don't require nolint directives to be specific about which linter is being skipped
+  revive:
+    confidence: 0
 
 linters:
   # please, do not use `enable-all`: it's deprecated and will be removed soon.
   # inverted configuration with `enable-all` and `disable` is not scalable during updates of golangci-lint
   disable-all: true
   enable:
-    - deadcode
+    - dogsled
     - errcheck
-    # - gosimple
-    - govet
-    - ineffassign
-    # - staticcheck
-    # - structcheck
-    - typecheck
-    # - unused
-    - varcheck
-    - depguard
-    - dupl
     - exportloopref
-    - funlen
-    - gci
-    - gocognit
-    - goconst
+    - gochecknoinits
     - gocritic
+    - goconst
     - gocyclo
-    - godot
     - gofumpt
+    - goimports
     - revive
     - gomnd
     - goprintffuncname
     - gosec
-    - ifshort
+    - gosimple
+    - govet
+    - ineffassign
+    - misspell
     - nolintlint
-    # - stylecheck
-    - thelper
+    - staticcheck
+    - stylecheck
+    - typecheck
     - unconvert
-    # - unparam
+    - unparam
+    - unused
     - whitespace
 
 issues:

.markdownlint.yaml

@@ -0,0 +1,14 @@
+# Default state for all rules
+default: true
+
+# hard-tabs
+MD010: false
+
+# 80 char line-length
+MD013:
+  code_blocks: false
+  tables: false
+
+# no-duplicate-header
+MD024:
+  siblings_only: true

.vscode/settings.json

@@ -1,9 +1,4 @@
 {
-    // gopls with gofumpt and import ordering
-    "go.useLanguageServer": true,
-    "gopls": {
-        "gofumpt": true,
-    },
     "[go]": {
         "editor.formatOnSave": true,
         "editor.codeActionsOnSave": {
@@ -16,10 +11,12 @@
             "source.organizeImports": true,
         },
     },
-
-    // golangci-lint  
+    "gopls": {
+        "formatting.local": "github.com/pellared/fluentassert",
+        "formatting.gofumpt": true,
+    },
     "go.lintTool": "golangci-lint",
     "go.lintFlags": [
         "--fast"
-    ]
+    ],
 }

CODE_OF_CONDUCT.md

@@ -67,10 +67,10 @@ members of the project's leadership.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>.
 
 [homepage]: https://www.contributor-covenant.org
 
 For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq
+<https://www.contributor-covenant.org/faq>.

build/build.go

@@ -1,6 +1,9 @@
 package main
 
 import (
+	"fmt"
+	"os"
+
 	"github.com/goyek/goyek"
 	"github.com/mattn/go-shellwords"
 )
@@ -16,9 +19,10 @@ func flow() *goyek.Flow {
 
 	test := flow.Register(taskTest())
 	lint := flow.Register(taskLint())
+	markdownlint := flow.Register(taskMarkdownLint())
 	misspell := flow.Register(taskMisspell())
 	all := flow.Register(taskAll(goyek.Deps{
-		test, lint, misspell,
+		test, lint, markdownlint, misspell,
 	}))
 
 	flow.DefaultTask = all
@@ -46,6 +50,24 @@ func taskLint() goyek.Task {
 	}
 }
 
+func taskMarkdownLint() goyek.Task {
+	return goyek.Task{
+		Name:  "markdownlint",
+		Usage: "markdownlint-cli (requires docker)",
+		Action: func(tf *goyek.TF) {
+			curDir, err := os.Getwd()
+			if err != nil {
+				tf.Fatal(err)
+			}
+			dockerTag := "markdownlint-cli"
+			buildCmd := fmt.Sprintf("docker build -t %s -f build/markdownlint-cli.dockerfile .", dockerTag)
+			Exec(tf, "", buildCmd)
+			runCmd := fmt.Sprintf("docker run --rm -v %s:/workdir %s *.md", curDir, dockerTag)
+			Exec(tf, "", runCmd)
+		},
+	}
+}
+
 func taskMisspell() goyek.Task {
 	return goyek.Task{
 		Name:  "misspell",

build/markdownlint-cli.dockerfile

@@ -0,0 +1 @@
+FROM ghcr.io/igorshubovych/markdownlint-cli:v0.32.2

f/assert.go

@@ -0,0 +1,2 @@
+// Package f contains convenience assertion functions.
+package f