Add yard, yardstick and yard-junk to document the gem
This commit is contained in:
parent
89a23a69e2
commit
08236c4194
2
.gitignore
vendored
2
.gitignore
vendored
@ -1,8 +1,10 @@
|
||||
/.bundle/
|
||||
/.yardoc
|
||||
/_yardoc/
|
||||
/.yardocck
|
||||
/coverage/
|
||||
/doc/
|
||||
/measurements/
|
||||
/pkg/
|
||||
/spec/reports/
|
||||
/tmp/
|
||||
|
22
.yardstick.yml
Normal file
22
.yardstick.yml
Normal file
@ -0,0 +1,22 @@
|
||||
threshold: 100
|
||||
rules:
|
||||
ApiTag::Presence:
|
||||
enabled: true
|
||||
ApiTag::Inclusion:
|
||||
enabled: true
|
||||
ApiTag::ProtectedMethod:
|
||||
enabled: true
|
||||
ApiTag::PrivateMethod:
|
||||
enabled: true
|
||||
ExampleTag:
|
||||
enabled: true
|
||||
ReturnTag:
|
||||
enabled: true
|
||||
Summary::Presence:
|
||||
enabled: true
|
||||
Summary::Length:
|
||||
enabled: false
|
||||
Summary::Delimiter:
|
||||
enabled: true
|
||||
Summary::SingleLine:
|
||||
enabled: false
|
14
Rakefile
14
Rakefile
@ -4,13 +4,27 @@ require 'bundler/audit/task'
|
||||
require 'bundler/gem_tasks'
|
||||
require 'rspec/core/rake_task'
|
||||
require 'rubocop/rake_task'
|
||||
require 'yaml'
|
||||
require 'yard/rake/yardoc_task'
|
||||
require 'yard-junk/rake'
|
||||
require 'yardstick/rake/measurement'
|
||||
require 'yardstick/rake/verify'
|
||||
|
||||
yardstick_options = YAML.load_file('.yardstick.yml')
|
||||
|
||||
Bundler::Audit::Task.new
|
||||
RSpec::Core::RakeTask.new(:spec)
|
||||
RuboCop::RakeTask.new
|
||||
YARD::Rake::YardocTask.new
|
||||
YardJunk::Rake.define_task
|
||||
Yardstick::Rake::Measurement.new(:yardstick_measure, yardstick_options)
|
||||
Yardstick::Rake::Verify.new
|
||||
|
||||
task default: %i[spec rubocop]
|
||||
|
||||
# Remove the report on rake clobber
|
||||
CLEAN.include('measurements', 'doc', '.yardoc', 'tmp')
|
||||
|
||||
# Delete these files and folders when running rake clobber.
|
||||
CLOBBER.include('coverage', '.rspec_status')
|
||||
|
||||
|
@ -46,4 +46,7 @@ Gem::Specification.new do |spec|
|
||||
spec.add_development_dependency 'rubocop-rspec', '2.16'
|
||||
spec.add_development_dependency 'simplecov', '~> 0.22'
|
||||
spec.add_development_dependency 'simplecov-console', '~> 0.9'
|
||||
spec.add_development_dependency 'yard', '~> 0.9'
|
||||
spec.add_development_dependency 'yard-junk', '~> 0.0.9'
|
||||
spec.add_development_dependency 'yardstick', '~> 0.9'
|
||||
end
|
||||
|
Loading…
x
Reference in New Issue
Block a user