Improve: Trigger grammar check when save edit. release v1.7.2

camilesing · Jul 18, 2023 · f4a1bd5 · f4a1bd5
1 parent bf09cd7
commit f4a1bd5
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 14 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,5 @@
+### v1.7.2
+- Improve: Trigger grammar check when save edit.
 ### v1.7.1
 - Feature: Grammar check be optional features from experiment.
 

diff --git a/README.md b/README.md
@@ -1,20 +1,21 @@
 # Flink-SQL-Checker
 
-This extension provides Flink SQL support for VSCode. Support Flink SQL error grammer check, syntax highlighting, complete keywords, rename and code format, including user-defined functions.
+This extension provides Flink SQL support for VSCode. support Flink SQL error grammar check, syntax highlighting, complete keywords, rename and code format, including user-defined functions.
 
 
 ## 1.Features
 
 ### 1.1 Grammar Check
-open your `setting.json`, add `"flink-sql-grammar-check.enable": true` or 
+open your `setting.json`, add `"flink-sql-grammar-check.enable": true` or setting like
 ![](images/open-setting.jpg)
 
-example:
-- ![](images/expect-semicolon.jpg)
+then the plugin will check grammar when you save edit (suggest you turn off automatic saving).
 
-- ![](images/select-not-expect-comma.jpg)
+example:
 
 - ![](images/unexpect-input.jpg)
+- ![](images/select-not-expect-comma.jpg)
+- ![](images/expect-semicolon.jpg)
 
 ### 1.2 Rename
 ![](images/rename.gif)

diff --git a/out/extension.js b/out/extension.js
diff --git a/out/extension.js.map b/out/extension.js.map
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "flink-sql",
-    "version": "1.7.1",
+    "version": "1.7.2",
     "displayName": "Flink SQL Checker",
     "description": "Support Flink SQL grammar check, syntax highlighting, complete keywords, rename and code format, including user-defined functions",
     "publisher": "CamileSing",

diff --git a/src/extension.ts b/src/extension.ts
@@ -75,17 +75,17 @@ function updateFeatureStatus() {
         // 创建诊断集合，用于报告语法错误和警告
         const diagnosticCollection = vscode.languages.createDiagnosticCollection(selector);
 
-        // 监听文件更改事件
-        vscode.workspace.onDidChangeTextDocument((event: vscode.TextDocumentChangeEvent) => {
+        // 保存时触发
+        vscode.workspace.onDidSaveTextDocument((event: vscode.TextDocument) => {
             // 检查文件是否为Flink SQL文件
-            if (event.document.languageId !== selector) {
+            if (event.languageId !== selector) {
                 return;
             }
             // 清除之前的诊断信息
             diagnosticCollection.clear();
 
             // 使用生成的词法分析器和解析器进行语法检查
-            const inputStream = new ANTLRInputStream(event.document.getText());
+            const inputStream = new ANTLRInputStream(event.getText());
             const lexer = new FlinkSQLLexer(inputStream);
             const tokenStream = new CommonTokenStream(lexer);
             const parser = new FlinkSQLParser(tokenStream);