Update: add package comment

ifooth · Sep 15, 2023 · a72afd6 · a72afd6
1 parent 2379fa8
commit a72afd6
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 0 deletions.
diff --git a/cmd/dev-init/main.go b/cmd/dev-init/main.go
@@ -1,3 +1,4 @@
+// dev-init is a program ...
 package main
 
 import (

diff --git a/cmd/dev/main.go b/cmd/dev/main.go
@@ -1,3 +1,4 @@
+// dev is a program ...
 package main
 
 import (

diff --git a/pkg/filebrowser/handler.go b/pkg/filebrowser/handler.go
@@ -1,3 +1,4 @@
+// Package filebrowser ...
 package filebrowser
 
 import (

diff --git a/pkg/terminal/handler.go b/pkg/terminal/handler.go
@@ -1,3 +1,4 @@
+// Package terminal ...
 package terminal
 
 //go:generate go run ./gen/main.go

diff --git a/pkg/web/handler.go b/pkg/web/handler.go
@@ -1,3 +1,4 @@
+// Package web ...
 package web
 
 import (

diff --git a/root/.golangci.yml b/root/.golangci.yml
@@ -19,6 +19,7 @@ linters:
     - unused
 
     # custom
+    # - gci
     - goconst
     - gocyclo
     - gofmt
@@ -46,6 +47,11 @@ linters-settings:
     min-complexity: 30
   # goimports:
   #   local-prefixes: github.com/ifooth/devcontainer
+  # gci:
+  #   sections:
+  #     - standard
+  #     - default
+  #     - prefix(github.com/ifooth/devcontainer)
   gosec:
     includes:
       - G201 # SQL query construction using format string
@@ -67,3 +73,6 @@ linters-settings:
         arguments:
           - checkPrivateReceivers
           - sayRepetitiveInsteadOfStutters
+      - name: package-comments
+        severity: warning
+        disabled: false