code-style.mak

# -*- makefile -*-

###########################################################################
### Do not use
###

# This is superseded by `prek`.


###########################################################################
### Documentation
###

# This Makefile fragment defines targets:
# * style-check : runs a linter on all HTML, Markdown, Python, Shell, and YAML
#   files in or under the current directory.
# * style-fix : fixes linting problems, where possible.  Not all can be fixed.
# * plume-scripts-update : updates the linting rules to the latest version.

# To use it, add these 5 lines to your Makefile:
#
# # Code style; defines `style-check` and `style-fix`.
# ifeq (,$(wildcard .plume-scripts))
# dummy := $(shell git clone --depth=1 -q https://github.com/plume-lib/plume-scripts.git .plume-scripts)
# endif
# include .plume-scripts/code-style.mak

# Environment variables (define them before the above snippet):
# * To add or remove files from style checking:
#   SH_SCRIPTS_USER := dots/.aliases dots/.environment dots/.profile
#   BASH_SCRIPTS_USER := dots/.bashrc dots/.bash_profile
#   # CODE_STYLE_EXCLUSIONS_USER is in the form of arguments to `grep`.
#   CODE_STYLE_EXCLUSIONS_USER := --exclude-dir apheleia --exclude-dir 'apheleia-*' --exclude-dir=mew --exclude=csail-athena-tickets.bash --exclude=conda-initialize.sh --exclude=addrfilter
#   # CODE_STYLE_FILTER_OUT_USER is in the form of arguments to Make's `filter-out`.
#   CODE_STYLE_FILTER_OUT_USER := %/doc/daikon/% %/doc/developer/%
# * To disable all style checking:
#   CODE_STYLE_DISABLE : set to any value.
# * To change the location where to clone the plume-scripts repository:
#   PLUME_SCRIPTS

# To use it in CI, copy file code-style-github-workflow.yml to
# .github/workflows/code-style.yml in your repository.

# Requirements/dependencies
#
# These programs must be installed:
# * make
# * wget
# * GNU grep (for `--include` command-line argument)
# * readline that supports `--` command-line argument
# The latter two are not provided by busybox (on distributions such as Alpine Linux).
#
# There are further requirements (usually just Python and uv) for specific languages or file types:
# * for HTML checking: Python, uv
# * for Markdown checking, either of these:
#   * npm, markdownlint-cli2
#   * Python, uv
# * for Perl checking: nothing (Perl checking is currently a no-op)
# * for Python checking: Python, uv
# * for Shell checking: shellcheck, shfmt
#   * to speed up Shell checking, also: bkt
# * for YAML checking: Python, uv

# Here are instructions for installing these tools:
# * Python is probably already installed on your system
# * [uv](https://docs.astral.sh/uv/#installation)
# * [shellcheck](https://github.com/koalaman/shellcheck#installing)
# * [shfmt](https://webinstall.dev/shfmt/)
# * [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2#install)
# * [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
# * [bkt](https://github.com/dimo414/bkt#installation)

# Your `.gitignore` file should contain this line:
# .plume-scripts


###########################################################################
### User-overridable variables
###

# You should set the variables *before* your makefile includes `code-style.mak`.

PLUME_SCRIPTS ?= .plume-scripts

CODE_STYLE_EXCLUSIONS_DEFAULT ?= --exclude-dir=.do-like-javac --exclude-dir=.git --exclude-dir='.nfs*' --exclude-dir=.venv --exclude-dir=api --exclude-dir=build --exclude='.nfs*' --exclude='\#*' --exclude='*~' --exclude='*.bak' --exclude='*.tar' --exclude='*.tdy' --exclude=gradlew
ifeq (.,${PLUME_SCRIPTS})
CODE_STYLE_EXCLUSIONS ?= ${CODE_STYLE_EXCLUSIONS_DEFAULT}
else
CODE_STYLE_EXCLUSIONS ?= ${CODE_STYLE_EXCLUSIONS_DEFAULT} --exclude-dir=${PLUME_SCRIPTS}
endif


###########################################################################
### To do
###

