Skip to content

Commit

Permalink
fix: groundwork towards adding a new viewer (#2509)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jason3S committed Feb 9, 2023
1 parent 76817b1 commit f8691ae
Show file tree
Hide file tree
Showing 29 changed files with 774 additions and 165 deletions.
34 changes: 34 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
root = true

[*]
indent_style = space
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.CRLF.txt]
end_of_line = crlf

[*.noEOL.txt]
insert_final_newline = false

[*.{yaml,yml}]
indent_size = 2

[{package*.json,lerna.json}]
indent_size = 2

[.github/integrations.json]
indent_size = 2

[*.md]
indent_size = 2
trim_trailing_whitespace = false

[config.json]
indent_size = 2

[*.tsx]
indent_size = 2
2 changes: 2 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ docs/_site
node_modules
packages/_integrationTests/out/
packages/*/dist/
packages/*/out/**
.yarn
packages/client/settingsViewer/
samples/php/**/vendor
tsconfig*.json
6 changes: 5 additions & 1 deletion .vscodeignore
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,14 @@
!packages/_serverPatternMatcher/dist/main.js.LICENSE.txt
!packages/_serverPatternMatcher/package.json

!packages/client/dist/**/*.{js,LICENSE.txt}
!packages/client/dist/**/*.js
!packages/client/License.txt
!packages/client/package.json
!packages/client/settingsViewer/webapp/*.{js,html,LICENSE.txt}
!resources/**

!packages/_settingsViewerNext/out/extension.js
!packages/_settingsViewerNext/media/**
!packages/_settingsViewerNext/package.json

# cspell:ignore callsites
6 changes: 5 additions & 1 deletion Spell Checker.code-workspace
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@
"name": "Settings Viewer",
"path": "packages/_settingsViewer"
},
{
"name": "Settings Viewer Next",
"path": "packages/_settingsViewerNext"
},
{
"name": "Integration Tests",
"path": "packages/_integrationTests"
Expand All @@ -39,7 +43,7 @@
],
"settings": {
"cSpell.import": ["${workspaceFolder:Spell Checker Root}/cSpell.json"],
"cSpell.customWorkspaceDictionaries": ["cspell-words"],
"cSpell.customDictionaries": { "cspell-words": true },
"typescript.tsdk": "Spell Checker Root/node_modules/typescript/lib",
"svg.preview.background": "black",
"editor.formatOnSave": true,
Expand Down
40 changes: 20 additions & 20 deletions docs/.cspell.json
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
{
"dictionaries": ["custom-dictionary"],
"dictionaryDefinitions": [
{
"name": "custom-dictionary",
"path": "./.cspell/custom-dictionary.txt",
"addWords": true
}
],
"languageSettings": [
{
"languageId": "markdown",
"patterns": [
"dictionaries": ["custom-dictionary"],
"dictionaryDefinitions": [
{
"name": "Internal Link",
"pattern": "/(?<=\\])\\(#\\w+\\)/g"
"name": "custom-dictionary",
"path": "./.cspell/custom-dictionary.txt",
"addWords": true
}
],
"ignoreRegExpList": ["Internal Link"]
}
],
"enableFiletypes": ["ruby"],
"ignorePaths": ["_site/**"]
],
"languageSettings": [
{
"languageId": "markdown",
"patterns": [
{
"name": "Internal Link",
"pattern": "/(?<=\\])\\(#\\w+\\)/g"
}
],
"ignoreRegExpList": ["Internal Link"]
}
],
"enableFiletypes": ["ruby"],
"ignorePaths": ["_site/**"]
}
32 changes: 16 additions & 16 deletions docs/.prettierrc.json
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
{
"printWidth": 120,
"singleQuote": true,
"overrides": [
{
"files": "**/*.{yaml,yml}",
"options": {
"singleQuote": false
}
},
{
"files": "**/*.{html,htm}",
"options": {
"tabWidth": 2
}
}
]
"printWidth": 120,
"singleQuote": true,
"overrides": [
{
"files": "**/*.{yaml,yml}",
"options": {
"singleQuote": false
}
},
{
"files": "**/*.{html,htm}",
"options": {
"tabWidth": 2
}
}
]
}
2 changes: 2 additions & 0 deletions docs/_includes/generated-docs/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
| `cSpell.addWordToUserSettings` | Add Words to User Settings |
| `cSpell.addWordToWorkspaceDictionary` | Add Words to Workspace Dictionary |
| `cSpell.addWordToWorkspaceSettings` | Add Words to Workspace Settings |
| `cSpell.coding.doRefactor` | Do some refactoring<br>**When:**<br> `config.cSpell.experimental.enableSettingsViewerV2` |
| `cSpell.coding.start` | Start coding session<br>**When:**<br> `config.cSpell.experimental.enableSettingsViewerV2` |
| `cSpell.createCSpellConfig` | Create a CSpell Configuration File. |
| `cSpell.createCustomDictionary` | Create a Custom Dictionary File. |
| `cSpell.disableCurrentLanguage` | Disable Spell Checking Document Language |
Expand Down
90 changes: 55 additions & 35 deletions docs/_includes/generated-docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -297,23 +297,23 @@ Default

