Github Actions: add codespell linter, warn only

diff --git a/.codespellrc b/.codespellrc
new file mode 100644 (file)
index 0000000..332bce5
--- /dev/null
+++ b/.codespellrc
@@ -0,0 +1,7 @@
+# https://github.com/codespell-project/codespell
+
+[codespell]
+skip = ./man/nominatim.1,data,./docs/styles.css,lib-php,module,munin,osm2pgsql,./test,./settings/*.lua,./settings/*.yaml,./settings/**/*.yaml,./settings/icu-rules,./nominatim/tokenizer/token_analysis/config_variants.py
+# Need to be lowercase in the list
+# Unter = Unter den Linden (an example address)
+ignore-words-list = inout,unter

diff --git a/.github/workflows/ci-tests.yml b/.github/workflows/ci-tests.yml
index 910114d7e5cf5e9e0a16d46949b14bbc2f8b5bd9..d1079375df0821ce3fc8b16e6bf0e5f0bf1547d9 100644 (file)
--- a/.github/workflows/ci-tests.yml
+++ b/.github/workflows/ci-tests.yml
@@ -386,3 +386,10 @@ jobs:
 
           - name: Check full import
             run: nominatim admin --check-database
 
           - name: Check full import
             run: nominatim admin --check-database

+
+    codespell:
+      runs-on: ubuntu-latest
+      steps:
+          - uses: codespell-project/actions-codespell@v2
+            with:
+                only_warn: 1

diff --git a/nominatim/api/search/db_search_builder.py b/nominatim/api/search/db_search_builder.py
index f2b653f2c2def3c3657abdc9159c3be66d215d5f..ef7a66b8507387630c6d0aacc5bfb2b67a08b566 100644 (file)
--- a/nominatim/api/search/db_search_builder.py
+++ b/nominatim/api/search/db_search_builder.py
@@ -5,7 +5,7 @@
 # Copyright (C) 2023 by the Nominatim developer community.
 # For a full list of authors see the git log.
 """
 # Copyright (C) 2023 by the Nominatim developer community.
 # For a full list of authors see the git log.
 """

-Convertion from token assignment to an abstract DB search.
+Conversion from token assignment to an abstract DB search.

 """
 from typing import Optional, List, Tuple, Iterator, Dict
 import heapq
 """
 from typing import Optional, List, Tuple, Iterator, Dict
 import heapq

diff --git a/nominatim/db/connection.py b/nominatim/db/connection.py
index 82801ae7995c9d1e5527baec0d9dd89c85e70e4d..d686083697f03d03bec86ed061e509884a9905b2 100644 (file)
--- a/nominatim/db/connection.py
+++ b/nominatim/db/connection.py
@@ -239,7 +239,7 @@ _PG_CONNECTION_STRINGS = {
 def get_pg_env(dsn: str,
                base_env: Optional[SysEnv] = None) -> Dict[str, str]:
     """ Return a copy of `base_env` with the environment variables for
 def get_pg_env(dsn: str,
                base_env: Optional[SysEnv] = None) -> Dict[str, str]:
     """ Return a copy of `base_env` with the environment variables for

-        PostgresSQL set up from the given database connection string.
+        PostgreSQL set up from the given database connection string.

         If `base_env` is None, then the OS environment is used as a base
         environment.
     """
         If `base_env` is None, then the OS environment is used as a base
         environment.
     """

diff --git a/settings/env.defaults b/settings/env.defaults
index 64a160c7197b9c7593a10670c439d66de3c7fab1..f4c33e7720abda310c95fd5012a4aaf5000a5baa 100644 (file)
--- a/settings/env.defaults
+++ b/settings/env.defaults
@@ -123,9 +123,9 @@ NOMINATIM_TABLESPACE_ADDRESS_DATA=
 # Tablespace for indexes used during address computation. Used for import and update only.
 NOMINATIM_TABLESPACE_ADDRESS_INDEX=
 
 # Tablespace for indexes used during address computation. Used for import and update only.
 NOMINATIM_TABLESPACE_ADDRESS_INDEX=
 

-# Tablespace for tables for auxilary data, e.g. TIGER data, postcodes.
+# Tablespace for tables for auxiliary data, e.g. TIGER data, postcodes.

 NOMINATIM_TABLESPACE_AUX_DATA=
 NOMINATIM_TABLESPACE_AUX_DATA=

-# Tablespace for indexes for auxilary data, e.g. TIGER data, postcodes.
+# Tablespace for indexes for auxiliary data, e.g. TIGER data, postcodes.

 NOMINATIM_TABLESPACE_AUX_INDEX=
 
 
 NOMINATIM_TABLESPACE_AUX_INDEX=
 
 


@@ -183,7 +183,7 @@ NOMINATIM_SEARCH_BATCH_MODE=no
 
 # Threshold for searches by name only.
 # Threshold where the lookup strategy in the database is switched. If there
 
 # Threshold for searches by name only.
 # Threshold where the lookup strategy in the database is switched. If there

-# are less occurences of a tem than given, the search does the lookup only
+# are less occurrences of a tem than given, the search does the lookup only

 # against the name, otherwise it uses indexes for name and address.
 NOMINATIM_SEARCH_NAME_ONLY_THRESHOLD=500
 
 # against the name, otherwise it uses indexes for name and address.
 NOMINATIM_SEARCH_NAME_ONLY_THRESHOLD=500
 


@@ -210,8 +210,8 @@ NOMINATIM_API_POOL_SIZE=10
 NOMINATIM_QUERY_TIMEOUT=10
 
 # Maximum time a single request is allowed to take. When the timeout is
 NOMINATIM_QUERY_TIMEOUT=10
 
 # Maximum time a single request is allowed to take. When the timeout is

-# exceeeded, the available results are returned.
-# When empty, then timouts are disabled.
+# exceeded, the available results are returned.
+# When empty, then timeouts are disabled.

 NOMINATIM_REQUEST_TIMEOUT=60
 
 # Search elements just within countries
 NOMINATIM_REQUEST_TIMEOUT=60
 
 # Search elements just within countries