chore: add pre-commit lint to remove trailing whitespace (#104)

* chore: add pre-commit lint to remove trailing whitespace

* use ruff instead of tox

Author: vincentsarago

.devcontainer/devcontainer.json

@@ -1,4 +1,4 @@
 {
     "name": "VS Code DEV Container for AWS CDK development",
     "image": "jsii/superchain:1-buster-slim-node16"
-}
+}

.github/pull_request_template.md

@@ -1,4 +1,4 @@
 ## :warning: Checklist if your PR is changing anything else than documentation
 - [ ] Posted the link to a successful manually triggered deployment workflow (successful including the resources destruction)
 
-## Merge request description
+## Merge request description

.github/workflows/build.yaml

@@ -12,7 +12,7 @@ on:
         required: false
       DS_RELEASE_BOT_PRIVATE_KEY:
         required: false
-        
+
 jobs:
   build_and_package:
     name: Build and package

.github/workflows/deploy.yaml

@@ -2,7 +2,7 @@ name: Deployment
 
 on:
   workflow_dispatch:
-    
+
 jobs:
   build_package_and_deploy:
     name: Build, package and deploy
@@ -30,7 +30,7 @@ jobs:
       - name: Generate distribution packages
         run: npm run package
 
-      
+
       - name: Install deployment environment
         id: install_deploy_env
         run: |
@@ -40,7 +40,7 @@ jobs:
           pip install dist/python/*.gz
           cd integration_tests/cdk
           pip install -r requirements.txt
-          npm install   
+          npm install
           deactivate
           cd -
 
@@ -56,7 +56,7 @@ jobs:
           PROJECT_ID: ${{ steps.short-sha.outputs.sha }}
         run: |
           source .deployment_venv/bin/activate
-          
+
           # synthesize the stack
           cd integration_tests/cdk
           npx cdk synth --debug --all --require-approval never
@@ -65,7 +65,7 @@ jobs:
           npx cdk deploy --ci --all --require-approval never
           deactivate
           cd -
-          
+
       - name: Tear down any infrastructure
         if: always()
         env:

.github/workflows/distribute.yaml

@@ -18,7 +18,7 @@ jobs:
         with:
           name: python
           path: dist
-          
+
       - run: pip install twine
 
       - run: twine upload dist/*

.github/workflows/lint.yaml

@@ -0,0 +1,26 @@
+name: Lint
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install pre-commit
+
+      - name: Run pre-commit
+        run: pre-commit run --all-files

.github/workflows/tox.yaml

@@ -10,15 +10,17 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python: [3.9]
+        python: [3.11]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Setup Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python }}
+
       - name: Install Tox and any other packages
         run: pip install tox
+
       - name: Run Tox
         # Run tox using the version of Python in `PATH`
         run: tox -e py

.gitignore

@@ -10,4 +10,4 @@ __pycache__
 .tox
 tests/*.egg*
 tests/*venv*
-tests/__pycache__
+tests/__pycache__

.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+
+# Optionally both commit and push
+default_stages: [commit]
+
+# Regex for files to exclude
+# Don't lint the generated JSON metadata files
+exclude: "diagrams/"
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.0.1
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.4.4
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format

README.md

@@ -56,4 +56,4 @@ _Warning_: If you rebase `main`, you must ensure that the commits referenced by
 
 ## Tests
 
-Each pull request to `main` is added to a [merge queue](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue#triggering-merge-group-checks-with-github-actions) so that a "deployment test" workflow can run before the merge actually happens. If the deployment fails, the merge is cancelled. Here is [the definition of this workflow](https://github.com/developmentseed/eoapi-cdk/blob/main/.github/workflows/deploy.yaml) and the [tests definition](https://github.com/developmentseed/eoapi-cdk/blob/main/tests).
+Each pull request to `main` is added to a [merge queue](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue#triggering-merge-group-checks-with-github-actions) so that a "deployment test" workflow can run before the merge actually happens. If the deployment fails, the merge is cancelled. Here is [the definition of this workflow](https://github.com/developmentseed/eoapi-cdk/blob/main/.github/workflows/deploy.yaml) and the [tests definition](https://github.com/developmentseed/eoapi-cdk/blob/main/tests).