https://github.com/benthosdev/vscode-benthos

https://github.com/benthosdev/vscode-benthos

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/benthosdev/vscode-benthos
• Owner: benthosdev
• License: mit
• Created: 2023-04-02T17:07:38.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-05-12T15:27:05.000Z (over 2 years ago)
• Last Synced: 2025-12-23T14:19:52.855Z (about 1 month ago)
• Size: 1.47 MB
• Stars: 23
• Watchers: 1
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# vscode-benthos

> This extensions is in a very experimental stage. Please test it out and submit

> any issues you find!

The [Benthos][benthos] extension for Visual Studio Code adds syntax highlighting

support for the Bloblang language within YAML files (`.yaml`/`.yml`) and mapping

files (`.blobl`).

![Bloblang syntax highlighting demo with GruvBox dark hard Visual Studio Code theme](./docs/images/syntax-dark.png)

![Bloblang syntax highlighting demo with GitHub Light Visual Studio Code theme](./docs/images/syntax-light.png)

## Working with YAML

Bloblang string interpolations and environment variable references should get

enhanced with syntax highlighting.

Syntax highlighting for plugins or plugin config fields that accept bloblang

mappings can be enabled using the `#!blobl` pragma as the first line. Here's an

example when using the `mapping` processor:

```yaml

pipelines:

  processors:

    - mapping: |

        #!blobl

        root.name = this.

          (fullName | nickName).

          not_empty().

          catch(err -> "failed to get pet name: %s".format(err))

        root.sound = if this.type == "cat" {

          this.cat.meow

        } else if this.type == "dog" {

          this.dog.woof.uppercase()

        } else {

          "sweet sweet silence"

        }

    - log:

        level: ${LOG_LEVEL:INFO}

        message: '${! this.name } sounds like ${! this.sound.or("nothing") }'

```

This snippet would look something like the following screenshot with this

extension installed in VS Code.

![Syntax highlighting demo for bloblang used in the benthos mapping processor](./docs/images/mapping-demo.png)

[benthos]: https://www.benthos.dev/