# Reporting and Display

| Setting | Scope | Description |
| ------------------------------------------------------------------------------------------- | -------------------- | ------------------------------------------------------------------------------- |
| [`cSpell.autoFormatConfigFile`](#cspellautoformatconfigfile) | window | Auto Format Configuration File |
| [`cSpell.diagnosticLevel`](#cspelldiagnosticlevel) | resource | Set Diagnostic Reporting Level |
| [`cSpell.hideAddToDictionaryCodeActions`](#cspellhideaddtodictionarycodeactions) | resource | Hide the options to add words to dictionaries or settings. |
| [`cSpell.maxDuplicateProblems`](#cspellmaxduplicateproblems) | resource | The maximum number of times the same word can be flagged as an error in a file. |
| [`cSpell.maxNumberOfProblems`](#cspellmaxnumberofproblems) | resource | Controls the maximum number of spelling errors per document. |
| [`cSpell.minWordLength`](#cspellminwordlength) | resource | The minimum length of a word before checking it against a dictionary. |
| [`cSpell.numSuggestions`](#cspellnumsuggestions) | resource | Controls the number of suggestions shown. |
| [`cSpell.showAutocompleteSuggestions`](#cspellshowautocompletesuggestions) | language-overridable | Show CSpell in-document directives as you type. |
| [`cSpell.showCommandsInEditorContextMenu`](#cspellshowcommandsineditorcontextmenu) | application | Show Spell Checker actions in Editor Context Menu |
| [`cSpell.showStatus`](#cspellshowstatus) | application | Display the spell checker status on the status bar. |
| [`cSpell.showStatusAlignment`](#cspellshowstatusalignment) | application | The side of the status bar to display the spell checker status. |
| [`cSpell.showSuggestionsLinkInEditorConte…`](#cspellshowsuggestionslinkineditorcontextmenu) | application | Show Spelling Suggestions link in the top level context menu. |
| [`cSpell.suggestionMenuType`](#cspellsuggestionmenutype) | resource | The type of menu used to display spelling suggestions. |
| [`cSpell.suggestionNumChanges`](#cspellsuggestionnumchanges) | resource | The maximum number of changes allowed on a word to be considered a suggestions. |
| [`cSpell.validateDirectives`](#cspellvalidatedirectives) | window | Verify that the in-document directives are correct. |
| Setting | Scope | Description |
| ------------------------------------------------------------------------------------------------ | -------------------- | ------------------------------------------------------------------------------- |
| [`cSpell.autoFormatConfigFile`](#cspellautoformatconfigfile) | window | Auto Format Configuration File |
| [`cSpell.diagnosticLevel`](#cspelldiagnosticlevel) | resource | Set Diagnostic Reporting Level |
| [`cSpell.hideAddToDictionaryCodeActions`](#cspellhideaddtodictionarycodeactions) | resource | Hide the options to add words to dictionaries or settings. |
| [`cSpell.maxDuplicateProblems`](#cspellmaxduplicateproblems) | resource | The maximum number of times the same word can be flagged as an error in a file. |
| [`cSpell.maxNumberOfProblems`](#cspellmaxnumberofproblems) | resource | Controls the maximum number of spelling errors per document. |
| [`cSpell.minWordLength`](#cspellminwordlength) | resource | The minimum length of a word before checking it against a dictionary. |
| [`cSpell.numSuggestions`](#cspellnumsuggestions) | resource | Controls the number of suggestions shown. |
| [`cSpell.showAutocompleteSuggestions`](#cspellshowautocompletesuggestions) | language-overridable | Show CSpell in-document directives as you type. |
| [`cSpell.showCommandsInEditorContextMenu`](#cspellshowcommandsineditorcontextmenu) | application | Show Spell Checker actions in Editor Context Menu |
| [`cSpell.showStatus`](#cspellshowstatus) | application | Display the spell checker status on the status bar. |
| [`cSpell.showStatusAlignment`](#cspellshowstatusalignment) | application | The side of the status bar to display the spell checker status. |
| [`cSpell.showSuggestionsLinkInEditorContextMenu`](#cspellshowsuggestionslinkineditorcontextmenu) | application | Show Spelling Suggestions link in the top level context menu. |
| [`cSpell.suggestionMenuType`](#cspellsuggestionmenutype) | resource | The type of menu used to display spelling suggestions. |
| [`cSpell.suggestionNumChanges`](#cspellsuggestionnumchanges) | resource | The maximum number of changes allowed on a word to be considered a suggestions. |
| [`cSpell.validateDirectives`](#cspellvalidatedirectives) | window | Verify that the in-document directives are correct. |

## Definitions

Expand Down Expand Up @@ -925,14 +925,14 @@ Default

# Performance

| Setting | Scope | Description |
| ------------------------------------------------------------------------------------------------- | -------------------- | -------------------------------------------------------------------------------- |
| [`cSpell.blockCheckingWhenAverageChunkSiz…`](#cspellblockcheckingwhenaveragechunksizegreaterthan) | language-overridable | The maximum average length of chunks of text without word breaks. |
| [`cSpell.blockCheckingWhenLineLengthGreat…`](#cspellblockcheckingwhenlinelengthgreaterthan) | language-overridable | The maximum line length. |
| [`cSpell.blockCheckingWhenTextChunkSizeGr…`](#cspellblockcheckingwhentextchunksizegreaterthan) | language-overridable | The maximum length of a chunk of text without word breaks. |
| [`cSpell.checkLimit`](#cspellchecklimit) | resource | The limit in K-Characters to be checked in a file. |
| [`cSpell.spellCheckDelayMs`](#cspellspellcheckdelayms) | application | Delay in ms after a document has changed before checking it for spelling errors. |
| [`cSpell.suggestionsTimeout`](#cspellsuggestionstimeout) | resource | The maximum amount of time in milliseconds to generate suggestions for a word. |
| Setting | Scope | Description |
| ------------------------------------------------------------------------------------------------------------ | -------------------- | -------------------------------------------------------------------------------- |
| [`cSpell.blockCheckingWhenAverageChunkSizeGreaterThan`](#cspellblockcheckingwhenaveragechunksizegreaterthan) | language-overridable | The maximum average length of chunks of text without word breaks. |
| [`cSpell.blockCheckingWhenLineLengthGreaterThan`](#cspellblockcheckingwhenlinelengthgreaterthan) | language-overridable | The maximum line length. |
| [`cSpell.blockCheckingWhenTextChunkSizeGreaterThan`](#cspellblockcheckingwhentextchunksizegreaterthan) | language-overridable | The maximum length of a chunk of text without word breaks. |
| [`cSpell.checkLimit`](#cspellchecklimit) | resource | The limit in K-Characters to be checked in a file. |
| [`cSpell.spellCheckDelayMs`](#cspellspellcheckdelayms) | application | Delay in ms after a document has changed before checking it for spelling errors. |
| [`cSpell.suggestionsTimeout`](#cspellsuggestionstimeout) | resource | The maximum amount of time in milliseconds to generate suggestions for a word. |

## Definitions

Expand Down Expand Up @@ -1216,13 +1216,13 @@ Default

# Advanced

| Setting | Scope | Description |
| -------------------------------------------------------------------------------------------------- | -------------------- | ------------------------------------------------ |
| [`cSpell.advanced.feature.useReferencePro…`](#cspelladvancedfeatureusereferenceproviderremove) | language-overridable | Remove Matching Characters Before Rename |
| [`cSpell.advanced.feature.useReferencePro…`](#cspelladvancedfeatureusereferenceproviderwithrename) | language-overridable | Use Reference Provider During Rename |
| [`cSpell.fixSpellingWithRenameProvider`](#cspellfixspellingwithrenameprovider) | language-overridable | Use Rename Provider when fixing spelling issues. |
| [`cSpell.logFile`](#cspelllogfile) | window | Write Logs to a File |
| [`cSpell.logLevel`](#cspellloglevel) | window | Set Logging Level |
| Setting | Scope | Description |
| ---------------------------------------------------------------------------------------------------------------- | -------------------- | ------------------------------------------------ |
| [`cSpell.advanced.feature.useReferenceProviderRemove`](#cspelladvancedfeatureusereferenceproviderremove) | language-overridable | Remove Matching Characters Before Rename |
| [`cSpell.advanced.feature.useReferenceProviderWithRename`](#cspelladvancedfeatureusereferenceproviderwithrename) | language-overridable | Use Reference Provider During Rename |
| [`cSpell.fixSpellingWithRenameProvider`](#cspellfixspellingwithrenameprovider) | language-overridable | Use Rename Provider when fixing spelling issues. |
| [`cSpell.logFile`](#cspelllogfile) | window | Write Logs to a File |
| [`cSpell.logLevel`](#cspellloglevel) | window | Set Logging Level |

## Definitions

Expand Down Expand Up @@ -1339,9 +1339,10 @@ Default

# Experimental

| Setting | Scope | Description |
| ----------------------------------------------------------------------------- | ----------- | -------------------------------- |
| [`cSpell.experimental.enableRegexpView`](#cspellexperimentalenableregexpview) | application | Show Regular Expression Explorer |
| Setting | Scope | Description |
| ----------------------------------------------------------------------------------------- | ----------- | --------------------------------------- |
| [`cSpell.experimental.enableRegexpView`](#cspellexperimentalenableregexpview) | application | Show Regular Expression Explorer |
| [`cSpell.experimental.enableSettingsViewerV2`](#cspellexperimentalenablesettingsviewerv2) | application | Enable the Settings Viewer V2 Extension |

## Definitions

Expand All @@ -1364,6 +1365,25 @@ Default

---

### `cSpell.experimental.enableSettingsViewerV2`

Name
: `cSpell.experimental.enableSettingsViewerV2`

Type
: boolean

Scope
: application

Description
: Enable the Settings Viewer V2 Extension

Default
: _`false`_

---

# Legacy

| Setting | Scope | Description |
Expand Down
Loading

0 comments on commit f8691ae

Please sign in to comment.