# Have a more consistent way of indicating which files to include/exclude,
# which is used throughout.


###########################################################################
### Alternatives
###

# The complexity of this file is getting out of hand.
# Consider using some other tool, such as:
#
# * megalinter
#   jscpd needs: --ignore-pattern "^import.*"
# * super-linter
# * qlty
# * codacy?
#
# However, each of them requires mucho setup and may not use the linters I like.


###########################################################################
### The code
###

.PHONY: style-fix style-check

showvars::
	@echo "PLUME_SCRIPTS=${PLUME_SCRIPTS}"
	@echo "CODE_STYLE_DISABLE=${CODE_STYLE_DISABLE}"

# This "if" is closed nearly at the end of the file.
ifdef CODE_STYLE_DISABLE
style-check:
	@echo 'Environment var CODE_STYLE_DISABLE is set, so `make style-check` does nothing.'
style-fix:
	@echo 'Environment var CODE_STYLE_DISABLE is set, so `make style-fix` does nothing.'
else # This "else" is closed nearly at the end of the file.

showvars::
	@echo "CODE_STYLE_EXCLUSIONS=${CODE_STYLE_EXCLUSIONS}"
	@echo "CODE_STYLE_EXCLUSIONS_USER=${CODE_STYLE_EXCLUSIONS_USER}"
	@echo "PLUME_SCRIPTS=${PLUME_SCRIPTS}"

# `checkbashisms` is not included by source because it uses the GPL.
ifeq (,$(wildcard ${PLUME_SCRIPTS}/checkbashisms))
dummy := $(shell cd ${PLUME_SCRIPTS} \
   && wget -q https://homes.cs.washington.edu/~mernst/software/checkbashisms \
   && chmod +x checkbashisms)
endif

BKT_EXISTS := $(shell if command -v bkt > /dev/null 2>&1; then echo "yes"; fi)
UV_EXISTS := $(shell if command -v uv > /dev/null 2>&1; then echo "yes"; fi)


## HTML
.PHONY: html-style-fix html-style-check
style-fix: html-style-fix
style-check: html-style-check
ifneq (,${UV_EXISTS})
# Any file ending with ".html".
HTML_FILES   := $(filter-out ${CODE_STYLE_FILTER_OUT} ${CODE_STYLE_FILTER_OUT_USER}, $(shell grep -r -l --include='*.html' ${CODE_STYLE_EXCLUSIONS} ${CODE_STYLE_EXCLUSIONS_USER} '^' .))
ifneq (,${HTML_FILES})
# HTML linters are listed in order of increasing precedence.
HTML5VALIDATOR_EXISTS_UV := $(shell if uv run html5validator --version > /dev/null 2>&1; then echo "yes"; fi)
ifdef HTML5VALIDATOR_EXISTS_UV
HTML_STYLE_FIX := uv run html5validator fix
HTML_STYLE_CHECK := uv run html5validator scan --show-warnings
HTML_STYLE_VERSION := uv run html5validator --version
endif
HTML5VALIDATOR_EXISTS_UVX := $(shell if uvx html5validator --version > /dev/null 2>&1; then echo "yes"; fi)
ifdef HTML5VALIDATOR_EXISTS_UVX
HTML_STYLE_FIX := uvx html5validator fix
HTML_STYLE_CHECK := uvx html5validator scan --show-warnings
HTML_STYLE_VERSION := uvx html5validator --version
endif
endif # ifneq (,${HTML_FILES})
endif # ifneq (,${UV_EXISTS})
html-style-fix:
ifeq (,${HTML_FILES})
	@:
else
ifeq (,${UV_EXISTS})
	@echo Skipping html5validator because uv is not installed.
else
ifndef HTML_STYLE_FIX
	@echo Skipping html5validator because it is not installed.
	-uvx html5validator --version
	-uv run html5validator --version
	@false
else
	@${PLUME_SCRIPTS}/cronic ${HTML_STYLE_FIX} ${HTML_FILES} || (${HTML_STYLE_VERSION} && false)
endif
endif
endif # ifneq (,${HTML_FILES})
html-style-check:
ifeq (,${HTML_FILES})
	@:
