Skip to content

Commit 09109cb

Browse files
committed
update README
1 parent cb4c04d commit 09109cb

2 files changed

Lines changed: 28 additions & 7 deletions

File tree

README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
# Flink-SQL-Helper
2-
Help you efficiently and focus on FlinkSQL development. support Flink SQL error grammar check, syntax highlighting, complete keywords, rename, find all references and code format, including user-defined functions.
32

3+
Help you efficiently and focus on FlinkSQL development. support Flink SQL error grammar check, syntax highlighting, complete keywords, rename, find all references and code format, including user-defined functions.
44

55
> I suggest that you develop and debug on vscode based on the information (https://code.visualstudio.com/docs/java/java-debugging) to obtain a better experience.
66
77
## 1.Features
88

99
### 1.1 Grammar Check
10+
1011
Setting plugin config like
1112
1. ![](docs/images/setting_1.png)
1213
2. ![](docs/images/setting_2.png)
@@ -20,47 +21,64 @@ example:
2021
- ![](docs/images/expect_semicolon_v3.jpg)
2122

2223
### 1.2 Refactorings
24+
2325
![](docs/images/refactorings.gif)
2426

2527
### 1.3 Code Completion Proposals
28+
2629
![](docs/images/code_completion_proposal_v3.gif)
2730

28-
### 1.4 Snippets
31+
### 1.4 Snippets
32+
2933
snippets keywords:
34+
3035
- create
3136
- select
3237
- insert
3338
- join
3439
- windows
3540

3641
#### create
42+
3743
![](docs/images/create_snippets_v2.gif)
38-
#### select
44+
45+
#### select
46+
3947
![](docs/images/select_snippets_v3.gif)
48+
4049
#### insert
50+
4151
![](docs/images/insert_snippets_v2.gif)
4252

4353
#### join
54+
4455
![](docs/images/join_snippets_v2.gif)
4556

4657
#### windows
58+
4759
![](docs/images/windows_snippets.gif)
4860

61+
### 1.5 Find All References
4962

50-
### 1.5 Find All References
5163
![](docs/images/find-all-references.gif)
64+
5265
### 1.6 Code Format
66+
5367
Select your FlinkSQL code and press ```Alt+Shift+f```.
5468

5569
## 2. User Guide
70+
5671
Enable the extension on your file, either name the file with a extension:
72+
5773
- SQL
5874
- FQL
5975

6076
Or press F1, type 'Change Language Mode', and then choose FlinkSQL.
6177

6278
### 2.1 Color theme recommend
79+
6380
Press F1, choose `Preference: Open User Setting(JSON)` then paste:
81+
6482
~~~json
6583
{
6684
"editor.tokenColorCustomizations": {
@@ -195,4 +213,5 @@ Press F1, choose `Preference: Open User Setting(JSON)` then paste:
195213
}
196214
}
197215
~~~
216+
198217
We provide so many options to allow developers to better customize their favorite themes. if you want to deep in, please see the `syntaxes/flink.tmLanguage.json` to understand keyword and color theme mapping.

docs/Develop Guide.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
# 1 Prerequisites
2+
23
- npm
34
- vsce
45

5-
# 2. Build
6+
# 2 Build
7+
68
- Run ```npm install --dependencies``` to install dependencies.
79
- Run ```vsce package``` to build extension.
810

11+
# 3 If you want add or update grammar rule
912

10-
# 3. If you want add or update grammar rule
1113
- Edit `FlinkSQL.g4`
1214
- Run `npm run antlr4ts` generate for ts code then move to src directory.
13-
- Copy ./gen ts file to src directory
15+
- Copy ./gen ts file to src directory

0 commit comments

Comments
 (0)