🔨 Configure optional typos checking and add supporting tooling (#8691)

Author: pcrespov

.github/ISSUE_TEMPLATE/5_release.yml

@@ -32,7 +32,7 @@ body:
     attributes:
       label: "Previous pre-release"
       description: |
-        Link to pre-release to staging that preceeds this release
+        Link to pre-release to staging that precedes this release
       value: https://github.com/ITISFoundation/osparc-simcore/releases/tag/staging_<sprint_name><version>
     validations:
       required: true
@@ -55,7 +55,7 @@ body:
     attributes:
       label: Motivation
       description: |
-        What is the motivation to release to production? Our current release policy recommends **at least one releast to production for every sprint**.
+        What is the motivation to release to production? Our current release policy recommends **at least one release to production for every sprint**.
         For the moment releases to production require maintenance and therefore interrupting users
         - Explain what motivates this release?
         - Which important changes we might pay attention to?
@@ -114,7 +114,7 @@ body:
       label: "Test assessment: user-testing 🧐"
       description: |
         Assessment performed together with a final user. The session is recorded and ``filesrv/osparc/DEVELOPERS/test-sessions``.
-        Create an issue for every bug/enhancement including the video timestap to follow up.
+        Create an issue for every bug/enhancement including the video timestamp to follow up.
         List issues here!
       placeholder: |
         Follow up issues:

.github/mergify.yml

@@ -1,7 +1,7 @@
 queue_rules:
   - name: default
-    queue_conditions: # condtions to be met to add the PR to the queue (manually or automatically)
-      # general prerequisits fo accept the PR in the queue
+    queue_conditions: # conditions to be met to add the PR to the queue (manually or automatically)
+      # general prerequisites for accept the PR in the queue
       - label=🤖-automerge # let Mergify know that the PR can be merged (added manually)
       - label!=🤖-do-not-merge # block Mergify from merging the PR (added manually)
       - base=master

.pre-commit-config.yaml

@@ -65,3 +65,4 @@ repos:
     hooks:
       - id: typos
         name: spellchecker
+        continue_on_error: true

.ruff.toml

@@ -18,7 +18,7 @@ lint.select = [
   "ICN",   # [https://github.com/joaopalmeiro/flake8-import-conventions]
   "ISC",   # [https://pypi.org/project/flake8-implicit-str-concat/]
   "N",     # [https://pypi.org/project/pep8-naming/]
-  "NPY",   # NumPy-speficic rules
+  "NPY",   # NumPy-specific rules
   "PERF",  # [https://pypi.org/project/perflint/]
   "PIE",   # [https://pypi.org/project/flake8-pie/]
   "PL",    # [https://pypi.org/project/pylint/]
@@ -59,7 +59,7 @@ target-version = "py313"
   "PLR0913", # too many arguments
   "N806",    # Uppercase variables in functions
   "PT001",   # use pytest.fixture over pytest.fixture() whatsoever
-  "PT004",   # does not return anythin, add leading underscore
+  "PT004",   # does not return anything, add leading underscore
   "ERA001",  # found commented out code
   "FBT001",  # Boolean positional arg in function definition
 ]

.typos.toml

@@ -0,0 +1,59 @@
+# typos spell-checker
+#
+# config .typos.toml
+#   SEE https://github.com/crate-ci/typos/blob/master/docs/reference.md
+#
+# usage:
+#.   uvx typos --help
+#
+# inline marks:
+#.  # spellchecker:disable-line
+#.  # spellchecker:<on|off>
+#.  # spellchecker:ignore-next-line
+#
+
+[files]
+extend-exclude = [
+      ".gitignore",
+      "**/migration/**",
+          "**/*.svg",
+          "**/*.css",
+]
+ignore-hidden = true
+ignore-files = true
+ignore-dot = true
+ignore-vcs = true
+ignore-global = true
+ignore-parent = true
+
+[default]
+binary = false
+check-filename = true
+check-file = true
+unicode=true
+locale = "en"
+extend-ignore-re = [
+    # e.g. "# spellchecker:disable-line"
+    "(?Rm)^.*(#|//)\\s*spellchecker:disable-line$",
+    # e.g. "# spellchecker:<on|off>"
+    "(?s)(#|//)\\s*spellchecker:off.*?\\n\\s*(#|//)\\s*spellchecker:on",
+    # e.g. # spellchecker:ignore-next-line
+    "(#|//)\\s*spellchecker:ignore-next-line\\n.*",
+
+    # UUIDs
+    '"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}"',
+    '"[0-9a-fA-F]{8}_[0-9a-fA-F]{4}_[1-5][0-9a-fA-F]{3}_[89abAB][0-9a-fA-F]{3}_[0-9a-fA-F]{12}"',
+    '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}_',
+
+    # Secrets
+    "[A-Za-z]+://\\S{3,50}:(\\S{8,50})@[\\dA-Za-z#%&+./:=?_~-]+", # URLs
+]
+extend-ignore-identifiers-re = []
+
+[default.extend-words]
+# <typo> = "<correction>"
+
+[default.extend-identifiers]
+# <typo> = "<correction>"
+instance_datas = "instance_datas"
+cMIS = "cMIS"

.vscode/launch.template.json

@@ -255,7 +255,7 @@
       ]
     },
     {
-      "name": "Python: Remote Attach dynamic-schduler (SCALE 1 replica first)",
+      "name": "Python: Remote Attach dynamic-scheduler (SCALE 1 replica first)",
       "type": "debugpy",
       "request": "attach",
       "connect": {

Makefile

@@ -166,7 +166,7 @@ _check_venv_active:
 
 ## DOCKER BUILD -------------------------------
 #
-# - all builds are immediatly tagged as 'local/{service}:${BUILD_TARGET}' where BUILD_TARGET='development', 'production', 'cache'
+# - all builds are immediately tagged as 'local/{service}:${BUILD_TARGET}' where BUILD_TARGET='development', 'production', 'cache'
 # - only production and cache images are released (i.e. tagged pushed into registry)
 #
 SWARM_HOSTS = $(shell docker node ls --format="{{.Hostname}}" 2>$(if $(IS_WIN),NUL,/dev/null))
@@ -714,7 +714,7 @@ SERVICES.md: ## Auto generates service.md
 
 
 .PHONY: postgres-upgrade
-postgres-upgrade: ## initalize or upgrade postgres db to latest state
+postgres-upgrade: ## initialize or upgrade postgres db to latest state
 	@$(MAKE_C) packages/postgres-database/docker build
 	@$(MAKE_C) packages/postgres-database/docker upgrade
 

api/specs/web-server/_nih_sparc.py

@@ -34,7 +34,7 @@ async def list_latest_services():
     response_model=Envelope[list[Viewer]],
 )
 async def list_viewers(file_type: str | None = None):
-    """Lists all publically available viewers
+    """Lists all publicly available viewers
 
     Notice that this might contain multiple services for the same filetype
 
@@ -51,7 +51,7 @@ async def list_default_viewers(file_type: str | None = None):
 
     This was interfaced as a subcollection of viewers because it is a very common use-case
 
-    Only publicaly available viewers
+    Only publicly available viewers
 
     If file_type is provided, then it filters viewer for that filetype
     """

api/specs/web-server/_nih_sparc_redirections.py

@@ -41,7 +41,7 @@ async def get_redirection_to_viewer(
 @router.get(
     "/study/{id}",
     response_class=RedirectResponse,
-    response_description="Opens osparc and opens a copy of publised study",
+    response_description="Opens osparc and opens a copy of published study",
     status_code=status.HTTP_302_FOUND,
 )
 async def get_redirection_to_study_page(id: ProjectID):

api/specs/web-server/_projects_access_rights.py

@@ -32,7 +32,7 @@
     status_code=status.HTTP_202_ACCEPTED,
     responses={
         status.HTTP_202_ACCEPTED: {
-            "description": "The request to share the project has been accepted, but the actual sharing process has to be confirmd."
+            "description": "The request to share the project has been accepted, but the actual sharing process has to be confirmed."
         }
     },
 )