Contents

module Fastlane
  class DocsGenerator
    def self.run(output_path, ff)
      output = ["fastlane documentation"]
      output << "================"

      output << "# Installation"
      output << "```"
      output << "sudo gem install fastlane"
      output << "```"

      output << "# Available Actions"
      
      all_keys = ff.runner.lanes.keys.reject(&:nil?) 
      all_keys.unshift(nil) # because we want root elements on top. always! They have key nil

      all_keys.each do |platform|
        output << "## #{formatted_platform(platform)}" if platform

        value = ff.runner.lanes[platform]

        if value
          value.each do |lane_name, lane|
            output << render(platform, lane_name, lane.description.join("\n\n"))          
          end

          output << ""
          output << "----"
          output << ""
        end
      end

      output << "Generate this documentation by running `fastlane docs`"
      output << "More information about fastlane can be found on [https://fastlane.tools](https://fastlane.tools)."
      output << "The documentation of fastlane can be found on [GitHub](https://github.com/KrauseFx/fastlane)"

      File.write(output_path, output.join("\n"))
      Helper.log.info "Successfully generated documentation to path '#{File.expand_path(output_path)}'".green
    end

    private

      def self.formatted_platform(pl)
        pl = pl.to_s
        return "iOS" if pl == 'ios'
        return "Mac" if pl == 'mac'

        return pl
      end

      def self.render(platform, lane, description)
        full_name = [platform, lane].reject(&:nil?).join(' ')

        output = []
        output << "### #{full_name}"
        output << "```"
        output << "fastlane #{full_name}"
        output << "```"
        output << description
        output
      end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
fastlane-1.9.0	lib/fastlane/docs_generator.rb