blob: 3c33bb2fe0a115f3502d4fda5aed13176c8fac83 [file] [log] [blame]
Joey Armstrong36592e32022-11-28 09:00:28 -05001# -*- makefile -*-
2# -----------------------------------------------------------------------
Joey Armstrong449ce7a2023-07-18 18:32:24 -04003# Copyright 2022-2023 Open Networking Foundation (ONF) and the ONF Contributors
Joey Armstrong36592e32022-11-28 09:00:28 -05004#
Joey Armstrong449ce7a2023-07-18 18:32:24 -04005# Licensed under the Apache License, Version 2.0 (the "License");
Joey Armstrong36592e32022-11-28 09:00:28 -05006# 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# -----------------------------------------------------------------------
Joey Armstrong449ce7a2023-07-18 18:32:24 -040017# https://gerrit.opencord.org/plugins/gitiles/onf-make
18# ONF.makefile.version = 1.0
19# -----------------------------------------------------------------------
Joey Armstrong36592e32022-11-28 09:00:28 -050020
Joey Armstrong4de98b72023-02-09 14:51:38 -050021##-------------------##
22##---] GLOBALS [---##
23##-------------------##
Joey Armstronga8bc8e12022-12-04 07:06:59 -050024
Joey Armstrong449ce7a2023-07-18 18:32:24 -040025# Gather sources to check
26# TODO: implement deps, only check modified files
27shell-check-find := find .
28# vendor scripts but they really should be lintable
29shell-check-find += -name 'vendor' -prune
30shell-check-find += -o \( -name '*.sh' \)
31shell-check-find += -type f -print0
Joey Armstronga8bc8e12022-12-04 07:06:59 -050032
Joey Armstrong449ce7a2023-07-18 18:32:24 -040033shell-check := $(env-clean) shellcheck
34# shell-check := shellcheck
35
36shell-check-args += --check-sourced
37shell-check-args += --external-sources
38
39##-------------------##
40##---] TARGETS [---##
41##-------------------##
Joey Armstrong4de98b72023-02-09 14:51:38 -050042ifndef NO-LINT-SHELL
Joey Armstrong449ce7a2023-07-18 18:32:24 -040043 lint : lint-shell
44endif
Joey Armstrong4de98b72023-02-09 14:51:38 -050045
46## -----------------------------------------------------------------------
Joey Armstrong449ce7a2023-07-18 18:32:24 -040047## Intent: Perform a lint check on command line script sources
Joey Armstrong4de98b72023-02-09 14:51:38 -050048## -----------------------------------------------------------------------
Joey Armstrong449ce7a2023-07-18 18:32:24 -040049lint-shell:
50 $(shell-check) -V
Joey Armstrong4de98b72023-02-09 14:51:38 -050051 @echo
Joey Armstrong449ce7a2023-07-18 18:32:24 -040052 $(HIDE)$(env-clean) $(shell-check-find) \
53 | $(xargs-n1) $(shell-check) $(shell-check-args)
Joey Armstronga8bc8e12022-12-04 07:06:59 -050054
Joey Armstrong4de98b72023-02-09 14:51:38 -050055## -----------------------------------------------------------------------
Joey Armstrong449ce7a2023-07-18 18:32:24 -040056## Intent: Display command help
Joey Armstrong4de98b72023-02-09 14:51:38 -050057## -----------------------------------------------------------------------
Joey Armstrong449ce7a2023-07-18 18:32:24 -040058help-summary ::
59 @echo ' lint-shell Syntax check shell sources'
Joey Armstrong4de98b72023-02-09 14:51:38 -050060
Joey Armstrong449ce7a2023-07-18 18:32:24 -040061# [SEE ALSO]
62# -----------------------------------------------------------------------
63# o https://www.shellcheck.net/wiki/Directive
Joey Armstrong36592e32022-11-28 09:00:28 -050064
65# [EOF]