b67-engineering / intellij-reek-plugin

Reek Linter Plugin for JetBrains products - IntelliJ and RubyMine

intellij-reek-plugin

Reek Linter Plugin for JetBrains products - IntelliJ and RubyMine.

Dependencies

Reek needs to be included in Gemfile or executable path provided in Settings > Tools > Reek Linter after installation.

Installation

You can install the plugin by opening Settings > Plugins > Marketplace and searching for Reek Linter.

Configuration

Plugin should work out-of-the box. You can provide path to .reek.yml in Settings > Tools > Reek Linter.

As mentioned in dependencies - You can provide path to Your reek executable or use default loader that uses project SDK / gems provided in Gemfile.

Credentials

Plugin has been inspired by intellij-protolint.

intellij-reek-plugin's Issues

Add unit tests

Unit tests with 100% coverage should be created

Disable plugin if there is no reek

If there is no SDK, no reek in Gemfile and path to executable is not provided we should disable plugin to prevent notifications.

Cut base to separate repository

Cut base from src.main.java.engineering.b67.intellij_linter_base into separate repository - b67-engineering/intellij-linter-base and include it as dependency.

Tests, create and store artifacts

1. Run tests in GitHub Actions
2. Create artifact
3. Upload artifact to GitHub Package Registry

Omit whitespaces when highlighting line

Context on screenshot:

Rewrite to Kotlin

After 1.0 release plugin should be rewritten to Kotlin

After updating to Ruby Mine 2021.2 plugin crashes after opening a new file

Add plugin logo

plugin.xml requires logo - https://www.jetbrains.org/intellij/sdk/docs/basics/plugin_structure/plugin_icon_file.html