else
ifeq (,${UV_EXISTS})
	@echo Skipping html5validator because uv is not installed.
else
ifndef HTML_STYLE_CHECK
	@echo Cannot find 'uvx html5validator' or 'uv run html5validator'
	-uvx html5validator --version
	-uv run html5validator --version
	@false
else
	@${PLUME_SCRIPTS}/cronic ${HTML_STYLE_CHECK} ${HTML_FILES} || (${HTML_STYLE_VERSION} && false)
endif
endif
endif # ifeq (,${HTML_FILES})
showvars::
	@echo "HTML_FILES=${HTML_FILES}"
ifneq (,${HTML_FILES})
	${HTML_STYLE_VERSION}
endif


## Makefiles
# I cannot find any decent Makefile linting tool, that handles
# non-trivial Makefiles (like this one!).  Three inadequate tools
# (best to worst) are:
# https://github.com/EbodShojaei/bake
# https://github.com/checkmake/checkmake
# https://crates.io/crates/unmake


## Markdown
.PHONY: markdown-style-fix markdown-style-check
style-fix: markdown-style-fix
style-check: markdown-style-check
MARKDOWN_FILES   := $(filter-out ${CODE_STYLE_FILTER_OUT} ${CODE_STYLE_FILTER_OUT_USER}, $(shell grep -r -l --include='*.md' ${CODE_STYLE_EXCLUSIONS} ${CODE_STYLE_EXCLUSIONS_USER} '^' .))
ifneq (,${MARKDOWN_FILES})
# Markdown linters are listed in order of increasing precedence.
ifneq (,${UV_EXISTS})
PYMARKDOWNLNT_EXISTS_UV := $(shell if uv run pymarkdownlnt version > /dev/null 2>&1; then echo "yes"; fi)
ifdef PYMARKDOWNLNT_EXISTS_UV
MARKDOWN_STYLE_FIX := uv run pymarkdownlnt --config ${PLUME_SCRIPTS}/.pymarkdown fix
MARKDOWN_STYLE_CHECK := uv run pymarkdownlnt --config ${PLUME_SCRIPTS}/.pymarkdown scan
MARKDOWN_STYLE_VERSION := uv run pymarkdownlnt version
endif
PYMARKDOWNLNT_EXISTS_UVX := $(shell if uvx pymarkdownlnt version > /dev/null 2>&1; then echo "yes"; fi)
ifdef PYMARKDOWNLNT_EXISTS_UVX
MARKDOWN_STYLE_FIX := uvx pymarkdownlnt --config ${PLUME_SCRIPTS}/.pymarkdown fix
MARKDOWN_STYLE_CHECK := uvx pymarkdownlnt --config ${PLUME_SCRIPTS}/.pymarkdown scan
MARKDOWN_STYLE_VERSION := uvx pymarkdownlnt version
endif
endif # ifneq (,${UV_EXISTS})
DOCKER_EXISTS := $(shell if docker --version > /dev/null 2>&1; then echo "yes"; fi)
ifeq (yes,${DOCKER_EXISTS})
DOCKER_RUNNING := $(shell if docker version > /dev/null 2>&1; then echo "yes"; fi)
endif
ifeq (yes,${DOCKER_RUNNING})
DMDL := docker run -w /myfolder -v $$PWD:/myfolder -v $$(readlink -f ${PLUME_SCRIPTS}):/plume-scripts davidanson/markdownlint-cli2:v0.20.0
MARKDOWN_STYLE_FIX := ${DMDL} --fix --config /plume-scripts/.markdownlint-cli2.yaml "\#node_modules"
MARKDOWN_STYLE_CHECK := ${DMDL} --config /plume-scripts/.markdownlint-cli2.yaml "\#node_modules"
MARKDOWN_STYLE_VERSION := ${DMDL} --help 2>&1 | head -1
endif
MARKDOWNLINT_CLI2_EXISTS := $(shell if markdownlint-cli2 --version > /dev/null 2>&1; then echo "yes"; fi)
ifdef MARKDOWNLINT_CLI2_EXISTS
MARKDOWN_STYLE_FIX := markdownlint-cli2 --fix --config ${PLUME_SCRIPTS}/.markdownlint-cli2.yaml "\#node_modules"
MARKDOWN_STYLE_CHECK := markdownlint-cli2 --config ${PLUME_SCRIPTS}/.markdownlint-cli2.yaml "\#node_modules"
MARKDOWN_STYLE_VERSION := markdownlint-cli2 --help | head -1
endif
endif # ifneq (,${MARKDOWN_FILES})
markdown-style-fix:
ifeq (,${MARKDOWN_FILES})
	@:
