Integrate starlark language server (#19)

Author: pcj

.github/workflows/release.yaml

@@ -38,7 +38,7 @@ jobs:
         run: npm install
       - name: Release
         env:
-          GITHUB_TOKEN: ${{ secrets.PERSONAL_GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
         run: npx semantic-release
       - name: Vscode release plugin

.vscodeignore

@@ -3,6 +3,7 @@
 out/test/**
 src/**
 .gitignore
+ext.vsix
 vsc-extension-quickstart.md
 **/tsconfig.json
 **/.eslintrc.json

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 0.4.0 (Sat Aug 1 2020)
+
+- Initial release of Starlark Language Server with HoverProvider implementation.
+
 ## 0.3.5 (Mon July 27 2020)
 
 - Relax vscode version compatibility to 1.39.0 (Sept 2019).

README.md

@@ -7,11 +7,12 @@ Bazel Support for Visual Studio Code.
 <td style="width: 120px; text-align: center"><img src="https://user-images.githubusercontent.com/50580/78734740-486ba400-7906-11ea-89fa-f207544de185.png" height="100"/></td>
 <td style="width: 120px; text-align: center"><img src="https://user-images.githubusercontent.com/29654835/27530004-e789a11e-5a13-11e7-8a34-870da7e678ac.PNG" height="90"/></td>
 </tr><tr>
-<td style="width: 120px; text-align: center">Bazel</td>
-<td style="width: 120px; text-align: center">Stack</td>
-<td style="width: 120px; text-align: center">VSCode</td>
+<td style="text-align: center">Bazel</td>
+<td style="text-align: center">Stack</td>
+<td style="text-align: center">VSCode</td>
 </tr></table>
 
+
 <table border-collapse="collapse" style="margin: 1rem 0">
 <tr><td style="border: 1px solid rgba(255,255,255,0.16)">
 
@@ -74,19 +75,50 @@ This extension contributes a HoverProvider that looks for built-in symbols in st
 </tr></tr>
 </table>
 
+
+
+<table border-collapse="collapse" style="margin: 1rem 0">
+<tr><td style="border: 1px solid rgba(255,255,255,0.16)">
+
+## Starlark Language Server (Experimental)
+
+This extension contributes a language server for bazel & starlark files.  
+
+> NOTE: currently this feature is **Disabled** by default.  To enable it, visit the extension settings and set `feature.starlark.lsp.enabled: true`.
+
+The Starlark Language Server implements a hoverProvider for builtin starlark
+language functions (e.g. `len`, `print`, etc), builtin bazel functions (e.g.
+`select`, `attr.string`, ...) in addition to builtin rules like `java_library`. 
+
+![starlark-ls-hover](https://user-images.githubusercontent.com/50580/89113148-551e8580-d42a-11ea-990e-04be3a90b77c.gif)
+
+</tr></tr>
+</table>
+
+
 ## Requirements
 
 Portions of this plugin may rely on the [bzl tool](https://build.bzl.io).  You
 can install & use the plugin without Bzl but some features will not be
 available.
 
-## Extension Settings
-
-None currently.
 
 ## Known Issues
 
 **Github Rate Limits**: This extension makes requests to the github v3 API.  If
 you experience errors due to rate limits, `export
 GITHUB_TOKEN={MY_PERSONAL_TOKEN}` and relaunch vscode  to get higher rate
 limits.
+
+**Language Server Spawn Error on Windows** If you observe this error on windows upon initial download of the executable, please reload the vscode window (`> Developer: Reload Window`).
+
+```
+[Error - 2:38:35 AM] Starting client failed
+Error: spawn EBUSY
+	at ChildProcess.spawn (internal/child_process.js:394:11)
+	at Object.spawn (child_process.js:553:9)
+	at c:\Users\develop\.vscode\extensions\stackbuild.bazel-stack-vscode-0.4.0\node_modules\vscode-languageclient\lib\main.js:376:40
+```
+
+> NOTE: portions of this extension were adapted from
+> https://github.com/bazelbuild/vscode-bazel (Apache 2.0).

media/bazel-icon.svg

@@ -2,7 +2,7 @@
 	"name": "bazel-stack-vscode",
 	"displayName": "bazel-stack-vscode",
 	"description": "Bazel Support for Visual Studio Code",
-	"version": "0.3.5",
+	"version": "0.4.0",
 	"publisher": "StackBuild",
 	"license": "Apache-2.0",
 	"icon": "stackb-full.png",
@@ -35,34 +35,75 @@
 			"type": "object",
 			"title": "Bzl",
 			"properties": {
+				"feature.starlark.lsp.enabled": {
+					"type": "boolean",
+					"default": false,
+					"description": "Flag to enable/disable this feature"
+				},
+				"feature.starlark.lsp.verbose": {
+					"type": "number",
+					"default": 0,
+					"description": "The verbosity level for extra diagnostics"
+				},
+				"feature.starlark.lsp.server.executable": {
+					"type": "string",
+					"description": "Path to a pre-installed LSP executable\n\n> if set, this prevents downloading a LSP binary from github"
+				},
+				"feature.starlark.lsp.github-release": {
+					"type": "string",
+					"default": "0.3.5",
+					"description": "The github release tag of the starlark-lsp release to download"
+				},
+				"feature.starlark.lsp.github-owner": {
+					"type": "string",
+					"default": "stackb",
+					"description": "The github owner for the starlark.lsp repository"
+				},
+				"feature.starlark.lsp.github-repo": {
+					"type": "string",
+					"default": "bazel-stack-vscode",
+					"description": "The github repo name for the starlark-lsp repository"
+				},
+				"feature.starlark.lsp.server.command": {
+					"type": "array",
+					"description": "The command (and optional arguments) to start the lsp server.",
+					"items": {
+						"type": "string"
+					},
+					"default": [
+						"lsp",
+						"serve",
+						"--log_level=info"
+					]
+				},
 				"feature.buildifier.enabled": {
 					"type": "boolean",
 					"default": true,
-					"markdownDescription": "Feature flag to enable (checked) or disable (unchecked)"
+					"description": "Flag to enable/disable this feature"
 				},
 				"feature.buildifier.verbose": {
 					"type": "number",
 					"default": 0,
-					"markdownDescription": "The verbosity level for extra diagnostics"
+					"description": "The verbosity level for extra diagnostics"
 				},
 				"feature.buildifier.github-release": {
 					"type": "string",
 					"default": "3.4.0",
-					"markdownDescription": "The github release tag of the Buildifier release to download"
+					"description": "The github release tag of the Buildifier release to download"
 				},
 				"feature.buildifier.github-owner": {
 					"type": "string",
 					"default": "bazelbuild",
-					"markdownDescription": "The github owner for the buildifier repository"
+					"description": "The github owner for the buildifier repository"
 				},
 				"feature.buildifier.github-repo": {
 					"type": "string",
 					"default": "buildtools",
-					"markdownDescription": "The github repo name for the buildifier repository"
+					"description": "The github repo name for the buildifier repository"
 				},
 				"feature.buildifier.executable": {
 					"type": "string",
-					"markdownDescription": "Path to a pre-installed buildifier executable.\n\n If set, this prevents downloading a buildifier binary from github"
+					"description": "Path to a pre-installed buildifier executable\n\n> if set, this prevents downloading a buildifier binary from github"
 				},
 				"feature.buildifier.fix-on-format": {
 					"type": "boolean",
@@ -72,17 +113,17 @@
 				"feature.bazeldoc.enabled": {
 					"type": "boolean",
 					"default": true,
-					"markdownDescription": "Feature flag to enable (checked) or disable (unchecked)"
+					"description": "Flag to enable/disable this feature"
 				},
 				"feature.bazeldoc.verbose": {
 					"type": "number",
 					"default": 0,
-					"markdownDescription": "The verbosity level for extra diagnostics"
+					"description": "The verbosity level for extra diagnostics"
 				},
 				"feature.bazeldoc.base-url": {
 					"type": "string",
 					"default": "https://docs.bazel.build/versions/master",
-					"markdownDescription": "The base-url of the documentation site"
+					"description": "The base-url of the documentation site"
 				}
 			}
 		},
@@ -163,12 +204,14 @@
 		"lint": "eslint src --ext ts",
 		"watch": "tsc -watch -p ./",
 		"pretest": "npm run compile && npm run lint",
-		"test": "node ./out/test/runTest.js"
+		"test": "node ./out/test/runTest.js",
+		"vscode-install": "vsce package --out ext.vsix && code --install-extension ext.vsix"
 	},
 	"dependencies": {
 		"@octokit/rest": "18.0.3",
 		"fs-extra": "9.0.1",
-		"request": "2.88.2"
+		"request": "2.88.2",
+		"vscode-languageclient": "6.1.3"
 	},
 	"devDependencies": {
 		"@octokit/types": "5.2.0",

media/bazel-wireframe.svg

@@ -91,7 +91,7 @@ export const builtInGroups = [
         items: ["http_archive", "http_file", "http_jar"], 
     },
     {
-        name: "special globals",
+        name: "language keywords",
         path: "build-ref.html",
         items: ["load"],
     },