Add codespell support (config, workflow to detect/not fix) and make it fix some typos (#7864)

* Add github action to codespell preview on push and PRs

* Add rudimentary codespell config

* [DATALAD RUNCMD] chore: run codespell throughout fixing a few typos interactively

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w -i 3 -C 4 ./apps/web/core/components/workspace/delete-workspace-form.tsx ./deployments/cli/community/README.md",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^

* Adjust coespell regex to ignore all camelCased words

* [DATALAD RUNCMD] chore: run codespell throughout fixing a few  new typos automagically

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "codespell -w",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^

Author: yarikoptic

.codespellrc

@@ -0,0 +1,7 @@
+[codespell]
+# Ref: https://github.com/codespell-project/codespell#using-a-config-file
+skip = .git*,*.svg,i18n,*-lock.yaml,*.css,.codespellrc,migrations,*.js,*.map,*.mjs
+check-hidden = true
+# ignore all CamelCase and camelCase
+ignore-regex = \b[A-Za-z][a-z]+[A-Z][a-zA-Z]+\b
+ignore-words-list = tread

.github/workflows/codespell.yml

@@ -0,0 +1,25 @@
+# Codespell configuration is within .codespellrc
+---
+name: Codespell
+
+on:
+  push:
+    branches: [preview]
+  pull_request:
+    branches: [preview]
+
+permissions:
+  contents: read
+
+jobs:
+  codespell:
+    name: Check for spelling errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Annotate locations with typos
+        uses: codespell-project/codespell-problem-matcher@v1
+      - name: Codespell
+        uses: codespell-project/actions-codespell@v2

apps/api/plane/api/serializers/intake.py

@@ -1,4 +1,4 @@
-# Module improts
+# Module imports
 from .base import BaseSerializer
 from .issue import IssueExpandSerializer
 from plane.db.models import IntakeIssue, Issue

apps/api/plane/app/views/cycle/base.py

@@ -1196,7 +1196,7 @@ def get(self, request, slug, project_id, cycle_id):
         if the issues were transferred to the new cycle, then the progress_snapshot will be present
         return the progress_snapshot data in the analytics for each date
             
-        else issues were not transferred to the new cycle then generate the stats from the cycle isssue bridge tables
+        else issues were not transferred to the new cycle then generate the stats from the cycle issue bridge tables
         """
 
         if cycle.progress_snapshot:

apps/api/plane/app/views/project/member.py

@@ -48,7 +48,7 @@ def create(self, request, slug, project_id):
         # Check if the members array is empty
         if not len(members):
             return Response(
-                {"error": "Atleast one member is required"},
+                {"error": "At least one member is required"},
                 status=status.HTTP_400_BAD_REQUEST,
             )
 

apps/api/plane/authentication/adapter/error.py

@@ -48,7 +48,7 @@
     "INCORRECT_OLD_PASSWORD": 5135,
     "MISSING_PASSWORD": 5138,
     "INVALID_NEW_PASSWORD": 5140,
-    # set passowrd
+    # set password
     "PASSWORD_ALREADY_SET": 5145,
     # Admin
     "ADMIN_ALREADY_EXIST": 5150,

apps/api/plane/db/management/commands/activate_user.py

@@ -31,4 +31,4 @@ def handle(self, *args, **options):
         user.is_active = True
         user.save()
 
-        self.stdout.write(self.style.SUCCESS("User activated succesfully"))
+        self.stdout.write(self.style.SUCCESS("User activated successfully"))

apps/api/plane/db/management/commands/reset_password.py

@@ -59,4 +59,4 @@ def handle(self, *args, **options):
         user.is_password_autoset = False
         user.save()
 
-        self.stdout.write(self.style.SUCCESS("User password updated succesfully"))
+        self.stdout.write(self.style.SUCCESS("User password updated successfully"))

apps/api/plane/db/management/commands/update_bucket.py

@@ -70,7 +70,7 @@ def check_s3_permissions(self, bucket_name):
         try:
             s3_client.delete_object(Bucket=bucket_name, Key="test_permission_check.txt")
         except ClientError:
-            self.stdout.write("Coudn't delete test object")
+            self.stdout.write("Couldn't delete test object")
 
         # 4. Test s3:PutBucketPolicy (attempt to put a bucket policy)
         try:

apps/space/helpers/authentication.helper.tsx

@@ -66,7 +66,7 @@ export enum EAuthenticationErrorCodes {
   INCORRECT_OLD_PASSWORD = "5135",
   MISSING_PASSWORD = "5138",
   INVALID_NEW_PASSWORD = "5140",
-  // set passowrd
+  // set password
   PASSWORD_ALREADY_SET = "5145",
   // Admin
   ADMIN_ALREADY_EXIST = "5150",