The project is in a healthy, maintained state
Adds a yard_lint diagnostic reporter to Solargraph, powered by the yard-lint gem. Surfaces YARD documentation issues in your editor.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Runtime

>= 0.52.0
~> 1.6
 Project Readme

solargraph-yard-lint

CI

A Solargraph plugin that surfaces yard-lint offenses as LSP diagnostics in your editor.

Demo

solargraph-yard-lint-demo.mp4

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