pyproject.toml

# ### CURLYLINT configuration
#
# ``curlylint`` is run through ``pre-commit`` and may be run manually using
# ``make util/lint/curlylint``.
#
# It does require *opt-in* to the actual rules.
[tool.curlylint.rules]
aria_role = true
html_has_lang = true
# Require all ``<img>`` tags to have the ``alt`` attribute (even empty).
image_alt = true
# use 2 spaces for indentation.
# NOTE: This must be synchronized with ``.editorconfig``.
# TODO: Seems broken atm, see https://github.com/thibaudcolas/curlylint/issues/6
#indent = 2
# allow users to zoom
meta_viewport = true
# don't use the ``autofocus`` attribute on any element
no_autofocus = true
# Don't use positive values for ``tabindex`` attributes
tabindex_no_positive = true


# ### DJLINT configuration
#
# ``djlint`` is run through ``pre-commit`` and may be run manually using
# ``make util/lint/djlint``.

[tool.djlint]
# H017: Tags should be self-closing, which is not true for void tags in HTML5
ignore = "H017"

# https://www.djlint.com/docs/configuration/#per_file_ignores
[tool.djlint.per-file-ignores]
# ignore recommendation to add meta description / keywords. These are provided
# using ``theme/mischback/seo.html``.
"theme/mischback/base.html" = "H030,H031"


# ### ISORT configuration
#
# ``isort`` us run through ``pre-commit`` and may be run manually using
# ``make util/lint/isort``.
#
# Very basic configuration, as this project is not really focussed on providing
# Python source code.
[tool.isort]
profile            = "black"
combine_as_imports = true
default_section    = "THIRDPARTY"
known_sphinx       = "sphinx"
sections           = [
  "FUTURE",
  "STDLIB",
  "SPHINX",
  "THIRDPARTY",
  "FIRSTPARTY",
  "LOCALFOLDER"
]
import_heading_stdlib      = "Python imports"
import_heading_sphinx      = "Sphinx imports"
import_heading_thirdparty  = "external imports"
import_heading_firstparty  = "app imports"
import_heading_localfolder = "local imports"


# ### TOX configuration
#
# ``tox`` is run to manage different virtual environments for different tasks.
# It is **not** used for its main purpose of running tests with different
# environments.
#
# Please note that ``tox`` >= 4.1 will support ``pyproject.toml`` natively, so
# this configuration will have to be adjusted, probably heavily.
#
# FIXME: #49
#        The ``pre-processing`` environment is no longer used for SCSS
#        compilation but is still referencing the wrapper script.
#        The environment may be re-used for other pre-processing task, e.g.
#        the font subsetting, and is kept for reference.
[tool.tox]
legacy_tox_ini = """
[tox]
minversion = 3.26.0

[testenv:sphinx]
basepython = python3
deps =
  -r {toxinidir}/requirements/sphinx.txt
envdir = {toxworkdir}/sphinx
setenv =
  PYTHONDONTWRITEBYTECODE=1
passenv = CI
skip_install = true
commands =
  {posargs:sphinx-build --version}

[testenv:pre-commit]
basepython = python3
deps =
  -r {toxinidir}/requirements/pre-commit.txt
envdir = {toxworkdir}/pre-commit
setenv =
  PYTHONDONTWRITEBYTECODE=1
passenv = SSH_AUTH_SOCK
skip_install = true
commands =
  {posargs:pre-commit run}

[testenv:pip-tools]
basepython = python3
deps =
  -r {toxinidir}/requirements/pip-tools.txt
envdir = {toxworkdir}/pip-tools
setenv =
  PYTHONDONTWRITEBYTECODE=1
skip_install = true
commands =
  pip-compile --resolver=backtracking {posargs}

[testenv:image-processing]
basepython = python3
deps =
  -r {toxinidir}/requirements/image-processing.txt
envdir = {toxworkdir}/image-processing
setenv =
  PYTHONDONTWRITEBYTECODE=1
skip_install = true
commands =
  {posargs:{toxinidir}/util/process-image.py}

[testenv:pre-processing]
basepython = python3
deps =
  -r {toxinidir}/requirements/pre-processing.txt
envdir = {toxworkdir}/pre-processing
setenv =
  PYTHONDONTWRITEBYTECODE=1
skip_install = true
commands =
  {posargs:{toxinidir}/util/compile-sass.py}

[testenv:post-processing]
basepython = python3
deps =
  -r {toxinidir}/requirements/post-processing.txt
envdir = {toxworkdir}/post-processing
setenv =
  PYTHONDONTWRITEBYTECODE=1
skip_install = true
commands =
  {posargs:{toxinidir}/util/prettify-html.py}
"""