From 918cb33dd00b763415029ab5051d26313eba1958 Mon Sep 17 00:00:00 2001 From: machty Date: Sun, 14 Jan 2024 07:49:17 +0800 Subject: [PATCH] tweak docs --- CONTRIBUTING.md | 2 +- README.md | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2b098ee67..0afa62af2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -32,7 +32,7 @@ Then you can configure your editor to point to the absolute path of the `./packa With the running `tsc --build --watch` command, the language server will rebuild when any source code files change. _Important_: after any source code file change and subsequent rebuild, you will need to restart the language server from within your editor in order for the changes to be reflected in your editor. In VSCode, this means running "Glint: Restart Glint Server" from the Command Palette. -## How to glint-language-server locally in debug mode? +## How to run glint-language-server locally in debug mode? There are a few VSCode Launch Configurations within `./vscode/launch.json` that are handy for debugging: diff --git a/README.md b/README.md index 2eedebb0a..327cc5ba6 100644 --- a/README.md +++ b/README.md @@ -39,3 +39,7 @@ Similarly, `glint-language-server` can be used by editor integrations to expose The language server can also enable your editor to provide other richer help, such as type information on hover, automated refactoring, and more. See [the VS Code extension README](packages/vscode) for further examples. [using-glint]: https://typed-ember.gitbook.io/glint/getting-started#using-glint + +## Debugging Glint + +See [CONTRIBUTING.md](./CONTRIBUTING.md) for instructions on how to run and debug the Glint language server and VSCode extension locally.