Skip to content

pcha/intellij-bloblang-support

Repository files navigation

intellij-bloblang-support

An IntelliJ-based IDEs plugin for Bloblang support.

Bloblang is a mapping language developed by @jeffail as part of Benthos, a high performance and resilient stream processor.

Features

This plugin recognizes the files *.blobl as bloblang files and check and highlight the syntax of these files. Fot more details you can check the CHANGELOG.

Install

From Marketplace

This alternative is the better to keep the plugin updated. Since the plugin is in the very beginning of its development, it isn't in the stable channel but in the EAP. For installing plugins from this channel you have to add the repository to your plugins repositories list.

  1. Press Ctrl+Alt+S for Linux and Windows or , for Mac to open the IDE settings and select Plugins.
  2. On the Plugins page, clickThe Settings button and select Manage Plugin Repositories.
  3. In the Custom Plugin Repositories dialog, click The Add icon and specify the URL https://plugins.jetbrains.com/plugins/eap/18756. Add plugin custom repository
  4. Click OK in the Custom Plugin Repositories dialog to save the list of plugin repositories.
  5. In the tab Marketplace type "bloblang" to find the plugin and click Install. Install plugin from marketplace
  6. Click OK in the Settings/Preferences dialog to apply the changes.

See the JetBrains Documentation for more details.

From disk

This alternative allows you to choose the version to install, also it avoids the Jetbrains moderation, so the last releases are available few days before than in the Marketplace.

  1. Go to the Release Github project page and Download the plugin archive of the desired version, named intellij-bloblang-support-x.y.z.zip, where x.y.z is the plugin version.
  2. Press Ctrl+Alt+S for Linux and Windows or , for Mac to open the IDE settings and select Plugins.
  3. On the Plugins page, click The Settings button and then click Install Plugin from Disk.
  4. Select the downloaded plugin file and click OK.
  5. Click OK to apply the changes and restart the IDE if prompted.

See the JetBrains Documentation for more details.

Feedback and Contribution

Bug Reports and Suggesting Enhancements

Everybody is welcome to report bugs and suggest enhancements. Please use the Github Issues page.

Contribute with Pull Requests

If you want to contribute with code, you're welcome! Please follow the next guidelines:

  • Create an Issue, if it doesn't already exist, and express your desire of contributing in the development, that way we can organize ourselves and avoid to work in the same feature or bug.
  • Use Conventional Commit Messages. This is used for the changelog and version generation.
  • For the moment the project doesn't have any test, so please be sure of test that the plugin is still working before push.
  • To test the plugin behavior the gradle task runIde can be used, this task regenerates the parser files, build the plugin and run the plugin in the IDE. (see the JetBrains Documentation for more details)
  • If want to test the plugin in a specific IDE or version you can change in the Intellij block of the build gradle file. See the Gradle Intellij Plugin documentation for more details.