Skip to content

Latest commit

 

History

History
282 lines (170 loc) · 14.8 KB

README.md

File metadata and controls

282 lines (170 loc) · 14.8 KB

Intellij rainbow brackets

🌈Rainbow Brackets for IntelliJ-based IDEs/Android Studio/HUAWEI DevEco Studio And Fleet


Table of contents

Core features

  • Rainbowify various types brackets(Round,Squiggly,Square,Angle)
  • Rainbowify variables for more languages & config colors using color generator
  • Rainbowify indent guidelines
  • Scope highlighting
  • Rainbowify tag name for XML/HTML
  • Rainbowify property name for YAML/JSON
  • Customize colors
  • Color generator
  • JSX support
  • Rainbowify Python keywords & indent guidelines
  • Scope highlighting for Python
  • Current Block Highlighting
  • Block list support

  • Compatibility

    IntelliJ IDEA(Ultimate/Community/Educational), PhpStorm, WebStorm, PyCharm(Professional/Community/Educational), RubyMine, AppCode, CLion, CLion(Nova), Gogland, DataGrip, Rider, MPS, Android Studio, HUAWEI DevEco Studio, DataSpell, Code With Me(Host), RustRover, Aqua, Fleet, WriterSide

    Supported languages

    Java, Scala, Clojure, Kotlin, Python, Haskell, Agda, Rust, JavaScript, TypeScript, Erlang, Go, Groovy, Ruby, Elixir, Objective-C, PHP, HTML, XML, SQL, Apex language, C#, F#, Dart, Pug/Jade, Bash, Vue.js, C# Razor Pages, GLSL(the OpenGL Shading Language), Go Template, C++, C, Solidity, Jinja2, Clang, CPP, C...

    Install

    Install it inside your IDE:

    For Windows & Linux - File > Settings > Plugins > Marketplace > Search for "Rainbow Brackets" > Install Plugin > Restart IntelliJ IDEA

    For Mac - IntelliJ IDEA > Preferences > Plugins > Marketplace > Search for "Rainbow Brackets" > Install Plugin > Restart IntelliJ IDEA

    Screenshots

    Java

    java

    Scala

    scala

    Clojure

    Clojure

    Kotlin

    kotlin

    HTML/XML

    NOTE: need to turn on the 'Rainbowify tag name' option

    HTML

    Javascript & Typescript

    NOTE: need to turn on the 'Rainbowify tag name' option

    js

    ts

    C#

    CSharp

    Dart

    dart

    Python

    image

    python

    image

    Pug/Jade

    pug

    YAML

    To disable rainbowify tags for yaml, please follow: #2639 (comment) pug

    Indent highlighting

    options:

    image
    • Focus mode
    image
    • Only selected indent guide(free)

    highlighting indent guideline only when you select this indent line image

    • Only current indent guide

    highlighting indent guide lines for current lines image

    • All indent guide related

    highlighting all indent guide lines for current lines image

    Scope highlighting

    The highlight effects will not remove after releasing the shortcuts, but press the ESC key can do this. You could also config Press any key to remove the highlighting effect on the setting page.

    Ctrl + Button3(Windows & Linux) or Meta + Button3(Mac):

    NOTE: Button3 means "Secondary Click (click or tap with two fingers)" on Mac os, "Right click" for Windows or Linux. NOTE: Meta means command on Mac os.

    current-scope

    Alt + Button3(Windows & Linux) or option + Button3(Mac):

    NOTE: Button3 means "Secondary Click (click or tap with two fingers)" on Mac os, "Right click" for Windows or Linux.

    rh

    looking forward to your screenshots(PR welcome!)

    Customize colors

    Settings/Preferences > Editor > Color Scheme > Rainbow Brackets:

    scheme

    Config the number of colors?

    Settings/Preferences > Other Settings > Rainbow Brackets > Color > Number of colors: 5 or more

    And you can use the color generator and configure your number of colors at the same time.

    NOTE: For the default and Darcula color scheme(Editor -> Color Scheme -> Rainbow Brackets -> Scheme) the color number is 10, for the other scheme the number is 5, if your number is bigger than the number, you can config them in the config file. If the color does not exist, we will use the color generator to generate it for you.

    Use the color generator

    If you didn't like the built-in colors or want some new colors but don't want to try out and pick colors. Please use the color generator.

    Settings/Preferences > Rainbow Brackets > Color > Use color generator

    If you turn on this option, we will auto-generate some colors for you.

    Advanced options for color generator

    image

    hue – Controls the hue of the generated color. You can pass a string representing a color name: red, orange, yellow, green, blue, purple, pink and monochrome are currently supported. If you pass a hexidecimal color string such as #00FFFF, the color generator will extract its hue value and use that to generate colors.

    luminosity – Controls the luminosity of the generated color. You can specify a string containing bright, light or dark.

    Config file path

    If you want to customize the advanced configuration, you could edit the config file and then restart your IDE. The config file path is in APP_CONFIG/rainbow_brackets.xml.

    In MAC OS env maybe like ~/Library/Preferences/IntelliJIdea2020.2/options/rainbow_brackets.xml.

    If you are using the ToolBox, then it will be like ~/Library/ApplicationSupport/JetBrains/IntelliJIdea2020.2/options/rainbow_brackets.xml

    In Linux env maybe like ~/.IntelliJIdea/config/options/rainbow_brackets.xml.

    In Windows env maybe like C:\Users\izhangzhihao\.IntelliJIdea2020.2\config\options\rainbow_brackets.xml.

    JSX support

    To enable rainbow brackets for JSX like this:

    var html = '<div><div><div>Hello</div></div></div>';

    This plugin will automatically override color scheme property "HTML_CODE" cause our rainbow color been covered by intellij built-in functionality. You still could set Settings/Preferences > Other Settings > Rainbow Brackets > Language Specific > Rainbowify JSX in the config file to disable.

    Kotlin function literal braces and arrow

    To enable rainbow brackets for multiple-level lambda Kotlin code like this:

    event.throwable?.let { throwable ->
        IdeErrorsDialog.findPluginId(throwable)?.let { pluginId ->
            PluginManager.getPlugin(pluginId)?.let { ideaPluginDescriptor ->
                if (!ideaPluginDescriptor.isBundled) {
                    bean.pluginName = ideaPluginDescriptor.name
                    bean.pluginVersion = ideaPluginDescriptor.version
                }
            }
        }
    }

    This plugin will automatically override the color scheme property "KOTLIN_FUNCTION_LITERAL_BRACES_AND_ARROW" cause our rainbow color is being covered by the Kotlin plugin's built-in functionality. You still could set Settings/Preferences > Other Settings > Rainbow Brackets > Language Specific > Rainbowify Kotlin function literal braces and arrow in the config page to disable.

    Disable rainbow brackets for specific languages

    Settings/Preferences > Other Settings > Rainbow Brackets > Do NOT rainbowify these languages (name or extension, comma separated):

    NOTE: You can use name of language or extension of file name(The names should be lowercase).

    Support Us

    You can support us by the following actions:

    • Buy a license here
    • Star this project
    • Share this plugin with your friends
    • Rate this plugin on JetBrains plugin repository
    • Make pull requests
    • Report bugs
    • Tell us your ideas
    • Buy Me a Coffee here

    Rainbow Brackets Lite

    This repo is used to compile a fully free version of our product for the community to use. This is because some users do not need the paid features and do not want to constantly update their software. An open-source, entirely free, and stable version is a good option for these users.

    I believe this will benefit both the community and our team. The community will have access to a free version of our software, and our team will continue to receive support from those who appreciate and value the paid features.

    Please download the Lite version here.

    NOTE: the lite version does NOT support C# lang and NOT support C++ in the Rider IDE

    Acknowledgements

    Intellij-rainbow-brackets is heavily inspired by Rainbow Brackets for Visual Studio Code