Merge pull request #23 from WATonomous/add-pre-commit

Add pre-commit

Author: vedantgrover

.config/.yamllint.yaml

@@ -0,0 +1,12 @@
+---
+extends: default
+
+rules:
+  line-length:
+    max: 256
+  commas: false
+
+  truthy:
+    ignore: |
+      .github/workflows/build_base_images.yml
+      .github/workflows/build_and_unitest.yml

.config/clang-format

@@ -0,0 +1,69 @@
+---
+# C++ Formatting rules for WATonomous Standard
+
+# See https://releases.llvm.org/14.0.0/tools/clang/docs/ClangFormatStyleOptions.html for documentation of these options
+BasedOnStyle: Google
+IndentWidth: 2
+ColumnLimit: 120
+
+AccessModifierOffset: -2
+AlignAfterOpenBracket: AlwaysBreak
+AlignConsecutiveAssignments: None
+AlignConsecutiveDeclarations: None
+AlignEscapedNewlines: Left
+AlignTrailingComments: false
+AllowAllArgumentsOnNextLine: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortBlocksOnASingleLine: Empty
+AllowShortFunctionsOnASingleLine: false
+BinPackArguments: false
+BinPackParameters: false
+BraceWrapping:
+  AfterClass: true
+  AfterControlStatement: MultiLine
+  AfterEnum: true
+  AfterFunction: true
+  AfterNamespace: true
+  AfterStruct: true
+  AfterUnion: true
+  AfterExternBlock: true
+  BeforeCatch: false
+  BeforeElse: false
+  BeforeLambdaBody: false
+  BeforeWhile: false
+  IndentBraces: false
+  SplitEmptyFunction: false
+  SplitEmptyRecord: false
+  SplitEmptyNamespace: false
+BreakBeforeBraces: Custom
+BreakConstructorInitializers: BeforeComma
+CompactNamespaces: false
+ContinuationIndentWidth: 2
+ConstructorInitializerIndentWidth: 0
+DerivePointerAlignment: false
+EmptyLineAfterAccessModifier: Never
+EmptyLineBeforeAccessModifier: LogicalBlock
+FixNamespaceComments: true
+IncludeBlocks: Regroup
+IncludeCategories:
+  # Headers in <> with .h extension (best guess at C system headers)
+  - Regex:           '<([A-Za-z0-9\Q/-_\E])+\.h>'
+    Priority:        1
+  # Headers in <> without extension (C++ system headers)
+  - Regex:           '<([A-Za-z0-9\Q/-_\E])+>'
+    Priority:        2
+  # Headers in <> with other extensions.
+  - Regex:           '<([A-Za-z0-9.\Q/-_\E])+>'
+    Priority:        3
+  # Headers in ""
+  - Regex:           '"([A-Za-z0-9.\Q/-_\E])+"'
+    Priority:        4
+IndentAccessModifiers: false
+IndentPPDirectives: BeforeHash
+PackConstructorInitializers: Never
+PointerAlignment: Middle
+ReferenceAlignment: Middle
+ReflowComments: false
+SeparateDefinitionBlocks: Always
+SortIncludes: CaseInsensitive
+SpacesBeforeTrailingComments: 2

.config/copyright.txt

@@ -0,0 +1,13 @@
+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.

.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

.github/workflows/pre-commit.yml

@@ -0,0 +1,32 @@
+---
+name: Pre-commit
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  run-pre-commit:
+    name: Pre-commit Check
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Install xmllint dependency
+        run: |
+          sudo apt-get update -qq
+          sudo apt-get install -y --no-install-recommends libxml2-utils
+
+      - name: Install pre-commit
+        run: |
+          python -m pip install --upgrade pip
+          pip install pre-commit
+
+      - name: Run pre-commit hooks
+        run: pre-commit run --all-files

.gitignore

@@ -5,4 +5,4 @@ __pycache__
 
 watod-config.local.sh
 **/.DS_Store
-draft_*
+draft_*