.cspell.json

// cSpell is our spell checker
// See: https://github.com/streetsidesoftware/cspell/tree/master/packages/cspell
{
  // Version of the setting file.  Always 0.1
  "version": "0.1",
  // language - current active spelling language
  "language": "en",
  // dictionaries - list of the names of the dictionaries to use
  "dictionaries": [
    "en_US",
    "softwareTerms",
    "cpp",
    "python",
    "python-custom"
  ],
  // dictionaryDefinitions - this list defines any custom dictionaries to use
  "dictionaryDefinitions": [
    {
      "name": "python-custom",
      "path": "./.cspell_python.txt"
    }
  ],
  "ignorePaths": [
    "**/*.stencil", // Sourcery templates
    "**/__pycache__/**",
    "**/node_modules/**", // Yep, we got some of dem JavaScript! (To generate BigInt tests)
    "./PyTests/RustPython/**", // They know what they are doing
    "./Scripts/**/*.out", // Compiled files
    "./Scripts/unicode/*.txt", // Unicode database
    "./Scripts/unicode/*.zip", // Some more Unicode
    "./Tests/UnicodeDataTests/Generated/*.swift", // Even more Unicode (this is tle last one, I promise!)
    "./Scripts/module_generate_empty_definition/*.html", // .html file that we will use to generate module scaffolding (with docs)
    "./Sources/Objects/Generated/Sourcery/dump.txt", // File generated by 'Sourcery'
    "./Scripts/ariel_output/*"
  ],
  // words - list of words to be always considered correct
  "words": [
    // Swift
    "struct",
    "structs",
    "typealias",
    "associatedtype",
    "fileprivate",
    "inout",
    "nonmutating",
    "discardable", // @discardableResult
    "deinit",
    "Hashable",
    "Hasher",
    "Strideable",
    "Reflectable", // CustomReflectable
    "lowercased",
    "uppercased",
    "uniquing", // https://developer.apple.com/documentation/swift/dictionary/3127161-init
    "pointee", // https://developer.apple.com/documentation/swift/unsafepointer/1640970-pointee
    "significand", // https://developer.apple.com/documentation/swift/binaryfloatingpoint
    "whitespaces", // https://developer.apple.com/documentation/foundation/nscharacterset/1413732-whitespacesandnewlines
    "titlecase", // Unicode prop
    "swiftlint",
    "swiftformat",
    "sourcery",
    "corelibs", // swift-corelibs-foundation
    // Python
    "cpython",
    "Bdfl", // Benevolent dictator for life
    "BDEVIL", // Benevolent Dictator Emeritus Vacationing Indefinitely from the Language (PEP-401)
    "FLUFL", // Friendly Language Uncle For Life (PEP-401)
    "kwarg",
    "kwargs",
    "vararg",
    "varargs",
    "metaclass", // Cthulhu
    "metaclasses", // Cthulhu (plural)
    "metatype", // Cthulhu (different name)
    "fstring", // Formatted string
    "fstrings",
    "docstring",
    "docstrings",
    "fileencoding",
    "linearization", // Python uses C3 linearization: https://www.python.org/download/releases/2.3/mro/
    "linearize",
    "keyworded", // Adjective of 'keyword', as in 'keyworded argument'
    "PYTHONDEBUG",
    "PYTHONINSPECT",
    "PYTHONPATH",
    "PYTHONHOME",
    "PYTHONPATH",
    "PYTHONVERBOSE",
    "PYTHONOPTIMIZE",
    "PYTHONWARNINGS",
    "VIOLETPATH",
    "VIOLETHOME",
    "Wdefault",
    "Werror",
    "Walways",
    "Wmodule",
    "Wonce",
    "Wignore",
    // Violet
    "Evergarden", // “Violet Evergarden” is the full character name
    "pytype",
    "pybase",
    "pyerrortype",
    "pymethod",
    "pytypedoc",
    "pystaticmethod",
    "pyclassmethod",
    "pyproperty",
    "pymain",
    "pystring",
    "zelf", // This is how we call 'self' parameter in static methods
    "pytest",
    "pytests",
    "Smi", // Part of our BigInt representation: small 32 bit integer
    "Smis",
    "letitgo", // File extension of our 'Elsa' tool
    // Disnep
    "Disnep", // Correct form of spelling “Disney” (look at the logo!)
    "Gaston", // Best waifu
    "Waifu", // Gaston
    "Arendelle", // Elsa homeland from “Frozen”
    "Kristoff", // Anna boyfriend from “Frozen”
    "snowgies", // Official (!) name of the small creatures that Elsa created
    "Frollo", // Antagonist from “The Hunchback of Notre Dame”
    "Jafar", // Antagonist from “Aladdin”
    "Agrabah", // City from “Aladdin”
    "Tigger", // Character from “Winnie the Pooh”, correct form of spelling “tiger”
    "Howse", // Rabbits Howse from “Winnie the Pooh”
    "Mulan", // You know who she is…
    "Maximus", // Horse from “Tangled”
    "Nani", // Sister from “Lilo & Stitch”
    "Cogsworth", // Character from “Beauty and the Beast”
    // Other
    "Galavant", // https://www.youtube.com/watch?v=QWnDwM0RSX4
    "Pikachu", // Mostly used inside “<surprised Pikachu face>”
    "bestdressed", // AKA. Ashley: https://www.youtube.com/channel/UCnQhwPVwcP-DnbUZtIMrupw
    // Cute
    "thingie", // Very important word, use often
    "smol", // 'small' but more cute
    "teknikly", // Other way of spelling 'technically', always surrounded by '*'
    "nuff", // 'nuff said
    "c'mon",
    "YOLO",
    // Algorithms
    "Wadler", // Philip Wadler (creator of our pretty printing algorithm)
    "Siphash", // Hashing algorithm
    "Aumasson", // Jean-Philippe Aumasson (creator of siphash)
    "Karatsuba", // BigInt multiplication algorithm
    // Function arity
    "nullary",
    "quartary",
    "quintary",
    // Events/websites
    "WWDC",
    "cppreference",
    "greentreesnakes", // https://greentreesnakes.readthedocs.io/en/latest/nodes.html
    // Other
    "Bytecode",
    "richcompare",
    "klass",
    "onespace",
    "unwinded",
    "subiterator", // Used inside instruction description
    "unicodectype", // Generating Unicode database
    "makeunicodedata",
    "unhashable",
    "subclassing",
    "typealiases",
    "choseong", // HANGUL CHOSEONG THIEUTH
    "thieuth"
  ],
  // flagWords - list of words to be always considered incorrect
  "flagWords": [
    "hte",
    "Disney" // Incorrect spelling of “Disnep”
  ],
  // TODO: Simplify?
  "ignoreRegExpList": [
    "[Ss](o)+[… ]", // Sooooo…
    "[Oo]+ps…", // Ooooops… - means that something went bad
    "[Ww](a)+y " // Waaaay too much
  ],
  // languageSettings - allow for per programming language configuration settings.
  "languageSettings": [
    {
      "languageId": "swift",
      "locale": "en",
      "words": [
        // Token related
        "amper", // &
        "vbar", // |
        "paren", // ()
        "parens",
        "dedent",
        "dedents",
        // AST related (mostly CPython grammar rule names)
        "asdl", // Root of CPython AST
        "tfpdef",
        "vfpdef",
        "funcdef",
        "classdef",
        "lambdef",
        "exprlist",
        "testlist",
        "arglist",
        "varargslist",
        "subscriptlist",
        "typedargslist",
        "augassign",
        "annassign",
        "sliceop",
        "parsestrplus",
        "dictorsetmaker",
        "nocond",
        "stmt",
        "stmts",
        "ENDMARKER",
        // Bytecode related
        "genexpr", // Code object names
        "listcomp",
        "setcomp",
        "dictcomp",
        "lnotab", // Code object properties
        "consts",
        "varnames",
        "freevars",
        "cellvars",
        "argcount",
        "kwonlyargcount",
        // Compiler related
        "symtable",
        "classcell",
        "qualname",
        "subscope",
        "subscopes",
        // Other
        "cyclomatic",
        "multiline",
        "TLDR",
        "prepend", // https://dictionary.cambridge.org/dictionary/english/prepend
        "subword",
        "Conformances",
        "bitshift",
        "deinitializing",
        "reimplement",
        "reimplemented",
        "concat", // concatenation
        "mkdirp"
      ]
    },
    {
      "languageId": "python",
      "locale": "en"
    },
    {
      "languageId": "markdown",
      "locale": "en",
      "words": [
        "pyhash",
        "uhash",
        "hashreal",
        "hashimag",
        "complexobject",
        "tupleobject",
        "tuplesubscript",
        "tupleitem",
        "listobject",
        "typeobject",
        "typeobj",
        "objimpl",
        "longobject",
        "longintrepr",
        "vectord",
        "pymethods",
        "gcmodule",
        "basicsize",
        "itemsize",
        "SSTATE",
        "malloc'ed",
        "DECREF",
        "arities", // Plural of 'arity': https://en.wiktionary.org/wiki/arity
        "Gameboy", // We sometimes compare our bytecode to Gameboy instructions
        "memberwise",
        "COVID",
        "lockdown"
      ]
    }
  ]
}