oushu/lava-oushudb-dt-sql-parser
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: integrating with monaco-editor (#34)

Browse Source 
* build: move standard-version to devDep

* docs: integrating with monaco-editor

* docs: update README
This commit is contained in:
Ziv 2021-07-16 14:33:35 +08:00 committed by GitHub
parent d020591da1
commit 02232cc870
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -12,11 +12,11 @@ English | [简体中文](./README-zh_CN.md)
dt-sql-parser is a **SQL Parser** project built with [ANTLR4](https://github.com/antlr/antlr4), and it's mainly for the **BigData** domain. The [ANTLR4](https://github.com/antlr/antlr4) generated the basic Parser, Visitor, and Listener, so it's easy to complete the **syntax validation**, **tokenizer**, **traverse** the AST, and so on features. dt-sql-parser is a **SQL Parser** project built with [ANTLR4](https://github.com/antlr/antlr4), and it's mainly for the **BigData** domain. The [ANTLR4](https://github.com/antlr/antlr4) generated the basic Parser, Visitor, and Listener, so it's easy to complete the **syntax validation**, **tokenizer**, **traverse** the AST, and so on features.
Besides, it' provides some helper methods, like **split** SQL, and filter the `--` and `/**/` types of comments in SQL. Besides, it provides some helper methods, like **split** SQL, and filter the `--` and `/**/` types of comments in SQL.
Supported SQL: Supported SQL:
- MySQL - Generic SQL (MySQL)
- Flink SQL - Flink SQL
- Spark SQL - Spark SQL
- Hive SQL - Hive SQL
@ -24,6 +24,11 @@ Supported SQL:
>Tips: This project is the default for Javascript language, also you can try to compile it to other languages if you need. >Tips: This project is the default for Javascript language, also you can try to compile it to other languages if you need.
## Integrating SQL Parser with Monaco Editor
We have provided a [monaco-sql-languages](https://github.com/DTStack/monaco-sql-languages) package, you can integrate with `monaco-editor`
easily.
## Installation ## Installation
```bash ```bash

6
package.json
View File

@ -33,7 +33,8 @@
"eslint-config-google": "^0.14.0", "eslint-config-google": "^0.14.0",
"jest": "^24.8.0", "jest": "^24.8.0",
"ts-jest": "^24.1.0", "ts-jest": "^24.1.0",
"typescript": "^3.6.3" "typescript": "^3.6.3",
"standard-version": "^9.1.0"
}, },
"git repository": "https://github.com/DTStack/dt-sql-parser", "git repository": "https://github.com/DTStack/dt-sql-parser",
"repository": "https://github.com/DTStack/dt-sql-parser", "repository": "https://github.com/DTStack/dt-sql-parser",
@ -42,7 +43,6 @@
}, },
"dependencies": { "dependencies": {
"@types/antlr4": "4.7.0", "@types/antlr4": "4.7.0",
"antlr4": "4.7.2", "antlr4": "4.7.2"
"standard-version": "^9.1.0"
} }
} }