Add typos tool to pre-commit (#1144)

This tool corrects common misspellings in all kinds of text files.

Author: adamchainz

.pre-commit-config.yaml

@@ -16,6 +16,18 @@ repos:
   - id: check-toml
   - id: end-of-file-fixer
   - id: trailing-whitespace
+- repo: https://github.com/crate-ci/typos
+  rev: 6cb49915af2e93e61f5f0d0a82216e28ad5c7c18  # frozen: v1
+  hooks:
+  - id: typos
+    exclude: |
+      (?x)^(
+        .*\.min\.css
+        |.*\.min\.js
+        |.*\.css\.map
+        |.*\.js\.map
+        |.*\.svg
+      )$
 - repo: https://github.com/tox-dev/pyproject-fmt
   rev: 57b6ff7bf72affdd12c7f3fd6de761ba18a33b3a  # frozen: v2.5.1
   hooks:

.typos.toml

@@ -0,0 +1,10 @@
+# Configuration file for 'typos' tool
+# https://github.com/crate-ci/typos
+
+[default]
+extend-ignore-re = [
+  # Single line ignore comments
+  "(?Rm)^.*(#|//)\\s*typos: ignore$",
+  # Multi-line ignore comments
+  "(?s)(#|//)\\s*typos: off.*?\\n\\s*(#|//)\\s*typos: on"
+]

docs/cache.rst

@@ -299,7 +299,7 @@ as memcached, in an InnoDB table the keys are stored in order so range scans
 are easy.
 
 To use these methods, it must be possible to reverse-map the "full" key stored
-in the databse to the key you would provide to ``cache.get``, via a 'reverse
+in the database to the key you would provide to ``cache.get``, via a 'reverse
 key function'. If you have not set ``KEY_FUNCTION``, ``MySQLCache`` will use
 Django’s default key function, and can therefore default the reverse key
 function too, so you will not need to add anything.

docs/changelog.rst

@@ -507,7 +507,7 @@ Changelog
 1.0.2 (2016-01-24)
 ------------------
 
-* New function ``add_QuerySetMixin`` allows addding the ``QuerySetMixin`` to
+* New function ``add_QuerySetMixin`` allows adding the ``QuerySetMixin`` to
   arbitrary ``QuerySet``\s, for when you can't edit a model class.
 * Added field class ``EnumField`` that uses MySQL's ``ENUM`` data type.
 
@@ -650,7 +650,7 @@ Changelog
 0.1.5 (2015-03-11)
 ------------------
 
-* Added ``manage.py`` command ``dbparams`` for outputting database paramters
+* Added ``manage.py`` command ``dbparams`` for outputting database parameters
   in formats useful for shell scripts
 
 

docs/queryset_extensions.rst

@@ -50,7 +50,7 @@ Approximate Counting
 
     .. attribute:: return_approx_int=True
 
-        When ``True``, an ``int`` is not returned (excpet when falling back),
+        When ``True``, an ``int`` is not returned (except when falling back),
         but instead a subclass called ``ApproximateInt``. This is for all
         intents and purposes an ``int``, apart from when cast to ``str``, it
         renders as e.g. **'Approximately 12345'** (internationalization

src/django_mysql/cache.py

@@ -467,7 +467,7 @@ def validate_key(self, key: str) -> None:
         """
         if len(key) > 250:
             raise ValueError(
-                f"Cache key is longer than the maxmimum 250 characters: {key}"
+                f"Cache key is longer than the maximum 250 characters: {key}"
             )
         return super().validate_key(key)
 

src/django_mysql/locks.py

@@ -24,7 +24,7 @@ def __init__(
         else:
             self.db = using
 
-        # For multi-database servers, we prefix the name of the lock wth
+        # For multi-database servers, we prefix the name of the lock with
         # the database, to protect against concurrent apps with the same locks
         self.name = self.make_name(self.db, name)
 

tests/settings.py

@@ -6,7 +6,7 @@
 DEBUG = False
 TEMPLATE_DEBUG = DEBUG
 
-SECRET_KEY = "THISuISdNOT9A$SECRET9x&ji!vceayg+wwt472!bgs$0!i3k4"
+SECRET_KEY = "THISuISdNOT9A$SECRET9x&ji!vceayg+wwt472!bgs$0!i3k4"  # typos: ignore
 
 DATABASES = {
     "default": {

tests/testapp/test_aggregates.py

@@ -142,7 +142,7 @@ def test_separator_ansi_mode(self):
 
     def test_ordering_invalid(self):
         with pytest.raises(ValueError) as excinfo:
-            self.shakes.tutees.aggregate(tids=GroupConcat("id", ordering="asceding"))
+            self.shakes.tutees.aggregate(tids=GroupConcat("id", ordering="unknown"))
         assert "'ordering' must be one of" in str(excinfo.value)
 
     def test_ordering_asc(self):

tests/testapp/test_rewrite_query.py

@@ -50,7 +50,7 @@ def test_straight_join(self):
             + "nothing() AND (1)"
         )
 
-    def test_straight_join_preceeding_whitespace(self):
+    def test_straight_join_preceding_whitespace(self):
         assert rewrite_query(
             "  SELECT col_a, col_b FROM sometable WHERE nothing() AND "
             + "(/*QueryRewrite':STRAIGHT_JOIN*/1)"
@@ -238,9 +238,9 @@ def test_index_hint_with_alias(self):
 
     def test_index_hint_multiple_indexes(self):
         assert rewrite_query(
-            "SELECT col_a FROM `tabl` WHERE "
-            "(/*QueryRewrite':index=`tabl` IGNORE `idx1`,`idx2`*/1)"
-        ) == ("SELECT col_a FROM `tabl` IGNORE INDEX (`idx1`,`idx2`) WHERE " + "(1)")
+            "SELECT col_a FROM `table` WHERE "
+            "(/*QueryRewrite':index=`table` IGNORE `idx1`,`idx2`*/1)"
+        ) == ("SELECT col_a FROM `table` IGNORE INDEX (`idx1`,`idx2`) WHERE " + "(1)")
 
     def test_index_hint_multiple_hints(self):
         assert rewrite_query(