Address review: clarify config filenames and snippet format

- Update SKILL.md description to mention both config paths (user-level
  and repo-level) instead of only lsp-config.json
- Clarify workflow step 6 with explicit file paths
- Add note in references/lsp-servers.md explaining snippets are objects
  to insert under the lspServers key
- Regenerate docs/README.skills.md with updated description

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
Bruno Borges
2026-04-02 15:35:07 -04:00
parent c6590f51ca
commit 9c7639427c
3 changed files with 5 additions and 3 deletions

View File

@@ -1,6 +1,6 @@
---
name: lsp-setup
description: 'Install and configure LSP servers for any programming language to work with GitHub Copilot CLI. Detects the OS, installs the right LSP server, and writes the lsp-config.json configuration. Say "setup LSP" to start.'
description: 'Install and configure LSP servers for any programming language to work with GitHub Copilot CLI. Detects the OS, installs the right LSP server, and generates the LSP configuration (user-level or repo-level). Say "setup LSP" to start.'
---
# LSP Setup for GitHub Copilot CLI
@@ -16,7 +16,7 @@ DO NOT USE FOR: general coding tasks, IDE/editor LSP configuration, non-Copilot-
3. **Look up the LSP server** — read `references/lsp-servers.md` for known servers, install commands, and config snippets
4. **Ask scope** — use `ask_user` to ask whether the config should be user-level (`~/.copilot/lsp-config.json`) or repo-level (`.github/lsp.json`)
5. **Install the server** — run the appropriate install command for the detected OS
6. **Write the config** — merge the new server entry into the chosen config file (create it if missing, preserve existing entries)
6. **Write the config** — merge the new server entry into the chosen config file (`~/.copilot/lsp-config.json` for user-level, `.github/lsp.json` for repo-level); create it if missing, preserve existing entries
7. **Verify** — confirm the LSP binary is on `$PATH` and the config file is valid JSON
## Configuration Format

View File

@@ -2,6 +2,8 @@
Reference data for the `lsp-setup` skill. Each section contains install commands per OS and a ready-to-use config snippet.
> **Config snippet format**: Each snippet below shows the object to insert as a value under the top-level `lspServers` key. A complete config file looks like: `{ "lspServers": { <snippet here> } }`. When adding multiple languages, merge their snippets as sibling keys under `lspServers`.
---
## TypeScript / JavaScript