else
ifndef MARKDOWN_STYLE_FIX
	@echo Cannot find 'uvx pymarkdownlnt' or 'uv run pymarkdownlnt' or 'markdownlint-cli2'
	-uvx pymarkdownlnt version
	-uv run pymarkdownlnt version
	-markdownlint-cli2 --version
else
	@${PLUME_SCRIPTS}/cronic ${MARKDOWN_STYLE_FIX} ${MARKDOWN_FILES} || (${MARKDOWN_STYLE_VERSION} && false)
endif
endif # ifeq (,${MARKDOWN_FILES})
markdown-style-check:
ifeq (,${MARKDOWN_FILES})
	@:
else
ifndef MARKDOWN_STYLE_CHECK
	@echo Cannot find 'uvx pymarkdownlnt' or 'uv run pymarkdownlnt' or 'markdownlint-cli2'
	-uvx pymarkdownlnt version
	-uv run pymarkdownlnt version
	-command -v markdownlint-cli2
	@false
else
	@${PLUME_SCRIPTS}/cronic ${MARKDOWN_STYLE_CHECK} ${MARKDOWN_FILES} || (${MARKDOWN_STYLE_VERSION} && false)
endif
endif # ifeq (,${MARKDOWN_FILES})
showvars::
	@echo "MARKDOWN_FILES=${MARKDOWN_FILES}"
ifneq (,${MARKDOWN_FILES})
	${MARKDOWN_STYLE_VERSION}
	@echo "DOCKER_EXISTS=${DOCKER_EXISTS}"
ifeq (yes,${DOCKER_EXISTS})
	which docker
	docker --version
	@echo "DOCKER_RUNNING=${DOCKER_RUNNING}"
ifeq (yes,${DOCKER_RUNNING})
	docker version
	echo "DMDL=${DMDL}"
endif
endif
	@echo "PYMARKDOWNLNT_EXISTS_UVX=${PYMARKDOWNLNT_EXISTS_UVX}"
	@echo "PYMARKDOWNLNT_EXISTS_UV=${PYMARKDOWNLNT_EXISTS_UV}"
	@echo "MARKDOWNLINT_CLI2_EXISTS=${MARKDOWNLINT_CLI2_EXISTS}"
	@echo "MARKDOWN_STYLE_FIX=${MARKDOWN_STYLE_FIX}"
	@echo "MARKDOWN_STYLE_CHECK=${MARKDOWN_STYLE_CHECK}"
endif


## Perl
.PHONY: perl-style-fix perl-style-check
style-fix: perl-style-fix
style-check: perl-style-check
# Any file ending with ".pl" or ".pm" or containing a Perl shebang line.
PERL_FILES   := $(strip $(filter-out ${CODE_STYLE_FILTER_OUT} ${CODE_STYLE_FILTER_OUT_USER}, $(shell grep -r -l --include='*.pl' --include='*.pm' ${CODE_STYLE_EXCLUSIONS} ${CODE_STYLE_EXCLUSIONS_USER} '^' .) $(shell grep -r -n --exclude='*.pl' --exclude='*.pm' ${CODE_STYLE_EXCLUSIONS} ${CODE_STYLE_EXCLUSIONS_USER} '^\#! \?\(/bin/\|/usr/bin/\|/usr/bin/env \)perl' . | grep ":1:" | sed "s/:1:.*//")))
perl-style-fix:
	@:
