Merge branch 'typos-hook' into 'master'

Check for obvious typos in pre-commit

See merge request simple-nixos-mailserver/nixos-mailserver!503

.typos.toml

@@ -0,0 +1,2 @@
+[default.extend-identifiers]
+reportd = "reportd"

docs/migrations.rst

@@ -26,7 +26,7 @@ change, requiring manual homedir relocation. Switching to UUID-based homedirs
 (``/var/vmail/ldap/<uuid>``) ensures stable, unique paths and applies well-known
 best practices to mailserver management.
 
-1. Copy the migration script script to your mailserver and make it executable:
+1. Copy the migration script to your mailserver and make it executable:
 
    .. code-block:: console
 
@@ -55,7 +55,7 @@ best practices to mailserver management.
    for example that of bob at ``/var/vmail/ldap/bob@example.com``.
    It then takes ``bob@example.com`` and queries the LDAP server for
    ``mail=bob@example.com`` to retrieve the UUID attribute. Finally
-   it starts suggesting the neceessary move operations to arrive at
+   it starts suggesting the necessary move operations to arrive at
    ``/var/vmail/ldap/f3b4e8ea-087f-42cc-95f0-cbfd99386092`` for bob.
 
    Example:
@@ -82,7 +82,7 @@ best practices to mailserver management.
    - OpenLDAP: ``entryUUID`` (`RFC4530`_)
 
    If yours LDAP provider isn't listed you can determine the correct
-   attribute by quering a user entry with ``ldapsearch``. Finally, configure
+   attribute by querying a user entry with ``ldapsearch``. Finally, configure
    :option:`mailserver.ldap.attributes.uuid` accordingly.
 
    Add ``--ldap-starttls`` if you use the the `ldap://` URI scheme and require

docs/setup-guide.rst

@@ -299,7 +299,7 @@ If you want to take things even further, more elaborate testing services can
 give you a clearer picture of your mail service and suggest ways to improve
 it.
 
-- `internet.nl`_ (supported by the Dutch Governement)
+- `internet.nl`_ (supported by the Dutch Government)
 - `MECSA`_ (supported by the European Commission)
 
 Finally, you can also browse the full list of `options`_ provided by NixOS mailserver.

flake.nix

@@ -167,6 +167,12 @@
               files = "\\.rst$";
             };
 
+            # spell checking
+            typos = {
+              enable = true;
+              settings.configPath = ".typos.toml";
+            };
+
             # nix
             deadnix.enable = true;
             nixfmt.enable = true;

migrations/nixos-mailserver-migration-04.py

@@ -190,7 +190,7 @@ running with `--execute`. Specific details can be found further up.""")
 
     if moved:
         print(f"""
-- {color(f"{moved} home directories were migrated succesfully.", GREEN)} {"(dry run)" if dry_run else ""}
+- {color(f"{moved} home directories were migrated successfully.", GREEN)} {"(dry run)" if dry_run else ""}
   This is great news, they are now UUID-based and will be immune to username changes!""")
 
     if skipped and accounts:
@@ -221,7 +221,7 @@ running with `--execute`. Specific details can be found further up.""")
 
     if moves_failed:
         print(f"""
-- {color("{moves_failed} home directores could not be renamed", RED)}
+- {color("{moves_failed} home directories could not be renamed", RED)}
   No reason to panic, but the script tried to rename a home directory and that
   triggered and error. Check further up what went wrong.""")
 
@@ -246,7 +246,7 @@ if __name__ == "__main__":
         "--ldap-uri",
         type=str,
         required=True,
-        help="URI for your LDAP server; ldaps://ldap1.example.com (TLS) or ldap://ldap1.exampe.com (Plain)",
+        help="URI for your LDAP server; ldaps://ldap1.example.com (TLS) or ldap://ldap1.example.com (Plain)",
     )
     parser.add_argument(
         "--ldap-starttls",
@@ -284,7 +284,7 @@ if __name__ == "__main__":
     parser.add_argument(
         "--ldap-filter",
         default="(mail=%s)",
-        help="LDAP query that filters for an account by the name in /var/vmail/ldap/<name> field, e.g. mail=%%s or uid=%%s if the name is not an email adress.",
+        help="LDAP query that filters for an account by the name in /var/vmail/ldap/<name> field, e.g. mail=%%s or uid=%%s if the name is not an email address.",
     )
     parser.add_argument(
         "--ldap-attr-uuid",