-
Notifications
You must be signed in to change notification settings - Fork 0
/
Makefile
123 lines (109 loc) · 4.04 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
# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
SHELL := /bin/bash
OUTPUT_FORMAT ?= $(shell if [ "${GITHUB_ACTIONS}" == "true" ]; then echo "github"; else echo ""; fi)
REPO_NAME = $(shell basename "$$(pwd)")
.PHONY: help
help: ## Shows all targets and help from the Makefile (this message).
@echo "$(REPO_NAME) Makefile"
@echo "Usage: make [COMMAND]"
@echo ""
@grep --no-filename -E '^([/a-z.A-Z0-9_%-]+:.*?|)##' $(MAKEFILE_LIST) | \
awk 'BEGIN {FS = "(:.*?|)## ?"}; { \
if (length($$1) > 0) { \
printf " \033[36m%-20s\033[0m %s\n", $$1, $$2; \
} else { \
if (length($$2) > 0) { \
printf "%s\n", $$2; \
} \
} \
}'
package-lock.json:
npm install
node_modules/.installed: package.json package-lock.json
npm ci
touch node_modules/.installed
## Tools
#####################################################################
.PHONY: autogen
autogen: ## Runs autogen on code files.
@set -euo pipefail; \
files=$$( \
git ls-files \
'*.go' '**/*.go' \
'*.ts' '**/*.ts' \
'*.js' '**/*.js' \
'*.py' '**/*.py' \
'*.yaml' '**/*.yaml' \
'*.yml' '**/*.yml' \
); \
for filename in $${files}; do \
if ! ( head "$${filename}" | grep -iL "Copyright" > /dev/null ); then \
autogen -i --no-code --no-tlc -c "Google LLC" -l apache "$${filename}"; \
fi; \
done; \
if ! ( head Makefile | grep -iL "Copyright" > /dev/null ); then \
autogen -i --no-code --no-tlc -c "Google LLC" -l apache Makefile; \
fi;
.PHONY: format
format: md-format yaml-format ## Format all files
.PHONY: md-format
md-format: node_modules/.installed ## Format Markdown files.
@npx prettier --write --no-error-on-unmatched-pattern "**/*.md" "**/*.markdown"
.PHONY: yaml-format
yaml-format: node_modules/.installed ## Format YAML files.
@npx prettier --write --no-error-on-unmatched-pattern "**/*.yml" "**/*.yaml"
## Linters
#####################################################################
.PHONY: lint
lint: yamllint actionlint markdownlint ## Run all linters.
.PHONY: actionlint
actionlint: ## Runs the actionlint linter.
@# NOTE: We need to ignore config files used in tests.
@set -euo pipefail;\
files=$$( \
git ls-files \
'.github/workflows/*.yml' \
'.github/workflows/*.yaml' \
); \
if [ "$(OUTPUT_FORMAT)" == "github" ]; then \
actionlint -format '{{range $$err := .}}::error file={{$$err.Filepath}},line={{$$err.Line}},col={{$$err.Column}}::{{$$err.Message}}%0A```%0A{{replace $$err.Snippet "\\n" "%0A"}}%0A```\n{{end}}' -ignore 'SC2016:' $${files}; \
else \
actionlint $${files}; \
fi
.PHONY: markdownlint
markdownlint: node_modules/.installed ## Runs the markdownlint linter.
@set -euo pipefail;\
if [ "$(OUTPUT_FORMAT)" == "github" ]; then \
exit_code=0; \
while IFS="" read -r p && [ -n "$$p" ]; do \
file=$$(echo "$$p" | jq -c -r '.fileName // empty'); \
line=$$(echo "$$p" | jq -c -r '.lineNumber // empty'); \
endline=$${line}; \
message=$$(echo "$$p" | jq -c -r '.ruleNames[0] + "/" + .ruleNames[1] + " " + .ruleDescription + " [Detail: \"" + .errorDetail + "\", Context: \"" + .errorContext + "\"]"'); \
exit_code=1; \
echo "::error file=$${file},line=$${line},endLine=$${endline}::$${message}"; \
done <<< "$$(npx markdownlint --dot --json . 2>&1 | jq -c '.[]')"; \
exit "$${exit_code}"; \
else \
npx markdownlint --dot .; \
fi
.PHONY: yamllint
yamllint: ## Runs the yamllint linter.
@set -euo pipefail;\
extraargs=""; \
if [ "$(OUTPUT_FORMAT)" == "github" ]; then \
extraargs="-f github"; \
fi; \
yamllint --strict -c .yamllint.yaml . $$extraargs