Merge pull request #1948 from kursatyurt/pre-commit-hooks

Pre-commit hooks for Formatting

Author: pcarruscag

.clang-format

@@ -2,3 +2,4 @@ BasedOnStyle: Google
 PointerAlignment: Left
 DerivePointerAlignment: false
 ColumnLimit: 120
+SortIncludes: Never

.github/ISSUE_TEMPLATE/bug_report.md

@@ -26,4 +26,3 @@ assignees: ''
  - C++ compiler and version: [e.g., g++ (GCC) 4.8.5]
  - MPI implementation and version: [e.g., OpenMPI 3.0.0]
  - SU2 Version: [e.g., v6.2.0]
-

.github/pull_request_template.md

@@ -1,6 +1,6 @@
 ## Proposed Changes
 *Give a brief overview of your contribution here in a few sentences.*
- 
+
 
 
 ## Related Work
@@ -14,5 +14,6 @@
 - [ ] I am submitting my contribution to the develop branch.
 - [ ] My contribution generates no new compiler warnings (try with --warnlevel=3 when using meson).
 - [ ] My contribution is commented and consistent with SU2 style (https://su2code.github.io/docs_v7/Style-Guide/).
+- [ ] I used the pre-commit hook to prevent dirty commits and used `pre-commit run --all` to format old commits.
 - [ ] I have added a test case that demonstrates my contribution, if necessary.
 - [ ] I have updated appropriate documentation (Tutorials, Docs Page, config_template.cpp), if necessary.

.github/release.yml

@@ -17,4 +17,3 @@ changelog:
       - title: 'Other Changes'
         labels:
           - "*"
-

.github/workflows/code-style.yml

@@ -0,0 +1,30 @@
+name: Code Style
+on:
+  pull_request:
+    paths:
+      - "**.[ch]pp"
+      - "**.[ch]"
+      - "**.cfg"
+      - "**.py"
+
+jobs:
+  formatting:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup python
+        uses: actions/setup-python@v4
+        with:
+         python-version: '3.10'
+         check-latest: true
+      - name: Install pre-commit
+        run: pip install pre-commit
+      - name: Run checks
+        run: pre-commit run -a -v
+      - name: Git status
+        if: always()
+        run: git status
+      - name: Full diff
+        if: always()
+        run: git diff

.github/workflows/release-management.yml

@@ -65,4 +65,3 @@ jobs:
           asset_path: ${{matrix.os_bin}}.zip
           asset_name: SU2-${{ steps.update_release.outputs.tagname }}-${{matrix.os_bin}}.zip
           asset_content_type: application/zip
-

.lgtm.yml

@@ -1,7 +1,7 @@
 extraction:
   cpp:
      prepare:
-        packages: 
+        packages:
           - libboost-all-dev
      configure:
         command:

.pep8

@@ -0,0 +1,6 @@
+[pycodestyle]
+max_line_length = 120
+ignore = E402
+in-place = true
+aggressive = 2
+recursive = true

.pre-commit-config.yaml

@@ -0,0 +1,62 @@
+repos:
+  # Official repo for the clang-format hook
+  - repo: https://github.com/pre-commit/mirrors-clang-format
+    rev: "v15.0.7"
+    hooks:
+      - id: clang-format
+        exclude: |
+            (?x)^(
+            ^Common/include/CConfig.hpp|
+            ^Common/include/option_structure.hpp|
+            ^Common/src/CConfig.cpp|
+            ^SU2_CFD|
+            ^externals|
+            ^subprojects|
+            ^TestCases|
+            ^legacy
+            )
+        types_or: [c++, c]
+  # black repo for python formatting
+  - repo: https://github.com/ambv/black
+    rev: 22.6.0
+    hooks:
+      - id: black
+        exclude: |
+            (?x)^(
+            ^SU2_CFD|
+            ^externals|
+            ^subprojects|
+            ^TestCases|
+            ^legacy
+            )
+  # Official repo for default hooks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v4.4.0"
+    hooks:
+      - id: mixed-line-ending
+        exclude: |
+            (?x)^(
+            ^SU2_CFD|
+            ^externals|
+            ^subprojects|
+            ^TestCases|
+            ^legacy
+            )
+      - id: trailing-whitespace
+        exclude: |
+            (?x)^(
+            ^SU2_CFD|
+            ^externals|
+            ^subprojects|
+            ^TestCases|
+            ^legacy
+            )
+      - id: end-of-file-fixer
+        exclude: |
+            (?x)^(
+            ^SU2_CFD|
+            ^externals|
+            ^subprojects|
+            ^TestCases|
+            ^legacy
+            )

.travis.yml

@@ -6,10 +6,10 @@ sudo: required
 
 language: c++
 
-cache: 
+cache:
     - ccache
     - pip
-    - directories: 
+    - directories:
       - $HOME/.pyenv_cache
 
 compiler:
@@ -19,7 +19,7 @@ notifications:
     email:
         recipients:
             - [email protected]
-  
+
 branches:
     only:
         - develop
@@ -81,7 +81,7 @@ before_script:
 
     # Get the tutorial cases
     - git clone --depth=1 -b develop https://github.com/su2code/su2code.github.io ./Tutorials
-    
+
     # Enter the SU2/TestCases/ directory, which is now ready to run
     - cd TestCases/