.github/actions/spelling/README.md

@@ -0,0 +1,15 @@
+# check-spelling/check-spelling configuration
+
+File | Purpose | Format | Info
+-|-|-|-
+[dictionary.txt](dictionary.txt) | Replacement dictionary (creating this file will override the default dictionary) | one word per line | [dictionary](https://github.com/check-spelling/check-spelling/wiki/Configuration#dictionary)
+[allow.txt](allow.txt) | Add words to the dictionary | one word per line (only letters and `'`s allowed) | [allow](https://github.com/check-spelling/check-spelling/wiki/Configuration#allow)
+[reject.txt](reject.txt) | Remove words from the dictionary (after allow) | grep pattern matching whole dictionary words | [reject](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-reject)
+[excludes.txt](excludes.txt) | Files to ignore entirely | perl regular expression | [excludes](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-excludes)
+[only.txt](only.txt) | Only check matching files (applied after excludes) | perl regular expression | [only](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-only)
+[patterns.txt](patterns.txt) | Patterns to ignore from checked lines | perl regular expression (order matters, first match wins) | [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-patterns)
+[expect.txt](expect.txt) | Expected words that aren't in the dictionary | one word per line (sorted, alphabetically) | [expect](https://github.com/check-spelling/check-spelling/wiki/Configuration#expect)
+[advice.md](advice.md) | Supplement for GitHub comment when unrecognized words are found | GitHub Markdown | [advice](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice)
+
+Note: you can replace any of these files with a directory by the same name (minus the suffix)
+and then include multiple files inside that directory (with that suffix) to merge multiple files together.

.github/actions/spelling/advice.md

@@ -0,0 +1,10 @@
+<details>
+<summary>
+:pencil2: Contributor please read this
+</summary>
+
+* You can probably just add items into `.github/actions/spell-check/expect/expect.txt`.
+
+* If you need to use a specific token in one place and it shouldn't generally be used, you can add an item in `.github/actions/spell-check/patterns.txt`.
+
+</details>

.github/actions/spelling/allow/haskell.txt

@@ -0,0 +1,111 @@
+Abitrary
+aeson
+anyclass
+bgroup
+bignum
+bytestring
+CBool
+CChar
+CInt
+coarbitrary
+compat
+coseries
+Coseries
+CPtrdiff
+CShort
+CSig
+CSize
+CWchar
+deepseq
+Exts
+fdicts
+fmap
+fmax
+fno
+foldl
+Foldl
+foldr
+Foldr
+forall
+frac
+fsimpl
+fspec
+fst
+funfolding
+fwarn
+fwrite
+gcc
+ghc
+GHC
+ghci
+gmp
+GMP
+hackage
+Hackage
+haskell
+Haskell
+hiedir
+HLINT
+hpc
+html
+hunit
+HUnit
+idx
+impl
+infixr
+INLINABLE
+lhs
+libiserv
+los
+mappend
+mathcal
+mconcat
+mempty
+metadata
+mtl
+newtype
+Newtype
+NOINLINE
+oadjust
+oall
+oany
+oelem
+ofold
+ofoldl
+ofoldr
+oindex
+olength
+olookup
+omap
+Omap
+onot
+onull
+oreplace
+oto
+otraverse
+ozip
+pfail
+Ptr
+Punc
+quickcheck
+rhs
+rnf
+rtsopts
+sconcat
+semigroups
+showb
+smallcheck
+snd
+succ
+svg
+textshow
+typeclass
+typeclasses
+uncurry
+unlines
+unnary
+unwords
+Werror
+Weverything
+Wno
+

.github/actions/spelling/allow/programming.txt

@@ -0,0 +1,46 @@
+api
+brightgreen
+broadword
+changelog
+codebase
+deps
+dhall
+dirs
+docdir
+endian
+Endian
+endianness
+endif
+enum
+Enum
+exitcode
+filepath
+github
+hashable
+Hashable
+Homepage
+htmldir
+http
+https
+hyperlink
+img
+installdir
+lts
+ncpus
+opensource
+README
+src
+stdio
+sudo
+Unicode
+wiki
+wikipedia
+Workflow
+workflows
+XNOR
+xor
+yaml
+yml
+semver
+versioning
+

.github/actions/spelling/allow/project.txt

@@ -0,0 +1,5 @@
+bitvec
+bvs
+VBV
+VBVs
+VBVS

.github/actions/spelling/excludes.txt

@@ -0,0 +1,2 @@
+# Ignore directories named `.git`
+(?:^|/)\.git.*/

.github/actions/spelling/patterns.txt

@@ -0,0 +1,3 @@
+# LaTeX-like formatting in Haddock documentation for nicely rendered asymptotics.
+\\left
+\\right