ifneq (,${PERL_FILES})
# I don't think that perltidy is an improvement.
#	@perltidy -w -b -bext='/' -gnu ${PERL_FILES}
#	@find . -name '*.tdy' -type f -delete
endif
perl-style-check:
	@:
ifneq (,${PERL_FILES})
# I don't think that perltidy is an improvement.
#	@perltidy -w ${PERL_FILES}
#	@find . -name '*.tdy' -type f -delete
endif
showvars::
	@echo "PERL_FILES=${PERL_FILES}"


## Python
.PHONY: python-style-fix python-style-check python-typecheck
style-fix: python-style-fix
style-check: python-style-check python-typecheck
# Any file ending with ".py" or containing a Python shebang line.
PYTHON_FILES:=$(strip $(filter-out ${CODE_STYLE_FILTER_OUT} ${CODE_STYLE_FILTER_OUT_USER}, $(shell grep -r -l --include='*.py' ${CODE_STYLE_EXCLUSIONS}  ${CODE_STYLE_EXCLUSIONS_USER} '^' .) $(shell grep -r -n --exclude='*.py' ${CODE_STYLE_EXCLUSIONS} ${CODE_STYLE_EXCLUSIONS_USER} '^\#! \?\(/bin/\|/usr/bin/\|/usr/bin/env \)python' . | grep ":1:" | sed "s/:1:.*//")))
ifneq (,${PYTHON_FILES})
ifneq (,${UV_EXISTS})
RUFF_EXISTS_UV := $(shell if uv run ruff version > /dev/null 2>&1; then echo "yes"; fi)
ifdef RUFF_EXISTS_UV
RUFF := uv run ruff
endif
RUFF_EXISTS_UVX := $(shell if uvx ruff version > /dev/null 2>&1; then echo "yes"; fi)
ifdef RUFF_EXISTS_UVX
RUFF := uvx ruff
endif
TY_EXISTS_UV := $(shell if uv run ty version > /dev/null 2>&1; then echo "yes"; fi)
ifdef TY_EXISTS_UV
TY := uv run ty
endif
TY_EXISTS_UVX := $(shell if uvx ty version > /dev/null 2>&1; then echo "yes"; fi)
ifdef TY_EXISTS_UVX
TY := uvx ty
endif
endif # ifneq (,${UV_EXISTS})
endif # ifneq (,${PYTHON_FILES})
python-style-fix:
ifeq (,${PYTHON_FILES})
	@:
else
ifeq (,${RUFF})
	@echo Skipping ruff because it is not installed.
else
	@${PLUME_SCRIPTS}/cronic ${RUFF} format --config ${PLUME_SCRIPTS}/.ruff.toml ${PYTHON_FILES} || (${RUFF} version && false)
	@${PLUME_SCRIPTS}/cronic ${RUFF} check --fix --config ${PLUME_SCRIPTS}/.ruff.toml ${PYTHON_FILES} || (${RUFF} version && false)
endif
endif
python-style-check:
ifeq (,${PYTHON_FILES})
	@:
else
ifeq (,${RUFF})
	@echo Skipping ruff because it is not installed.
else
	@${PLUME_SCRIPTS}/cronic ${RUFF} format --check --config ${PLUME_SCRIPTS}/.ruff.toml ${PYTHON_FILES} || (${RUFF} version && false)
	@${PLUME_SCRIPTS}/cronic ${RUFF} check --config ${PLUME_SCRIPTS}/.ruff.toml ${PYTHON_FILES} || (${RUFF} version && false)
endif
endif
python-typecheck:
ifeq (,${PYTHON_FILES})
	@:
else
ifeq (,${TY})
	@echo Skipping ty because it is not installed.
else
# Problem: `ty` ignores files passed on the command line that do not end with `.py`.
	@${PLUME_SCRIPTS}/cronic ${TY} check --error-on-warning --no-progress ${PYTHON_FILES} || (${TY} version && false)
endif
endif
showvars::
	@echo "PYTHON_FILES=${PYTHON_FILES}"
ifneq (,${PYTHON_FILES})
	@echo "RUFF_EXISTS_UVX=${RUFF_EXISTS_UVX}"
	@echo "RUFF_EXISTS_UV=${RUFF_EXISTS_UV}"
	@echo "RUFF=${RUFF}"
