Class: RubyLsp::CheckDocs
- Inherits:
-
Rake::TaskLib
- Object
- Rake::TaskLib
- RubyLsp::CheckDocs
- Extended by:
- T::Sig
- Defined in:
- lib/ruby_lsp/check_docs.rb
Overview
This rake task checks that all requests or extensions are fully documented. Add the rake task to your Rakefile and specify the absolute path for all files that must be required in order to discover all listeners
# Rakefile
request_files = FileList.new("#{__dir__}/lib/ruby_lsp/requests/*.rb") do |fl|
fl.exclude(/base_request\.rb/)
end
RubyLsp::CheckDocs.new(request_files)
# Run with bundle exec rake ruby_lsp:check_docs
Instance Method Summary collapse
-
#initialize(require_files) ⇒ CheckDocs
constructor
A new instance of CheckDocs.
Constructor Details
permalink #initialize(require_files) ⇒ CheckDocs
Returns a new instance of CheckDocs.
21 22 23 24 25 26 27 |
# File 'lib/ruby_lsp/check_docs.rb', line 21 def initialize(require_files) super() @name = T.let("ruby_lsp:check_docs", String) @file_list = require_files define_task end |