Add vscode extension

Author: maximebf

README.md

@@ -18,6 +18,7 @@ Sqlorm intends to provide a solution where SQL stays front and center and where
 - Built-in SQL based migration system
 - Low coupling between different parts of the library which can be used directly with DBAPI Connections
 - Easy to understand code
+- VS Code syntax highlighting using [extension](https://marketplace.visualstudio.com/items?itemName=hyperflask.sqlorm-language-support)
 
 [Read the documentation](https://hyperflask.github.io/sqlorm)
 

docs/index.md

@@ -122,6 +122,10 @@ with engine as tx:
     task.toggle()
 ```
 
+## Editor support
+
+VS Code syntax highlighting using [extension](https://marketplace.visualstudio.com/items?itemName=hyperflask.sqlorm-language-support)
+
 ## Acknowledgements
 
 sqlorm is inspired by the many great ORMs that already exists in Python and other languages.

vscode/.vscode/launch.json

@@ -0,0 +1,17 @@
+// A launch configuration that launches the extension inside a new window
+// Use IntelliSense to learn about possible attributes.
+// Hover to view descriptions of existing attributes.
+// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+{
+	"version": "0.2.0",
+	"configurations": [
+		{
+			"name": "Extension",
+			"type": "extensionHost",
+			"request": "launch",
+			"args": [
+				"--extensionDevelopmentPath=${workspaceFolder}"
+			]
+		}
+	]
+}

vscode/.vscodeignore

@@ -0,0 +1,4 @@
+.vscode/**
+.vscode-test/**
+.gitignore
+vsc-extension-quickstart.md

vscode/README.md

@@ -0,0 +1,5 @@
+# sqlorm-syntax-highligting
+
+Highlight SQL statements inside SQLORM sql functions
+
+WARNING: this is a basic extension that highlights docstrings that start with an SQL keyword. works need to be done to make it better

vscode/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "sqlorm-language-support",
+  "displayName": "SQLORM Syntax Highlighting",
+  "description": "Highlight SQL statements inside Python function docstrings",
+  "version": "0.0.1",
+  "engines": {
+    "vscode": "^1.96.0"
+  },
+  "categories": [
+    "Programming Languages"
+  ],
+  "contributes": {
+    "grammars": [{
+      "path": "./syntaxes/injection.json",
+      "scopeName": "sql-docstring.injection",
+      "injectTo": ["source.python"],
+      "embeddedLanguages": {
+        "meta.embedded.sql": "sql"
+      }
+    }]
+  }
+}

vscode/syntaxes/injection.json

@@ -0,0 +1,21 @@
+{
+    "scopeName": "sql-docstring.injection",
+    "injectionSelector": "L:string.quoted.docstring.multi.python",
+    "patterns": [
+        {
+            "begin": "\\b(SELECT|INSERT|UPDATE|DELETE|CREATE|DROP|ALTER|WITH)\\b",
+            "end": "(?=\"\"\")|(?=''')",
+            "beginCaptures": {
+                "1": {
+                    "name": "keyword.other.sql"
+                }
+            },
+            "contentName": "meta.embedded.sql",
+            "patterns": [
+                {
+                    "include": "source.sql"
+                }
+            ]
+        }
+    ]
+}