ignorePaths:
  - build/**
  - src/libxrpl/crypto
  - CMakeUserPresets.json
  - Doxyfile
  - docs/**/*.puml
  - cmake/**
  - LICENSE.md
  - .clang-tidy
language: en
allowCompoundWords: true # TODO (#6334)
ignoreRandomStrings: true
minWordLength: 5
dictionaries:
  - cpp
  - en_US
  - en_GB
ignoreRegExpList:
  - /\b[rs][1-9A-HJ-NP-Za-km-z]{25,34}/g # addresses and seeds
  - /\bC[A-Z0-9]{15}/g # CTIDs
  - /\b(XRPL|BEAST)_[A-Z_0-9]+_H_INCLUDED+/g # include guards
  - /\b(XRPL|BEAST)_[A-Z_0-9]+_H+/g # include guards
  - /::[a-z:_]+/g # things from other namespaces
  - /\blib[a-z]+/g # libraries
  - /\b[0-9]{4}-[0-9]{2}-[0-9]{2}[,:][A-Za-zÀ-ÖØ-öø-ÿ.\s]+/g # copyright dates
  - /\b[0-9]{4}[,:]?\s*[A-Za-zÀ-ÖØ-öø-ÿ.\s]+/g # copyright years
  - /\[[A-Za-z0-9-]+\]\(https:\/\/github.com\/[A-Za-z0-9-]+\)/g # Github usernames
  - /-[DWw][a-zA-Z0-9_-]+=/g # compile flags
  - /[\['"`]-[DWw][a-zA-Z0-9_-]+['"`\]]/g # compile flags
  - ABCDEFGHIJKLMNOPQRSTUVWXYZ
  - ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz
overrides:
  - filename: "**/*_test.cpp" # all test files
    ignoreRegExpList:
      - /"[^"]*"/g # double-quoted strings
      - /'[^']*'/g # single-quoted strings
      - /`[^`]*`/g # backtick strings
suggestWords:
  - xprl->xrpl
  - xprld->xrpld # cspell: disable-line not sure what this problem is....
  - unsynched->unsynced # cspell: disable-line not sure what this problem is....
  - synched->synced
  - synch->sync
words:
  - abempty
  - AMMID
  - amt
  - amts
  - asnode
  - asynchrony
  - attestation
  - authorises
  - autobridge
  - autobridged
  - autobridging
  - bimap
  - bindir
  - bookdir
  - Bougalis
  - Britto
  - Btrfs
  - canonicality
  - changespq
  - checkme
  - choco
  - chrono
  - citardauq
  - clawback
  - clawbacks
  - coeffs
  - coldwallet
  - compr
  - conanfile
  - conanrun
  - confs
  - connectability
  - coro
  - coros
  - cowid
  - cryptocondition
  - cryptoconditional
  - cryptoconditions
  - csprng
  - ctest
  - ctid
  - currenttxhash
  - daria
  - dcmake
  - dearmor
  - deleteme
  - demultiplexer
  - deserializaton
  - desync
  - desynced
  - determ
  - distro
  - doxyfile
  - dxrpl
  - endmacro
  - exceptioned
  - Falco
  - fcontext
  - finalizers
  - firewalled
  - fmtdur
  - fsanitize
  - funclets
  - gcov
  - gcovr
  - ghead
  - Gnutella
  - gpgcheck
  - gpgkey
  - hotwallet
  - hwaddress
  - hwrap
  - ifndef
  - inequation
  - insuf
  - insuff
  - invasively
  - iou
  - ious
  - isrdc
  - itype
  - jemalloc
  - jlog
  - jtnofill
  - keylet
  - keylets
  - keyvadb
  - kwarg
  - kwargs
  - ledgerentry
  - ledgerhash
  - ledgerindex
  - leftw
  - legleux
  - levelization
  - levelized
  - libpb
  - libxrpl
  - llection
  - LOCALGOOD
  - logwstream
  - lseq
  - lsmf
  - ltype
  - mcmodel
  - MEMORYSTATUSEX
  - Merkle
  - Metafuncton
  - misprediction
  - mptbalance
  - MPTDEX
  - mptflags
  - mptid
  - mptissuance
  - mptissuanceid
  - mptoken
  - mptokenid
  - mptokenissuance
  - mptokens
  - mpts
  - mtgox
  - multisig
  - multisign
  - multisigned
  - Nakamoto
  - nftid
  - nftoffer
  - nftoken
  - nftokenid
  - nftokenpages
  - nftokens
  - nftpage
  - nikb
  - nixfmt
  - nixos
  - nixpkgs
  - NOLINT
  - NOLINTNEXTLINE
  - nonxrp
  - noripple
  - nudb
  - nullptr
  - nunl
  - Nyffenegger
  - ostr
  - pargs
  - partitioner
  - paychan
  - paychans
  - permdex
  - perminute
  - permissioned
  - pointee
  - populator
  - preauth
  - preauthorization
  - preauthorize
  - preauthorizes
  - preclaim
  - protobuf
  - protos
  - ptrs
  - pushd
  - pyenv
  - pyparsing
  - qalloc
  - queuable
  - Raphson
  - replayer
  - rerere
  - retriable
  - RIPD
  - ripdtop
  - rippleci
  - rippled
  - ripplerpc
  - rippletest
  - RLUSD
  - rngfill
  - rocksdb
  - Rohrs
  - roundings
  - sahyadri
  - Satoshi
  - scons
  - secp
  - sendq
  - seqit
  - sf
  - SFIELD
  - sfields
  - shamap
  - shamapitem
  - sidechain
  - SIGGOOD
  - sle
  - sles
  - soci
  - socidb
  - sslws
  - statsd
  - STATSDCOLLECTOR
  - stissue
  - stnum
  - stobj
  - stobject
  - stpath
  - stpathset
  - sttx
  - stvar
  - stvector
  - stxchainattestations
  - superpeer
  - superpeers
  - takergets
  - takerpays
  - ters
  - TMEndpointv2
  - trixie
  - tx
  - txid
  - txids
  - txjson
  - txn
  - txns
  - txs
  - UBSAN
  - ubsan
  - umant
  - unacquired
  - unambiguity
  - unauthorizes
  - unauthorizing
  - unergonomic
  - unfetched
  - unflatten
  - unfund
  - unimpair
  - unroutable
  - unscalable
  - unserviced
  - unshareable
  - unshares
  - unsquelch
  - unsquelched
  - unsquelching
  - unvalidated
  - unveto
  - unvetoed
  - upvotes
  - USDB
  - variadics
  - venv
  - vfalco
  - vinnie
  - wasmi
  - wextra
  - wptr
  - writeme
  - wsrch
  - wthread
  - xbridge
  - xchain
  - ximinez
  - EXPECT_STREQ
  - XMACRO
  - xrpkuwait
  - xrpl
  - xrpld
  - xrplf
  - xxhash
  - xxhasher