Rainbow Brackets document

Intellij rainbow brackets

Rainbow Brackets / Rainbow Parentheses for IntelliJ based IDEs.


Compatibility

IntelliJ IDEA, PhpStorm, WebStorm, PyCharm, RubyMine, AppCode, CLion, Gogland, DataGrip, Rider, MPS, Android Studio

Supported languages

Java, Scala, Clojure, Kotlin, Python, Haskell, Agda, Rust, JavaScript, TypeScript, Erlang, Go, Groovy, Ruby, Elixir, ObjectiveC, PHP, HTML, XML, SQL, Apex language, C#, Dart, …

Author’s choice

Rainbow Brackets + Material Theme UI(Oceanic theme) + Nyan Progress Bar + Fira Code (Font)

This plugin is being sponsored by Codota and CodeStream.

Code faster and smarter using code completions learned from millions of programs directly in IntelliJ, Android Studio or Eclipse. Get Codota

https://codestream.com

Discussing code is now as easy as highlighting a block and typing a comment right from your IDE. Take the pain out of code reviews and improve code quality. Try it free!

Development powered by JetBrains.

https://www.jetbrains.com/?from=IntelliJRainbowBrackets

Whichever technologies you use, there’s a JetBrains tool to match.

Screenshots

  • with Java

  • with Scala

  • with Clojure

  • with Kotlin

  • with HTML/XML

  • Scope highlighting

The highlight effects will not remove after release the shortcuts, but press ESC key can do this. You could also config Press any key to remove the highlighting effect in 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.

Alt + Button3:

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

  • Rainbow indent guide lines

  • looking forward to your screenshots(PR welcome!)

Install

Install snapshot build

You can download the latest snapshot build from here, just click in the latest build and click the ‘Artifacts’ tab.(You must logged in via github)

Customize colors

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

Customize colors

Use color generator

I didn’t like the build-in colors, I want some new color but does want to try out and pick colors. Please use color generator.

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

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

If you need more control, you can decide the options of color generator by edit the config file,

The value of the option customColorGeneratorOption is a json object, available options are:

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, 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.

Please make sure the value of the option customColorGeneratorOption is escaped in xml format, you can use this tool to do this. Please don’t forget to restart your IDE after change the config file.

<application>
  <component name="RainbowSettings">
    <option name="useColorGenerator" value="true" />
    <option name="customColorGeneratorOption" value="{&quot;luminosity&quot;: &quot;light&quot;,&quot;hue&quot;: &quot;blue&quot;}"/>
  </component>
</application>

Want to config the number of colors?

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

NOTE: For 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 is not exist, we will use color generator to generator it for you.

Please follow the official guide:

  • Export a color scheme as XML
  • Edit the xml file, put ROUND_BRACKETS_RAINBOW_COLOR5 to ROUND_BRACKETS_RAINBOW_COLOR100 to match your number just like the default color scheme.
  • Import a color scheme

Config file path

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

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

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

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

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

HTML code in js

To enable rainbow brackets for HTML inside js code 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 <option name="rainbowifyHTMLInsideJS" value="false" /> in config file to disable just like Config brackets colors.

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 color scheme property “KOTLIN_FUNCTION_LITERAL_BRACES_AND_ARROW” cause our rainbow color is being covered by kotlin plugin built-in functionality. You still could set <option name="rainbowifyKotlinFunctionLiteralBracesAndArrow" value="false" /> in config file to disable just like Config brackets colors.

Disable rainbow brackets for specific languages

If you want to disable rainbow brackets for javascript languages and java languages, you could set languageBlacklist property in config file just like:

<application>
  <component name="RainbowSettings">
    <option name="languageBlacklist">
      <array>
        <option value="java" />
        <option value="javascript" />
      </array>
    </option>
  </component>
</application>

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

Contribute

NOTE: To view the PSI tree and explore the internal structure of source code, you need to setup your IDE follow this.

  • gradle test
  • gradle runIde
  • gradle buildPlugin

Support Us

You can support us by the following actions:

  • Star this project on GitHub
  • Share this plugin with your friends/colleagues
  • Rate this plugin on JetBrains plugin repository
  • Make pull requests
  • Report bugs
  • Tell us your ideas
  • Become a sponsor by donating on Open Collective
  • Become a sponsor by donating with AliPay or WeChatPay
AliPay WeChatPay

Backers

Thank you to all our backers! ❤️ [Become a backer]

Sponsors

Support this project by becoming a sponsor! 🌈 Your logo will show up here with a link to your website. [Become a sponsor]

Acknowledgements

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


Original link:https://izhangzhihao.github.io//rainbow-brackets-document/

Search

    Table of Contents