class Gemsmith::Generators::Documentation

Generates documentation support.

Attributes

writer[R]

Public Class Methods

new(cli, configuration: {}) click to toggle source
Calls superclass method Gemsmith::Generators::Base::new
# File lib/gemsmith/generators/documentation.rb, line 9
def initialize cli, configuration: {}, writer: Tocer::Writer.new
  super cli, configuration: configuration
  @writer = writer
end

Public Instance Methods

run() click to toggle source
# File lib/gemsmith/generators/documentation.rb, line 14
def run
  create_files
  update_readme
end

Private Instance Methods

create_files() click to toggle source
# File lib/gemsmith/generators/documentation.rb, line 23
def create_files
  template "%gem_name%/README.md.tt"
  template "%gem_name%/CONTRIBUTING.md.tt"
  template "%gem_name%/CODE_OF_CONDUCT.md.tt"
  template "%gem_name%/LICENSE.md.tt"
  template "%gem_name%/CHANGES.md.tt"
end
update_readme() click to toggle source
# File lib/gemsmith/generators/documentation.rb, line 31
def update_readme
  gem_root.join("README.md").then { |path| writer.call path }
end