Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
These are some small repo changes that I've had locally for a little while and on't want to keep git-ignoring locally or stashing every PR
.vscode/cspell.json
to include a dictionary of words used in this project for the spell checker@ts-expect-error
inCesiumSandcastle
because it's using the "wrong"require
function and if you have JS Type checking on it flags the entire fileCode Spell Checker
Code spell checker is really helpful when coding to make sure variable names and strings are spelled correctly. Longer term we may want to add
cspell
as a CI or pre-commit check but right now there's too many words that would be flagged as incorrect to justify that effort. To that end I do want to push people to use the extension more and collectively, gradually build up the dictionary until we're at a point there are very few flagged words and using the cli is more seemless.When a word is flagged you just have to put the cursor on it and trigger the VSCode suggestion window
Ctrl+.
for me. Then just make sure you select thecspell.json
file to make sure it's added to the repo's dictionary instead of your user or workspace settings.@ggetz I know we discussed this and I think you have a list of words already in your user settings, feel free to copy those over and commit to this branch if you have a bunch to add intantly
Issue number and link
Part of #11954
Testing plan
Not much to test.
You can try turning on JS type checking for the sandcastle if you want, just be aware there are still lots of other TS errors we have in the library.
Add the extension if you don't already have it and flag a word and make sure you understand how to add words to our dictionary.
Author checklist
CONTRIBUTORS.md
CHANGES.md
with a short summary of my change