search

codacy / codacy-intellij-extension

Codacy IntelliJ Idea Extension
MIT License
2 stars 0 forks source link

readme

Codacy IntelliJ Plugin

The Codacy plugin for IntelliJ helps you review and manage the issues found by Codacy directly within IntelliJ IDEs. It notifies you whether a pull request is up to standards by highlighting problematic code patterns and displaying code quality metrics.

Codacy IntelliJ Plugin Screenshot

Codacy is an automated code review tool that helps your team write high-quality code by analyzing over 40 programming languages, such as PHP, JavaScript, Python, Java, and Ruby. Codacy lets you define and enforce your own quality rules, code patterns, and quality settings to prevent issues in your codebase.

Codacy Logo

Prerequisites

Before installing the plugin, make sure you meet the following requirements:

  1. You have a Codacy account.
  2. The repository you’re working on has been added to Codacy Cloud.
  3. You have at least Repository Read permissions for the repository you’re working on.

Installation

From JetBrains Marketplace

  1. Open your IntelliJ IDE and navigate to Settings > Plugins.
  2. Search for "Codacy" in the Marketplace tab.
  3. Click Install and restart your IntelliJ IDE.

Manually Installing

  1. Download the latest .zip file from the releases page.
  2. Open your IntelliJ IDE and navigate to Settings > Plugins.
  3. Click the gear icon and choose Install Plugin from Disk....
  4. Select the downloaded .zip file and restart your IntelliJ IDE.

Building from Source

  1. Clone the repository from GitHub.
  2. Open the project in your IntelliJ IDE.
  3. Run ./gradlew buildPlugin
  4. The built plugin will be located in the build/distributions directory.
  5. Install the plugin manually

Usage

Ensure Codacy's inspections are enabled by following this guide.

Contributing

We welcome all contributions, from small bug fixes to large features.

For information on how to contribute to this project, please refer to the contributing guidelines.

Troubleshooting

If you're having trouble using the Codacy plugin, see below to troubleshoot errors.

Could not find repository

If you see this error, confirm that the repository has been added to Codacy Cloud and that you have at least Repository Read permissions.

The Codacy plugin for IntelliJ helps you review and manage the issues found by Codacy directly within your IntelliJ IDE. It notifies you whether a pull request is up to standards by highlighting problematic code patterns and displaying code quality metrics.