aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorsilverwind <me@silverwind.io>2022-10-16 10:11:17 +0200
committerGitHub <noreply@github.com>2022-10-16 16:11:17 +0800
commit0647df3e831c320436d42a5572a6ec6a9d23d8b1 (patch)
treefde6e41c5e353dc0fe535fa30875f00b4462a42c
parent9fb251fb6fa2bb857bb8f5ae27f06c9d597bc1eb (diff)
downloadgitea-0647df3e831c320436d42a5572a6ec6a9d23d8b1.tar.gz
gitea-0647df3e831c320436d42a5572a6ec6a9d23d8b1.zip
Simplify fmt-check (#21458)
`fmt-check` now simply does `fmt` before and relies on `git diff` like other checks like 'tidy-check' already do, so we can remove the argument in the tool that handles printing changed files. Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: zeripath <art27@cantab.net> Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
-rw-r--r--.golangci.yml4
-rw-r--r--Makefile34
-rw-r--r--build/code-batch-process.go11
-rw-r--r--build/codeformat/formatimports.go7
4 files changed, 21 insertions, 35 deletions
diff --git a/.golangci.yml b/.golangci.yml
index 0e796a2016..99133badd9 100644
--- a/.golangci.yml
+++ b/.golangci.yml
@@ -12,7 +12,6 @@ linters:
- dupl
#- gocyclo # The cyclomatic complexety of a lot of functions is too high, we should refactor those another time.
- gofmt
- - misspell
- gocritic
- bidichk
- ineffassign
@@ -148,9 +147,6 @@ issues:
- path: models/issue_comment_list.go
linters:
- dupl
- - linters:
- - misspell
- text: '`Unknwon` is a misspelling of `Unknown`'
- path: models/update.go
linters:
- unused
diff --git a/Makefile b/Makefile
index a8bb260921..5170436d83 100644
--- a/Makefile
+++ b/Makefile
@@ -130,6 +130,7 @@ TEST_TAGS ?= sqlite sqlite_unlock_notify
TAR_EXCLUDES := .git data indexers queues log node_modules $(EXECUTABLE) $(FOMANTIC_WORK_DIR)/node_modules $(DIST) $(MAKE_EVIDENCE_DIR) $(AIR_TMP_DIR) $(GO_LICENSE_TMP_DIR)
GO_DIRS := cmd tests models modules routers build services tools
+WEB_DIRS := web_src/js web_src/less
GO_SOURCES := $(wildcard *.go)
GO_SOURCES += $(shell find $(GO_DIRS) -type f -name "*.go" -not -path modules/options/bindata.go -not -path modules/public/bindata.go -not -path modules/templates/bindata.go)
@@ -263,11 +264,24 @@ clean:
.PHONY: fmt
fmt:
- @MISSPELL_PACKAGE=$(MISSPELL_PACKAGE) GOFUMPT_PACKAGE=$(GOFUMPT_PACKAGE) $(GO) run build/code-batch-process.go gitea-fmt -w '{file-list}'
+ GOFUMPT_PACKAGE=$(GOFUMPT_PACKAGE) $(GO) run build/code-batch-process.go gitea-fmt -w '{file-list}'
$(eval TEMPLATES := $(shell find templates -type f -name '*.tmpl'))
@# strip whitespace after '{{' and before `}}` unless there is only whitespace before it
@$(SED_INPLACE) -e 's/{{[ ]\{1,\}/{{/g' -e '/^[ ]\{1,\}}}/! s/[ ]\{1,\}}}/}}/g' $(TEMPLATES)
+.PHONY: fmt-check
+fmt-check: fmt
+ @diff=$$(git diff $(GO_SOURCES) templates $(WEB_DIRS)); \
+ if [ -n "$$diff" ]; then \
+ echo "Please run 'make fmt' and commit the result:"; \
+ echo "$${diff}"; \
+ exit 1; \
+ fi
+
+.PHONY: misspell-check
+misspell-check:
+ go run $(MISSPELL_PACKAGE) -error -i unknwon $(GO_DIRS) $(WEB_DIRS)
+
.PHONY: vet
vet:
@echo "Running go vet..."
@@ -311,22 +325,6 @@ errcheck:
@echo "Running errcheck..."
$(GO) run $(ERRCHECK_PACKAGE) $(GO_PACKAGES)
-.PHONY: fmt-check
-fmt-check:
- @# get all go files and run gitea-fmt (with gofmt) on them
- @diff=$$(MISSPELL_PACKAGE=$(MISSPELL_PACKAGE) GOFUMPT_PACKAGE=$(GOFUMPT_PACKAGE) $(GO) run build/code-batch-process.go gitea-fmt -l '{file-list}'); \
- if [ -n "$$diff" ]; then \
- echo "Please run 'make fmt' and commit the result:"; \
- echo "$${diff}"; \
- exit 1; \
- fi
- @diff2=$$(git diff templates); \
- if [ -n "$$diff2" ]; then \
- echo "Please run 'make fmt' and commit the result:"; \
- echo "$${diff2}"; \
- exit 1; \
- fi
-
.PHONY: checks
checks: checks-frontend checks-backend
@@ -334,7 +332,7 @@ checks: checks-frontend checks-backend
checks-frontend: lockfile-check svg-check
.PHONY: checks-backend
-checks-backend: tidy-check swagger-check swagger-validate
+checks-backend: tidy-check swagger-check fmt-check misspell-check swagger-validate
.PHONY: lint
lint: lint-frontend lint-backend
diff --git a/build/code-batch-process.go b/build/code-batch-process.go
index dce5288cf3..b6c4171ede 100644
--- a/build/code-batch-process.go
+++ b/build/code-batch-process.go
@@ -20,7 +20,7 @@ import (
)
// Windows has a limitation for command line arguments, the size can not exceed 32KB.
-// So we have to feed the files to some tools (like gofmt/misspell) batch by batch
+// So we have to feed the files to some tools (like gofmt) batch by batch
// We also introduce a `gitea-fmt` command, it does better import formatting than gofmt/goimports. `gitea-fmt` calls `gofmt` internally.
@@ -195,7 +195,6 @@ Options:
Commands:
%[1]s gofmt ...
- %[1]s misspell ...
Arguments:
{file-list} the file list
@@ -239,9 +238,9 @@ func containsString(a []string, s string) bool {
return false
}
-func giteaFormatGoImports(files []string, hasChangedFiles, doWriteFile bool) error {
+func giteaFormatGoImports(files []string, doWriteFile bool) error {
for _, file := range files {
- if err := codeformat.FormatGoImports(file, hasChangedFiles, doWriteFile); err != nil {
+ if err := codeformat.FormatGoImports(file, doWriteFile); err != nil {
log.Printf("failed to format go imports: %s, err=%v", file, err)
return err
}
@@ -280,10 +279,8 @@ func main() {
if containsString(subArgs, "-d") {
log.Print("the -d option is not supported by gitea-fmt")
}
- cmdErrors = append(cmdErrors, giteaFormatGoImports(files, containsString(subArgs, "-l"), containsString(subArgs, "-w")))
+ cmdErrors = append(cmdErrors, giteaFormatGoImports(files, containsString(subArgs, "-w")))
cmdErrors = append(cmdErrors, passThroughCmd("go", append([]string{"run", os.Getenv("GOFUMPT_PACKAGE"), "-extra", "-lang", getGoVersion()}, substArgs...)))
- case "misspell":
- cmdErrors = append(cmdErrors, passThroughCmd("go", append([]string{"run", os.Getenv("MISSPELL_PACKAGE")}, substArgs...)))
default:
log.Fatalf("unknown cmd: %s %v", subCmd, subArgs)
}
diff --git a/build/codeformat/formatimports.go b/build/codeformat/formatimports.go
index 5d051b2726..1076e3a0d1 100644
--- a/build/codeformat/formatimports.go
+++ b/build/codeformat/formatimports.go
@@ -7,7 +7,6 @@ package codeformat
import (
"bytes"
"errors"
- "fmt"
"io"
"os"
"sort"
@@ -159,7 +158,7 @@ func formatGoImports(contentBytes []byte) ([]byte, error) {
}
// FormatGoImports format the imports by our rules (see unit tests)
-func FormatGoImports(file string, doChangedFiles, doWriteFile bool) error {
+func FormatGoImports(file string, doWriteFile bool) error {
f, err := os.Open(file)
if err != nil {
return err
@@ -183,10 +182,6 @@ func FormatGoImports(file string, doChangedFiles, doWriteFile bool) error {
return nil
}
- if doChangedFiles {
- fmt.Println(file)
- }
-
if doWriteFile {
f, err = os.OpenFile(file, os.O_TRUNC|os.O_WRONLY, 0o644)
if err != nil {