From ff86c5328e02c752f008b56cadcffc37852cacca Mon Sep 17 00:00:00 2001 From: Jason Dent Date: Tue, 18 Feb 2020 15:33:44 +0100 Subject: [PATCH] docs: thoughts on changes to settings. --- packages/client/docs/settings.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 packages/client/docs/settings.md diff --git a/packages/client/docs/settings.md b/packages/client/docs/settings.md new file mode 100644 index 0000000000..6fb771e585 --- /dev/null +++ b/packages/client/docs/settings.md @@ -0,0 +1,20 @@ +# Settings + +Settings, Configuration, and Preferences + +## `cSpell.configLocation` +A resource level setting that specifies the location of the `cspell.json` file. + +## `cSpell.userWordsUrl`, `cSpell.wordsUrl`, `cSpell.ignoreWordsUrl` + + +## Raw Notes + +* need setting to indicate that settings should use `cspell.json` by default. +* need to be able to specify the location of user words, words, ignore words, and forbid words. +* would like to have a format for a single list of words that represents words / ignore / forbid. + * Use the format for cspell 5 + * `!` indicates forbidden + * `+` indicates compound required + * `*` indicates optional compound + * ` ` (don't know yet) indicates do not suggest.