Skip to content

earthly/earthly-intellij-plugin

Repository files navigation

earthly-intellij-plugin

IntelliJ plugin for Earthly language support.

Check the currently released versions on the JetBrains Marketplace.

Features

  • Syntax highlighting for Earthfiles
  • Code completion
  • Formatter
  • Commenter
  • Go To Symbol Contributor
  • ... Let us know!

Darcula theme Light theme

Requirements

This plugin is dependent on https://github.com/earthly/earthfile-grammar for syntax.

Building

The following command generates a earthly-intellij-plugin-<version>.zip package in the current directory:

earthly +dist [--version=<version>]

For local development, this will generate a gradle wrapper (gradle/) corresponding to the gradle version used in the build itself:

earthly +generate-gradle-wrapper

Signing (requires earthly-technologies org membership)

The following command generates a earthly-intellij-plugin-signed-<version>.zip package in the current directory:

earthly +sign [--version=<version>]

Publishing (requires earthly-technologies org membership)

The following command builds, signs and publishes the plugin to the IntelliJ Marketplace:

earthly --push +publish --version=<version>

This target is automatically triggered when a new git tag is pushed in the form of vX.Y.Z.

Testing

earthly +ide

Contributing

Code of Conduct

Please refer to the CNCF Community Code of Conduct v1.0

CLA

Individual

All contributions must indicate agreement to the Earthly Contributor License Agreement by logging into GitHub via the CLA assistant and signing the provided CLA. The CLA assistant will automatically notify the PRs that require CLA signing.

Entity

If you are an entity, please use the Earthly Contributor License Agreement form in addition to requiring your individual contributors to sign all contributions.