add cspell pre-commit

.config/cspell.config.yaml

@@ -0,0 +1,154 @@
+ignorePaths:
+    - external/**
+    - build/**
+    # TODO: go through test files too
+    # For a first cut, just ignore everything in src/test
+    - src/test/**
+    - src/libxrpl/crypto
+    - CMakeUserPresets.json
+language: en
+dictionaries:
+    - cpp
+ignoreRegExpList:
+    - /r[1-9A-HJ-NP-Za-km-z]{25,34}/g
+    - /RIPPLE_[A-Z_]+_H_INCLUDED+/g
+    - /RIPPLE_[A-Z_]+_H+/g
+    - /boost::[a-z:]+/g
+    - /std::[a-z:]+/g
+    - /sle[a-z]{1,3}/g
+    - /[a-z]{1,3}obj/g
+    - /lib[a-z]+/g
+    - /https?:\/\/[^\s"'<>]+/g
+ignoreWords:
+    - nudb
+    - rippled
+    - xrpl
+    - rippletest
+    - levelization
+    - distro
+    - xrplf
+    - libpb
+    - protos
+    - protobuf
+    - jemalloc
+    - keylet
+    - keylets
+    - insuf
+    - clawback
+    - vfalco
+    - funclets
+    - shamap
+    - rocksdb
+    - noripple
+    - mptoken
+    - mptokens
+    - nftoken
+    - nftokens
+    - mptid
+    - mptokenid
+    - nftid
+    - nftokenid
+    - permissioned
+    - variadics
+    - jlog
+    - daria
+    - checkme
+    - xchain
+    - insuff
+    - preauth
+    - preauthorization
+    - preauthorize
+    - libxrpl
+    - legleux
+    - sle
+    - sles
+    - txs
+    - tx
+    - txid
+    - txids
+    - txjson
+    - txn
+    - txns
+    - deserializaton
+    - ledgerhash
+    - ledgerindex
+    - wptr
+    - replayer
+    - cowid
+    - xrpld
+    - conanrun
+    - bindir
+    - ters
+    - RIPD
+    - USDB
+    - RLUSD
+    - ters
+    - AMMID
+    - takerpays
+    - takergets
+    - autobridged
+    - autobridge
+    - autobridging
+    - mptissuance
+    - preclaim
+    - finalizers
+    - LOCALGOOD
+    - SIGGOOD
+    - compr
+    - shamapitem
+    - ptrs
+    - Merkle
+    - nullptr
+    - ctid
+    - nftoffer
+    - ledgerentry
+    - hotwallet
+    - coldwallet
+    - venv
+    - pyenv
+    - gcov
+    - inequation
+    - levelized
+    - vinnie
+    - falco
+    - fmtdur
+    - ifndef
+    - nunl
+    - sidechain
+    - nftpage
+    - cryptocondition
+    - cryptoconditions
+    - preauthorizes
+    - coro
+    - unshareable
+    - chrono
+    - sttx
+    - stobj
+    - queuable
+    - multisigned
+    - multisign
+    - multisig
+    - nikb
+    - rngfill
+    - paychan
+    - perminute
+    - ious
+    - iou
+    - stpath
+    - stpathset
+    - amt
+    - amts
+    - xxhasher
+    - bookdir
+    - ripplerpc
+    - mptflags
+    - mptbalance
+    - permdex
+    - ostr
+    - soci
+    - unshares
+    - lseq
+    - secp
+    - superpeer
+    - superpeers
+    - nftokenpages

.pre-commit-config.yaml

@@ -50,6 +50,20 @@ repos:
         entry: check-merge-conflict --assume-in-merge
         language: system
         types: [text]
+  - repo: https://github.com/streetsidesoftware/cspell-cli
+    rev: v9.2.0
+    hooks:
+      - id: cspell # Spell check changed files
+      - id: cspell # Spell check the commit message
+        name: check commit message spelling
+        args:
+          - --no-must-find-files
+          - --no-progress
+          - --no-summary
+          - --files
+          - .git/COMMIT_EDITMSG
+        stages: [commit-msg]
+        always_run: true # This might not be necessary.
   - repo: local
     hooks:
       - id: prettier

docs/0001-negative-unl/negativeUNLSqDiagram.puml

@@ -43,7 +43,7 @@ alt phase == OPEN
             alt sqn%256==0
             CA -[#green]> RM: <font color=green>getValidations
             CA -[#green]> CA: <font color=green>create UNLModify Tx
-            hnote over CA#lightgreen: use validatations of the last 256 ledgers\nto figure out UNLModify Tx candidates.\nIf any, create UNLModify Tx, and add to TxSet.
+            hnote over CA#lightgreen: use validations of the last 256 ledgers\nto figure out UNLModify Tx candidates.\nIf any, create UNLModify Tx, and add to TxSet.
             end
         CA -> GC
         GC -> CA: propose

include/xrpl/beast/unit_test/runner.h

@@ -42,7 +42,7 @@ class runner
 
         The argument string is available to suites and
         allows for customization of the test. Each suite
-        defines its own syntax for the argumnet string.
+        defines its own syntax for the argument string.
         The same argument is passed to all suites.
     */
     void

include/xrpl/json/json_reader.h

@@ -87,7 +87,7 @@ class Reader
      * error occurred during parsing.
      */
     std::string
-    getFormatedErrorMessages() const;
+    getFormattedErrorMessages() const;
 
     static constexpr unsigned nest_limit{25};
 

include/xrpl/protocol/Indexes.h

@@ -37,7 +37,7 @@
 namespace ripple {
 
 class SeqProxy;
-/** Keylet computation funclets.
+/** Keylet computation functions.
 
     Entries in the ledger are located using 256-bit locators. The locators are
     calculated using a wide range of parameters specific to the entry whose

include/xrpl/protocol/Permissions.h

@@ -46,14 +46,14 @@ enum GranularPermissionType : std::uint32_t {
 #pragma pop_macro("PERMISSION")
 };
 
-enum Delegation { delegatable, notDelegatable };
+enum Delegation { delegable, notDelegatable };
 
 class Permission
 {
 private:
     Permission();
 
-    std::unordered_map<std::uint16_t, Delegation> delegatableTx_;
+    std::unordered_map<std::uint16_t, Delegation> delegableTx_;
 
     std::unordered_map<std::string, GranularPermissionType>
         granularPermissionMap_;

include/xrpl/protocol/TxFormats.h

@@ -59,7 +59,7 @@ enum TxType : std::uint16_t
 #pragma push_macro("TRANSACTION")
 #undef TRANSACTION
 
-#define TRANSACTION(tag, value, name, delegatable, fields) tag = value,
+#define TRANSACTION(tag, value, name, delegable, fields) tag = value,
 
 #include <xrpl/protocol/detail/transactions.macro>
 

include/xrpl/protocol/detail/ledger_entries.macro

@@ -254,7 +254,7 @@ LEDGER_ENTRY(ltOFFER, 0x006f, Offer, offer, ({
     {sfAdditionalBooks,      soeOPTIONAL},
 }))
 
-/** A ledger object which describes a deposit preauthorization.
+/** A ledger object which describes a deposit pre-authorization.
 
     \sa keylet::depositPreauth
  */