blob: 19e8628ab051ed8f88c969ddde70ca4a004902aa [file] [log] [blame]
Joey Armstrongdd334492023-07-09 17:59:02 -04001# -*- makefile -*-
2# -----------------------------------------------------------------------
Joey Armstrong518f3572024-02-11 07:56:25 -05003# Copyright 2022-2024 Open Networking Foundation (ONF) and the ONF Contributors
Joey Armstrongdd334492023-07-09 17:59:02 -04004#
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 Armstrong518f3572024-02-11 07:56:25 -050017# SPDX-FileCopyrightText: 2024 Open Networking Foundation (ONF) and the ONF Contributors
Joey Armstrongdd334492023-07-09 17:59:02 -040018# SPDX-License-Identifier: Apache-2.0
19# -----------------------------------------------------------------------
20
21$(if $(DEBUG),$(warning ENTER))
22
23## -----------------------------------------------------------------------
24## Intent: Install the yamllint tool
25## -----------------------------------------------------------------------
26.PHONY: lint-yaml-install
27
28# -----------------------------------------------------------------------
29# We can(/should?) define a command macro
30# wait a bit until use cases are better known.
31# Initial use required inserting xargs bash -c "$(YAMLLINT) {}"
32# -----------------------------------------------------------------------
33# YAMLLINT ?= $(venv-activate-bin)/yamllint
34# YAMLLINT ?= $(activate) && yamllint
35
36## -----------------------------------------------------------------------
37## Intent: Display yamllint command version string.
38## Note: As a side effect, install yamllint by dependency
39## -----------------------------------------------------------------------
40.PHONY: lint-yaml-cmd-version
41lint-yaml-cmd-version : $(venv-activate-bin)/yamllint
42
43 $(HIDE) echo
44 $< --version
45
46## -----------------------------------------------------------------------
47## Intent: On-demand instalation of the yamllint command
48## -----------------------------------------------------------------------
49lint-yaml-install := $(venv-activate-bin)/yamllint
50$(lint-yaml-install) : $(venv-activate-script)
51
52 $(call banner-enter,Target $@)
53 $(activate) && pip install yamllint
54 $(call banner-leave,Target $@)
55
56## -----------------------------------------------------------------------
57## Intent: Purge yamllint tool installation
58## -----------------------------------------------------------------------
59sterile ::
60 $(HIDE)$(RM) "$(venv-abs-bin)/yamllint"
61 $(HIDE)$(RM) -r .venv/lib/*/site-packages/yamllint
62
63 # Remove both file:command and dir:libraries
64 # find "$(venv-abs-path)" -iname 'yamllint' -print0 \
65 # | $(xargs-n1-clean) $(RM) -r {}
66
67## -----------------------------------------------------------------------
68## Intent: Display command usage
69## -----------------------------------------------------------------------
70help::
71 @echo ' lint-yaml-install Install the yamllint tool'
72
73# [EOF]