Skip to content

Commit 90fae10

Browse files
committed
chore: 更新Makefile以简化文档生成过程并移除冗余脚本
1 parent 001c33c commit 90fae10

File tree

5 files changed

+17
-32
lines changed

5 files changed

+17
-32
lines changed

Makefile

+7-16
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
include scripts/Makefile.docs
2-
31
MODULE := $(shell go list -m)
42
MODULE_NAME := $(lastword $(subst /, ,$(MODULE)))
53
BUILD := $(shell git rev-parse --short HEAD)@$(shell date +%s)
@@ -22,7 +20,8 @@ init: ## Init all dependencies
2220
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
2321
go install github.com/favadi/protoc-go-inject-tag@latest
2422
$(MAKE) install
25-
$(MAKE) generate
23+
$(MAKE) gen-ent
24+
$(MAKE) gen-docs
2625
buf dep update
2726
go mod tidy
2827

@@ -38,19 +37,13 @@ gen-proto: ## Generate proto files and run protoc plugins
3837
buf generate
3938
protoc-go-inject-tag -input="./api/*/*/*.pb.go" -remove_tag_comment
4039

41-
.PHONY: gen-docs
42-
gen-docs: gen-proto ## Generate swagger docs
43-
$(call gen_docs,api,API)
44-
$(call gen_docs,dash,Dash)
45-
46-
.PHONY: gen-ts
47-
gen-ts: gen-docs ## Generate typescript client
48-
$(call gen_ts,api,API)
49-
$(call gen_ts,dash,Dash)
50-
5140
.PHONY: gen-ent
5241
gen-ent: ## Generate ent code
53-
go generate ./internal/pkg/database
42+
go generate ./internal/pkg/database/generate.go
43+
44+
.PHONY: gen-docs
45+
gen-docs: gen-proto ## Generate swagger docs
46+
go generate docs.go
5447

5548
.PHONY: gen-wire
5649
gen-wire: ## Generate wire code
@@ -62,8 +55,6 @@ gen-conf: ## Generate example config
6255

6356
.PHONY: generate
6457
generate: ## Run all generate command
65-
$(MAKE) gen-ent
66-
$(MAKE) gen-docs
6758
go generate ./...
6859

6960
.PHONY: dash

buf.lock

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
version: v2
33
deps:
44
- name: buf.build/bufbuild/protovalidate
5-
commit: 5a7b106cbb87462d9a8c9ffecdbd2e38
6-
digest: b5:0f2dc6c9453e9cc9e9f36807aaa5f94022e837d91fef4dcaeed79a35c0843cc64eba28ff077aab24da3b2cb12639ad256246f9f9a36c033b99d5754b19996b7e
5+
commit: a3320276596649bcad929ac829d451f4
6+
digest: b5:285a6d3a423b195a21f45aacc97ee222ac09cfb01a42f0d546aa51d92177b0b9d00eb9ae93e72dabbbefdc77f35a4c7a11f15d913cc08da764fcb6071f85d148
77
- name: buf.build/googleapis/googleapis
8-
commit: f52d4f76a8434cc5966798b1d3b4f110
9-
digest: b5:5e634ff0ee118aea188b3e9c13ad7d285a192ef6c591bc20ff5a3360438d6ca310cfe9d663b20d60e1daa21789add35b919eac84e8e94a4d576e83a50dd2d62c
8+
commit: e93e34f48be043dab55be31b4b47f458
9+
digest: b5:cebe5dfac5f7d67c55296f37ad9d368dba8d9862777e69d5d99eb1d72dc95fa68cd6323b483ca42cf70e66060002c1bc36e1f5f754b217a5c771c108eb243dbf
1010
- name: buf.build/tbxark/options
1111
commit: e7482b79686642c9ba41312ad0c050fc
1212
digest: b5:1231f70757a8eb4c99955ef4b8feca4e18bcdcbd8ef3967065a1d06852b032c37ce992f4fa8105217a299a0637d7e35e2d0705b768fc5134ba1c332846f8d231

