aesy / yamllint-intellij

Yamllint integration for IntelliJ-based IDEs

Yamllint support for IntelliJ-based IDEs

A plugin providing static code analysis of Yaml files through integration with Yamllint.

Installation

Download and install the plugin through your IDE or through the marketplace.

Usage

Install Yamllint according to the documentation and make sure it's in your PATH or as a package in your projects' SDK, such as virtualenv.

After opening a YAML file and if the project is applicable you'll be asked if you want to enable to plugin. If not, go to Settings > Tools > Yamllint to configure the plugin.

Open a Yaml file, warnings and errors should be displayed inline according to your settings!

Development

Prerequisites

• Gradle 7.5+
• A Java 11+ Runtime

Build

To compile and package the plugin, simply issue the following command:

$ ./gradlew buildPlugin

This will create a zip located in build/distributions/.

Test

Run the tests as you would in any other gradle project:

$ ./gradlew test

Run

To run the plugin from the command line, the following command can be used:

$ ./gradlew runIde

This will start IntelliJ Community with all necessary plugins loaded. Logs are located at build/idea-sandbox/system/log/idea.log.

Contribute

Use the issue tracker to report bugs or make feature requests.

License

MIT, see LICENSE file.