From dd8a64f72b8291eca4433d5e9f52745a35ae02f9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alja=C5=BE=20Mur=20Er=C5=BEen?= Date: Sat, 13 Jul 2024 15:39:43 +0200 Subject: [PATCH] build: cleanup vscode metadata --- .github/workflows/publish.yaml | 6 ++ .vscodeignore | 29 +++++--- README.md | 36 +++++----- edgedb-ls-vscode/package-lock.json | 106 ----------------------------- edgedb-ls-vscode/package.json | 4 -- icon.png | Bin 0 -> 1482 bytes package.json | 5 +- readmes/vscode.md | 44 ++++++++++++ 8 files changed, 90 insertions(+), 140 deletions(-) create mode 100644 icon.png create mode 100644 readmes/vscode.md diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml index 1b7e50c..38ca6f1 100644 --- a/.github/workflows/publish.yaml +++ b/.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 diff --git a/.vscodeignore b/.vscodeignore index 66d3e91..018b5e1 100644 --- a/.vscodeignore +++ b/.vscodeignore @@ -1,4 +1,5 @@ -.vscode/** +.vscode +.github **/*.ts **/*.map .gitignore @@ -6,10 +7,22 @@ **/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}/** \ No newline at end of file +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}/** \ No newline at end of file diff --git a/README.md b/README.md index bd1dad0..57d65bc 100644 --- a/README.md +++ b/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). \ No newline at end of file +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`. diff --git a/edgedb-ls-vscode/package-lock.json b/edgedb-ls-vscode/package-lock.json index 3bb4695..418d0d5 100644 --- a/edgedb-ls-vscode/package-lock.json +++ b/edgedb-ls-vscode/package-lock.json @@ -9,8 +9,6 @@ "version": "0.0.1", "license": "MIT", "dependencies": { - "@microsoft/vscode-file-downloader-api": "^1.0.1", - "@skhaz/zstd": "^1.0.21", "env-paths": "^2.0.0", "tar": "^7.1.0", "vscode-languageclient": "^9.0.1" @@ -50,11 +48,6 @@ "node": ">=18.0.0" } }, - "node_modules/@microsoft/vscode-file-downloader-api": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/@microsoft/vscode-file-downloader-api/-/vscode-file-downloader-api-1.0.1.tgz", - "integrity": "sha512-cO9n/IpTMbXizz5YcEkiuRyX5r66SBY/3LnrlroyXbQXrgDdaKecfV3n4viTcvp9O//QF2AxcBfDZex2d4VSTg==" - }, "node_modules/@pkgjs/parseargs": { "version": "0.11.0", "resolved": "https://registry.npmjs.org/@pkgjs/parseargs/-/parseargs-0.11.0.tgz", @@ -64,20 +57,6 @@ "node": ">=14" } }, - "node_modules/@skhaz/zstd": { - "version": "1.0.21", - "resolved": "https://registry.npmjs.org/@skhaz/zstd/-/zstd-1.0.21.tgz", - "integrity": "sha512-4J1wGSWWdycC8dAiBOVeinVOJrjrgPRGQFA8Dwxig2c4QsPLVUKsS0XbOKyoyYGmpboPXZZE0AkC1B/hKGZxJQ==", - "hasInstallScript": true, - "dependencies": { - "nan": "^2.14.2", - "node-gyp-build": "^4.6.1", - "pond": "^2.1.2" - }, - "engines": { - "node": ">=16" - } - }, "node_modules/@tootallnate/once": { "version": "1.1.2", "resolved": "https://registry.npmjs.org/@tootallnate/once/-/once-1.1.2.tgz", @@ -248,14 +227,6 @@ "node": ">= 8" } }, - "node_modules/debug": { - "version": "3.2.7", - "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz", - "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==", - "dependencies": { - "ms": "^2.1.1" - } - }, "node_modules/eastasianwidth": { "version": "0.2.0", "resolved": "https://registry.npmjs.org/eastasianwidth/-/eastasianwidth-0.2.0.tgz", @@ -438,26 +409,6 @@ "url": "https://github.com/sponsors/isaacs" } }, - "node_modules/ms": { - "version": "2.1.3", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", - "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==" - }, - "node_modules/nan": { - "version": "2.19.0", - "resolved": "https://registry.npmjs.org/nan/-/nan-2.19.0.tgz", - "integrity": "sha512-nO1xXxfh/RWNxfd/XPfbIfFk5vgLsAxUR9y5O0cHMJu/AW9U95JLXqthYHjEp+8gQ5p96K9jUp8nbVOxCdRbtw==" - }, - "node_modules/node-gyp-build": { - "version": "4.8.1", - "resolved": "https://registry.npmjs.org/node-gyp-build/-/node-gyp-build-4.8.1.tgz", - "integrity": "sha512-OSs33Z9yWr148JZcbZd5WiAXhh/n9z8TxQcdMhIOlpN9AhWpLfvVFO73+m77bBABQMaY9XSvIa+qk0jlI7Gcaw==", - "bin": { - "node-gyp-build": "bin.js", - "node-gyp-build-optional": "optional.js", - "node-gyp-build-test": "build-test.js" - } - }, "node_modules/pako": { "version": "1.0.11", "resolved": "https://registry.npmjs.org/pako/-/pako-1.0.11.tgz", @@ -495,17 +446,6 @@ "node": "14 || >=16.14" } }, - "node_modules/pond": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/pond/-/pond-2.1.2.tgz", - "integrity": "sha512-tFHqQ0A+KZ5EDI8C6erkxgeCji2+Z0kZ9yqa1GH29/9TKkbvFdvR+sCwMYeqOQCrm+jWJ8lrlCsqvsa7VVUHDg==", - "dependencies": { - "debug": "^3.2.7" - }, - "engines": { - "node": ">= 10" - } - }, "node_modules/process-nextick-args": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.1.tgz", @@ -899,27 +839,12 @@ "minipass": "^7.0.4" } }, - "@microsoft/vscode-file-downloader-api": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/@microsoft/vscode-file-downloader-api/-/vscode-file-downloader-api-1.0.1.tgz", - "integrity": "sha512-cO9n/IpTMbXizz5YcEkiuRyX5r66SBY/3LnrlroyXbQXrgDdaKecfV3n4viTcvp9O//QF2AxcBfDZex2d4VSTg==" - }, "@pkgjs/parseargs": { "version": "0.11.0", "resolved": "https://registry.npmjs.org/@pkgjs/parseargs/-/parseargs-0.11.0.tgz", "integrity": "sha512-+1VkjdD0QBLPodGrJUeqarH8VAIvQODIbwh9XpP5Syisf7YoQgsJKPNFoqqLQlu+VQ/tVSshMR6loPMn8U+dPg==", "optional": true }, - "@skhaz/zstd": { - "version": "1.0.21", - "resolved": "https://registry.npmjs.org/@skhaz/zstd/-/zstd-1.0.21.tgz", - "integrity": "sha512-4J1wGSWWdycC8dAiBOVeinVOJrjrgPRGQFA8Dwxig2c4QsPLVUKsS0XbOKyoyYGmpboPXZZE0AkC1B/hKGZxJQ==", - "requires": { - "nan": "^2.14.2", - "node-gyp-build": "^4.6.1", - "pond": "^2.1.2" - } - }, "@tootallnate/once": { "version": "1.1.2", "resolved": "https://registry.npmjs.org/@tootallnate/once/-/once-1.1.2.tgz", @@ -1048,14 +973,6 @@ "which": "^2.0.1" } }, - "debug": { - "version": "3.2.7", - "resolved": "https://registry.npmjs.org/debug/-/debug-3.2.7.tgz", - "integrity": "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ==", - "requires": { - "ms": "^2.1.1" - } - }, "eastasianwidth": { "version": "0.2.0", "resolved": "https://registry.npmjs.org/eastasianwidth/-/eastasianwidth-0.2.0.tgz", @@ -1185,21 +1102,6 @@ "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-3.0.1.tgz", "integrity": "sha512-+NsyUUAZDmo6YVHzL/stxSu3t9YS1iljliy3BSDrXJ/dkn1KYdmtZODGGjLcc9XLgVVpH4KshHB8XmZgMhaBXg==" }, - "ms": { - "version": "2.1.3", - "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", - "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==" - }, - "nan": { - "version": "2.19.0", - "resolved": "https://registry.npmjs.org/nan/-/nan-2.19.0.tgz", - "integrity": "sha512-nO1xXxfh/RWNxfd/XPfbIfFk5vgLsAxUR9y5O0cHMJu/AW9U95JLXqthYHjEp+8gQ5p96K9jUp8nbVOxCdRbtw==" - }, - "node-gyp-build": { - "version": "4.8.1", - "resolved": "https://registry.npmjs.org/node-gyp-build/-/node-gyp-build-4.8.1.tgz", - "integrity": "sha512-OSs33Z9yWr148JZcbZd5WiAXhh/n9z8TxQcdMhIOlpN9AhWpLfvVFO73+m77bBABQMaY9XSvIa+qk0jlI7Gcaw==" - }, "pako": { "version": "1.0.11", "resolved": "https://registry.npmjs.org/pako/-/pako-1.0.11.tgz", @@ -1227,14 +1129,6 @@ } } }, - "pond": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/pond/-/pond-2.1.2.tgz", - "integrity": "sha512-tFHqQ0A+KZ5EDI8C6erkxgeCji2+Z0kZ9yqa1GH29/9TKkbvFdvR+sCwMYeqOQCrm+jWJ8lrlCsqvsa7VVUHDg==", - "requires": { - "debug": "^3.2.7" - } - }, "process-nextick-args": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.1.tgz", diff --git a/edgedb-ls-vscode/package.json b/edgedb-ls-vscode/package.json index 4711c0f..d48fa0d 100644 --- a/edgedb-ls-vscode/package.json +++ b/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" }, diff --git a/icon.png b/icon.png new file mode 100644 index 0000000000000000000000000000000000000000..38ad03788db474ea41afd64698ef77727b5508bb GIT binary patch literal 1482 zcmeAS@N?(olHy`uVBq!ia0vp^TR@nD4M^IaWiw)6V4djc;uum9_xA4Eb#b8r4G-^n zuUPw-uZr;nm)ok!a>|Z8LFX^r4X5c-vipgPpmEUy6S&gBr4RK%R=rNlx zujXRd`^qwwErTsgl%eWs@h+YVJZrQVzN~s)BDp{^B9!4p==qmM4#pc+FLY$|9_u9ZXI7E5?d$wx?x{e`YB75 z3zo9_ySnc$eE*5LHn7X`a3hC$+s{GP&Ta@l1v}V?nVB?@iW>1?>T6EZHtNJok{=#C^emf8mT` zo&}BPCYq#(FKCo=GJG!Kz&uwu^MsxQvu#V#Il~5Q7KSv|{d<1)%Rc^j zdiLYV+SZ?6-+l8=+x~0qwj1^L_w(8pNcj|BOm$%Y%q+_jzK7>ULc)UPhh5VdWqEi? z3}QYSEog3R&_`|0w7S1V8d`}z8fxPJa;vpt{YHthSv{^!AL_2cdL?RI{Oej+RXV$U@3 zo18EHr?dZ3;`!Xh#9K0N8KX5L?-z!)N_Svz+4wS-F-g5(M1A{AJMmY;GxGtL{r~`xRfWdnXU~nzZJm3cm zu7<>Wg23SNzuYhv7(Wb$_b3D72djl5ZT9#66z%zbHC?lM?@6`udG)q+yZ*lQ-4?O+ z8vjYQ`IqfYgsB)}@L+#qzn&i)-h~f5Z|~==U&UbS8S^o+L67gw#=n={`}^C!%a`;> z*)zZR=>O#vGgIw#ju+w8lK)vRIP|+$J!^1au03}8M}8w)mCYq%b{44@#&O5$xlJxS zo;c4^;ex~bk4FEZfx*)Mmpg%oi8d8n()`Zwtv-IgQu(w zdj2^M>5L1kvuB6KF}(P6gsnu3Vb|tuk)u-3(D)(kSiJGqM$ZS^fMqm;r>mdKI;Vst E08Tr00ssI2 literal 0 HcmV?d00001 diff --git a/package.json b/package.json index 599de02..c9fdbc1 100644 --- a/package.json +++ b/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", + "version": "0.1.9", "publisher": "magicstack", + "icon": "icon.png", "engines": { "atom": "*", "node": "*", diff --git a/readmes/vscode.md b/readmes/vscode.md new file mode 100644 index 0000000..e08c90e --- /dev/null +++ b/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). \ No newline at end of file