blob: a02da31314d41999f1acc28b44beba733e3d4d0d [file] [log] [blame]
Joey Armstrong0205d332023-04-11 17:29: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# -----------------------------------------------------------------------
Joey Armstronge98239c2023-05-08 17:10:07 -040017# https://gerrit.opencord.org/plugins/gitiles/onf-make
18# ONF.makefile.version = 1.0
19# -----------------------------------------------------------------------
Joey Armstrong0205d332023-04-11 17:29:23 -040020
21##-------------------##
22##---] GLOBALS [---##
23##-------------------##
24
25# 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
32
33# shell-check := $(env-clean) pylint
34shell-check := shellcheck
35
Joey Armstronge98239c2023-05-08 17:10:07 -040036shell-check-args += --check-sourced
Joey Armstrongd26858f2023-07-08 15:52:16 -040037shell-check-args += --extenal-sources
Joey Armstrong0205d332023-04-11 17:29:23 -040038
39##-------------------##
40##---] TARGETS [---##
41##-------------------##
42ifndef NO-LINT-SHELL
43 lint : lint-shell
44endif
45
46## -----------------------------------------------------------------------
47## Intent: Perform a lint check on command line script sources
48## -----------------------------------------------------------------------
49lint-shell:
50 $(shell-check) -V
51 @echo
52 $(HIDE)$(env-clean) $(shell-check-find) \
53 | $(xargs-n1) $(shell-check) $(shell-check-args)
54
55## -----------------------------------------------------------------------
56## Intent: Display command help
57## -----------------------------------------------------------------------
58help-summary ::
59 @echo ' lint-shell Syntax check shell sources'
60
Joey Armstronge98239c2023-05-08 17:10:07 -040061# [SEE ALSO]
62# -----------------------------------------------------------------------
63# o https://www.shellcheck.net/wiki/Directive
64
Joey Armstrong0205d332023-04-11 17:29:23 -040065# [EOF]