pre-commit checks

Author: keiravillekode

.clang-format

@@ -0,0 +1,10 @@
+---
+BasedOnStyle: Google
+
+AllowShortEnumsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: None
+ColumnLimit: 140
+IndentWidth: 4
+PointerAlignment: Right
+SortIncludes: Never
+...

.github/workflows/pre-commit.yml

@@ -0,0 +1,23 @@
+name: arm64-assembly / pre-commit checks
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  pre-commit:
+    name: Pre-commit checks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+      - name: set PY
+        run: echo "PY=$(python -VV | sha256sum | cut -d' ' -f1)" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          path: ~/.cache/pre-commit
+          key: pre-commit|${{ env.PY }}|${{ hashFiles('.pre-commit-config.yaml') }}
+      - uses: pre-commit/[email protected]

.pre-commit-config.yaml

@@ -0,0 +1,36 @@
+exclude: |
+    (?x)^(
+        .*/vendor/.*|
+        .github/CODEOWNERS
+    )$
+
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+-   repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: v20.1.3
+    hooks:
+    -   id: clang-format
+        exclude_types: [json]
+-   repo: local
+    hooks:
+    -   id: update-from-templates
+        name: Check that all exercises use up-to-date copies from templates dir
+        language: system
+        entry: bin/update-from-templates
+        pass_filenames: false
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.11
+    hooks:
+        - id: ruff
+          args: [--fix]
+        - id: ruff-format
+-   repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: v0.10.0.1
+    hooks:
+    -   id: shellcheck

README.md

@@ -34,6 +34,15 @@ Generate the test cases with the following command:
 ./generators/generate <exercise name>
 ```
 
+## pre-commit
+
+You may choose to install [pre-commit](https://pre-commit.com/) hooks using
+
+```
+pip install pre-commit
+pre-commit install
+```
+
 ## Contributing Guide
 
 Please see the [contributing guide](https://github.com/exercism/docs/blob/master/contributing-to-language-tracks/README.md).