Add pre-commit feature to devcontainer

It supports to spot easy to detect issues before committing code and
reduce the number of failed CI runs and review cycles.

Author: lurtz

src/s-core-devcontainer/.devcontainer/devcontainer-lock.json

@@ -5,6 +5,11 @@
       "resolved": "ghcr.io/devcontainers-community/features/llvm@sha256:4f464ab97a59439286a55490b55ba9851616f6f76ac3025e134127ac08ad79e2",
       "integrity": "sha256:4f464ab97a59439286a55490b55ba9851616f6f76ac3025e134127ac08ad79e2"
     },
+    "ghcr.io/devcontainers-extra/features/pre-commit:2": {
+      "version": "2.0.18",
+      "resolved": "ghcr.io/devcontainers-extra/features/pre-commit@sha256:6e0bb2ce80caca1d94f44dab5d0653d88a1c00984e590adb7c6bce012d0ade6e",
+      "integrity": "sha256:6e0bb2ce80caca1d94f44dab5d0653d88a1c00984e590adb7c6bce012d0ade6e"
+    },
     "ghcr.io/devcontainers/features/common-utils": {
       "version": "2.5.4",
       "resolved": "ghcr.io/devcontainers/features/common-utils@sha256:00fd45550f578d9d515044d9e2226e908dbc3d7aa6fcb9dee4d8bdb60be114cf",

src/s-core-devcontainer/.devcontainer/devcontainer.json

@@ -37,6 +37,9 @@
                 "rustfmt"
             ]
         },
+        "ghcr.io/devcontainers-extra/features/pre-commit:2": {
+            "version": "4.5.1"
+        },
         "./s-core-local": {}
     },
     "overrideFeatureInstallOrder": [
@@ -45,10 +48,10 @@
         "ghcr.io/devcontainers/features/common-utils",
         "ghcr.io/devcontainers-community/features/llvm",
         "ghcr.io/devcontainers/features/rust",
+        "ghcr.io/devcontainers-extra/features/pre-commit",
         "./s-core-local"
     ],
     "remoteUser": "vscode",
-
     "customizations": {
         "vscode": {
             "extensions": [

src/s-core-devcontainer/.devcontainer/s-core-local/devcontainer-feature.json

@@ -8,7 +8,8 @@
         // The repos in S-CORE may use different Bazel versions. This ensures that the required version is installed.
         // Should be removed once we provide versions of the devcontainer.
         "Install matching Bazel version": "bash /devcontainer/features/s-core-local/install_matching_bazel_version.sh",
-        "Setup persistent bash history": "bash /devcontainer/features/s-core-local/setup_command_history.sh"
+        "Setup persistent bash history": "bash /devcontainer/features/s-core-local/setup_command_history.sh",
+        "Enable pre-commit hooks": "bash /devcontainer/features/s-core-local/enable_pre_commit_hooks.sh"
     },
     "mounts": [
         {

src/s-core-devcontainer/.devcontainer/s-core-local/enable_pre_commit_hooks.sh

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+PRE_COMMIT_CONFIG_FILE=".pre-commit-config.yaml"
+
+if [[ -f "${PRE_COMMIT_CONFIG_FILE}" ]]
+then
+    echo "Pre-commit configuration found (${PRE_COMMIT_CONFIG_FILE})"
+    $PIPX_BIN_DIR/pre-commit install
+else
+    echo "No pre-commit configuration found (${PRE_COMMIT_CONFIG_FILE})"
+    echo "Skipping pre-commit hook's installation"
+fi

src/s-core-devcontainer/test-project/test.sh

@@ -19,6 +19,9 @@ check "validate cargo clippy is working and has the correct version" bash -c "ca
 check "validate rustfmt is working and has the correct version" bash -c "rustfmt --version | grep '1.8.0-stable'"
 check "validate rust-analyzer is working and has the correct version" bash -c "rust-analyzer --version | grep '1.83.0'"
 
+# pre-commit, it is available via $PATH in login shells, but not in non-login shells
+check "validate pre-commit is working and has the correct version" bash -c "$PIPX_BIN_DIR/pre-commit --version | grep '4.5.1'"
+
 # Tests from the local s-core-local feature
 source /devcontainer/features/s-core-local/tests/test_default.sh