Serenade for JetBrains

To use Serenade for JetBrains, you'll also need the Serenade app, which is freely available at https://serenade.ai.

Serenade is the fastest and easiest way to write code with natural speech. Give your hands a break without missing a beat.

Edit code, run terminal commands, and write documentation entirely with voice. Whether you have an injury or you’re looking to prevent one, Serenade can help you be just as productive without lifting a finger. Use voice alongside your existing workflow, or abandon your keyboard entirely.

Learn more at https://serenade.ai.

Development

Prerequisites

1. IntelliJ IDEA 2021.1 (latest)

2. brew install ktlint
   ktlint installGitPreCommitHook
   

3. In IntelliJ IDEA, add the Plugin SDK: https://jetbrains.org/intellij/sdk/docs/basics/getting_started/setting_up_environment.html

4. In File > Project Structure ... be sure that the right JDKs are selected, from the installed IntelliJ IDEA, and selected everywhere:

   

   

   

   

5. ktlint -F "**/*.kt*" should find and fix any lint issues.

6. Once the project is opened, there should be a panel for running Gradle tasks, and use buildPlugin and runIde for testing.

Manual build

1. Update pluginVersion in gradle.properties.
   • If there has been a major IntelliJ update, update pluginUntilBuild and platformVersion as well based on the branch number and platform version of the most recent version.
   • The build may also fail if some dependencies in build.gradle.kts are out of date, so update those version numbers as well.
2. Add version to CHANGELOG.md.
3. ./gradlew build should create a build/distributions/serenade-x.x.x.zip that contains all the dependencies.

Auto-build

1. Every time a valid commit is pushed, a GitHub Actions runs: https://github.com/serenadeai/intellij/actions
2. The most recent successful run (with a green checkmark) will have a plugin-artifact under the build section. Download and run unzip plugin-artifact.zip to get a serenade-x.x.x.zip that should be identical to a manual build.

Installation

1. In an IntelliJ IDE, go to Preferences > Plugins > (gear icon) > Install Plugin from Disk ... and select serenade-x.x.x.zip. plugin-artifact.zip will not work unless it's unzipped once first.
2. Then click Apply. The IDE will reload everything, and a Serenade tab should appear on the right side in the editor window.