From fb63982f8d5020c0e584652089b647811219d2c1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nacho=20Cord=C3=B3n?= Date: Thu, 20 Jun 2024 13:40:42 +0100 Subject: [PATCH] Bumps VSCode version (#227) --- .../workflows/publish-vscode-extension.yaml | 1 + packages/vscode-extension/CHANGELOG.md | 5 ++ packages/vscode-extension/README.md | 49 ++++++++++++++++++- packages/vscode-extension/package.json | 2 +- 4 files changed, 55 insertions(+), 2 deletions(-) diff --git a/.github/workflows/publish-vscode-extension.yaml b/.github/workflows/publish-vscode-extension.yaml index 2592c71c0..7b69daebe 100644 --- a/.github/workflows/publish-vscode-extension.yaml +++ b/.github/workflows/publish-vscode-extension.yaml @@ -1,6 +1,7 @@ name: Publish VSCode extension to Marketplace and OpenVSX on: + workflow_dispatch: push: tags: - 'neo4j-for-vscode@*.*.*' diff --git a/packages/vscode-extension/CHANGELOG.md b/packages/vscode-extension/CHANGELOG.md index a1e6d784c..086fc6f85 100644 --- a/packages/vscode-extension/CHANGELOG.md +++ b/packages/vscode-extension/CHANGELOG.md @@ -1,5 +1,10 @@ # @neo4j-cypher/vscode-extension +## 1.2.0 + +- Adds basic connection pane to connect to Neo4j using VSCode menus +- Adds syntax highlighting inside Markdown files and for annotated strings in Java, Python, Javascript, .NET and Go + ## 1.1.1 ### Patch Changes diff --git a/packages/vscode-extension/README.md b/packages/vscode-extension/README.md index ae0e66d7a..35b8696e1 100644 --- a/packages/vscode-extension/README.md +++ b/packages/vscode-extension/README.md @@ -15,11 +15,58 @@ Our extension preview provides a rich set of features for working with Cypher, t ![demo-gif](https://github.com/neo4j/cypher-language-support/blob/main/packages/vscode-extension/resources/images/demo.gif?raw=true) +It also provides a basic database connection management pane and syntax highlighting embedded in other languages, namely Markdown, Java, Python, Javascriopt, .NET and Go. This is possible having a multiline string that starts with `//cypher` or `/*cypher*/` or a single line string starting with `/*cypher*/`. We also support a templated string `/*cypher*/`{{query here}}` in Javascript. Examples: + +### Markdown + +```` +```cypher +MATCH (n) RETURN n +``` +```` + +### Java + +```java +String a = """//cypher + MATCH (n) + RETURN n +""" + +String b = """/*cypher*/ + MATCH (n) + RETURN n +""" + +String c = "/*cypher*/ MATCH (n:Label) RETURN function(n.property)" +``` + +### Javascript / Typescript + +```typescript +const a = /* cypher */ ` + MATCH (n) + RETURN n +`; + +const b = `//cypher + MATCH (n) + RETURN n +`; + +const c = `/*cypher*/ + MATCH (n) + RETURN n +`; + +const d = '/*cypher*/ MATCH (n) RETURN n'; +``` + ## Upcoming features We're working on adding more features to the extension, such as: -- Easier database connection management +- Improved database connection management - Embedded cypher support in other file types - Query exectution and result visualization - Automatic query formatting diff --git a/packages/vscode-extension/package.json b/packages/vscode-extension/package.json index 71a1ba8b5..b303a2458 100644 --- a/packages/vscode-extension/package.json +++ b/packages/vscode-extension/package.json @@ -6,7 +6,7 @@ "publisher": "neo4j-extensions", "author": "Neo4j Inc.", "license": "Apache-2.0", - "version": "1.1.1", + "version": "1.2.0", "preview": true, "categories": [ "Programming Languages",