Use Buf CLI as an LSP (#392)

Hi team, I've spent the last couple weekends looking at #344 which
appears abandoned. This snowballed a bit into a rewrite for mostly
maintainability and testability reasons.

Apologies for the size of the pull - happy to split it up if you want to
take it on, else I'll continue happily running this locally.

Changes I've introduced:
  - Introduce a command pattern for command handling.
- Rewrite installation processes via install/update commands (now works
cross platform).
  - Provide flexible method of using buf located in path/storage.
  - Improve status bar with a command picker.
  - Support 'buf generate' as a command.
  - ~~Support module detection for the active file in editor.~~
  - ~~Provide a shortcut to opening 'buf.yaml' as a command.~~

---------

Co-authored-by: Paul Sachs <psachs@buf.build>

Author: christogav

.gitignore

@@ -4,3 +4,4 @@ node_modules
 .vscode-test/
 *.vsix
 .env/
+.user-data-dir-test

.vscode/launch.json

@@ -9,20 +9,32 @@
       "name": "Run Extension",
       "type": "extensionHost",
       "request": "launch",
-      "args": ["--extensionDevelopmentPath=${workspaceFolder}"],
+      "args": [
+        "--disable-extensions",
+        "--extensionDevelopmentPath=${workspaceFolder}"
+      ],
       "outFiles": ["${workspaceFolder}/out/**/*.js"],
-      "preLaunchTask": "${defaultBuildTask}"
+      "preLaunchTask": "npm: watch"
     },
     {
       "name": "Extension Tests",
       "type": "extensionHost",
       "request": "launch",
+      "runtimeExecutable": "${execPath}",
       "args": [
+        "--disable-extensions",
+        "--profile-temp",
         "--extensionDevelopmentPath=${workspaceFolder}",
-        "--extensionTestsPath=${workspaceFolder}/out/test/suite/index"
+        "--extensionTestsPath=${workspaceFolder}/out/test/unit/index",
+        "--user-data-dir=${workspaceFolder}/extension/.user-data-dir-test",
+        "--timeout",
+        "999999"
       ],
       "outFiles": ["${workspaceFolder}/out/test/**/*.js"],
-      "preLaunchTask": "${defaultBuildTask}"
+      "sourceMaps": true,
+      "smartStep": true,
+      "preLaunchTask": "npm: watch",
+      "cwd": "${workspaceFolder}/extension"
     }
   ]
 }

.vscode/tasks.json

@@ -4,6 +4,7 @@
   "version": "2.0.0",
   "tasks": [
     {
+      "label": "npm: watch",
       "type": "npm",
       "script": "watch",
       "problemMatcher": "$tsc-watch",

README.md

@@ -1,34 +1,98 @@
 # Buf for Visual Studio Code
 
-## Installation
+The [VS Code Buf extension](https://marketplace.visualstudio.com/items?itemName=bufbuild.vscode-buf) provides rich support for [Protocol Buffers](https://protobuf.dev/) using the [Buf](https://buf.build/) development environment.
 
-Install via the Visual Studio Code extension browser or see
-[the extension page](https://marketplace.visualstudio.com/items?itemName=bufbuild.vscode-buf)
-for detailed installation instructions.
-
-## Features
+## Requirements
 
-- Lints your protobuf files using `buf lint`. It checks your currently opened file
-  whenever you save it.
+* Visual Studio Code
+* A [Buf](https://buf.build/) configuration environment.
 
-  ![Lint errors](./lint_errors.png)
+## Getting Started
 
-- Formats your protobuf files using `buf format`.
+The Buf CLI is the ultimate tool for modern, fast, and efficient Protobuf API management. Getting started is simple!
 
-- Provides syntax highlighting for `.proto` files.
+1. Install the [VS Code Buf extension](https://marketplace.visualstudio.com/items?itemName=bufbuild.vscode-buf).
+2. Create a [buf.yaml](https://buf.build/docs/cli/#default-configuration) in the root of your workspace.
+3. Open any Protobuf file to automatically activate the extension. A Buf status bar appears in the bottom right corner of the window.
+4. The extension depends on the [Buf CLI](https://buf.build/docs/cli/). If a Buf binary is not found in your path, the extension will attempt to install the latest release from Github.
 
-## Requirements
+## Features
 
-- [buf](https://docs.buf.build/installation)
+- **Code navigation** - Jump to or peek at a symbol's declaration.
+- **Syntax highlighting** - Protobuf specific color and styling of code.
+- **Code editing** - Support for formatting and linting.
+- **Buf command support** - Execution of Buf CLI commands e.g. [Buf Generate](https://buf.build/docs/generate/tutorial/).
 
 ## Extension Settings
 
 This extension contributes the following settings:
 
-- `buf.binaryPath`: configure the path to your buf binary. By default it uses `buf` in your `$PATH`.
+### buf.commandLine.path
+
+Default: `null`
+
+The path to a specific install of Buf to use. Relative paths are supported and are relative to the workspace root.
+
+> If not set and `buf.commandLine.version` is also not set, the extension will attempt to find a os-specific Buf binary on the path.
+
+### buf.commandLine.version
+
+Default: `null`
+
+Specific version (git tag e.g. 'v1.53.0') of Buf release to download and install.
+
+### buf.restartAfterCrash
+
+Default: `true`
+
+Automatically restart Buf (up to 4 times) if it crashes.
+
+### buf.checkUpdates
+
+Default: `true`
+
+Check for language server updates on startup.
+
+### buf.enableHover
+
+Default: `true`
+
+Enable hover features provided by the language server.
+
+### buf.enable
+
+Default: `true`
+
+Enable Buf language server features.
+
+### buf.debug
+
+Default: `false`
+
+Enable debug mode.
+
+### buf.log-format
+
+Default: `text`
+
+Buf language server log format.
+
+### buf.checks.breaking.againstStrategy
+
+Default: `git`
+
+The strategy to use when checking breaking changes against a specific reference.
+
+### buf.checks.breaking.againstGitRef
+
+Default: `refs/remotes/origin/HEAD`
+
+The Git reference to check breaking changes against.
 
 ## Changelog
 
+- v0.8.0
+  - Improve overall editor functionality, using Buf Language Server.
 - v0.7.2
   - Fix issue with `buf` commands returning an unexpected error on exec.
 - v0.7.1