pyproject.toml

[tool.poetry]
name = "mkdocs-file-filter-plugin"
version = "0.0.0"
description = 'A MkDocs plugin that lets you exclude/include docs files using globs, regexes, gitignore-style file and Markdown/Frontmatter tags metadata.'
authors = [
  "Dariusz Porowski <3431813+dariuszporowski@users.noreply.github.com>",
]
homepage = "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin"
repository = "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin"
documentation = "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/blob/main/README.md"
readme = "README.md"
license = "MIT"
keywords = [
  "mkdocs",
  "plugin",
  "exclude",
  "include",
  "glob",
  "regex",
  "gitignore",
  "markdown",
  "frontmatter",
  "metadata",
  "tags",
]
classifiers = [
  "Development Status :: 3 - Alpha",
  "Programming Language :: Python",
  "Programming Language :: Python :: 3",
  "Programming Language :: Python :: 3.9",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: 3 :: Only",
  "Operating System :: OS Independent",
  "License :: OSI Approved :: MIT License",
  "Intended Audience :: Developers",
  "Intended Audience :: Information Technology",
  "Topic :: Documentation",
]
packages = [{ include = "mkdocs_file_filter_plugin" }]

[tool.poetry.urls]
Issues = "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/issues"
History = "https://github.com/DariuszPorowski/mkdocs-file-filter-plugin/releases"

[tool.poetry.plugins."mkdocs.plugins"]
file-filter = "mkdocs_file_filter_plugin.plugin:FileFilter"
file_filter = "mkdocs_file_filter_plugin.plugin:FileFilter"

[tool.poetry.dependencies]
python = ">=3.9,<4.0"
mkdocs = "^1.6.0"
igittigitt = "^2.1.4"
schema = "^0.7.5"
pyyaml = "^6.0.1"
pyyaml-env-tag = "^0.1"

[tool.poetry.group.dev.dependencies]
mkdocs-material = "^9.5.29"
mkdocs-awesome-pages-plugin = "^2.9.2"
mkdocs-exclude-unused-files = "^1.4.0"
isort = "^5.13.2"
black = "^24.4.2"
pylint = "^3.2.5"
flake8 = "^7.1.0"
mypy = "^1.10.1"
mypy-extensions = "^1.0.0"
pydocstyle = "^6.3.0"
bandit = "^1.7.9"
pytest = "^8.2.2"
pytest-cov = "^5.0.0"
pre-commit = "^3.7.1"
ruff = "^0.5.2"
pyupgrade = "^3.16.0"
setuptools = ">=70.3,<72.0"

[tool.poetry.plugins."poetry-plugin-up"]
# https://github.com/MousaZeidBaker/poetry-plugin-up#usage

[tool.poetry-dynamic-versioning]
# https://github.com/mtkennerly/poetry-dynamic-versioning#configuration
enable = true
style = "semver"
vcs = "git"
bump = true

[tool.poe.tasks]
# https://github.com/nat-n/poethepoet
test = "poetry run pytest -c pyproject.toml --junit-xml=report-junit.xml --cov-report term-missing --cov-report=html --cov-report=xml --cov-report=lcov --cov=mkdocs_file_filter_plugin tests/"
install = "poetry install --without=dev --verbose"
build = "poetry build --verbose"
isort-check = "poetry run isort --settings-path pyproject.toml --check-only ."
isort-fix = "poetry run isort --settings-path pyproject.toml"
black-check = "poetry run black --config pyproject.toml --check ."
black-fix = "poetry run black --config pyproject.toml ."
pylint = "poetry run pylint --rcfile pyproject.toml ."
flake8 = "poetry run flake8 --count ."
mypy = "poetry run mypy --config-file pyproject.toml --install-types --non-interactive ."
mypy-pre-commit = "poetry run mypy --config-file pyproject.toml --install-types --non-interactive"
pydocstyle = "poetry run pydocstyle --config pyproject.toml --count ."
bandit = "poetry run bandit --configfile pyproject.toml --recursive ."
bandit-pre-commit = "poetry run bandit --configfile pyproject.toml --recursive"
ruff-check = "poetry run ruff check --config pyproject.toml --no-fix ."
ruff-fix = "poetry run ruff check --config pyproject.toml --fix ."
pre-commit-update = "poetry run pre-commit autoupdate"
pre-commit-all = "poetry run pre-commit run --all-files"
pyupgrade = "poetry run pyupgrade --py39-plus"

