solargraph-yard-lint
A Solargraph plugin that surfaces yard-lint offenses as LSP diagnostics in your editor.
Demo
https://github.com/user-attachments/assets/2bcd3a5a-3e3c-4b26-8667-f4f6c2479ef8
Installation
Add to your project's Gemfile:
group :development do
gem 'solargraph'
gem 'solargraph-yard-lint'
end
Then bundle install.
Usage
Add to your project's .solargraph.yml:
plugins:
+ - solargraph-yard-lint
reporters:
+ - yard_lint
Restart your Solargraph language server. YARD documentation offenses will appear as diagnostics in your editor.
Configure yard-lint itself via .yard-lint.yml in your project root — see
yard-lint's documentation for details.
Contributing
Bug reports and pull requests are welcome at github.com/lekemula/solargraph-yard-lint.
bundle install
bundle exec rspec
bundle exec rubocop
bundle exec yard-lint lib/
Please run the full check suite locally before opening a PR — CI runs the same three commands. New behavior should come with specs.
License
MIT