Add pre-commit config & upgrade devcontainer

.devcontainer/devcontainer.json

@@ -1,5 +1,5 @@
 {
     "name": "eclipse-s-core",
-    "image": "ghcr.io/eclipse-score/devcontainer:1.0.0",
+    "image": "ghcr.io/eclipse-score/devcontainer:v1.2.0",
     "updateContentCommand": "bazel run //:ide_support"
 }

.github/actions/link-check/link_parser.py

@@ -51,9 +51,7 @@ def generate_markdown_table(broken_links: list[BrokenLink]) -> str:
     table += "|----------|-------------|-----------|\n"
 
     for link in broken_links:
-        table += (
-            f"| {link.location} | {link.line_nr} | {link.reasoning} |\n"
-        )
+        table += f"| {link.location} | {link.line_nr} | {link.reasoning} |\n"
 
     return table
 
@@ -62,7 +60,7 @@ def generate_issue_body(broken_links: list[BrokenLink]) -> str:
     markdown_table = generate_markdown_table(broken_links)
     return f"""
 # Broken Links Report.
-**Last updated: {datetime.now().strftime('%d-%m-%Y %H:%M')}**
+**Last updated: {datetime.now().strftime("%d-%m-%Y %H:%M")}**
 
 The following broken links were detected in the documentation:
 {markdown_table}
@@ -73,7 +71,8 @@ def generate_issue_body(broken_links: list[BrokenLink]) -> str:
 
 ---
 This issue will be auto updated regularly if link issues are found.
-You may close it if you wish, though a new one will be created if link issues are still present.
+You may close it if you wish.
+Though a new one will be created if link issues are still present.
 
 """
 
@@ -85,11 +84,11 @@ def strip_ansi_codes(text: str) -> str:
 
 
 if __name__ == "__main__":
