Add pre-commit (#5)

* add claude support in devcontainer

* pre-commit

Author: Edwardius

.cpplint.cfg

@@ -0,0 +1,14 @@
+# Because of cpplint's config file assumptions, this can't be contained in .config/ directory
+linelength=256
+
+filter=-legal/copyright
+filter=-build/header_guard
+filter=-build/c++17
+
+# Disable all formatting checks, this is handled by clang-format
+filter=-readability/braces
+filter=-whitespace/braces
+filter=-whitespace/indent
+filter=-whitespace/newline
+filter=-whitespace/parens
+filter=-whitespace/semicolon

.devcontainer/Dockerfile

@@ -2,21 +2,26 @@
 ARG ROS_DISTRO=humble
 FROM ros:${ROS_DISTRO}-ros-base
 
-# Install only essential ROS development tools not in base image
-RUN apt-get update && apt-get install -y \
+# Install development tools not in base image
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    python3-pip \
     python3-colcon-common-extensions \
     python3-rosdep \
     openssh-client \
     curl \
     && rm -rf /var/lib/apt/lists/*
 
+# Install pre-commit
+RUN python3 -m pip install --no-cache-dir pre-commit==3.8.0
+
 # Install Node.js 20 LTS (required for Claude Code)
+SHELL ["/bin/bash", "-o", "pipefail", "-c"]
 RUN curl -fsSL https://deb.nodesource.com/setup_20.x | bash - && \
-    apt-get install -y nodejs && \
+    apt-get install -y --no-install-recommends nodejs && \
     rm -rf /var/lib/apt/lists/*
 
 # Install Claude Code CLI via npm
-RUN npm install -g @anthropic-ai/claude-code
+RUN npm install -g @anthropic-ai/claude-code@1.0.0
 
 # Initialize rosdep
 RUN rosdep init || true
@@ -29,16 +34,18 @@ ARG USERNAME
 
 SHELL ["/bin/bash", "-c"]
 COPY .env /tmp/.env
+# hadolint ignore=SC2086
 RUN source /tmp/.env && rm /tmp/.env \
     && groupadd --gid $USER_GID $USERNAME \
     && useradd --uid $USER_UID --gid $USER_GID -m $USERNAME --shell /bin/bash \
     && apt-get update \
-    && apt-get install -y sudo \
+    && apt-get install -y --no-install-recommends sudo \
     && echo $USERNAME ALL=\(ALL\) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME \
     && chmod 0440 /etc/sudoers.d/$USERNAME \
     && cp /etc/skel/.bashrc /home/$USERNAME/.bashrc \
     && cp /etc/skel/.profile /home/$USERNAME/.profile \
-    && chown $USERNAME:$USERNAME /home/$USERNAME/.bashrc /home/$USERNAME/.profile
+    && chown $USERNAME:$USERNAME /home/$USERNAME/.bashrc /home/$USERNAME/.profile \
+    && rm -rf /var/lib/apt/lists/*
 
 # Set the default user. Omit if you want to keep the default as root.
 USER $USERNAME

.devcontainer/devcontainer.json

@@ -28,5 +28,7 @@
   "workspaceFolder": "/deep_ros_ws",
   "workspaceMount": "source=${localWorkspaceFolder},target=/deep_ros_ws,type=bind",
   "containerName": "deep-ros-devcontainer",
-  "runArgs": ["--hostname=deep-devcontainer"]
+  "runArgs": [
+    "--hostname=deep-devcontainer"
+  ]
 }

.devcontainer/gen_env.sh

@@ -1,5 +1,18 @@
 #!/bin/bash
 
+# Copyright (c) 2025-present WATonomous. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 set -e
 
 # Check if ROS_DISTRO was provided as argument
@@ -12,10 +25,12 @@ ROS_DISTRO="$1"
 ENV_FILE=".devcontainer/.env"
 
 echo "Generating $ENV_FILE ..."
-echo "USER=$(whoami)" > "$ENV_FILE"
-echo "USER_UID=$(id -u)" >> "$ENV_FILE"
-echo "USER_GID=$(id -g)" >> "$ENV_FILE"
-echo "ROS_DISTRO=$ROS_DISTRO" >> "$ENV_FILE"
+{
+    echo "USER=$(whoami)"
+    echo "USER_UID=$(id -u)"
+    echo "USER_GID=$(id -g)"
+    echo "ROS_DISTRO=$ROS_DISTRO"
+} >> "$ENV_FILE"
 
 echo "Done. Contents:"
 cat "$ENV_FILE"

.pre-commit-config.yaml

@@ -0,0 +1,112 @@
+---
+# WATonomous Pre-commit Config
+
+# See https://pre-commit.com for more information on these settings
+repos:
+  # General-purpose sanity checks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-ast
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-shebang-scripts-are-executable
+      - id: check-symlinks
+      - id: check-toml
+      - id: check-xml
+      - id: end-of-file-fixer
+      - id: forbid-submodules
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+
+  # JSON (supports comments)
+  - repo: https://gitlab.com/bmares/check-json5
+    rev: v1.0.0
+    hooks:
+      - id: check-json5
+        files: '\.(json|json5|jsonc)$'
+
+  # Python (formatting + linting)
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.5
+    hooks:
+      - id: ruff-format
+      - id: ruff
+        args: [--fix]
+
+  # C++ formatting
+  - repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: v19.1.7
+    hooks:
+      - id: clang-format
+        args: ["--style=file:.config/clang-format"]
+
+  # C++ linting
+  - repo: https://github.com/cpplint/cpplint
+    rev: 2.0.0
+    hooks:
+      - id: cpplint
+        args: ["--config=.cpplint.cfg", "--filter=-runtime/references", --quiet, --output=sed]
+
+  # CMake linting
+  - repo: https://github.com/cmake-lint/cmake-lint
+    rev: 1.4.3
+    hooks:
+      - id: cmakelint
+        args: [--linelength=140]
+
+  # Bash / Shell scripts
+  - repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: v0.10.0.1
+    hooks:
+      - id: shellcheck
+        args: [-e, SC1091]
+
+  # Dockerfile linting
+  - repo: https://github.com/AleksaC/hadolint-py
+    rev: v2.12.1b3
+    hooks:
+      - id: hadolint
+        args: [--ignore, SC1091, --ignore, DL3006, --ignore, DL3008]
+
+  # Markdown linting
+  - repo: https://github.com/jackdewinter/pymarkdown
+    rev: v0.9.28
+    hooks:
+      - id: pymarkdown
+        args: [-d, MD013, fix]
+
+  # XML (ROS-specific)
+  - repo: https://github.com/emersonknapp/ament_xmllint
+    rev: v0.1
+    hooks:
+      - id: ament_xmllint
+
+  # YAML linting
+  - repo: https://github.com/adrienverge/yamllint.git
+    rev: v1.29.0
+    hooks:
+      - id: yamllint
+        args: ["-c", ".config/.yamllint.yaml"]
+
+  # License headers
+  - repo: https://github.com/Lucas-C/pre-commit-hooks
+    rev: v1.5.5
+    hooks:
+      - id: insert-license
+        types_or: [python, cmake, shell]
+        name: Copyright headers for Python/CMake
+        args:
+          [
+            --license-filepath,
+            .config/copyright.txt,
+            --comment-style,
+            "#",
+            --allow-past-years,
+            --no-extra-eol,
+          ]
+      - id: insert-license
+        types_or: [c++, c]
+        name: Copyright headers for C/C++
+        args: [--license-filepath, .config/copyright.txt, --comment-style, "//", --allow-past-years]

DEVELOPING.md

@@ -47,4 +47,4 @@ source install/setup.bash
 ### Troubleshooting
 
 - If the container fails to build, check that Docker is running
-- To rebuild from scratch: "Dev Containers: Rebuild Container"
+- To rebuild from scratch: "Dev Containers: Rebuild Container"