Fix typos and add typos check action.

rnpgp · Sep 18, 2024 · 4ce0d1f · 4ce0d1f
1 parent 78f8dcc
commit 4ce0d1f
Show file tree

Hide file tree

Showing 8 changed files with 20 additions and 7 deletions.
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -54,3 +54,12 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: ludeeus/action-shellcheck@master
+  typos:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+          submodules: true
+      - uses: crate-ci/typos@master
+
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -250,7 +250,7 @@ if(WITH_SEXP_TESTS)
         set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
         # do not install gtest
         set(INSTALL_GTEST OFF CACHE BOOL "" FORCE)
-        # explicitely disable unneeded gmock build
+        # explicitly disable unneeded gmock build
         set(BUILD_GMOCK OFF CACHE BOOL "" FORCE)
 
         FetchContent_MakeAvailable(googletest)

diff --git a/README.adoc b/README.adoc
@@ -20,7 +20,7 @@ Prof. Ronald Rivest and Prof. Butler Lampson of MIT LCS (now CSAIL).
 
 This library differs from the original C implementation in the following ways:
 
-* It aims to be reuseable in C++ implementations and is importable via CMake.
+* It aims to be reusable in C++ implementations and is importable via CMake.
 * It includes a test suite for correctness testing and tests against malformed
   S-Expressions.
 * It supports, and is tested against, all major platforms, including:

diff --git a/_typos.toml b/_typos.toml
@@ -0,0 +1,4 @@
+[files]
+extend-exclude = [
+    "tests/abi/libsexpp.0.abi"
+]
diff --git a/include/sexpp/sexp.h b/include/sexpp/sexp.h
@@ -44,7 +44,7 @@
 #include "sexp-public.h"
 #include "sexp-error.h"
 
-// We are implementing char traits for octet_t with trhe following restrictions
+// We are implementing char traits for octet_t with the following restrictions
 //  -- limit visibility so that other traits for unsigned char are still possible
 //  -- create template specializatio in std workspace (use workspace specialization
 //     is not specified and causes issues at least with gcc 4.8
@@ -454,7 +454,7 @@ class SEXP_PUBLIC_SYMBOL sexp_output_stream_t : sexp_depth_manager {
   public:
     const uint32_t default_line_length = 75;
     enum sexp_print_mode {                /* PRINTING MODES */
-                           canonical = 1, /* standard for hashing and tranmission */
+                           canonical = 1, /* standard for hashing and transmission */
                            base64 = 2,    /* base64 version of canonical */
                            advanced = 3   /* pretty-printed */
     };

diff --git a/tests/scripts/tests.sh b/tests/scripts/tests.sh
@@ -96,7 +96,7 @@ test_install_script() {
 
 # ......................................................................
 # Check sexp client application
-# THese are the examples from README.adoc
+# These are the examples from README.adoc
 test_sexp_cli() {
    echo "==> SEXP client application test"
 

diff --git a/tests/src/exception-tests.cpp b/tests/src/exception-tests.cpp
@@ -60,7 +60,7 @@ TEST_F(ExceptionTests, IllegalCharacter)
                            "SEXP ERROR: illegal character '?' (0x3f) at position 16");
 }
 
-TEST_F(ExceptionTests, UnexpectedEofAfterQoute)
+TEST_F(ExceptionTests, UnexpectedEofAfterQuote)
 {
     do_scan_with_exception("(\")\n", "SEXP ERROR: unexpected end of file at position 4");
 }

diff --git a/tests/src/primitives-tests.cpp b/tests/src/primitives-tests.cpp
@@ -110,7 +110,7 @@ TEST_F(PrimitivesTests, Base64Ofoctet_t)
     do_test_advanced("|YWJj|", "abc");
 }
 
-TEST_F(PrimitivesTests, Base64OfVerbatium)
+TEST_F(PrimitivesTests, Base64OfVerbatim)
 {
     do_test_canonical("{MzphYmM=}", "3:abc");
     do_test_advanced("{MzphYmM=}", "abc");