chore: drop multitool & cleanup (#474)

AlexanderLanin · web-flow · commit 36fe6b454db8 · 2026-04-09T15:24:00.000+02:00
* drop multitool and some cleanup
* drop aspect_rules_lint
* fix README
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -15,11 +15,27 @@ repos:
       - id: check-added-large-files
         args: ["--maxkb=150"]
 
-  # use LOCAL hooks for python tooling so versions come from the virtualenv
+  - repo: https://github.com/rhysd/actionlint
+    rev: v1.7.11
+    hooks:
+      - id: actionlint
+        args:
+          # Disable shellcheck and pyflakes for now, to enforce consistent behavior.
+          - -shellcheck=
+          - -pyflakes=
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.9
+    hooks:
+      - id: ruff-check
+        args: [ --fix ]
+      - id: ruff-format
+
+  # Note: this is super slow, therefore it is last
   - repo: local
     hooks:
-      - id: Linter Scripts
-        name: Run linter script
-        entry: ./scripts/run-linters.sh
-        language: unsupported_script
+      - id: BasedPyright
+        name: BasedPyright
+        entry: bash -c 'bazel run //:ide_support && .venv_docs/bin/python3 -m basedpyright'
+        language: system
         pass_filenames: false
diff --git a/MODULE.bazel b/MODULE.bazel
@@ -12,11 +12,7 @@
 # *******************************************************************************
 
 # Versioning is handled by GitHub Releases.
-# Here we always keep "0.0.0" to indicate that.
-module(
-    name = "score_docs_as_code",
-    version = "0.0.0",
-)
+module(name = "score_docs_as_code")
 
 ###############################################################################
 #
@@ -53,13 +49,6 @@ use_repo(pip, "docs_as_code_hub_env")
 bazel_dep(name = "aspect_rules_py", version = "1.4.0")
 bazel_dep(name = "buildifier_prebuilt", version = "8.2.0.2")
 
-###############################################################################
-#
-# Generic linting and formatting rules
-#
-###############################################################################
-bazel_dep(name = "aspect_rules_lint", version = "1.5.3")
-
 # PlantUML for docs
 bazel_dep(name = "rules_java", version = "8.15.1")
 
@@ -86,17 +75,4 @@ http_file(
 # Note: requirements were last aligned with 1.2.0,
 # the switch to 1.3.1 is purely to drop the dependency on docs-as-code 1.x.
 bazel_dep(name = "score_process", version = "1.5.1")
-
-# Add Linter
-bazel_dep(name = "rules_multitool", version = "1.9.0")
 bazel_dep(name = "score_tooling", version = "1.2.0")
-
-multitool_root = use_extension("@rules_multitool//multitool:extension.bzl", "multitool")
-use_repo(multitool_root, "actionlint_hub", "multitool", "ruff_hub", "shellcheck_hub", "yamlfmt_hub")
-
-register_toolchains(
-    "@ruff_hub//toolchains:all",
-    "@actionlint_hub//toolchains:all",
-    "@shellcheck_hub//toolchains:all",
-    "@yamlfmt_hub//toolchains:all",
-)
diff --git a/MODULE.bazel.lock b/MODULE.bazel.lock
diff --git a/README.md b/README.md
@@ -31,14 +31,7 @@ pre-commit install
 pre-commit install --hook-type pre-push
 ```
 
-Execute the pre-commit manually via `pre-commit`
-
-### Format your documentation with:
-
-```bash
-bazel test //src:format.check
-bazel run //src:format.fix
-```
+Execute the pre-commit manually via `pre-commit run` or `pre-commit run --all-files` to run it on all files.
 
 ### Find & fix missing copyright
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,27 +1,76 @@
 # This file is at the root level, as it applies to all Python code,
 # not only to docs or to tools.
 [tool.pyright]
-extends = "bazel-bin/ide_support.runfiles/score_tooling+/python_basics/pyproject.toml"
+# Standard mode + some additional warnings as defined below
+typeCheckingMode = "standard"
+
+# Warn if function parameters lack type annotations
+reportMissingParameterType = "warning"
+
+# Warn if generic types (e.g. List) are missing type args
+reportMissingTypeArgument = "warning"
+
+# Warn when using members marked as private (e.g. _log)
+reportPrivateUsage = "warning"
+
+# Warn when variable type can't be inferred or is 'Any'
+reportUnknownVariableType = "warning"
+
+# Warn about declared but unused variables
+reportUnusedVariable = "warning"
 
 exclude = [
-    "**/__pycache__",
-    "**/.*",
-    "**/bazel-*",
-    ".venv*/**",
+  "**/__pycache__",
+  "**/.*",
+  "**/bazel-*",
+  ".venv*/**",
 ]
 
 venvPath = "."
 venv = ".venv_docs"
 
 [tool.ruff]
-extend = "bazel-bin/ide_support.runfiles/score_tooling+/python_basics/pyproject.toml"
+target-version = "py312"
+
+[tool.ruff.lint]
+select = [
+  "E",    # pycodestyle (PEP8)
+  "F",    # pyflakes (undefined vars, unused imports)
+  "I",    # isort (import sorting)
+  "B",    # flake8-bugbear (likely bugs)
+  "C90",  # mccabe (complexity checks)
+  "UP",   # pyupgrade (modern Python 3.12+ features)
+  "SIM",  # flake8-simplify (simplifies code patterns)
+  "RET"   # flake8-return (consistent return statements)
 
-extend-exclude = [
-    "**/__pycache__",
-    "/.*",
-    "bazel-*",
-    ".venv*/**",
+  # FIXME:
+  # "W",    # pycodestyle warnings
+  # "N",    # pep8-naming
+  # "C4",   # flake8-comprehensions
+  # "TCH",  # flake8-type-checking
+  # "TID",  # flake8-tidy-imports
+  # "RUF",  # ruff-specific rules
+  # "PT",   # flake8-pytest-style
+  # "PIE",  # flake8-pie
+  # "T20",  # flake8-print
+  # "RSE",  # flake8-raise
+]
+ignore = [
+  "E501",   # line too long (handled by formatter)
+  "T201",   # allow print() globally for CLI friendliness
+  "RET505", # opinionated decision: allow else after if-return for readability
 ]
+
+
+[tool.ruff.lint.isort]
+combine-as-imports = true
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = [
+  "S101",  # assert used
+]
+
+
 [tool.pytest.ini_options]
 log_cli = true
 log_cli_level = "Debug"
diff --git a/scripts/README.md b/scripts/README.md
diff --git a/scripts/run-linters.sh b/scripts/run-linters.sh
diff --git a/src/BUILD b/src/BUILD
@@ -11,7 +11,6 @@
 # SPDX-License-Identifier: Apache-2.0
 # *******************************************************************************
 
-load("@aspect_rules_lint//format:defs.bzl", "format_multirun", "format_test")
 load("@aspect_rules_py//py:defs.bzl", "py_library")
 load("@rules_java//java:java_binary.bzl", "java_binary")
 load("@rules_python//python:pip.bzl", "compile_pip_requirements")
@@ -104,26 +103,3 @@ dash_license_checker(
     file_type = "requirements",
     visibility = ["//visibility:public"],
 )
-
-format_multirun(
-    name = "format.fix",
-    python = "@aspect_rules_lint//format:ruff",
-    starlark = "@buildifier_prebuilt//:buildifier",
-    visibility = [
-        "//visibility:public",
-    ],
-    yaml = "@aspect_rules_lint//format:yamlfmt",
-)
-
-format_test(
-    name = "format.check",
-    no_sandbox = True,
-    python = "@aspect_rules_lint//format:ruff",
-    starlark = "@buildifier_prebuilt//:buildifier",
-    tags = ["manual"],
-    visibility = [
-        "//visibility:public",
-    ],
-    workspace = "//:MODULE.bazel",
-    yaml = "@aspect_rules_lint//format:yamlfmt",
-)
diff --git a/src/extensions/score_metamodel/__init__.py b/src/extensions/score_metamodel/__init__.py
@@ -27,14 +27,10 @@
 # Import and re-export some types and functions for easier access
 from src.extensions.score_metamodel.metamodel_types import (
     ProhibitedWordCheck as ProhibitedWordCheck,
-)
-from src.extensions.score_metamodel.metamodel_types import (
     ScoreNeedType as ScoreNeedType,
 )
 from src.extensions.score_metamodel.yaml_parser import (
     default_options as default_options,
-)
-from src.extensions.score_metamodel.yaml_parser import (
     load_metamodel_data as load_metamodel_data,
 )
 from src.helper_lib import config_setdefault
diff --git a/src/extensions/score_source_code_linker/__init__.py b/src/extensions/score_source_code_linker/__init__.py
@@ -253,9 +253,7 @@ def build_and_save_repo_scl_file(outdir: Path):
 
 
 def setup_repo_linker(app: Sphinx, _: BuildEnvironment):
-    grouped_cache = get_cache_filename(
-        app.outdir, "score_repo_grouped_scl_cache.json"
-    )
+    grouped_cache = get_cache_filename(app.outdir, "score_repo_grouped_scl_cache.json")
     grouped_cache_exists = grouped_cache.exists()
     # TODO this cache should be done via Bazel
     if (
@@ -301,7 +299,7 @@ def setup_once(app: Sphinx):
 def setup(app: Sphinx) -> dict[str, str | bool]:
     # Esbonio will execute setup() on every iteration.
     # setup_once will only be called once.
-    app.add_config_value("KNOWN_GOOD_JSON", default="",rebuild="env",types=str)
+    app.add_config_value("KNOWN_GOOD_JSON", default="", rebuild="env", types=str)
     setup_once(app)
 
     return {
diff --git a/src/extensions/score_source_code_linker/repo_source_links.py b/src/extensions/score_source_code_linker/repo_source_links.py
@@ -93,9 +93,7 @@ def RepoSourceLinks_JSON_Decoder(
     return d
 
 
-def store_repo_source_links_json(
-    file: Path, source_code_links: list[RepoSourceLinks]
-):
+def store_repo_source_links_json(file: Path, source_code_links: list[RepoSourceLinks]):
     # After `rm -rf _build` or on clean builds the directory does not exist,
     # so we need to create it. We create any folder that might be missing
     file.parent.mkdir(exist_ok=True, parents=True)
@@ -139,9 +137,7 @@ def group_needs_by_repo(links: list[SourceCodeLinks]) -> list[RepoSourceLinks]:
 
         if repo_key not in repo_groups:
             repo_groups[repo_key] = RepoSourceLinks(
-                repo=RepoInfo(
-                    name=repo_key, hash=first_link.hash, url=first_link.url
-                )
+                repo=RepoInfo(name=repo_key, hash=first_link.hash, url=first_link.url)
             )
 
         # TODO: Add an assert that checks if needs only are
diff --git a/src/extensions/score_source_code_linker/tests/test_helpers.py b/src/extensions/score_source_code_linker/tests/test_helpers.py
@@ -393,7 +393,6 @@ def test_get_github_link_with_real_repo(git_repo: Path) -> None:
     assert hash_from_link == actual_hash
 
 
-
 def test_complete_workflow(known_good_json: Path):
     """Test complete workflow from path to GitHub link."""
 
diff --git a/src/extensions/score_source_code_linker/tests/test_repo_source_link_integration.py b/src/extensions/score_source_code_linker/tests/test_repo_source_link_integration.py
@@ -358,7 +358,7 @@ def test_repo_cache_json_format(
         assert len(raw_json) > 0
 
         # Check first repo structure
-        first_repo = raw_json[0]
+        first_repo = raw_json[0]  # pyright: ignore[reportUnknownVariableType]
         assert "repo" in first_repo
         assert "needs" in first_repo
         assert "name" in first_repo["repo"]
@@ -367,9 +367,9 @@ def test_repo_cache_json_format(
 
         # Check that needlinks don't have metadata
         if first_repo["needs"]:
-            first_need = first_repo["needs"][0]
+            first_need = first_repo["needs"][0]  # pyright: ignore[reportUnknownVariableType]
             if "links" in first_need and first_need["links"].get("CodeLinks"):
-                codelink = first_need["links"]["CodeLinks"][0]
+                codelink = first_need["links"]["CodeLinks"][0]  # pyright: ignore[reportUnknownVariableType]
                 assert "repo_name" not in codelink, (
                     "CodeLinks should not contain repo_name metadata"
                 )
diff --git a/src/extensions/score_source_code_linker/xml_parser.py b/src/extensions/score_source_code_linker/xml_parser.py
@@ -310,7 +310,7 @@ def build_test_needs_from_files(
     tcns: list[DataOfTestCase] = []
     for file in xml_paths:
         # Last value can be ignored. The 'is_valid' function already prints infos
-        test_cases, tests_missing_all_props,_ = read_test_xml_file(file)
+        test_cases, tests_missing_all_props, _ = read_test_xml_file(file)
         non_prop_tests = ", ".join(n for n in tests_missing_all_props)
         if non_prop_tests:
             logger.info(f"Tests missing all properties: {non_prop_tests}")
diff --git a/src/helper_lib/test_helper_lib.py b/src/helper_lib/test_helper_lib.py
@@ -30,7 +30,7 @@
 class _FakeConfig:
     """Minimal stand-in for sphinx.config.Config."""
 
-    def __init__(self, raw: dict[Any,Any]):
+    def __init__(self, raw: dict[Any, Any]):
         self._raw_config = raw
 
 
diff --git a/src/requirements.in b/src/requirements.in
@@ -30,5 +30,5 @@ needs-config-writer == 0.2.4
 # use this for a specific commit for fast development iterations
 # needs-config-writer @ https://github.com/useblocks/needs-config-writer/archive/032a5f8.zip
 
-# Need this to enable non bazel exectuion
+# Need this to enable non bazel execution
 bazel-runfiles
diff --git a/src/tests/test_consumer.py b/src/tests/test_consumer.py