docs.go

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
//go:generate swag init --output ./swagger/api --tags api.v1,shared.v1 --instanceName API -g docs.go --parseDependency
2+
//go:generate swag init --output ./swagger/dash --tags dash.v1,shared.v1 --instanceName Dash -g docs.go --parseDependency
3+
4+
//go:generate npx swagger-typescript-api -p ./swagger/api/API_swagger.json -o ./swagger/api/typescript --modular --responses --extract-response-body --extract-response-error
5+
//go:generate npx swagger-typescript-api -p ./swagger/dash/Dash_swagger.json -o ./swagger/dash/typescript --modular --responses --extract-response-body --extract-response-error
6+
17
package sphere
28

39
import (

go.sum

-5
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,6 @@ github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeN
126126
github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
127127
github.com/google/pprof v0.0.0-20240409012703-83162a5b38cd h1:gbpYu9NMq8jhDVbvlGkMFWCjLFlqqEZjEmObmhUy6Vo=
128128
github.com/google/pprof v0.0.0-20240409012703-83162a5b38cd/go.mod h1:kf6iHlnVGwgKolg33glAes7Yg/8iWP8ukqeldJSO7jw=
129-
github.com/google/subcommands v1.2.0 h1:vWQspBTo2nEqTUFita5/KeEWlUL8kQObDFbub/EN9oE=
130129
github.com/google/subcommands v1.2.0/go.mod h1:ZjhPrFU+Olkh9WazFPsl27BQ4UPiG37m3yTrtFlrHVk=
131130
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
132131
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
@@ -171,8 +170,6 @@ github.com/mailru/easyjson v0.7.7 h1:UGYAvKxe3sBsEDzO8ZeWOSlIQfWFlxbzLZe7hwFURr0
171170
github.com/mailru/easyjson v0.7.7/go.mod h1:xzfreul335JAWq5oZzymOObrkdz5UnU4kGfJJLY9Nlc=
172171
github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
173172
github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
174-
github.com/mattn/go-runewidth v0.0.9 h1:Lm995f3rfxdpd6TSmuVCHVb/QhupuXlYr8sCI/QdE+0=
175-
github.com/mattn/go-runewidth v0.0.9/go.mod h1:H031xJmbD/WCDINGzjvQ9THkh0rPKHF+m2gUSrubnMI=
176173
github.com/mattn/go-sqlite3 v1.14.16 h1:yOQRA0RpS5PFz/oikGwBEqvAWhWg5ufRz4ETLjwpU1Y=
177174
github.com/mattn/go-sqlite3 v1.14.16/go.mod h1:2eHXhiwb8IkHr+BDWZGa96P6+rkvnG63S2DGjv9HUNg=
178175
github.com/meilisearch/meilisearch-go v0.28.0 h1:f3XJ66ZM+R8bANAOLqsjvoq/HhQNpVJPYoNt6QgNzME=
@@ -190,8 +187,6 @@ github.com/modern-go/reflect2 v1.0.2 h1:xBagoLtFs94CBntxluKeaWgTMpvLxC4ur3nMaC9G
190187
github.com/modern-go/reflect2 v1.0.2/go.mod h1:yWuevngMOJpCy52FWWMvUC8ws7m/LJsjYzDa0/r8luk=
191188
github.com/ncruces/go-strftime v0.1.9 h1:bY0MQC28UADQmHmaF5dgpLmImcShSi2kHU9XLdhx/f4=
192189
github.com/ncruces/go-strftime v0.1.9/go.mod h1:Fwc5htZGVVkseilnfgOVb9mKy6w1naJmn9CehxcKcls=
193-
github.com/olekukonko/tablewriter v0.0.5 h1:P2Ga83D34wi1o9J6Wh1mRuqd4mF/x/lgBS7N7AbDhec=
194-
github.com/olekukonko/tablewriter v0.0.5/go.mod h1:hPp6KlRPjbx+hW8ykQs1w3UBbZlj6HuIJcUGPhkA7kY=
195190
github.com/patrickmn/go-cache v2.1.0+incompatible h1:HRMgzkcYKYpi3C8ajMPV8OFXaaRUnok+kx1WdO15EQc=
196191
github.com/patrickmn/go-cache v2.1.0+incompatible/go.mod h1:3Qf8kWWT7OJRJbdiICTKqZju1ZixQ/KpMGzzAfe6+WQ=
197192
github.com/pelletier/go-toml/v2 v2.2.3 h1:YmeHyLY8mFWbdkNWwpr+qIL2bEqT0o95WSdkNHvL12M=

scripts/Makefile.docs

-7
This file was deleted.

0 commit comments

Comments
 (0)