Skip to content

lekemula/solargraph-yard-lint

Repository files navigation

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

About

Solargraph plugin that surfaces yard-lint offenses as LSP diagnostics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages