From: Aleš Mrázek <ales.mrazek@nic.cz>
Date: Fri, 5 Dec 2025 09:58:41 +0000 (+0100)
Subject: pyproject.toml: better naming for poe tasks
X-Git-Tag: v6.1.0~9^2~5
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=aadf53db4b5d1b8a553c44f39e25fbf0238fd288;p=thirdparty%2Fknot-resolver.git

pyproject.toml: better naming for poe tasks
---

diff --git a/pyproject.toml b/pyproject.toml
index 503064ff3..23d1a7c9c 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -73,22 +73,25 @@ kresctl = 'knot_resolver.client.main:main'
 knot-resolver = 'knot_resolver.manager.main:main'
 
 [tool.poe.tasks]
-# tasks runed through scripts located in 'scripts/poe-tasks/'
-configure = { cmd = "scripts/poe-tasks/configure", help = "(Re)configure Meson build directory" }
-run = { cmd = "scripts/poe-tasks/run", help = "Run Knot Resolver" }
-run-debug = { cmd = "scripts/poe-tasks/run-debug", help = "Debug Knot Resolver with debugpy" }
-doc = { cmd = "scripts/poe-tasks/doc", help = "Create Knot Resolver HTML documentation" }
-schema = { cmd = "scripts/poe-tasks/schema", help = "Generate a JSON schema of the Knot Resolver configuration"}
-test = { cmd = "scripts/poe-tasks/test", help = "Run pytest unit tests" }
-lint = { cmd = "scripts/poe-tasks/lint", help = "Run static code analysis (Ruff) and check typing (Mypy)" }
-check = { cmd = "scripts/poe-tasks/check", help = "Check that all dependencies are properly installed and generated files are not behind project." }
-examples = { cmd = "scripts/poe-tasks/examples", help = "Validate all configuration examples using 'kresctl validate' utility" }
-gen-constantspy = { cmd = "scripts/poe-tasks/gen-constantspy", help = "Generate 'constants.py' module using Meson configured options" }
-gen-setuppy = { cmd = "scripts/poe-tasks/gen-setuppy", help = "Generate 'setup.py' file for backwards compatibility" }
-format = { cmd = "scripts/poe-tasks/format", help = "Check and fix code formatting using Ruff." }
+# Tasks to configure, build and run
+configure = { cmd = "scripts/poe-tasks/configure", help = "(Re)configure Meson build directory." }
+run = { cmd = "scripts/poe-tasks/run", help = "Run Knot Resolver." }
+run-debug = { cmd = "scripts/poe-tasks/run-debug", help = "Debug Knot Resolver with debugpy." }
 kresctl = { cmd = "scripts/poe-tasks/kresctl", help="Run kresctl utility" }
-clean = { cmd = "scripts/poe-tasks/clean", help="Cleanup build directories and files" }
-test-migrate = { cmd = "scripts/poe-tasks/test-migrate", help = "Migrate testing configuration using 'kresctl migrate' utility and validate it" }
+docs = { cmd = "scripts/poe-tasks/docs", help = "Build Knot Resolver's HTML documentation." }
+# Tasks to generate files
+gen-constantspy = { cmd = "scripts/poe-tasks/gen-constantspy", help = "Generate 'constants.py' module using Meson configured options." }
+gen-schema = { cmd = "scripts/poe-tasks/gen-schema", help = "Generate a JSON schema of Knot Resolver's declarative configuration."}
+gen-setuppy = { cmd = "scripts/poe-tasks/gen-setuppy", help = "Generate 'setup.py' file for backwards compatibility." }
+# Tasks to fix, check and test
+fix-format = { cmd = "scripts/poe-tasks/fix-format", help = "Check and fix code formatting using Ruff." }
+check-code = { cmd = "scripts/poe-tasks/check-code", help = "Check code format, run static code analysis (Ruff) and typing checker (Mypy)." }
+check-files = { cmd = "scripts/poe-tasks/check-files", help = "Check that all dependencies are properly installed and generated files are not behind project." }
+test-unit = { cmd = "scripts/poe-tasks/test-unit", help = "Run pytest unit tests." }
+test-examples = { cmd = "scripts/poe-tasks/test-examples", help = "Validate all configuration examples using 'kresctl validate' utility." }
+test-migrate = { cmd = "scripts/poe-tasks/test-migrate", help = "Migrate testing configuration using 'kresctl migrate' utility and validate it." }
+# Other tasks
+clean = { cmd = "scripts/poe-tasks/clean", help="Cleanup build directories and files." }
 
 [tool.ruff]
 line-length = 120