Class: DangerPackwerk::Update::DefaultFormatter

Inherits:
Object
  • Object
show all
Extended by:
T::Sig
Includes:
OffensesFormatter
Defined in:
lib/danger-packwerk/update/default_formatter.rb

Instance Method Summary collapse

Constructor Details

#initialize(custom_help_message: nil) ⇒ DefaultFormatter

Returns a new instance of DefaultFormatter.



14
15
16
 
# File 'lib/danger-packwerk/update/default_formatter.rb', line 14

def initialize(custom_help_message: nil)
  @custom_help_message = custom_help_message
end

Instance Method Details

#format_offenses(offenses, repo_link, org_name) ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/danger-packwerk/update/default_formatter.rb', line 19

def format_offenses(offenses, repo_link, org_name)
  violation = T.must(offenses.first)
  referencing_file_pack = ParsePackwerk.package_from_path(violation.file)
  # We remove leading double colons as they feel like an implementation detail of packwerk.
  constant_name = violation.class_name.delete_prefix('::')
  constant_source_package_name = violation.to_package_name

  constant_source_package = T.must(ParsePackwerk.find(constant_source_package_name))
  constant_source_package_owner = Private::OwnershipInformation.for_package(constant_source_package, org_name)

  package_referring_to_constant_owner = Private::OwnershipInformation.for_package(referencing_file_pack, org_name)

  disclaimer = 'We noticed you ran `bin/packwerk update-todo`. Check out [the docs](https://github.com/Shopify/packwerk/blob/main/RESOLVING_VIOLATIONS.md) to see other ways to resolve violations.'
  pluralized_violation = offenses.count > 1 ? 'these violations' : 'this violation'
  request_to_add_context = "- Could you add some context as a reply here about why we needed to add #{pluralized_violation}?\n"

  dependency_violation_message = "- cc #{package_referring_to_constant_owner.github_team} (#{package_referring_to_constant_owner.markdown_link_to_slack_room}) for the dependency violation.\n" if package_referring_to_constant_owner.owning_team

  privacy_violation_message = "- cc #{constant_source_package_owner.github_team} (#{constant_source_package_owner.markdown_link_to_slack_room}) for the privacy violation.\n" if constant_source_package_owner.owning_team

  if offenses.any?(&:dependency?) && offenses.any?(&:privacy?)
    <<~MESSAGE.chomp
      Hi again! It looks like `#{constant_name}` is private API of `#{constant_source_package_name}`, which is also not in `#{referencing_file_pack.name}`'s list of dependencies.
      #{disclaimer}

      #{request_to_add_context}#{dependency_violation_message}#{privacy_violation_message}
      #{@custom_help_message}
    MESSAGE
  elsif offenses.any?(&:dependency?)
    <<~MESSAGE.chomp
      Hi again! It looks like `#{constant_name}` belongs to `#{constant_source_package_name}`, which is not in `#{referencing_file_pack.name}`'s list of dependencies.
      #{disclaimer}

      #{request_to_add_context}#{dependency_violation_message}
      #{@custom_help_message}
    MESSAGE
  else # violations.any?(&:privacy?)
    <<~MESSAGE.chomp
      Hi again! It looks like `#{constant_name}` is private API of `#{constant_source_package_name}`.
      #{disclaimer}

      #{request_to_add_context}#{privacy_violation_message}
      #{@custom_help_message}
    MESSAGE
  end
end