christoph-maurer
commented
2 years ago In PR #241, I tried the plugin Code Spell Checker for Visual Studio Code. In settings.json, I added
"cSpell.language": "en-US",However, Code Spell Checker does not detect words in British English. Therefore, I closed #241.
One result of #241 which may be useful is the list of words which should be excluded from the spell checking. They don't appear in the dictionary, but are needed in the repository:
"cSpell.userWords": [
"AERC",
"ASHRAE",
"ASTM",
"BIPV",
"BIST",
"BREEAM",
"BSDF",
"CENELEC",
"CIELAB",
"Conshohocken",
"Coreutils",
"DGNB",
"DVWG",
"FIPS",
"Fronius",
"Galvo",
"Glaz",
"Goniometric",
"IPXX",
"Klems",
"Koester",
"Kwith",
"LBNL",
"LEED",
"Latn",
"Mermet",
"NFRC",
"POSIX",
"Retrolux",
"Revit",
"Riba",
"SHGC",
"SPARQL",
"Soleil",
"Subtag",
"UNECE",
"WUFI",
"accreditations",
"addkey",
"brep",
"brise",
"buildingenvelopedata",
"concretization",
"decentral",
"decentrally",
"dgst",
"emittance",
"ffffffzzz",
"hkps",
"hygrothermal",
"keypairs",
"keyserver",
"keysize",
"lichtplanung",
"longwave",
"marquisolette",
"metabase",
"micromorph",
"monocrystalline",
"nanocrystalline",
"nearnormal",
"nurbs",
"officedocument",
"openxmlformats",
"perovskite",
"photovoltaics",
"plasmonic",
"poissons",
"prepending",
"shasum",
"solener",
"standardizer",
"standardizers",
"subcomponents",
"subkey",
"subschema",
"underspecified",
"wavelenghts",
"wordprocessingml"
], Maybe, the plugin Spell Right for Visual Studio Code is able to detect British English?
In order to avoid confusion, the keys must use American English and the rest should use American English. The documentation (README, ...) should state this clearly.
This task is done best with a software for spell-checking. In the same run, typos and misspellings should be corrected.