tailix/libkernaux
1
0
Fork 0
mirror of https://github.com/tailix/libkernaux.git synced 2025-02-17 15:45:32 -05:00
Code Releases Activity

Ruby: ensure 100% doc coverage

Browse source
This commit is contained in:
Alex Kotov 2022-01-30 12:58:18 +05:00
parent 30d0c28875
commit a02e707643
Signed by: kotovalexarian
GPG key ID: 553C0EBBEB5D5F08
1 changed files with 14 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
pkgs/ruby/Rakefile
View file

@ -20,7 +20,7 @@ CLEAN << 'doc'
CLEAN << 'spec/examples.txt'
desc 'Run default checks'
task default: %i[test lint]
task default: %i[test lint yard:cov]
desc 'Run tests'
task test: :spec
@ -65,3 +65,16 @@ desc 'Open development console'
task :console do
sh 'bundle', 'exec', File.expand_path(File.join('bin', 'console'), __dir__)
end
namespace :yard do
desc 'Measure documentation coverage'
task :cov do
result = `bundle exec yard stats`.lines.last.strip.freeze
m = result.match(/\A(\d+(\.\d+)?)% documented\z/)
raise 'Invalid result' if m.nil?
coverage = m[1].to_f.round(2)
puts "Documentation coverage: #{coverage}%"
raise 'Not fully documented!' if coverage != 100
end
end