ifdef RUFF
	${RUFF} version
endif
	@echo "TY_EXISTS_UVX=${TY_EXISTS_UVX}"
	@echo "TY_EXISTS_UV=${TY_EXISTS_UV}"
	@echo "TY=${TY}"
ifdef TY
	${TY} version
endif
endif

## Shell
.PHONY: shell-style-fix shell-style-check
style-fix: shell-style-fix
style-check: shell-style-check
# Files ending with ".sh" might be bash or Posix sh, so don't make any assumption about them.
SH_SCRIPTS   := $(strip ${SH_SCRIPTS_USER} $(filter-out ${CODE_STYLE_FILTER_OUT} ${CODE_STYLE_FILTER_OUT_USER}, $(shell grep -r -n ${CODE_STYLE_EXCLUSIONS} ${CODE_STYLE_EXCLUSIONS_USER} '^\#! \?\(/bin/\|/usr/bin/env \)sh' . | grep ":1:" | sed "s/:1:.*//")))
# Any file ending with ".bash" or containing a bash shebang line.
BASH_SCRIPTS := $(strip ${BASH_SCRIPTS_USER} $(filter-out ${CODE_STYLE_FILTER_OUT} ${CODE_STYLE_FILTER_OUT_USER}, $(shell grep -r -l --include='*.bash' ${CODE_STYLE_EXCLUSIONS} ${CODE_STYLE_EXCLUSIONS_USER} '^' .) $(shell grep -r -n --exclude='*.bash' ${CODE_STYLE_EXCLUSIONS} ${CODE_STYLE_EXCLUSIONS_USER} '^\#! \?\(/bin/\|/usr/bin/env \)bash' . | grep ":1:" | sed "s/:1:.*//")))
SH_AND_BASH_SCRIPTS := $(strip ${SH_SCRIPTS} ${BASH_SCRIPTS})
ifneq (,${SH_AND_BASH_SCRIPTS})
ifneq (,${BKT_EXISTS})
SHELL_BKT_COMMAND := bkt --cwd $(patsubst %,--modtime %,${SH_AND_BASH_SCRIPTS}) --ttl 1month --
endif
SHFMT_EXISTS := $(shell if shfmt --version > /dev/null 2>&1; then echo "yes"; fi)
SHELLCHECK_EXISTS := $(shell if shellcheck --version > /dev/null 2>&1; then echo "yes"; fi)
endif # ifneq (,$SH_AND_BASH_SCRIPTS)
shell-style-fix:
ifeq (,${SH_AND_BASH_SCRIPTS})
	@:
else
ifeq (,${SHFMT_EXISTS})
	@echo "skipping shfmt because it is not installed"
else
	@${SHELL_BKT_COMMAND} ${PLUME_SCRIPTS}/cronic shfmt -w -i 2 -ci -bn -sr ${SH_AND_BASH_SCRIPTS} || (echo -s "shfmt version " && shfmt --version && false)
endif
ifeq (,${SHELLCHECK_EXISTS})
	@echo "skipping shellcheck because it is not installed"
else
	@${SHELL_BKT_COMMAND} shellcheck -x -P SCRIPTDIR --format=diff ${SH_AND_BASH_SCRIPTS} | patch -p1 || (shellcheck --version && false)
endif
endif # ifeq (,${SH_AND_BASH_SCRIPTS})
shell-style-check:
ifeq (,${SH_AND_BASH_SCRIPTS})
	@:
else
ifeq (,${SHFMT_EXISTS})
	@echo "skipping shfmt because it is not installed"
else
	@${SHELL_BKT_COMMAND} ${PLUME_SCRIPTS}/cronic shfmt -d -i 2 -ci -bn -sr ${SH_AND_BASH_SCRIPTS} || (shfmt --version && false)
endif
ifeq (,${SHELLCHECK_EXISTS})
	@echo "skipping shellcheck because it is not installed"
