Skip to content

Commit

Permalink
chore: update README and bump to 0.3.0 (#41)
Browse files Browse the repository at this point in the history
* chore: update README and bump to 0.2.2

Signed-off-by: he1pa <[email protected]>

* bump to 0.3.0

Signed-off-by: he1pa <[email protected]>

---------

Signed-off-by: he1pa <[email protected]>
  • Loading branch information
He1pa authored Sep 18, 2024
1 parent 4df4ce4 commit 9902a8e
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 24 deletions.
33 changes: 10 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ To keep everything working, do not remove `<!-- ... ->`

The KCL IntelliJ IDEA plugin provides rich language support for the [KCL 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)
<!-- Plugin description end -->
## Quick Start

Expand All @@ -21,30 +20,18 @@ Welcome to KCL developing! We hope this plugin enhances your development experie

## Features

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.
This extension provides many coding assistance based on Language Server Protocol.

### Highlight

<div style="text-align: center;"><img src="docs/img/highlight.jpg" alt="highlight"></div>

### Completion

This extension provides baisc keywords completion

### 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, 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, 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>
+ **Highlight:** Syntax and semantic highlight
+ **Completion:** Completion for keywords, variable name, attributes and more
+ **Goto definition:** Goto definition of schema, variable, schema attribute, and import pkg
+ **Structure:** Main definition(schema def) and variables in KCL file
+ **Hover:** Identifier information (type and schema documentation)
+ **Diagnostics:** Warnings and errors in KCL file
+ **Code Action:** Quick fix for some errors
+ **InlayHint:** Hint for variable type, function and schema args

Other useful features such as diagnostics and testing are in developing.

## Ask for help

Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ pluginGroup = io.kusionstack.kcl
pluginName = intellij-kcl
pluginRepositoryUrl = https://github.com/KusionStack/intellij-kcl
# SemVer format -> https://semver.org
pluginVersion = 0.2.1
pluginVersion = 0.3.0

# Supported build number ranges and IntelliJ Platform versions -> https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html
pluginSinceBuild = 221
Expand Down

0 comments on commit 9902a8e

Please sign in to comment.