forked from stdlib-js/stdlib
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcommitlint.mk
More file actions
130 lines (115 loc) · 3.23 KB
/
commitlint.mk
File metadata and controls
130 lines (115 loc) · 3.23 KB
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
125
126
127
128
129
130
#/
# @license Apache-2.0
#
# Copyright (c) 2023 The Stdlib Authors.
#
# 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.
#/
# VARIABLES #
# Define the path to the [commitlint][1] executable.
#
# To install commitlint:
#
# ```bash
# $ npm install commitlint
# ```
#
# [1]: https://github.com/conventional-changelog/commitlint
COMMITLINT ?= $(BIN_DIR)/commitlint
# Define the command-line options to be used when invoking the executable:
COMMITLINT_FLAGS ?= \
--cwd "$(ROOT_DIR)" \
--config "$(CONFIG_DIR)/commitlint/.commitlintrc.js" \
--verbose
# RULES #
#/
# Performs linting initialization tasks.
#
# ## Notes
#
# - We have to temporarily move the `tsconfig` file, as `commitlint` (erroneously) attempts to use the file for compiling TypeScript.
#
# @private
#
# @example
# make commitlint-init
#/
commitlint-init:
ifneq ("$(wildcard $(ROOT_DIR)/tsconfig.json)", "")
$(QUIET) mv $(ROOT_DIR)/tsconfig.json $(ROOT_DIR)/tsconfig.json.tmp
endif
.PHONY: commitlint-init
#/
# Performs linting clean-up tasks.
#
# @private
#
# @example
# make commitlint-cleanup
#/
commitlint-cleanup:
ifneq ("$(wildcard $(ROOT_DIR)/tsconfig.json.tmp)", "")
$(QUIET) mv $(ROOT_DIR)/tsconfig.json.tmp $(ROOT_DIR)/tsconfig.json
endif
.PHONY: commitlint-cleanup
#/
# Lints a commit.
#
# @private
#
# @example
# make commitlint
#/
commitlint: $(NODE_MODULES) commitlint-init
$(QUIET) "$(COMMITLINT)" $(COMMITLINT_FLAGS) --edit || ( $(MAKE) -f $(this_file) commitlint-cleanup && exit 1 )
$(QUIET) $(MAKE) -f $(this_file) commitlint-cleanup
.PHONY: commitlint
#/
# Lints a commit message.
#
# @private
#
# @example
# make commitlint-message GIT_COMMIT_MESSAGE='feat: add `foo/bar`'
#/
commitlint-message: $(NODE_MODULES) commitlint-init
$(QUIET) ( printf '$(GIT_COMMIT_MESSAGE)' | "$(COMMITLINT)" $(COMMITLINT_FLAGS) ) || ( $(MAKE) -f $(this_file) commitlint-cleanup && exit 1 )
$(QUIET) $(MAKE) -f $(this_file) commitlint-cleanup
.PHONY: commitlint-message
#/
# Lints a list of files, each containing a commit message.
#
# @private
#
# @param {string} FILES - list of file paths
# @param {*} [FAST_FAIL] - flag indicating whether to stop linting upon encountering a lint error
#
# @example
# make commitlint-files FILES='/foo/commit.txt'
#/
commitlint-files: $(NODE_MODULES) commitlint-init
ifeq ($(FAIL_FAST), true)
$(QUIET) for file in $(FILES); do \
echo ''; \
echo "Linting commit message:"; \
( cat $$file | grep -v '^#' | "$(COMMITLINT)" $(COMMITLINT_FLAGS) ) || ( $(MAKE) -f $(this_file) commitlint-cleanup && exit 1 ); \
done
else
$(QUIET) for file in $(FILES); do \
echo ''; \
echo "Linting commit message"; \
( cat $$file | grep -v '^#' | "$(COMMITLINT)" $(COMMITLINT_FLAGS) ) || echo 'Linting failed.'; \
done
endif
$(QUIET) $(MAKE) -f $(this_file) commitlint-cleanup
.PHONY: commitlint-files