Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Visual Studio Spell Check config settings. And fix reported spellings problems #8940

Merged
merged 2 commits into from
Jul 6, 2023

Conversation

filzrev
Copy link
Contributor

@filzrev filzrev commented Jul 6, 2023

This PR add Visual Studio's Spell Checker configurations. and fix reported spelling problems.

Spell Checker feature are introduced VS2022 17.5.
See: https://learn.microsoft.com/en-us/visualstudio/ide/text-spell-checker?view=vs-2022

The reported problems are shown at Visual Studio's Error List window as Intellisense category.
Problems are shown while target file is opened. It don't affects build results.

1. .editorconfig changes (52e48da)

Add .editorconfig settings to support spell check options.
Following settings are changed from default

spelling_error_severity Set level to warning level.
spelling_exclusion_path Set file name to SpellingExclusions.dic (Because other dotnet organizations using this naming styles

2. SpellingExclusions.dic (52e48da)
This file define words that are ignored by VS Spell Checker.

3. Fix spelling problems(337e9b4))
Spelling related problems are fixed by this commit.

Other remaining tasks
I'll create another PR to handler following tasks.

  • Snapshot test related spelling fix.
  • Some option's parameter spelling fix.

@codecov
Copy link

codecov bot commented Jul 6, 2023

Codecov Report

Patch coverage: 76.04% and project coverage change: -0.01 ⚠️

Comparison is base (c1545fe) 76.90% compared to head (337e9b4) 76.90%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #8940      +/-   ##
==========================================
- Coverage   76.90%   76.90%   -0.01%     
==========================================
  Files         605      605              
  Lines       25088    25088              
==========================================
- Hits        19295    19294       -1     
- Misses       5793     5794       +1     
Impacted Files Coverage Δ
src/Microsoft.DocAsCode.Build.Engine/XrefClient.cs 0.00% <0.00%> (ø)
...ode.Build.ManagedReference/ApplyPlatformVersion.cs 0.00% <0.00%> (ø)
...ld.ManagedReference/SplitClassPageToMemberLevel.cs 9.69% <0.00%> (ø)
...ild.OverwriteDocuments/MarkdownFragmentsCreator.cs 97.67% <ø> (ø)
src/Microsoft.DocAsCode.Common/CommandUtility.cs 82.00% <ø> (ø)
src/Microsoft.DocAsCode.Common/Git/GitUtility.cs 81.96% <ø> (-0.55%) ⬇️
src/Microsoft.DocAsCode.Common/Path/PathUtility.cs 65.57% <ø> (ø)
src/Microsoft.DocAsCode.Common/StringExtension.cs 44.00% <0.00%> (ø)
....DocAsCode.DataContracts.Common/JTokenConverter.cs 0.00% <0.00%> (ø)
...c/Microsoft.DocAsCode.Dotnet/MetadataJsonConfig.cs 94.73% <ø> (ø)
... and 32 more

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Contributor

@yufeih yufeih left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This has solved a really big problem 🔥
Thank you so much @filzrev !

@yufeih yufeih merged commit 6e4b5a8 into dotnet:main Jul 6, 2023
7 checks passed
@yufeih yufeih added the new-feature Makes the pull request to appear in "New Features" section of the next release note label Jul 6, 2023
@filzrev filzrev deleted the add-vs-spell-check-configs branch July 17, 2023 00:18
p-kostov pushed a commit to ErpNetDocs/docfx that referenced this pull request Jun 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new-feature Makes the pull request to appear in "New Features" section of the next release note
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants