FTLOG Don't use light gray on a white background

Open
#195 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
powershell
Domain
tooling

Research direction

Start by examining how the PowerShell ISE theme maps the keyword.operator scope and compare it with the reported editor.tokenColorCustomizations workaround. Use the provided PowerShell sample to check the contrast of -, =, !, $, and @; done means these syntax elements are readable on the white background without custom user settings.

Written by the indexing model from the issue text.

Description

Environment
  • VS Code 1.41.1
  • Your primary theme: "PowerShell ISE"
Issue Description

Insufficient contrast between = ! - , and the background, and exacerbated when the use has render white space on.

Screenshots

image

Notice the last line has a misplaced - sign which is very hard to see. Params is rendered here as the name of a variable which will be splatted, but -@params is treated as a string literal to be passed as a parameter value .
In the ISE the - sign changes the rendering
image

Supplementary In the ISE, the $ and @ are rendered in the same colour as the variable name.

Expected Behavior

I am now working around this by adding the following to my vs code settings

    "editor.tokenColorCustomizations": {
        "[PowerShell ISE]": {"textMateRules": [
            {
                "scope": "keyword.operator",
                "settings": {
                    "foreground": "#000000",
                }

            }
        ]}
    },

image

Code Samples

    $Params.Uri      = "$repoUri/annotatedtags?api-version=5.1-preview" 
    $Params['Body']  = [ordered]@{
        name         = $Name
        taggedObject = @{objectId = $env:BUILD_SOURCEVERSION} 
        message      = $Message } | ConvertTo-Json -Depth 2
    Invoke-RestMethod   -@Params   -ContentType 'application/json' -Method Post  | Format-List
Suggestion

Maintain a difference of at least 127 (50%) between the background and syntax elements. The rgb values for these elements are A9A9A9 (169 decimal), which is the 2/3 point rather than the 50%

Consider using smaller even differentials between rendered white space/control characters and the back ground or

Dominant language
PowerShell
Stars
151
Forks
55
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from PowerShell/EditorSyntax

All issues in PowerShell/EditorSyntax

Similar issues

More DevTools issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.