Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New Tool: Add Cadence support for IntelliJ Platform - Milestone 2-3-4 #112

Merged
merged 2 commits into from
Nov 9, 2021
Merged

New Tool: Add Cadence support for IntelliJ Platform - Milestone 2-3-4 #112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33f4136
Extend Intellij Cadence plugin info
Oct 30, 2021
6c008e7
Move files in team name folder
Oct 31, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 ...lestone-1/intellij-cadence-plugin-info.md → ...lestone-1/intellij-cadence-plugin-info.md
View file
Open in desktop
File renamed without changes.
22 changes: 22 additions & 0 deletions submissions/issue-19/freeflowers/milestone-2-3-4/intellij-cadence-plugin-info.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# General
- A new plugin, [Cadence](https://plugins.jetbrains.com/plugin/17764-cadence) has been developed, for Intellij Platform based IDEs
- The plugin was developed based on the official Intellij guide [](https://plugins.jetbrains.com/docs/intellij/custom-language-support-tutorial.html)
- The code of the plugin can be found on the [public github repository](https://github.com/cadence-tools/cadence-for-intellij-platform) under the open source GPLv3 license
- Instructions on how to get, use, and modify the plugin have been documented in the [README](https://github.com/cadence-tools/cadence-for-intellij-platform/blob/main/README.md) file

# Milestones
- The plugin provides syntax highlighting for Cadence language files, identified by the `.cdc` extension (milestone 1)
- The plugin provides language server protocol support (since version 0.4), by utilizing the [lsp4intellij](https://github.com/ballerina-platform/lsp4intellij/) library (milestone 2)
- The plugin is compatible with all intellij platform IDEs from versions 2021.2.2 and up, for example Intellij, GoLand, PyCharm, PhpStorm etc (milestone 3)
- The plugin is published in the [Jetbrains marketplace](https://plugins.jetbrains.com/plugin/17764-cadence), and can be installed directly by searching in the supported IDEs

# Extra
- The plugin includes settings to configure the colors of the different tokens of the syntax highlighting
- The syntax highlighting will be adapted to any color scheme / theme the user uses, as we follow platform defaults
- The plugin has been developed as a [dynamic plugin](https://plugins.jetbrains.com/docs/intellij/dynamic-plugins.html), allowing hot reload without restart of the IDE
- The plugin has functionality (configurable by settings) to log all the incoming and outgoing messages to the LSP server, to enable debugging / improvements int he future
- The plugin is suggested automatically by Intellij for `.cdc` files, and has already over 50 unique downloads

# Links
- https://github.com/cadence-tools/cadence-for-intellij-platform
- https://plugins.jetbrains.com/plugin/17764-cadence