Class: LicenseFinder::CLI::Main

Inherits:
Base
  • Object
show all
Extended by:
Rootcommand
Defined in:
lib/license_finder/cli/main.rb

Constant Summary collapse

FORMATS = 
{
  'text' => TextReport,
  'html' => HtmlReport,
  'markdown' => MarkdownReport,
  'csv' => CsvReport,
  'xml' => XmlReport,
  'json' => JsonReport
}.freeze

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Rootcommand

subcommand

Class Method Details

.format_option ⇒ Object

Method options which are shared between report and action_item



39
40
41
42
43
44
 
# File 'lib/license_finder/cli/main.rb', line 39

def self.format_option
  method_option :format,
                desc: 'Emit detailed info about what LicenseFinder is doing',
                default: 'text',
                enum: FORMATS.keys
end

.shared_options ⇒ Object 



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/license_finder/cli/main.rb', line 46

def self.shared_options
  method_option :debug,
                aliases: '-d',
                type: :boolean,
                desc: 'Emit detailed info about what LicenseFinder is doing'

  method_option :prepare,
                aliases: '-p',
                type: :boolean,
                desc: 'Prepares the project first for license_finder',
                default: false,
                required: false

  method_option :prepare_no_fail,
                type: :boolean,
                desc: 'Prepares the project first for license_finder but carries on despite any potential failures',
                default: false,
                required: false

  method_option :recursive,
                aliases: '-r',
                type: :boolean,
                default: false,
                desc: 'Recursively runs License Finder on all sub-projects'

  method_option :aggregate_paths,
                aliases: '-a',
                type: :array,
                desc: "Generate a single report for multiple projects. Ex: --aggregate_paths='path/to/project1' 'path/to/project2'"

  method_option :quiet,
                aliases: '-q',
                type: :boolean,
                desc: 'Silences progress report',
                required: false

  method_option :columns,
                desc: "For text or CSV reports, which columns to print. Pick from: #{CsvReport::AVAILABLE_COLUMNS}",
                type: :array
end

Instance Method Details

#action_items ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/license_finder/cli/main.rb', line 97

def action_items
  finder = LicenseAggregator.new(config, aggregate_paths)
  any_packages = finder.any_packages?
  unapproved = finder.unapproved
  blacklisted = finder.blacklisted

  # Ensure to start output on a new line even with dot progress indicators.
  say "\n"

  unless any_packages
    say 'No dependencies recognized!', :red
    exit 0
  end

  if unapproved.empty?
    say 'All dependencies are approved for use', :green
  else
    unless blacklisted.empty?
      say 'Blacklisted dependencies:', :red
      say report_of(blacklisted)
    end

    other_unapproved = unapproved - blacklisted
    unless other_unapproved.empty?
      say 'Dependencies that need approval:', :yellow
      say report_of(other_unapproved)
    end

    exit 1
  end
end

#diff(file1, file2) ⇒ Object 



150
151
152
153
154
155
 
# File 'lib/license_finder/cli/main.rb', line 150

def diff(file1, file2)
  f1 = IO.read(file1)
  f2 = IO.read(file2)
  report = DiffReport.new(Diff.compare(f1, f2))
  save? ? save_report(report, config.save_file) : say(report)
end

#project_roots ⇒ Object 



89
90
91
92
 
# File 'lib/license_finder/cli/main.rb', line 89

def project_roots
  config.strict_matching = true
  aggregate_paths
end

#report ⇒ Object 



136
137
138
139
140
 
# File 'lib/license_finder/cli/main.rb', line 136

def report
  finder = LicenseAggregator.new(config, aggregate_paths)
  report = report_of(finder.dependencies)
  save? ? save_report(report, config.save_file) : say(report)
end

#version ⇒ Object 



143
144
145
 
# File 'lib/license_finder/cli/main.rb', line 143

def version
  puts LicenseFinder::VERSION
end