Background Phi Colors README

🇯🇵 Japanese / 日本語

This extension colors the background in various ways. It is too ambitious and may be very annoying.

This extension just colors the background of all text files. However, this always means that the search will be fully automatic. It will improve code recognition. Unfortunately, this extension is probably not for everyone, and the ratings will vary widely depending on the person. But for those who like it, it will be a very powerful extension.

Features

This extension colors the background in follow ways.

• indent level
• error indent
• current line
• blank lines ( this is disabled by default )
• tokens
• symbols ( this is disabled by default )
• spaces in body
• trailing spaces

Indent: light

Indent: smart

Indent: full

Current line

Blank lines

Token: light

Token: smart

Token: full

Symbols

Spaces

Tutorial

0. ⬇️ Install Background Phi Colors

Show extension side bar within VS Code(Mac:Command+Shift+X, Windows and Linux: Ctrl+Shift+X), type background-phi-colors and press Enter and click Install. Restart VS Code when installation is completed.

1. 🌈 Colors background

Open a text file. And move cursor. The background color changes automatically.

2. 🔧 Next step

You can change settings by settings.json. And you can apply keyboard shortcuts by keybindings.json.

Enjoy!

Commands

Launch Command Palette(Mac:F1 or Shift+Command+P, Windows and Linux: F1 or Shift+Ctrl+P)

• Background Phi Colors: Active Scrope: Editor : sets active scope to editor. ( Each editor is highlighted independently. )
• Background Phi Colors: Active Scrope: Document : sets active scope to document. ( Highlight are shared in the same document editors. )
• Background Phi Colors: Active Scrope: Window : sets active scope to window. ( Highlight are shared in the all editors. )
• Background Phi Colors: Toggle Mute : disables background coloring for the text editor in focus. Execute this command again to enable. This command overrides the backgroundPhiColors.enabled setting.
• Background Phi Colors: Toggle Mute All : disables background coloring for all text editors. Execute this command again to enable. This command overrides the backgroundPhiColors.enabled setting.
• Background Phi Colors: Toggle Pause : keeps the current highlighting of the focused text editor even as you move the cursor. Execute this command again not to keep.
• Background Phi Colors: Toggle Pause All : keeps the current highlighting of all text editors as you move the cursor. Execute this command again not to keep.
• Background Phi Colors: Over the Limit : forces it to work if this extension stopped by the file size limit. ⚠ Keep in mind that VS Code may become extremely heavy depending on the machine performance and text files. If it gets too heavy, please quit or kill VS Code once.
• Background Phi Colors: Report Profile : report a profile.

Extension Settings

This extension contributes the following settings by settings.json( Mac: Command+,, Windows / Linux: File -> Preferences -> User Settings ):

