search

TINGWEIJING / vscode-bread-jam

Make your code variables easier to distinguish with different render patterns.
https://marketplace.visualstudio.com/items?itemName=tingcode.bread-jam
MIT License
15 stars 0 forks source link
vscode-extension

readme

Bread Jam

This extension provides various render patterns for code components, particularly for variable names, making it easier to differentiate code and enhance readability.

Demo

[!NOTE] Having too much color rendered in your editor may cause eye strain. Please use the Alt + B, Alt + J (Windows & Linux) or ⌥ + B, ⌥ + J (MacOS) keyboard shortcuts to toggle the extension's effects on and off. You may also adjust the number of colors to use in the extension settings to make it easier on your eyes.

Features

Commands

Command Description Key Binding
Bread Jam: Select Render Pattern Displays a quick-pick list of render patterns. Use the Up and Down keys to navigate and preview the render patterns. -
Bread Jam: Clear Renderings Temporarily Temporarily removes all renderings in the currently active editor. Renderings will reappear when you refocus or edit the code in that editor. -
Bread Jam: Reload Renderings Reloads all renderings. Use this command if the renderings behave unexpectedly or appear buggy. -
Bread Jam: Turn On/Off Toggles the extension's effects on or off. This command allows you to quickly enable or disable the visual enhancements provided by the extension. Windows & Linux: Alt + B, Alt + J
MacOS: ⌥ + B, ⌥ + J

Supported Languages & Requirements

This extension utilizes Semantic Tokenization provided by Language Server Extensions for various programming languages. Below is a table listing the language extensions that may support semantic highlighting. You only need to install the language extension(s) for the languages you intend to use.

Language File Extension Support? Required Extension (Extension ID)
Javascript / TypeScript .js, .jsx, .ts, .tsx ✅ (VS Code built in extension)
C++ .cpp ✅ ms-vscode.cpptools
C# .cs ✅ ms-dotnettools.csdevkit
Dart .dart ✅ Dart-Code.dart-code
Go .go ✅ Extra config required golang.go
Java .java ✅ redhat.java
Lua .lua ✅ sumneko.lua
Python .py ✅ ms-python.python
Rust .rs ✅ rust-lang.rust-analyzer
Julia .jl ❌ Issue julialang.language-julia
R .r ❌ Issue REditorSupport.r
Ruby .ruby 🆘 Shopify.ruby-lsp

Legend

If you have experience with Ruby and can assist in making the Ruby extension work with this extension, please create an issue on this GitHub repository to let me know. Your expertise would be greatly appreciated!

Render Patterns

Preview render patterns

Extension Settings

This section demonstrates a few of the effects of available extension's settings. For detailed explanations of each setting, please refer to the settings description in the VS Code extension settings UI.

Basic

Experimental

These settings are experimental and may be changed or removed in future update.

FAQ

  1. Why is it called "Bread Jam"?

    Initially, I thought about naming this extension something straightforward like "Variable Color." However, it offers more than just adding color—it also has the option to decorate with emojis. In the future, I plan to add various other render patterns. This led me to a fun metaphor:

    Think of coding in your editor/IDE as having breakfast. Just as people enjoy different types of breads—like white bread, bagels, croissants, and buns—programmers have their favorite themes, such as Dracula, Monokai Pro, One Dark Pro, Night Owl, etc. But sometimes, just bread isn't enough; it can get a bit boring. You might want to jazz it up with different jams or ingredients to enhance the flavor. Similarly, "Bread Jam" aims to spice up your coding environment. Of course, just like with actual bread, not everyone will want to add jam—that's perfectly fine too!

License

This project is licensed under the MIT License - see the LICENSE file for details.