-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: update readme. 1.update kcl website link 2. temporarily remove description about invalid format feature 3. install the plugin from marketplace Signed-off-by: he1pa <[email protected]>
- Loading branch information
Showing
1 changed file
with
19 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,56 +1,56 @@ | ||
| # KCL Plugin for IntelliJ IDEA | ||
| [](https://app.fossa.com/projects/git%2Bgithub.com%2Fkcl-lang%2Fintellij-kcl?ref=badge_shield) | ||
|
|
||
| The KCL IntelliJ IDEA plugin provides rich language support for the [KCL language](https://kcl-lang.io/). | ||
|
|
||
| The KCL IntelliJ IDEA plugin provides rich language support for the [KCL programming language](https://kcl-lang.io/). | ||
| In addition, we also have a plugin implemented based on the LSP(Language Server Protocol), which can be found [here](https://github.com/kcl-lang/intellij-kcl-lsp) | ||
|
|
||
| ## Quick Start | ||
|
|
||
| Welcome to KCL developing! We hope this plugin enhances your development experience with KCL. | ||
|
|
||
| - **Step 1.** Install [KCL](https://kcl-lang.io/docs/user_docs/getting-started/install) on your system. | ||
| - **Step 2.** Install the KCL extension for IntelliJ IDEA. Download the distribution from [here](distributions) and in IntelliJ IDEA, click Preference -> plugins -> install Plugin from Disk... -> select `kcl-idea-plugin` zip -> restart IDE. This plugin requires the IntelliJ IDEA 2020.2+ | ||
| - **Step 3.** Open or create a KCL file and begin your KCL tour! | ||
|
|
||
| <div style="text-align: center;"><img src="docs/img/how-to-install.gif" alt="IntelliJ KCL Plugin install"></div> | ||
| - **Step 1.** [Install KCL](https://kcl-lang.io/docs/user_docs/getting-started/install) on your system. | ||
|
|
||
| ## Features | ||
| - **Step 2.** Install the KCL plugin for IntelliJ IDEA in Marketplace. Preference -> plugins -> Marketplace -> search `KCL` -> install -> restart IDE. This plugin requires the IntelliJ IDEA Ultimate 2023.2+ | ||
|
|
||
| <!-- Plugin description --> | ||
| - **Step 3.** Open or create a KCL file and begin your KCL tour! | ||
|
|
||
| This extension provides coding assistance such as basic syntax highlight, IntelliSense such as auto-complete, and some basic code navigation. Other useful features such as diagnostics and testing are in development. | ||
| ## Features | ||
|
|
||
| <!-- Plugin description end --> | ||
| This extension provides coding assistance such as basic syntax highlight, IntelliSense such as auto complete, and some basic code navigation. Other useful features such as diagnostics and testing are in developing. | ||
|
|
||
| ### Highlight | ||
|
|
||
| <div style="text-align: center;"><img src="docs/img/highlight.jpg" alt="highlight"></div> | ||
|
|
||
| ### Code Formatting | ||
| ### Completion | ||
|
|
||
| This extension provides baisc keywords completion | ||
|
|
||
| Right-click on the editor and select KCL Tools -> Format File to format the current KCL file: | ||
| <!-- ### Code Formatting | ||
| Right click on the editor and select KCL Tools -> Format File to format current KCL file: | ||
| <div style="text-align: center;"><img src="docs/img/format-file.png" alt="format file"></div> | ||
| Right-click on the target directory in the project structure panel, and select KCL Tools -> Format Directory to format all files under the selected folder: | ||
| Right click on the target directory in the project structure panel, select KCL Tools -> Format Directory to format all files under the selected folder: | ||
| <div style="text-align: center;"><img src="docs/img/format-directory.png" alt="format directory"></div> | ||
| Right-click on the project name in the project structure panel, and select KCL Tools -> Format Project to format all files in the project: | ||
| Right click on the project name in the project structure panel, select KCL Tools -> Format Project to format all files in the project: | ||
| <div style="text-align: center;"><img src="docs/img/format-project.png" alt="format project"></div> --> | ||
|
|
||
| <div style="text-align: center;"><img src="docs/img/format-project.png" alt="format project"></div> | ||
|
|
||
| ## Ask for help | ||
|
|
||
| If the plugin isn't working as you expect, please reach out to us by filing an issue. | ||
|
|
||
|
|
||
| ## Contributing | ||
|
|
||
| We are working actively on improving the KCL development on IntelliJ IDEA, and we welcome all kinds of contributions. You can refer to our [contribution guide](docs/CONTRIBUTING.md). It introduces how to build and run the extension locally. | ||
|
|
||
|
|
||
| ## License | ||
|
|
||
| Apache License Version 2.0 | ||
|
|
||
|
|
||
| [](https://app.fossa.com/projects/git%2Bgithub.com%2Fkcl-lang%2Fintellij-kcl?ref=badge_large) |