pre-commit: Add codespell (#6)

https://github.com/codespell-project/codespell

Author: cclauss

.github/CODEOWNERS

@@ -6,7 +6,7 @@
 *.ts @Aeternalis-Ingenium
 *.cjs @Aeternalis-Ingenium
 
-# HTML & CSS realted code
+# HTML & CSS related code
 *.html @Aeternalis-Ingenium
 *.css @Aeternalis-Ingenium
 *.scss @Aeternalis-Ingenium

.github/workflows/ci-backend.yaml

@@ -33,7 +33,7 @@ jobs:
           cache: 'pip'
       - name: Display Python version
         run: python -c "import sys; print(sys.version)"
-      - name: Install depenencies
+      - name: Install dependencies
         run:  |
           python -m pip install --upgrade pip
           if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
@@ -62,7 +62,7 @@ jobs:
           cache: 'pip'
       - name: Display Python version
         run: python -c "import sys; print(sys.version)"
-      - name: Install dev depenencies
+      - name: Install dev dependencies
         run:  |
           python -m pip install --upgrade pip
           if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
@@ -158,7 +158,7 @@ jobs:
           cache: 'pip'
       - name: Display Python version
         run: python -c "import sys; print(sys.version)"
-      - name: Install depenencies
+      - name: Install dependencies
         run:  |
           python -m pip install --upgrade pip
           if [ -f requirements.txt ]; then pip install -r requirements.txt; fi

.pre-commit-config.yaml

@@ -33,6 +33,12 @@ repos:
         name: isort (python)
         args:
         - --settings-path=backend/pyproject.toml
+-   repo: https://github.com/codespell-project/codespell
+    rev: v2.2.2
+    hooks:
+    -   id: codespell
+        additional_dependencies:
+        - tomli
 -   repo: https://github.com/pre-commit/mirrors-mypy
     rev: "v0.991"
     hooks:

backend/README.md

@@ -6,7 +6,7 @@ This backend application template consists of:
 * Create the backend server with FastAPI and Uvicorn,
 * Connect the backend app with PostgreSQL server via the asynchronous SQLAlchemy with AsyncPG driver.
 * Set up Alembic for the auto-generation of database migrations.
-* Create `Account` (domain) class as our database entitiy `account`.
+* Create `Account` (domain) class as our database entity `account`.
 * Create data validation for our database entity with [Pydantic](https://pydantic-docs.helpmanual.io/).
 * Create formatters for `json` convention and `datetime`.
 * Create authorization with JWT Token generator.
@@ -97,7 +97,7 @@ The secret variables are accessed by 2 different files:
 
 ## Pre-Commit
 
-**INFO**: Run **Step 1** everytime you `git add` a file to identify any mistakes before `git commit`. Otherwise, you will re-write your perfect commit message again 👿🤬🤮
+**INFO**: Run **Step 1** every time you `git add` a file to identify any mistakes before `git commit`. Otherwise, you will re-write your perfect commit message again 👿🤬🤮
 
 * Step 1 $\rightarrow$ Install the pre-commit hook:
     ```shell

backend/src/repository/migrations/versions/2022_12_09_1825-60d1844cb5d3_initial_migration_fo_account_table.py

@@ -1,4 +1,4 @@
-"""initial migration fo account table
+"""initial migration for account table
 
 Revision ID: 60d1844cb5d3
 Revises:

backend/src/securities/hashing/hash.py

@@ -26,7 +26,7 @@ def generate_password_salt_hash(self) -> str:
 
     def generate_password_hash(self, hash_salt: str, password: str) -> str:
         """
-        A function taht adds the user's password with the layer 1 Bcrypt hash, before
+        A function that adds the user's password with the layer 1 Bcrypt hash, before
         hash it for the second time using Argon2 algorithm.
         """
         return self._hash_ctx_layer_2.hash(secret=hash_salt + password)