blob: 5c466e405cb32269938749f1336522b34dc6b0cc [file] [log] [blame]
Joey Armstrong04cdd9f2023-06-09 15:18:23 -04001# -*- makefile -*-
2# -----------------------------------------------------------------------
3# Copyright 2022-2023 Open Networking Foundation (ONF) and the ONF Contributors
4#
5# Licensed under the Apache License, Version 2.0 (the "License");
6# you may not use this file except in compliance with the License.
7# You may obtain a copy of the License at
8#
9# http://www.apache.org/licenses/LICENSE-2.0
10#
11# Unless required by applicable law or agreed to in writing, software
12# distributed under the License is distributed on an "AS IS" BASIS,
13# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14# See the License for the specific language governing permissions and
15# limitations under the License.
16# -----------------------------------------------------------------------
17# https://gerrit.opencord.org/plugins/gitiles/onf-make
18# ONF.makefile.version = 1.0
19# -----------------------------------------------------------------------
20
21##-------------------##
22##---] GLOBALS [---##
23##-------------------##
24
25shell-check := $(env-clean) shellcheck
26
27shell-check-args += --check-sourced
28shell-check-args += --external-sources
29
30##-------------------##
31##---] TARGETS [---##
32##-------------------##
33ifndef NO-LINT-SHELLCHECK
34 lint : lint-shellcheck
35endif
36
37## -----------------------------------------------------------------------
38## Intent: Perform a lint check on command line script sources
39## -----------------------------------------------------------------------
40lint-shellcheck: # shellcheck-version
41
42 $(call banner-enter,Target $@)
43 $(call gen-shellcheck-find-cmd) \
44 | $(xargs-cmd-clean) -I'{}' \
45 bash -c "$(shell-check) $(shell-check-args) {}"
46 $(call banner-leave,Target $@)
47
48## -----------------------------------------------------------------------
49## Intent: Display yamllint command version string.
50## Note: As a side effect, install yamllint by dependency
51## -----------------------------------------------------------------------
52.PHONY: shellcheck-cmd-version
53shellcheck-cmd-version :
54
55 @echo
56 $(shell-check) -V
57
58## -----------------------------------------------------------------------
59## Intent: Display command help
60## -----------------------------------------------------------------------
61help-summary ::
62 @echo ' lint-shellcheck Syntax check shell sources'
63
64# [SEE ALSO]
65# -----------------------------------------------------------------------
66# o https://www.shellcheck.net/wiki/Directive
67
68# [EOF]