-
Notifications
You must be signed in to change notification settings - Fork 0
feat: add yaml-ls plugin for YAML code intelligence v1.0.0 #16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,11 @@ | ||||||
| { | ||||||
| "name": "yaml-ls", | ||||||
| "version": "1.0.0", | ||||||
| "description": "YAML language server (yaml-language-server) for code intelligence, go-to-definition, find-references, and hover docs in YAML files (.yaml, .yml)", | ||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The description is missing
Suggested change
|
||||||
| "license": "MIT", | ||||||
| "author": { | ||||||
| "name": "vnz" | ||||||
| }, | ||||||
| "repository": "https://github.com/vnz/cc-plugins", | ||||||
| "keywords": ["yaml", "yml", "lsp", "language-server", "schema", "validation"] | ||||||
| } | ||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| { | ||
| "yaml-language-server": { | ||
| "command": "yaml-language-server", | ||
| "args": ["--stdio"], | ||
| "extensionToLanguage": { | ||
| ".yaml": "yaml", | ||
| ".yml": "yaml" | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| # yaml-ls | ||
|
|
||
| YAML language server plugin for Claude Code, providing code intelligence features for YAML files. | ||
|
|
||
| ## Features | ||
|
|
||
| | Feature | Description | | ||
| |---------|-------------| | ||
| | **goToDefinition** | Navigate to anchor definitions | | ||
| | **findReferences** | Find all alias usages across your file | | ||
| | **hover** | Inline documentation from JSON Schema associations | | ||
| | **diagnostics** | Real-time validation and error checking | | ||
|
|
||
| ## Supported Files | ||
|
|
||
| | Extension | Language ID | Description | | ||
| |-----------|-------------|-------------| | ||
| | `.yaml` | `yaml` | YAML configuration | | ||
| | `.yml` | `yaml` | YAML configuration (short extension) | | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Requires [yaml-language-server](https://github.com/redhat-developer/yaml-language-server) in your PATH. | ||
|
|
||
| ```bash | ||
| npm install -g yaml-language-server | ||
| ``` | ||
|
|
||
| ## Installation | ||
|
|
||
| ```bash | ||
| # Add marketplace from vnz/cc-plugins (aliased as cc-plugins-vnz) | ||
| /plugin marketplace add vnz/cc-plugins | ||
|
|
||
| # Install plugin from the new marketplace | ||
| /plugin install yaml-ls@cc-plugins-vnz | ||
| ``` | ||
|
|
||
| Enable LSP in your Claude Code settings (`~/.claude/settings.json`): | ||
|
|
||
| ```json | ||
| { | ||
| "env": { | ||
| "ENABLE_LSP_TOOL": "1" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| ### Plugin not visible | ||
| Run `/plugin list` and verify the plugin appears. Try reinstalling if needed. | ||
|
|
||
| ### LSP not working | ||
| 1. Verify yaml-language-server is in your PATH: `which yaml-language-server` | ||
| 2. Check that `ENABLE_LSP_TOOL=1` is set in your settings and restart Claude Code. | ||
| 3. Check Claude Code logs for any `yaml-language-server` errors. | ||
|
|
||
| ## Links | ||
|
|
||
| - [yaml-language-server GitHub](https://github.com/redhat-developer/yaml-language-server) | ||
| - [YAML Specification](https://yaml.org/spec/) | ||
| - [JSON Schema Store](https://www.schemastore.org/json/) (for schema associations) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The description is missing
diagnostics, which is a key feature of this language server and is mentioned in the README. For better accuracy and consistency with other LSP plugins in this marketplace (liketerraform-ls), I suggest updating the description to include it.