lint: linter for package docstrings (mmcloughlin#59)

Fixes mmcloughlin#38
portalgun-io · Jan 23, 2019 · 9c913ee · 9c913ee
1 parent f1e854a
commit 9c913ee
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 0 deletions.
diff --git a/script/lib.sh b/script/lib.sh
@@ -0,0 +1,6 @@
+# Print an error message to the terminal.
+print_error() {
+    local red='\033[0;31m'
+    local nocolor='\033[0m'
+    printf "${red}error${nocolor}\t$1\n"
+}
diff --git a/script/lint b/script/lint
@@ -15,3 +15,6 @@ golangci-lint run ./... ./examples/...
 
 # Check asm declarations.
 asmdecl ./...
+
+# Custom linters.
+./script/linter/pkgdoc
diff --git a/script/linter/pkgdoc b/script/linter/pkgdoc
@@ -0,0 +1,12 @@
+#!/bin/bash -e
+
+source script/lib.sh
+
+status=0
+pkgs=$(go list -f '{{if not .Doc}}{{.ImportPath}}{{end}}' ./...)
+for pkg in ${pkgs}; do
+    print_error "${pkg} missing docstring"
+    status=1
+done
+
+exit ${status}
diff --git a/tests/fixedbugs/issue50/doc.go b/tests/fixedbugs/issue50/doc.go
@@ -0,0 +1,2 @@
+// Package issue50 tests for 32-bit MOVD/MOVQ instruction forms.
+package issue50
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// Package issue50 tests for 32-bit MOVD/MOVQ instruction forms.
		package issue50