• backgroundPhiColors.enabled: enables that colors background.
• backgroundPhiColors.enabledPanels: enables that colors background in output panels.
• backgroundPhiColors.fileSizeLimit: does not working for files that exceed this size.
• backgroundPhiColors.basicDelay: delay from event occurrence to coloring. ( Milliseconds when file size is 16KiB or less. It is proportional to the square root of the file size. )
• backgroundPhiColors.additionalDelay: addtional delay from update event occurrence to coloring. ( Milliseconds when file size is 16KiB or less. )
• backgroundPhiColors.clipDelay: delay from event occurrence to coloring when rendering by clipping. ( Millisecond. When clipped, it is fixed regardless of file size. )
• backgroundPhiColors.baseColor: background colors are automatically generated by rotating the hue by 1 / phi all around based on this color. ( #RRGGBB )
• backgroundPhiColors.spaceBaseColor: space background colors are automatically generated by rotating the hue by 1 / phi all around based on this color. If this value is null backgroundPhiColors.baseColor will be used instead. ( #RRGGBB )
• backgroundPhiColors.spaceErrorColor: error space background color. ( #RRGGBB )
• backgroundPhiColors.symbolBaseColor: symbol background colors are automatically generated by rotating the hue by 1 / phi all around based on this color. If this value is null backgroundPhiColors.baseColor will be used instead. ( #RRGGBB )
• backgroundPhiColors.symbolColorMap: you can specify the background color for each symbol.
• backgroundPhiColors.tokenBaseColor: token background colors are automatically generated by rotating the hue by 1 / phi all around based on this color. If this value is null backgroundPhiColors.baseColor will be used instead. ( #RRGGBB )
• backgroundPhiColors.tokenColorMap: you can specify the background color for each token.
• backgroundPhiColors.indentMode: none: does not color indents, light: colors indents statically, smart: colors the current indent, full: light + smart,
• backgroundPhiColors.lineEnabled: colors the current line.
• backgroundPhiColors.blankLinesEnabled: colors blank lines.
• backgroundPhiColors.tokenMode: none: does not color tokens, light: colors all tokens statically, smart:colors the tokens contained in the current line, full: light + smart,
• backgroundPhiColors.activeScope: editor: each editor is highlighted independently, document: highlight are shared in the same document editors, window: highlight are shared in the all editors,
• backgroundPhiColors.indentErrorEnabled: colors indent errors
• backgroundPhiColors.traillingSpacesErrorEnabled: colors trailing spaces errors
• backgroundPhiColors.bodySpacesEnabled: colors two or more consecutive spaces background except for the indent and trailing.
• backgroundPhiColors.traillingSpacesEnabled: colors trailing spaces.
• backgroundPhiColors.symbolEnabled: colors symbol background.
• backgroundPhiColors.indentErrorInOverviewRulerLane: overview ruler lane of indent errors.
• backgroundPhiColors.activeTokenInOverviewRulerLane: overview ruler lane of active tokens.
• backgroundPhiColors.blankLinesInOverviewRulerLane: overview ruler lane of blank lines.
• backgroundPhiColors.trailingSpacesErrorInOverviewRulerLane: overview ruler lane of trailing sspaces errors.
• backgroundPhiColors.spacesAlpha: Spaces background color opacity. ( 0 - 255)
• backgroundPhiColors.spacesActiveAlpha: active spaces background color opacity. ( 0 - 255)
• backgroundPhiColors.spacesErrorAlpha: error Spaces background color opacity. ( 0 - 255)
• backgroundPhiColors.blankLinesAlpha: blank lines background color opacity. ( 0 - 255)
• backgroundPhiColors.symbolAlpha: symbols background color opacity. ( 0 - 255)
• backgroundPhiColors.tokenAlpha: tokens background color opacity. ( 0 - 255)
• backgroundPhiColors.tokenActiveAlpha: active tokens background color opacity. ( 0 - 255)
• backgroundPhiColors.indent: indent unit.
• backgroundPhiColors.enabledProfile: enables that self-profiler.
• backgroundPhiColors.overTheLimitMessageShowMode.description: over the limit message mode. none: never show message, until 16x: show message until 16 times the limit size, until 256x: show message until 256 times the limit size, always: always show message,
• backgroundPhiColors.clipByVisibleRange: clips the rendering only to the viewing area for large documents. Conversely, it is slower for small documents. Overview ruler lane is hidden.

setting example

"backgroundPhiColors.tokenColorMap":
{
    "if": null,
    "else": null,
    "wraith13": "#0000FF"
}

Language specific settings

All settings of Background Phi Colors except backgroundPhiColors.activeScope can be language specific.

see https://code.visualstudio.com/docs/getstarted/settings#_language-specific-editor-settings.

Keyboard shortcut Settings

In default, Background Phi Colors's commands doesn't apply keyboard shortcuts. Althogh, you can apply keyboard shortcuts by keybindings.json ( Mac: Code -> Preferences -> Keyboard Shortcuts, Windows / Linux: File -> Preferences -> Keyboard Shortcuts).

Command name on keybindings.json is diffarent from on Command Pallete. See below table.

Release Notes

see ChangLog on marketplace or github

Support

GitHub Issues

License

Boost Software License