https://github.com/Alaanor/candid-intellij-plugin

A Candid language plugin that provide a complete support to efficiently edit .did files.
https://github.com/Alaanor/candid-intellij-plugin

Last synced: 5 days ago
JSON representation

A Candid language plugin that provide a complete support to efficiently edit .did files.

• Host: GitHub
• URL: https://github.com/Alaanor/candid-intellij-plugin
• Owner: Alaanor
• License: mit
• Created: 2022-03-05T18:32:25.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-09-15T17:52:04.000Z (about 1 year ago)
• Last Synced: 2024-08-02T06:16:32.383Z (3 months ago)
• Language: Kotlin
• Homepage: https://plugins.jetbrains.com/plugin/19148-candid
• Size: 1.69 MB
• Stars: 8
• Watchers: 1
• Forks: 2
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-internet-computer - Intellij Candid Plugin - A Candid language plugin for editing .did files. (Candid / Libraries / Frameworks)

README

        


  





  

  

  



#  IntelliJ Candid Language Plugin

A [Candid](https://github.com/dfinity/candid) language plugin that provide a complete support to efficiently edit `.did` files. [Candid](https://github.com/dfinity/candid) is an interface description language (IDL) for interacting with canisters (also known as services or actors) running on the [Internet Computer](https://internetcomputer.org/).

Features supported so far:

- 💡 Syntax Highlighting

- ⌨️ Auto Completion

- 🔍 Find Usage

- 💄 Code Format

- 🦀 Rust integration

## 🦀  Rust integration

For the sake of correctness, the plugin will only enable rust integration for a given candid file if the followings are found in `dfx.json`:

```json

{

  "canisters": {

    "foobar-canister": {

      "type": "rust",

      "candid": "correct/path/to/candid-file.did",

      "package": "rust-package-name"

    }

  }

}

```

All three `type`, `candid` and `package` fields are required to enable rust integration. `dfx.json` is expected to be found at the root of the project.

The type `custom` will not be supported because of the lack of explicit information that the plugin require to correctly resolve items.

## Installation

- Using IDE built-in plug system: Settings/Preferences > Plugins > Marketplace > Search for "Candid" >

  Install Plugin

- Manually: Download the [latest release](https://github.com/Alaanor/candid-intellij-plugin/releases/latest) and install it manually using

  Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...