-
Notifications
You must be signed in to change notification settings - Fork 5
/
Makefile
124 lines (102 loc) · 3.62 KB
/
Makefile
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
SHELL = /usr/bin/env bash -o nounset -o pipefail -o errexit -c
ifneq ("$(wildcard .env)","")
include .env
export
endif
APP_NAME = fibr
PACKAGES ?= ./...
MAIN_SOURCE = ./cmd/fibr
MAIN_RUNNER = go run $(MAIN_SOURCE)
ifeq ($(DEBUG), true)
MAIN_RUNNER = dlv debug $(MAIN_SOURCE) --
endif
.DEFAULT_GOAL := app
## help: Display list of commands
.PHONY: help
help: Makefile
@sed -n 's|^##||p' $< | column -t -s ':' | sort
## name: Output app name
.PHONY: name
name:
@printf "$(APP_NAME)"
## version: Output last commit sha in short version
.PHONY: version
version:
@printf "$(shell git rev-parse --short HEAD)"
## version-full: Output last commit sha
.PHONY: version-full
version-full:
@printf "$(shell git rev-parse HEAD)"
## version-date: Output last commit date
.PHONY: version-date
version-date:
@printf "$(shell git log -n 1 "--date=format:%Y%m%d%H%M" "--pretty=format:%cd")"
## dev: Build app
.PHONY: dev
dev: format style test build build-web
## app: Build whole app
.PHONY: app
app: init dev
## init: Bootstrap your application. e.g. fetch some data files, make some API calls, request user input etc...
.PHONY: init
init:
@curl --disable --silent --show-error --location --max-time 30 "https://raw.githubusercontent.com/ViBiOh/scripts/main/bootstrap.sh" | bash -s -- "-c" "git_hooks" "coverage.sh"
go install "github.com/golangci/golangci-lint/cmd/golangci-lint@latest"
go install "github.com/tdewolff/minify/v2/cmd/minify@latest"
go install "github.com/ViBiOh/auth/v2/cmd/argon@latest"
go install "golang.org/x/tools/cmd/goimports@latest"
go install "golang.org/x/tools/go/analysis/passes/fieldalignment/cmd/fieldalignment@master"
go install "mvdan.cc/gofumpt@latest"
go mod tidy
## format: Format code. e.g Prettier (js), format (golang)
.PHONY: format
format:
find . -name "*.go" -exec goimports -w {} \+
find . -name "*.go" -exec gofumpt -w {} \+
## style: Check lint, code styling rules. e.g. pylint, phpcs, eslint, style (java) etc ...
.PHONY: style
style:
fieldalignment -fix -test=false $(PACKAGES)
golangci-lint run --fix
## mocks: Generate mocks
.PHONY: mocks
mocks:
go install "go.uber.org/mock/mockgen@latest"
find . -name "mocks" -type d -exec rm -r "{}" \+
go generate -run mockgen $(PACKAGES)
fieldalignment -fix -test=false $(PACKAGES) || true
## test: Shortcut to launch all the test tasks (unit, functional and integration).
.PHONY: test
test:
scripts/coverage.sh
$(MAKE) bench
## bench: Shortcut to launch benchmark tests.
.PHONY: bench
bench:
go test $(PACKAGES) -bench . -benchmem -run Benchmark.*
## build: Build the application.
.PHONY: build
build:
CGO_ENABLED=0 go build -ldflags="-s -w" -installsuffix nocgo -o bin/$(APP_NAME) $(MAIN_SOURCE)
## build: Build the application.
.PHONY: build-web
build-web:
rm -f "cmd/fibr/static/scripts/index.min.js" "cmd/fibr/static/styles/main.min.css"
minify --bundle --all --recursive --output "cmd/fibr/static/scripts/index.min.js" "cmd/fibr/static/scripts/"*.js
minify --bundle --all --recursive --output "cmd/fibr/static/styles/main.min.css" "cmd/fibr/static/styles/"
## run: Locally run the application, e.g. node index.js, python -m myapp, go run myapp etc ...
.PHONY: run
run:
$(MAIN_RUNNER) \
-ignorePattern ".git|node_modules" \
-authUsers "1:admin:`argon password`"
## config: Create local configuration
.PHONY: config
config:
@cp .env.example .env
## config-compose: Create local configuration for docker compose
.PHONY: config-compose
config-compose:
@printf "DATA_USER_ID=%s\n" "$(shell id -u)" > .env.compose
@printf "DATA_DIR=%s\n" "$(shell pwd)" >> .env.compose
@printf "BASIC_USERS=1:admin:%s\n" '$(shell argon password | sed 's|\$$|\$$\$$|g')' >> .env.compose