streetsidesoftware / vscode-spell-checker

A simple source code spell checker for code
https://streetsidesoftware.github.io/vscode-spell-checker/
Other
1.45k stars 131 forks source link

fix: Adjust default color and style for spelling error decorations #3799

Closed mnoah1 closed 6 days ago

mnoah1 commented 1 week ago

The transition to custom decorations has led to feedback that the yellow squiggly is too intrusive and can be mistaken for actual code diagnostics (#3798).

Proposing less intrusive defaults that are similar to the prior appearance and also leverage the new "dotted" appearance to clearly distinguish this from other diagnostics. These values should look fine in either light or dark mode.

Light mode example: image

Dark mode example: image

BEGIN_COMMIT_OVERRIDE fix: Do not use custom decorations by default fix: Adjust the default color of custom decorations END_COMMIT_OVERRIDE

Jason3S commented 1 week ago

@mnoah1,

Thank you for the PR. The package.json file is auto generated. It is better to change it here: https://github.com/streetsidesoftware/vscode-spell-checker/blob/b8baccdb85669957bc0a5d30c9865e83ba1266ff/packages/_server/src/config/cspellConfig/AppearanceSettings.mts#L110

mnoah1 commented 1 week ago

Ok, thanks - I just pushed an update including that change.

Jason3S commented 1 week ago

@mnoah1,

I need to think about the right coloring to use. I read the feedback, but people are asking for two different thing. The PR tries to satisfy those that use hint, but not those that use information.

For now, I think I will default the custom decoration to be off and spend a bit more time on how to approach the coloring.

mnoah1 commented 1 week ago

Ok, would you like me to close this one and you'll create a separate one for that, or should I go ahead and update this one?

Jason3S commented 1 week ago

@mnoah1,

Would you change it? https://github.com/streetsidesoftware/vscode-spell-checker/blob/b8baccdb85669957bc0a5d30c9865e83ba1266ff/packages/_server/src/config/cspellConfig/AppearanceSettings.mts#L188

I'm ok the color change, but the dots are very hard to see. Please leave it wavy for now.

mnoah1 commented 1 week ago

I just made the update - this keeps the color change, puts it back to wavy, and defaults useCustomDecorations to false.