-    argparse = argparse.ArgumentParser(
+    arg = argparse.ArgumentParser(
         description="Parse broken links from Sphinx log and generate issue body."
     )
-    argparse.add_argument("logfile", type=str, help="Path to the Sphinx log file.")
-    args = argparse.parse_args()
+    arg.add_argument("logfile", type=str, help="Path to the Sphinx log file.")
+    args = arg.parse_args()
     with open(args.logfile) as f:
         log_content_raw = f.read()
     log_content = strip_ansi_codes(log_content_raw)

.github/workflows/consumer_test.yml

@@ -31,26 +31,29 @@ jobs:
       - name: Checkout PR
         uses: actions/checkout@v4.2.2
 
-      - name: Prepare Python
-        run: |
-          bazel run //:ide_support
 
-      - name: Prepare report directory
-        run: |
-          mkdir -p reports
+      - name: Build and run dev container task
+        uses: devcontainers/ci@v0.3
+        with:
+          cacheFrom: ghcr.io/eclipse-score/devcontainer@v1.2.0
+          push: never
+          # The pipefail ensures that non 0 exit codes inside the pytest execution get carried into the pipe
+          # & make the tests red in the end. Without this we only would check the exit code of the 'tee' command.
+          runCmd: |
+            set -euxo pipefail
+            uv venv && uv pip install -r src/requirements.txt
 
-      # The pipefail ensures that non 0 exit codes inside the pytest execution get carried into the pipe
-      # & make the tests red in the end. Without this we only would check the exit code of the 'tee' command.
-      - name: Run Consumer tests
+            mkdir -p reports
 
-        run: |
-          set -o pipefail
-          .venv_docs/bin/python -m pytest -s -v src/tests/ --repo="$CONSUMER" --junitxml="reports/${{ matrix.consumer }}.xml" | tee "reports/${{ matrix.consumer }}.log"
-        env:
-          FORCE_COLOR: "1"
-          TERM: xterm-256color
-          PYTHONUNBUFFERED: "1"
-          CONSUMER: ${{ matrix.consumer }}
+            export FORCE_COLOR="1"
+            export TERM="xterm-256color"
+            export PYTHONUNBUFFERED="1"
+            export CONSUMER="${{ matrix.consumer }}"
+            export PYTHONPATH=.
+            uv run pytest -s -v src/tests/ \
+              --repo="$CONSUMER" \
+              --junitxml="reports/${{ matrix.consumer }}.xml" \
+              | tee "reports/${{ matrix.consumer }}.log"
 
       - name: Upload consumer test report
         if: ${{ always() }}

.github/workflows/lint.yml

@@ -27,15 +27,9 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4.2.2
 
-      - name: Setup Bazel
-        uses: bazel-contrib/setup-bazel@0.15.0
+      - name: Build and run dev container task
+        uses: devcontainers/ci@v0.3
         with:
-          disk-cache: true
-          repository-cache: true
-          bazelisk-cache: true
-
-      - name: Install pre-commit
-        run: pip install pre-commit
-
-      - name: Run pre-commit checks
-        run: pre-commit run -a
+          cacheFrom: ghcr.io/eclipse-score/devcontainer
+          push: never
+          runCmd: ${PIPX_BIN_DIR}/pre-commit run -a

.github/workflows/test.yml

@@ -22,33 +22,17 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4.2.2
-      - name: Cache Bazel and pip
-        uses: actions/cache@v4
-        with:
-          path: |
-            ~/.cache/bazel
-            ~/.cache/pip
-          key: ${{ runner.os }}-test-${{ hashFiles('**/*.bazel', '**/BUILD', '**/*.bzl', 'src/requirements.txt', 'src/**/*.py') }}
 
-      - name: Setup Bazel with cache
-        uses: bazel-contrib/setup-bazel@0.15.0
+      - name: Build and run dev container task
+        uses: devcontainers/ci@v0.3
         with:
-          disk-cache: true
-          repository-cache: true
-          bazelisk-cache: true
-      - name: Run test targets
-        run: |
-          bazel run //:ide_support
-          bazel test //src/...
-
-      - name: Prepare bundled consumer report
-        if: always()
-        # Creating tests-report directory
-        # Follow Symlinks via '-L' to copy correctly
-        # Copy everything inside the 'test-reports' folder
-        run: |
-          mkdir -p tests-report
-          rsync -amL --include='*/' --include='test.xml' --include='test.log' --exclude='*' bazel-testlogs/ tests-report/
+          cacheFrom: ghcr.io/eclipse-score/devcontainer@v1.2.0
+          push: never
+          runCmd: |
+            bazel run //:ide_support
+            bazel test //src/...
+            mkdir -p tests-report
+            rsync -amL --include='*/' --include='test.xml' --include='test.log' --exclude='*' bazel-testlogs/ tests-report/
 
       - name: Upload bundled consumer report
         if: always()

.pre-commit-config.yaml

@@ -18,8 +18,52 @@ repos:
   # use LOCAL hooks for python tooling so versions come from the virtualenv
   - repo: local
     hooks:
-      - id: Linter Scripts
-        name: Run linter script
-        entry: ./scripts/run-linters.sh
-        language: unsupported_script
+      - id: ruff
+        name: ruff
+        entry: ruff check --fix
+        language: system
+        types_or: [python, pyi]
+
+      - id: ruff-format
+        name: ruff format
+        entry: ruff format
+        language: system
+        types_or: [python, pyi]
+
+      # Can not get this to run ;/
+      - id: basedpyright
+        name: basedpyright
+        entry: basedpyright
+        language: system
+        types_or: [python, pyi]
         pass_filenames: false
+
+      - id: actionlint
+        name: actionlint (container)
+        entry: actionlint
+        language: system
+        files: ^\.github/workflows/.*\.ya?ml$
+
+      - id: yamlfmt
+        name: yamlfmt (container)
+        entry: yamlfmt
+        language: system
+        types: [yaml]
+
+      - id: shellcheck
+        name: shellcheck (container)
+        entry: shellcheck
+        language: system
+        types: [shell]
+
+      - id: buildifier fix
+        name: bazel linting fix (container)
+        entry: buildifier --lint=fix
+        language: system
+        files: '(^|/)(BUILD(\.bazel)?|MODULE\.bazel|.*\.bzl)$'
+
+      - id: buildifier format
+        name: bazel formatting (container)
+        entry: buildifier
+        language: system
+        files: '(^|/)(BUILD(\.bazel)?|MODULE\.bazel|.*\.bzl)$'

pyproject.toml

@@ -1,24 +1,58 @@
 # 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"
+typeCheckingMode = "standard"
+pythonVersion = "3.12" # Keep in sync with MODULE.bazel
+
+# 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*/**",
 ]
 
 venvPath = "."
 venv = ".venv_docs"
 
 [tool.ruff]
-extend = "bazel-bin/ide_support.runfiles/score_tooling+/python_basics/pyproject.toml"
-
+#line-length=59
+target-version = "py312" # Keep in sync with MODULE.bazel
 extend-exclude = [
+    "__pycache__",
+    ".*",
+    "bazel-*",
     "**/__pycache__",
     "/.*",
-    "bazel-*",
     ".venv*/**",
 ]
+
+# Selected rules for clean code, readability, and bug prevention
+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)
+]
+
+lint.ignore = [
+    # Rules we want to ignore go in here.
+    # Always provide a comment explaining why.
+]

src/BUILD

@@ -13,6 +13,7 @@
 
 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")
 load("@score_tooling//:defs.bzl", "dash_license_checker")
 

src/extensions/BUILD

@@ -11,9 +11,7 @@
 # SPDX-License-Identifier: Apache-2.0
 # *******************************************************************************
 
-load("@aspect_rules_py//py:defs.bzl", "py_binary", "py_library")
-load("@docs_as_code_hub_env//:requirements.bzl", "all_requirements")
-load("@score_tooling//:defs.bzl", "score_py_pytest", "score_virtualenv")
+load("@aspect_rules_py//py:defs.bzl", "py_library")
 
 py_library(
     name = "score_plantuml",

src/helper_lib/__init__.py

@@ -16,7 +16,7 @@
 import sys
 from pathlib import Path
 
-from python.runfiles import Runfiles
+from runfiles import Runfiles
 from sphinx_needs.logging import get_logger
 
 LOGGER = get_logger(__name__)