build: cleanup vscode metadata

.github/workflows/publish.yaml

@@ -14,8 +14,14 @@ jobs:
       uses: actions/setup-node@v4
       with:
         node-version: 18.x
+
     - run: npm install
 
+    - name: replace README.md
+      run: |
+        rm README.md
+        mv readmes/vscode.md README.md 
+
     - name: Publish vsce --pre-release
       if: startsWith(github.ref, 'refs/tags/v') && contains(github.ref, '-')
       run: ./node_modules/.bin/vsce publish --pre-release

.vscodeignore

@@ -1,15 +1,28 @@
-.vscode/**
+.vscode
+.github
 **/*.ts
 **/*.map
 .gitignore
 **/tsconfig.json
 **/tsconfig.base.json
 contributing.md
 .travis.yml
-ededb-ls-vscode/node_modules/**
-!ededb-ls-vscode/node_modules/vscode-jsonrpc/**
-!ededb-ls-vscode/node_modules/vscode-languageclient/**
-!ededb-ls-vscode/node_modules/vscode-languageserver-protocol/**
-!ededb-ls-vscode/node_modules/vscode-languageserver-types/**
-!ededb-ls-vscode/node_modules/{minimatch,brace-expansion,concat-map,balanced-match}/**
-!ededb-ls-vscode/node_modules/{semver,lru-cache,yallist}/**
+Makefile
+
+test
+settings/sublime
+settings/atom.cson
+generator
+misc
+readmes
+
+edgedb-ls-vscode/package.json
+edgedb-ls-vscode/package-lock.json
+edgedb-ls-vscode/out/test
+edgedb-ls-vscode/node_modules/**
+!edgedb-ls-vscode/node_modules/vscode-jsonrpc/**
+!edgedb-ls-vscode/node_modules/vscode-languageclient/**
+!edgedb-ls-vscode/node_modules/vscode-languageserver-protocol/**
+!edgedb-ls-vscode/node_modules/vscode-languageserver-types/**
+!edgedb-ls-vscode/node_modules/{minimatch,brace-expansion,concat-map,balanced-match}/**
+!edgedb-ls-vscode/node_modules/{semver,lru-cache,yallist}/**

README.md

@@ -12,32 +12,28 @@ ESDL (EdgeDB Schema Definition Language).  The plugin is designed to work with
 [Chromodynamics](https://github.com/MagicStack/Chromodynamics).)
 
 
-## Installation Instructions
+## Installation
 
-In **Atom** and **Visual Studio Code** install the `edgedb` package.
+In **Atom** and **Visual Studio Code** install the `EdgeDB` package.
 
 In **Sublime Text**, install the `EdgeDB` package via "Package Control".
 
+## Contributing
 
-## Syntax highlighting for embedded code blocks
+We are accepting pull requests for anything that improves this extension:
+new features, fixes or documentation. We are not accepting code refactors.
 
-This extension also provides syntax highlighting within string literals of other languages such as JavaScript and Go.
-To enable the highlighting, include `# edgeql` in a backtick-quoted string.
-This will make it easier to spot syntax errors and make your embedded queries more readable.
+## Publishing
 
-```go
-// Go
-query := `#edgeql
-select Example { * };
-`
-```
+To publish a new version:
+- increment the version number in `package.json` to e.g. `0.1.8`,
+- commit and tag the changes with tag of format `v0.1.8`,
+- push to GitHub.
 
-```javascript
-// JavaScript
-const query = `
-  # edgeql
-  SELECT ... 
-`;
-```
+This will start the GitHub Action that will publish to the Azure Marketplace.
 
-Other languages are not yet implemented, but we are accepting pull requests at [edgedb-editor-plugin](https://github.com/edgedb/edgedb-editor-plugin).
+To publish a prerelease version, tag the commit with `v0.1.8-pre`.
+Do not add `-pre` to the version in `package.json`.
+A regular release cannot have the same number as the prerelease version,
+so (at least) the patch number must be increased. For example,
+after publishing `v0.1.8-pre`, we would publish `v0.1.9`.

edgedb-ls-vscode/package.json

@@ -5,10 +5,6 @@
     "license": "MIT",
     "version": "0.0.1",
     "publisher": "vscode",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/Microsoft/vscode-extension-samples"
-    },
     "engines": {
         "vscode": "^1.75.0"
     },

package.json

@@ -1,9 +1,10 @@
 {
   "name": "edgedb",
-  "displayName": "edgedb",
+  "displayName": "EdgeDB",
   "description": "EdgeDB plugin for Sublime Text, Atom, and VSCode",
   "version": "0.1.8",
   "publisher": "magicstack",
+  "icon": "icon.png",
   "engines": {
     "atom": "*",
     "node": "*",

readmes/vscode.md

@@ -0,0 +1,44 @@
+# EdgeDB extension for Visual Studio Code
+
+Extension that provides support for EdgeDB query language (EdgeQL) and  EdgeDB Schema Definition Language (ESDL).
+
+![](https://edgedb.github.io/edgedb-editor-plugin/edgedb-st.png)
+
+(The color scheme used in the screenshot is
+[Chromodynamics](https://github.com/MagicStack/Chromodynamics).)
+
+## Features
+
+- syntax highlighting,
+- syntax highlighting in embedded code blocks,
+
+
+## Installation Instructions
+
+In **Atom** and **Visual Studio Code** install the `edgedb` package.
+
+In **Sublime Text**, install the `EdgeDB` package via "Package Control".
+
+
+## Syntax highlighting for embedded code blocks
+
+This extension also provides syntax highlighting within string literals of other languages such as JavaScript and Go.
+To enable the highlighting, include `# edgeql` in a backtick-quoted string.
+This will make it easier to spot syntax errors and make your embedded queries more readable.
+
+```go
+// Go
+query := `#edgeql
+select Example { * };
+`
+```
+
+```javascript
+// JavaScript
+const query = `
+  # edgeql
+  SELECT ... 
+`;
+```
+
+Other languages are not yet implemented, but we are accepting pull requests at [edgedb-editor-plugin](https://github.com/edgedb/edgedb-editor-plugin).