[tool.poe.tasks.clean-win]
shell = "Remove-Item -Path @('dist', 'build', 'site', 'htmlcov', 'coverage.lcov', 'coverage.xml', '.coverage') -Recurse -Force -ErrorAction SilentlyContinue"
interpreter = "pwsh"

[tool.poe.tasks.clean-linux]
shell = "rm -rf dist build site htmlcov coverage.lcov coverage.xml .coverage"
interpreter = "posix"

[tool.isort]
# https://pycqa.github.io/isort/docs/configuration/options.html
py_version = 39
profile = "black"

[tool.black]
# https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#configuration-format
target-version = ["py39"]
line-length = 120

[tool.pylint]
# https://pylint.readthedocs.io/en/latest/user_guide/configuration/all-options.html
py-version = "3.9"
ignore = [".venv"]
max-line-length = 120
recursive = true

[tool.pydocstyle]
# https://www.pydocstyle.org/en/stable/usage.html#available-options
convention = "google"

[tool.mypy]
# https://mypy.readthedocs.io/en/stable/config_file.html
python_version = "3.9"
exclude = ["setup.py", ".venv"]
disallow_any_unimported = true
show_column_numbers = true
show_error_context = true
pretty = true
explicit_package_bases = true
ignore_missing_imports = true
follow_imports = "silent"

[tool.bandit]
# https://bandit.readthedocs.io/en/latest/config.html#bandit-settings
exclude_dirs = [".venv"]

[tool.bandit.assert_used]
skips = ["*/test_*.py"]

[tool.ruff]
# https://docs.astral.sh/ruff/settings/
# select = ["ALL"]

select = [
  "F",
  "E",
  "W",
  "C90",
  "I",
  "N",
  "D",
  "UP",
  "YTT",
  "ANN",
  "S",
  "BLE",
  "FBT",
  "B",
  "A",
  "COM",
  "C4",
  "DTZ",
  "T10",
  "DJ",
  "EM",
  "EXE",
  "ISC",
  "ICN",
  "G",
  "INP",
  "PIE",
  "T20",
  "PYI",
  "PT",
  "Q",
  "RSE",
  "RET",
  "SLF",
  "SIM",
  "TID",
  "TCH",
  "INT",
  "ARG",
  "PTH",
  "ERA",
  "PD",
  "PGH",
  "PL",
  "PLC",
  "PLE",
  "PLR",
  "PLW",
  "TRY",
  "NPY",
  "RUF",
]
line-length = 120
target-version = "py39"
ignore = ["ANN101"]
fix = false
force-exclude = true
output-format = "github"
show-fixes = true

[tool.ruff.pycodestyle]
max-doc-length = 120

[tool.ruff.pydocstyle]
# Use Google-style docstrings.
convention = "google"

[tool.ruff.per-file-ignores]
"tests/*" = ["S101"]

[tool.autopep8]
max_line_length = 120
in-place = true
recursive = true
aggressive = 3
exclude_globs = [".venv"]

[tool.pyright]
# https://microsoft.github.io/pyright/#/configuration
venvPath = ".venv"

[tool.pytest.ini_options]
addopts = ["--import-mode=importlib"]
junit_family = "xunit2"
junit_log_passing_tests = true
junit_logging = "all"

[build-system]
requires = ["poetry-core>=1.8.1", "poetry-dynamic-versioning"]
build-backend = "poetry_dynamic_versioning.backend"