Fix typos, add CI job to help catch them (#1194)

Author: mwtoews

.codespellrc

@@ -0,0 +1,3 @@
+[codespell]
+skip = ./tools/astyle,./src/deps,./web/themes,./util/geosop/cxxopts.hpp
+ignore-words = ./tools/codespell.ignore

.github/workflows/ci.yml

@@ -528,13 +528,17 @@ jobs:
         set -e
         sudo -E apt-get update
         sudo -E apt-get -yq --no-install-suggests --no-install-recommends install cppcheck
+        python3 -m pip install --disable-pip-version-check --user codespell
 
     - name: 'Check Out'
       uses: actions/checkout@v4
 
     - name: 'cppcheck'
       run: ./tools/cppcheck.sh
 
+    - name: codespell
+      run: codespell
+      # false-positives can be added to tools/codespell.ignore
 
   cmake-subproject:
     name: 'CMake Subproject'

NEWS.md

@@ -29,7 +29,7 @@
 
 - Breaking Changes
   - Zero-length linestrings (eg LINESTRING(1 1, 1 1)) are now treated as equivalent to points (POINT(1 1)) in boolean predicates
-  - CMake 3.15 or later is requried (GH-1143, Mike Taves)
+  - CMake 3.15 or later is required (GH-1143, Mike Taves)
 
 - Fixes/Improvements:
   - WKTReader: Points with all-NaN coordinates are not considered empty anymore (GH-927, Casper van der Wel)
@@ -933,7 +933,7 @@ See 3.7.0 notes
 - Added Polygonizer and LineMerger classes.
 - python wrapper examples
 - General cleanup / warnings removal
-- cleaner win32 / older copilers builds
+- cleaner win32 / older compilers builds
 - Reduced heap allocations
 - debian package builder scripts
 - reduction of standard C lib headers dependency

include/geos/geom/Geometry.h

@@ -720,7 +720,7 @@ class GEOS_DLL Geometry {
      *   and dissolving the linework.
      * - Unioning a set of [Polygons](@ref Polygon) will always
      *   return a polygonal geometry (unlike Geometry::Union(const Geometry* other) const),
-     *   which may return geometrys of lower dimension if a topology collapse
+     *   which may return geometries of lower dimension if a topology collapse
      *   occurred.
      *
      * @return the union geometry

include/geos/geom/Surface.h

@@ -100,7 +100,7 @@ class GEOS_DLL Surface : public Geometry {
     int
     compareToSameClass(const Geometry* g) const override;
 
-    // Helper method allowing PolygonImpl to use GeometryFactory without cirular imports
+    // Helper method allowing PolygonImpl to use GeometryFactory without circular imports
     static std::unique_ptr<Geometry> createEmptyRing(const GeometryFactory&);
 
     virtual Curve* getExteriorRing() = 0;

include/geos/io/WKTWriter.h

@@ -107,7 +107,7 @@ class GEOS_DLL WKTWriter {
     /**
      * Generates the WKT for a N-point <code>LineString</code>.
      *
-     * @param seq the sequence to outpout
+     * @param seq the sequence to output
      *
      * @return the WKT
      */

include/geos/noding/IteratedNoder.h

@@ -104,7 +104,7 @@ class GEOS_DLL IteratedNoder : public Noder { // implements Noder
 
 
     /** \brief
-     * Fully nodes a list of {@link SegmentString}s, i.e. peforms noding iteratively
+     * Fully nodes a list of {@link SegmentString}s, i.e. performs noding iteratively
      * until no intersections are found between segments.
      *
      * Maintains labelling of edges correctly through the noding.

include/geos/operation/overlayng/OverlayUtil.h

@@ -69,7 +69,7 @@ class GEOS_DLL OverlayUtil {
     * are:
     *
     * - INTERSECTION: result envelope is the intersection of the input envelopes
-    * - DIFERENCE: result envelope is the envelope of the A input geometry
+    * - DIFFERENCE: result envelope is the envelope of the A input geometry
     *
     * Otherwise, <code>null</code> is returned to indicate full extent.
     */

include/geos/planargraph/DirectedEdge.h

@@ -84,7 +84,7 @@ class GEOS_DLL DirectedEdge: public GraphComponent {
      * to the given parentEdges vector.
      *
      * @note Parents are pushed to the parentEdges vector, make sure
-     * it is empty if index-based corrispondence is important.
+     * it is empty if index-based correspondence is important.
      */
     static void toEdges(std::vector<DirectedEdge*>& dirEdges,
                         std::vector<Edge*>& parentEdges);

include/geos/vend/json.hpp

@@ -5091,7 +5091,7 @@ struct wide_string_input_helper<BaseInputAdapter, 2>
     }
 };
 
-// Wraps another input apdater to convert wide character types into individual bytes.
+// Wraps another input adapter to convert wide character types into individual bytes.
 template<typename BaseInputAdapter, typename WideCharType>
 class wide_string_input_adapter
 {