gruvbox-plain

Color theme for IntelliJ (+ other JetBrains IDEs) and VSCode, based on morhetz/gruvbox but with a plainer color palette. Comes with a cold and a warm variant.

• IntelliJ plugin: https://plugins.jetbrains.com/plugin/27768-gruvbox-plain
• VSCode extension: https://marketplace.visualstudio.com/items?itemName=hermannm.gruvbox-plain

Contents

• Screenshots
• Color palette
• Installation
  • IntelliJ/JetBrains IDEs
  • VSCode
• Maintainer's guide
• Credits

Screenshots

gruvbox-plain-cold in IntelliJ:

gruvbox-plain-warm in VSCode:

Color palette

gruvbox-plain uses a limited subset of the gruvbox dark mode color palette. The table below shows the general usage of the different colors.

Usage	gruvbox-plain-cold	gruvbox-plain-warm
Variables, properties, plain text	#ebdbb2	#ebdbb2
Keywords, operators	#d3869b	#fe8019
Types, classes, namespaces, components, tags	#83a598	#fabd2f
Functions, methods	#b8bb26	#b8bb26
Values, language constants	#8ec07c	#8ec07c
Punctuation	#a89984	#a89984
Comments, documentation	#928374	#928374
Background color	#282828	#282828

For edge cases in languages where these may not apply, the color deemed most appropriate has been chosen. This can always be overridden under Preferences -> Editor -> Color Scheme in IntelliJ/JetBrains IDEs, or editor.tokenColorCustomizations in VSCode's settings.json.

Installation

IntelliJ/JetBrains IDEs

Click "Get" on the JetBrains Marketplace page: https://plugins.jetbrains.com/plugin/27768-gruvbox-plain

Now gruvbox-plain-cold and gruvbox-plain-warm should be available under Settings -> Appearance & Behavior -> Appearance -> Theme!

Manual installation

1. Clone the repo:

   git clone https://github.com/hermannm/gruvbox-plain.git
   

2. Open the repo's intellij subfolder in IntelliJ
3. Install the "Plugin DevKit" plugin: https://plugins.jetbrains.com/plugin/22851-plugin-devkit
4. Build the plugin:
   • Open the Gradle menu (click the Gradle icon on the taskbar to the right in IntelliJ)
   • Click Tasks -> intellij platform -> buildPlugin
5. Open up Settings in your IDE
6. Go to the Plugins tab
7. Click the cogwheel in the top bar
8. Click Install Plugin from Disk...
9. Select the .zip file from gruvbox-plain/intellij/build/distributions

VSCode

Click "Install" on the Visual Studio Marketplace page: https://marketplace.visualstudio.com/items?itemName=hermannm.gruvbox-plain

Now gruvbox-plain-cold and gruvbox-plain-warm should be available under Settings -> Workbench: Color Theme!

I recommend installing the Gruvbox Material Icons extension as well, to complete the theme.

Manual installation

1. Install the VSCode extension manager:

   npm install -g @vscode/vsce
   

2. Clone the repo:

   git clone https://github.com/hermannm/gruvbox-plain.git
   

3. Navigate to the repo's vscode subfolder in your terminal
4. Package the extension:

   vsce package
   

5. Go to the Extensions tab in VSCode
6. Click ... in the top right of the tab
7. Click Install from VSIX..., and select the .vsix file from gruvbox-plain/vscode

Maintainer's guide

Publishing a new release

• Bump version in intellij/build.gradle.kts and vscode/package.json
• Add an entry to CHANGELOG.md (with the current date)
  • Remember to update the link section, and bump the version for the [Unreleased] link
• Copy CHANGELOG.md to vscode/CHANGELOG.md
• Create commit and tag for the release (update TAG variable in below command):

  TAG=vX.Y.Z && git commit -m "Release ${TAG}" && git tag -a "${TAG}" -m "Release ${TAG}" && git log --oneline -2
  

• Publish JetBrains plugin:
  • Open the intellij subfolder in IntelliJ
  • Check that you have the "Plugin DevKit" plugin installed: https://plugins.jetbrains.com/plugin/22851-plugin-devkit
  • Build the plugin:
    • Open the Gradle menu (click the Gradle icon on the taskbar to the right in IntelliJ)
    • Click Tasks -> intellij platform -> buildPlugin
  • Go to https://plugins.jetbrains.com/author/me, and log in with your JetBrains account
  • Click the plugin, and then "Upload update"
  • Select the newly built .zip file from gruvbox-plain/intellij/build/distributions
  • Confirm "Upload update"
• Publish VSCode extension:
  • Navigate to vscode subfolder in your terminal
  • Check that you have vsce installed:

    vsce --version
    

    • If you don't have it installed:

      npm install -g @vscode/vsce
      

    • If you do have it installed, update it:

      npm update -g @vscode/vsce
      

  • Login:

    vsce login <publisher>
    

    • You may have to get a personal access token from https://dev.azure.com
      • Top right settings icon -> Personal Access Tokens
  • Publish:

    vsce publish
    

    • If you have issues, see the docs: https://code.visualstudio.com/api/working-with-extensions/publishing-extension
• Push the commit and tag:

  git push && git push --tags
  

  • Our release workflow will then create a GitHub release with the pushed tag's changelog entry

Credits

• morhetz/gruvbox for the original color scheme
  • Copyright (c) 2017 Pavel Pertsev, MIT/X11 license
• jdinhify/vscode-theme-gruvbox for the base VSCode UI theme
  • Copyright (c) 2017 JD, MIT license
• Vincent-P/gruvbox-intellij-theme for the base IntelliJ UI theme
  • Copyright (c) 2019 Vincent Parizet, MIT license