https://github.com/codiga/jetbrains-plugin

Jetbrains plugin for Codiga. Coding Assistant and Code Analysis in all JetBrains products. Codiga supports more than 10+ languages, try it for free on https://www.codiga.io
https://github.com/codiga/jetbrains-plugin

c coding-assistant complexity-analysis cpp intellij intellij-plugin intellij-plugins java javascript jetbrains phpstorm phpstorm-plugin pycharm-ide pycharm-plugin python snippets-manager

Last synced: 3 months ago
JSON representation

Jetbrains plugin for Codiga. Coding Assistant and Code Analysis in all JetBrains products. Codiga supports more than 10+ languages, try it for free on https://www.codiga.io

• Host: GitHub
• URL: https://github.com/codiga/jetbrains-plugin
• Owner: codiga
• License: gpl-3.0
• Archived: true
• Created: 2021-03-17T03:36:13.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-05-04T17:10:56.000Z (over 2 years ago)
• Last Synced: 2024-09-27T06:04:19.482Z (about 1 year ago)
• Topics: c, coding-assistant, complexity-analysis, cpp, intellij, intellij-plugin, intellij-plugins, java, javascript, jetbrains, phpstorm, phpstorm-plugin, pycharm-ide, pycharm-plugin, python, snippets-manager
• Language: Java
• Homepage: https://www.codiga.io/get-codiga/jetbrains/
• Size: 11.4 MB
• Stars: 21
• Watchers: 3
• Forks: 10
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[Datadog acquired Codiga](https://www.codiga.io/blog/codiga-joins-datadog/). This repository is no longer active.

![JetBrains Plugins Download](https://img.shields.io/jetbrains/plugin/d/17969)

![JetBrains Plugins Ratings](https://img.shields.io/jetbrains/plugin/r/rating/17969)

![JetBrains Plugins](https://img.shields.io/jetbrains/plugin/v/17969)

# Codiga for Jetbrains

Codiga is a static code analyzer on steroids.

Codiga is compatible with all JetBrains products: IntelliJ, AppCode, PHPStorm, DataDrip, GoLand, RubyMine, PyCharm,

CLion (and many more).

![Code Analysis](images/code-analysis.gif "Static Code Analysis with Codiga")

## Installation

Codiga is available on the [Jetbrains marketplace](https://plugins.jetbrains.com/plugin/17969-codiga)

and you can install it directly within any Jetbrains product (IntelliJ, PHPStorm, PYCharm, etc).

![Codiga Jetbrains plugin](images/plugin-description.png "Codiga PlugIn")

## Static Code Analysis

The static code analysis works for Python in Beta.

With Codiga, you can:

- Use Code Analysis rules from the [Codiga Hub](https://app.codiga.io/hub/rulesets)

- Create your own Code Analysis rules

### Getting Started

### Automatically

At the root of your project, invoke the following command

```bash

npx @codiga/cli@latest ruleset-add

```

**Note**: you must have `npx` installed (available with `npm`)

### Manually

Visit the [Codiga Hub](https://app.codiga.io/hub/rulesets) and select the rulesets to use for your project.

Then, create a `codiga.yml` **at the root of your project** with the list of rulesets you want to use.

Example of `codiga.yml` for Python:

```yaml

rulesets:

  - python-security

  - python-best-practices

```

## Code Snippets

### Quick Start

Open a file, make a one-line comment to see all suggestions from the Codiga API.

By default, Codiga searches all public snippet. If you want Codiga to also

look for your own snippets, add your API keys (see configuration below).

### Using shortcuts in the IDE

Install the extension and type `.` in your IDE to list all available snippets for your current environment (language,

file, libraries).

Accept a snippet using either Enter ↩ or Tab ↹. Go through the snippet variables using the Tab key.

![Using Code Snippet Shortcut](images/shortcut.gif "Using a shortcut")

### Snippet Search

Use the Codiga Snippets panel on the right to find code snippets that match your environment.

Syntax highlighting is available for Python and Java snippets.

![Code Snippet Search](images/snippet-search.gif "Code Snippet Search")

### Semantic Search

Press CTRL + ALT + C (or choose the menu option "Tools" → "Coding Assistant") to launch a request

to Codiga and find snippets based on your keywords.

![Code Snippet Semantic Search](images/coding-assistant.gif "Coding Assistant")

### List all shortcuts

Press CTRL + ALT + S (or choose the menu option "Tools" → "Shortcuts") to list

all keywords for your environment.

![List all snippet shortcuts](images/shortcut-list.gif "List of all shortcuts")

### Creating and sharing snippets

![Create Code Snippet](images/create-recipe.gif "Creating Recipe")

1. Select the code in your editor

2. Right click on `Create Codiga Snippet`

## Connecting your Codiga Account

You can connect your Codiga account and benefit from all the Codiga features:

1. use the code snippets and cookbooks you define and subscribe to

2. use all your code analysis preferences on Codiga

In order to link your Codiga account, you need to add your API token to your preferences.

First, go on our application and generate an API token as shown below.

![API Token Creation](images/api-token-creation.gif)

Then, enter your API token in the Jetbrains plugin configuration, as shown below.

![Project Configuration](images/api-token.png)

Once the token is added, click on "Apply" and then "Test API connection".

# Support

You can use the current [issue tracker](https://github.com/codiga/jetbrains-plugin/issues)

or report the issue on

our [Slack channel](https://join.slack.com/t/codigahq/shared_invite/zt-9hvmfwie-9BUVFwZDwvpIGlkHv2mzYQ).

# Implementation Details

## Dependencies

* [apollo-android](https://github.com/apollographql/apollo-android)

  to access the [Code Inspector GraphQL API](https://doc.codiga.io/docs/api/)

## License

This project is under the GPL-3. See the LICENSE file for more information.

## Contact

To report a bug, submit an issue directly on

the [GitHub issue tracker](https://github.com/codiga/jetbrains-plugin/issues).