else
	@${SHELL_BKT_COMMAND} ${PLUME_SCRIPTS}/cronic shellcheck -x -P SCRIPTDIR --format=gcc ${SH_AND_BASH_SCRIPTS} || (shellcheck --version && false)
endif
endif # ifeq (,${SH_AND_BASH_SCRIPTS})
ifneq (,${SH_SCRIPTS})
ifeq (,$(wildcard ${PLUME_SCRIPTS}/checkbashisms))
	@make --quiet -C ${PLUME_SCRIPTS} checkbashisms
endif
	@${SHELL_BKT_COMMAND} ${PLUME_SCRIPTS}/cronic ${PLUME_SCRIPTS}/checkbashisms -l ${SH_SCRIPTS}
endif
showvars::
	@echo "SH_SCRIPTS=${SH_SCRIPTS}"
	@echo "BASH_SCRIPTS=${BASH_SCRIPTS}"
ifneq (,${SH_AND_BASH_SCRIPTS})
	@echo "SHFMT_EXISTS=${SHFMT_EXISTS}"
ifneq (,${SHFMT_EXISTS})
	shfmt --version
endif
	@echo "UV_EXISTS=${UV_EXISTS}"
ifneq (,${UV_EXISTS})
	uv --version
endif
	@echo "BKT_EXISTS=${BKT_EXISTS}"
ifneq (,${BKT_EXISTS})
	bkt --version
	@echo "SHELL_BKT_COMMAND=${SHELL_BKT_COMMAND}"
endif
	@echo "SHELLCHECK_EXISTS=${SHELLCHECK_EXISTS}"
ifneq (,${SHELLCHECK_EXISTS})
	shellcheck --version | head -2
endif
endif


## YAML
.PHONY: yaml-style-fix yaml-style-check
style-fix: yaml-style-fix
style-check: yaml-style-check
# Any file ending with ".yaml" or ".yml".
YAML_FILES   := $(filter-out ${CODE_STYLE_FILTER_OUT} ${CODE_STYLE_FILTER_OUT_USER}, $(shell grep -r -l --include='*.yaml' --include='*.yml' ${CODE_STYLE_EXCLUSIONS} ${CODE_STYLE_EXCLUSIONS_USER} '^' .))
ifneq (,${YAML_FILES})
# YAML linters are listed in order of increasing precedence.
YAMLLINT_EXISTS := $(shell if yamllint --version > /dev/null 2>&1; then echo "yes"; fi)
ifneq (,${YAMLLINT_EXISTS})
YAMLLINT := yamllint
endif
ifneq (,${UV_EXISTS})
PYYAMLLNT_EXISTS_UV := $(shell if uv run yamllint --version > /dev/null 2>&1; then echo "yes"; fi)
ifdef PYYAMLLNT_EXISTS_UV
YAMLLINT := uv run yamllint
endif
PYYAMLLNT_EXISTS_UVX := $(shell if uvx yamllint --version > /dev/null 2>&1; then echo "yes"; fi)
ifdef PYYAMLLNT_EXISTS_UVX
YAMLLINT := uvx yamllint
endif
endif # ifneq (,${UV_EXISTS})
endif # ifneq (,${YAML_FILES})
yaml-style-fix:
ifeq (,${YAML_FILES})
	@:
else
	@:
endif
yaml-style-check:
ifeq (,${YAML_FILES})
	@:
else
ifeq (,${YAMLLINT})
	@echo "skipping yamllint because it is not installed"
else
	@${PLUME_SCRIPTS}/cronic ${YAMLLINT} -c ${PLUME_SCRIPTS}/.yamllint.yaml --format parsable ${YAML_FILES} || (${YAMLLINT} --version && false)
endif
endif # ifeq (,${YAML_FILES})
showvars::
	@echo "YAML_FILES=${YAML_FILES}"
	@echo "YAMLLINT=${YAMLLINT}"
ifneq (,${YAMLLINT})
	${YAMLLINT} --version
endif


endif # ifdef CODE_STYLE_DISABLE


plume-scripts-update update-plume-scripts:
	@${PLUME_SCRIPTS}/cronic git -C ${PLUME_SCRIPTS} pull -q --ff-only