https://github.com/open-policy-agent/opa-idea-plugin

Open Policy Agent plugin for IntelliJ
https://github.com/open-policy-agent/opa-idea-plugin

Last synced: 3 days ago
JSON representation

Open Policy Agent plugin for IntelliJ

• Host: GitHub
• URL: https://github.com/open-policy-agent/opa-idea-plugin
• Owner: open-policy-agent
• License: mit
• Created: 2020-03-11T23:04:33.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-08-26T21:25:12.000Z (2 months ago)
• Last Synced: 2024-08-27T00:24:32.411Z (2 months ago)
• Language: Kotlin
• Size: 1.09 MB
• Stars: 56
• Watchers: 9
• Forks: 22
• Open Issues: 36
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome-opa - IntelliJ plugin - OPA plugin for the IntelliJ IDE (IDE and Editor Integrations / Datasource Integrations Blogs and Articles)

README

        
# Opa IntelliJ plugin

A plugin for [IntelliJ](https://www.jetbrains.com/idea/) that provides support for [Open Policy Agent](https://www.openpolicyagent.org/)

Main features are:

* highlighting

* `opa eval` run configuration

* `opa test` run configuration

# Compatibility

The plugin is compatible with all IntelliJ-based IDEs starting from the version 2020.3, with the following differences in the sets of the available features:

|                        | [IntelliJ IDEA] Community and Ultimate (commercial) |Other IDE

|------------------------|---|---|

| Rego project creation  | + | - |

| Other features         | + | + |

Plugin has been tested against OPA `0.28.0`, but should work with more recent versions.

# Installation 

OPA binary must be in the path.

Installation instructions for OPA can be found [here](https://www.openpolicyagent.org/docs/latest/#running-opa).

## from Jetbrains repository

Go to `Settings / Preferences / Plugins` menu. Then, search `opa` in the `Marketplace` tab and install the plugin.

![Step 3](docs/user/img/3_install_opa_plugin.png)

## from source

You can build the project from source and then install it. Build instructions are available [here](docs/devel/setup_development_env.md).

# Documentation 

User documentation is available [here](docs/user/README.md).

# Contributing

Interested in contributing? Please, start by reading this [document](CONTRIBUTING.md).

# Acknowledgment

This project is widely inspired by [rust IntelliJ plugin](https://github.com/intellij-rust/intellij-rust). So, thank you

[JetBrains](https://www.jetbrains.org/) team.