| Joey Armstrong | a527814 | 2023-06-28 16:56:54 -0400 | [diff] [blame] | 1 | # -*- makefile -*- |
| 2 | # ----------------------------------------------------------------------- |
| Joey Armstrong | 098eedd | 2024-02-11 10:00:59 -0500 | [diff] [blame^] | 3 | # Copyright 2022-2024 Open Networking Foundation (ONF) and the ONF Contributors |
| Joey Armstrong | a527814 | 2023-06-28 16:56:54 -0400 | [diff] [blame] | 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 | |
| 25 | # Gather sources to check |
| 26 | # TODO: implement deps, only check modified files |
| 27 | shell-check-find := find . |
| 28 | # vendor scripts but they really should be lintable |
| 29 | shell-check-find += -name 'vendor' -prune |
| 30 | shell-check-find += -o \( -name '*.sh' \) |
| 31 | shell-check-find += -type f -print0 |
| 32 | |
| 33 | shell-check := $(env-clean) shellcheck |
| 34 | # shell-check := shellcheck |
| 35 | |
| 36 | shell-check-args += --check-sourced |
| 37 | shell-check-args += --external-sources |
| 38 | |
| 39 | ##-------------------## |
| 40 | ##---] TARGETS [---## |
| 41 | ##-------------------## |
| 42 | ifndef NO-LINT-SHELL |
| 43 | lint : lint-shell |
| 44 | endif |
| 45 | |
| 46 | ## ----------------------------------------------------------------------- |
| 47 | ## Intent: Perform a lint check on command line script sources |
| 48 | ## ----------------------------------------------------------------------- |
| 49 | lint-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 | ## ----------------------------------------------------------------------- |
| 58 | help-summary :: |
| 59 | @echo ' lint-shell Syntax check shell sources' |
| 60 | |
| 61 | # [SEE ALSO] |
| 62 | # ----------------------------------------------------------------------- |
| 63 | # o https://www.shellcheck.net/wiki/Directive |
| 64 | |
| 65 | # [EOF] |