From 02232cc8707421b23a2bddcf28e9e65f63480306 Mon Sep 17 00:00:00 2001 From: Ziv Date: Fri, 16 Jul 2021 14:33:35 +0800 Subject: [PATCH] docs: integrating with monaco-editor (#34) * build: move standard-version to devDep * docs: integrating with monaco-editor * docs: update README --- README.md | 9 +++++++-- package.json | 6 +++--- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1d12241..ea7be50 100644 --- a/README.md +++ b/README.md @@ -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. -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: -- MySQL +- Generic SQL (MySQL) - Flink SQL - Spark 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. +## 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 ```bash diff --git a/package.json b/package.json index 5398d50..70092fe 100644 --- a/package.json +++ b/package.json @@ -33,7 +33,8 @@ "eslint-config-google": "^0.14.0", "jest": "^24.8.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", "repository": "https://github.com/DTStack/dt-sql-parser", @@ -42,7 +43,6 @@ }, "dependencies": { "@types/antlr4": "4.7.0", - "antlr4": "4.7.2", - "standard-version": "^9.1.0" + "antlr4": "4.7.2" } }