danger-packwerk 0.7.1 → 0.8.0

data/sorbet/rbi/gems/code_ownership@1.29.1.rbi

@@ -0,0 +1,336 @@
+# typed: true
+
+# DO NOT EDIT MANUALLY
+# This is an autogenerated file for types exported from the `code_ownership` gem.
+# Please instead update this file by running `bin/tapioca gem code_ownership`.
+
+module CodeOwnership
+  extend ::CodeOwnership
+
+  requires_ancestor { Kernel }
+
+  sig do
+    params(
+      backtrace: T.nilable(T::Array[::String]),
+      excluded_teams: T::Array[::CodeTeams::Team]
+    ).returns(T.nilable(::CodeTeams::Team))
+  end
+  def for_backtrace(backtrace, excluded_teams: T.unsafe(nil)); end
+
+  sig { params(klass: T.nilable(T.any(::Class, ::Module))).returns(T.nilable(::CodeTeams::Team)) }
+  def for_class(klass); end
+
+  sig { params(file: ::String).returns(T.nilable(::CodeTeams::Team)) }
+  def for_file(file); end
+
+  sig { params(package: ::ParsePackwerk::Package).returns(T.nilable(::CodeTeams::Team)) }
+  def for_package(package); end
+
+  sig { params(team: T.any(::CodeTeams::Team, ::String)).returns(::String) }
+  def for_team(team); end
+
+  sig { params(files: T::Array[::String], autocorrect: T::Boolean, stage_changes: T::Boolean).void }
+  def validate!(files: T.unsafe(nil), autocorrect: T.unsafe(nil), stage_changes: T.unsafe(nil)); end
+
+  class << self
+    sig { void }
+    def bust_caches!; end
+
+    sig { params(filename: ::String).void }
+    def remove_file_annotation!(filename); end
+  end
+end
+
+class CodeOwnership::Cli
+  class << self
+    def for_file(argv); end
+    def for_team(argv); end
+    def run!(argv); end
+
+    private
+
+    def validate!(argv); end
+  end
+end
+
+class CodeOwnership::InvalidCodeOwnershipConfigurationError < ::StandardError; end
+
+module CodeOwnership::Private
+  class << self
+    sig { void }
+    def bust_caches!; end
+
+    sig { returns(::CodeOwnership::Private::Configuration) }
+    def configuration; end
+
+    sig { returns(::CodeOwnership::Private::OwnershipMappers::FileAnnotations) }
+    def file_annotations_mapper; end
+
+    sig { params(files: T::Array[::String]).returns(T::Hash[::String, T::Array[::String]]) }
+    def files_by_mapper(files); end
+
+    sig { params(team_name: ::String, location_of_reference: ::String).returns(::CodeTeams::Team) }
+    def find_team!(team_name, location_of_reference); end
+
+    sig { returns(T::Array[::CodeOwnership::Private::OwnershipMappers::Interface]) }
+    def mappers; end
+
+    sig { params(klass: T.nilable(T.any(::Class, ::Module))).returns(T.nilable(::String)) }
+    def path_from_klass(klass); end
+
+    sig { returns(T::Array[::String]) }
+    def tracked_files; end
+
+    sig { params(files: T::Array[::String], autocorrect: T::Boolean, stage_changes: T::Boolean).void }
+    def validate!(files:, autocorrect: T.unsafe(nil), stage_changes: T.unsafe(nil)); end
+  end
+end
+
+class CodeOwnership::Private::Configuration < ::T::Struct
+  const :js_package_paths, T::Array[::String]
+  const :owned_globs, T::Array[::String]
+  const :skip_codeowners_validation, T::Boolean
+  const :unowned_globs, T::Array[::String]
+
+  class << self
+    sig { returns(::CodeOwnership::Private::Configuration) }
+    def fetch; end
+
+    def inherited(s); end
+
+    sig { params(config_hash: T::Hash[T.untyped, T.untyped]).returns(T::Array[::String]) }
+    def js_package_paths(config_hash); end
+  end
+end
+
+CodeOwnership::Private::Configuration::DEFAULT_JS_PACKAGE_PATHS = T.let(T.unsafe(nil), Array)
+module CodeOwnership::Private::OwnershipMappers; end
+
+class CodeOwnership::Private::OwnershipMappers::FileAnnotations
+  include ::CodeOwnership::Private::OwnershipMappers::Interface
+
+  sig { override.void }
+  def bust_caches!; end
+
+  sig { override.returns(T::Hash[::String, T.nilable(::CodeTeams::Team)]) }
+  def codeowners_lines_to_owners; end
+
+  sig { override.returns(::String) }
+  def description; end
+
+  sig { params(filename: ::String).returns(T.nilable(::CodeTeams::Team)) }
+  def file_annotation_based_owner(filename); end
+
+  sig { override.params(file: ::String).returns(T.nilable(::CodeTeams::Team)) }
+  def map_file_to_owner(file); end
+
+  sig { override.params(files: T::Array[::String]).returns(T::Hash[::String, T.nilable(::CodeTeams::Team)]) }
+  def map_files_to_owners(files); end
+
+  sig { params(filename: ::String).void }
+  def remove_file_annotation!(filename); end
+end
+
+CodeOwnership::Private::OwnershipMappers::FileAnnotations::TEAM_PATTERN = T.let(T.unsafe(nil), Regexp)
+
+module CodeOwnership::Private::OwnershipMappers::Interface
+  interface!
+
+  sig { abstract.void }
+  def bust_caches!; end
+
+  sig { abstract.returns(T::Hash[::String, T.nilable(::CodeTeams::Team)]) }
+  def codeowners_lines_to_owners; end
+
+  sig { abstract.returns(::String) }
+  def description; end
+
+  sig { abstract.params(file: ::String).returns(T.nilable(::CodeTeams::Team)) }
+  def map_file_to_owner(file); end
+
+  sig { abstract.params(files: T::Array[::String]).returns(T::Hash[::String, T.nilable(::CodeTeams::Team)]) }
+  def map_files_to_owners(files); end
+end
+
+class CodeOwnership::Private::OwnershipMappers::JsPackageOwnership
+  include ::CodeOwnership::Private::OwnershipMappers::Interface
+
+  sig { override.void }
+  def bust_caches!; end
+
+  sig { override.returns(T::Hash[::String, T.nilable(::CodeTeams::Team)]) }
+  def codeowners_lines_to_owners; end
+
+  sig { override.returns(::String) }
+  def description; end
+
+  sig { override.params(file: ::String).returns(T.nilable(::CodeTeams::Team)) }
+  def map_file_to_owner(file); end
+
+  sig { override.params(files: T::Array[::String]).returns(T::Hash[::String, T.nilable(::CodeTeams::Team)]) }
+  def map_files_to_owners(files); end
+
+  sig { params(package: ::CodeOwnership::Private::ParseJsPackages::Package).returns(T.nilable(::CodeTeams::Team)) }
+  def owner_for_package(package); end
+
+  private
+
+  sig { params(file: ::String).returns(T.nilable(::CodeOwnership::Private::ParseJsPackages::Package)) }
+  def map_file_to_relevant_package(file); end
+end
+
+class CodeOwnership::Private::OwnershipMappers::PackageOwnership
+  include ::CodeOwnership::Private::OwnershipMappers::Interface
+
+  sig { override.void }
+  def bust_caches!; end
+
+  sig { override.returns(T::Hash[::String, T.nilable(::CodeTeams::Team)]) }
+  def codeowners_lines_to_owners; end
+
+  sig { override.returns(::String) }
+  def description; end
+
+  sig { override.params(file: ::String).returns(T.nilable(::CodeTeams::Team)) }
+  def map_file_to_owner(file); end
+
+  sig { override.params(files: T::Array[::String]).returns(T::Hash[::String, T.nilable(::CodeTeams::Team)]) }
+  def map_files_to_owners(files); end
+
+  sig { params(package: ::ParsePackwerk::Package).returns(T.nilable(::CodeTeams::Team)) }
+  def owner_for_package(package); end
+end
+
+class CodeOwnership::Private::OwnershipMappers::TeamGlobs
+  include ::CodeOwnership::Private::OwnershipMappers::Interface
+
+  sig { override.void }
+  def bust_caches!; end
+
+  sig { override.returns(T::Hash[::String, T.nilable(::CodeTeams::Team)]) }
+  def codeowners_lines_to_owners; end
+
+  sig { override.returns(::String) }
+  def description; end
+
+  sig { override.params(file: ::String).returns(T.nilable(::CodeTeams::Team)) }
+  def map_file_to_owner(file); end
+
+  sig { override.params(files: T::Array[::String]).returns(T::Hash[::String, T.nilable(::CodeTeams::Team)]) }
+  def map_files_to_owners(files); end
+end
+
+module CodeOwnership::Private::ParseJsPackages
+  class << self
+    sig { returns(T::Array[::CodeOwnership::Private::ParseJsPackages::Package]) }
+    def all; end
+  end
+end
+
+CodeOwnership::Private::ParseJsPackages::METADATA = T.let(T.unsafe(nil), String)
+CodeOwnership::Private::ParseJsPackages::PACKAGE_JSON_NAME = T.let(T.unsafe(nil), String)
+
+class CodeOwnership::Private::ParseJsPackages::Package < ::T::Struct
+  const :metadata, T::Hash[::String, T.untyped]
+  const :name, ::String
+
+  sig { returns(::Pathname) }
+  def directory; end
+
+  class << self
+    sig { params(pathname: ::Pathname).returns(::CodeOwnership::Private::ParseJsPackages::Package) }
+    def from(pathname); end
+
+    def inherited(s); end
+  end
+end
+
+CodeOwnership::Private::ParseJsPackages::ROOT_PACKAGE_NAME = T.let(T.unsafe(nil), String)
+module CodeOwnership::Private::TeamPlugins; end
+
+class CodeOwnership::Private::TeamPlugins::Github < ::CodeTeams::Plugin
+  sig { returns(::CodeOwnership::Private::TeamPlugins::Github::GithubStruct) }
+  def github; end
+end
+
+class CodeOwnership::Private::TeamPlugins::Github::GithubStruct < ::Struct
+  def do_not_add_to_codeowners_file; end
+  def do_not_add_to_codeowners_file=(_); end
+  def team; end
+  def team=(_); end
+
+  class << self
+    def [](*_arg0); end
+    def inspect; end
+    def members; end
+    def new(*_arg0); end
+  end
+end
+
+class CodeOwnership::Private::TeamPlugins::Ownership < ::CodeTeams::Plugin
+  sig { returns(T::Array[::String]) }
+  def owned_globs; end
+end
+
+module CodeOwnership::Private::Validations; end
+
+class CodeOwnership::Private::Validations::FilesHaveOwners
+  include ::CodeOwnership::Private::Validations::Interface
+
+  sig do
+    override
+      .params(
+        files: T::Array[::String],
+        autocorrect: T::Boolean,
+        stage_changes: T::Boolean
+      ).returns(T::Array[::String])
+  end
+  def validation_errors(files:, autocorrect: T.unsafe(nil), stage_changes: T.unsafe(nil)); end
+end
+
+class CodeOwnership::Private::Validations::FilesHaveUniqueOwners
+  include ::CodeOwnership::Private::Validations::Interface
+
+  sig do
+    override
+      .params(
+        files: T::Array[::String],
+        autocorrect: T::Boolean,
+        stage_changes: T::Boolean
+      ).returns(T::Array[::String])
+  end
+  def validation_errors(files:, autocorrect: T.unsafe(nil), stage_changes: T.unsafe(nil)); end
+end
+
+class CodeOwnership::Private::Validations::GithubCodeownersUpToDate
+  include ::CodeOwnership::Private::Validations::Interface
+
+  sig do
+    override
+      .params(
+        files: T::Array[::String],
+        autocorrect: T::Boolean,
+        stage_changes: T::Boolean
+      ).returns(T::Array[::String])
+  end
+  def validation_errors(files:, autocorrect: T.unsafe(nil), stage_changes: T.unsafe(nil)); end
+
+  private
+
+  sig { returns(T::Array[::String]) }
+  def codeowners_file_lines; end
+end
+
+module CodeOwnership::Private::Validations::Interface
+  interface!
+
+  sig do
+    abstract
+      .params(
+        files: T::Array[::String],
+        autocorrect: T::Boolean,
+        stage_changes: T::Boolean
+      ).returns(T::Array[::String])
+  end
+  def validation_errors(files:, autocorrect: T.unsafe(nil), stage_changes: T.unsafe(nil)); end
+end

data/sorbet/rbi/gems/code_teams@1.0.0.rbi

@@ -0,0 +1,120 @@
+# typed: true
+
+# DO NOT EDIT MANUALLY
+# This is an autogenerated file for types exported from the `code_teams` gem.
+# Please instead update this file by running `bin/tapioca gem code_teams`.
+
+module CodeTeams
+  class << self
+    sig { returns(T::Array[::CodeTeams::Team]) }
+    def all; end
+
+    sig { void }
+    def bust_caches!; end
+
+    sig { params(name: ::String).returns(T.nilable(::CodeTeams::Team)) }
+    def find(name); end
+
+    sig { params(dir: ::String).returns(T::Array[::CodeTeams::Team]) }
+    def for_directory(dir); end
+
+    sig { params(string: ::String).returns(::String) }
+    def tag_value_for(string); end
+
+    sig { params(teams: T::Array[::CodeTeams::Team]).returns(T::Array[::String]) }
+    def validation_errors(teams); end
+  end
+end
+
+class CodeTeams::IncorrectPublicApiUsageError < ::StandardError; end
+
+class CodeTeams::Plugin
+  abstract!
+
+  sig { params(team: ::CodeTeams::Team).void }
+  def initialize(team); end
+
+  class << self
+    sig { returns(T::Array[T.class_of(CodeTeams::Plugin)]) }
+    def all_plugins; end
+
+    sig { params(team: ::CodeTeams::Team).returns(T.attached_class) }
+    def for(team); end
+
+    sig { params(base: T.untyped).void }
+    def inherited(base); end
+
+    sig { params(team: ::CodeTeams::Team, key: ::String).returns(::String) }
+    def missing_key_error_message(team, key); end
+
+    sig { params(teams: T::Array[::CodeTeams::Team]).returns(T::Array[::String]) }
+    def validation_errors(teams); end
+
+    private
+
+    sig { params(team: ::CodeTeams::Team).returns(T.attached_class) }
+    def register_team(team); end
+
+    sig { returns(T::Hash[T.nilable(::String), T::Hash[::Class, ::CodeTeams::Plugin]]) }
+    def registry; end
+  end
+end
+
+module CodeTeams::Plugins; end
+
+class CodeTeams::Plugins::Identity < ::CodeTeams::Plugin
+  sig { returns(::CodeTeams::Plugins::Identity::IdentityStruct) }
+  def identity; end
+
+  class << self
+    sig { override.params(teams: T::Array[::CodeTeams::Team]).returns(T::Array[::String]) }
+    def validation_errors(teams); end
+  end
+end
+
+class CodeTeams::Plugins::Identity::IdentityStruct < ::Struct
+  def name; end
+  def name=(_); end
+
+  class << self
+    def [](*_arg0); end
+    def inspect; end
+    def members; end
+    def new(*_arg0); end
+  end
+end
+
+class CodeTeams::Team
+  sig { params(config_yml: T.nilable(::String), raw_hash: T::Hash[T.untyped, T.untyped]).void }
+  def initialize(config_yml:, raw_hash:); end
+
+  sig { params(other: ::Object).returns(T::Boolean) }
+  def ==(other); end
+
+  sig { returns(T.nilable(::String)) }
+  def config_yml; end
+
+  def eql?(*args, &blk); end
+
+  sig { returns(::Integer) }
+  def hash; end
+
+  sig { returns(::String) }
+  def name; end
+
+  sig { returns(T::Hash[T.untyped, T.untyped]) }
+  def raw_hash; end
+
+  sig { returns(::String) }
+  def to_tag; end
+
+  class << self
+    sig { params(raw_hash: T::Hash[T.untyped, T.untyped]).returns(::CodeTeams::Team) }
+    def from_hash(raw_hash); end
+
+    sig { params(config_yml: ::String).returns(::CodeTeams::Team) }
+    def from_yml(config_yml); end
+  end
+end
+
+CodeTeams::UNKNOWN_TEAM_STRING = T.let(T.unsafe(nil), String)

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: danger-packwerk
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-20 00:00:00.000000000 Z
+date: 2022-12-13 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: code_ownership
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
   requirement: !ruby/object:Gem::Requirement
@@ -188,12 +202,16 @@ files:
 - README.md
 - lib/danger-packwerk.rb
 - lib/danger-packwerk/basic_reference_offense.rb
+- lib/danger-packwerk/check/default_formatter.rb
+- lib/danger-packwerk/check/offenses_formatter.rb
 - lib/danger-packwerk/danger_deprecated_references_yml_changes.rb
 - lib/danger-packwerk/danger_packwerk.rb
 - lib/danger-packwerk/packwerk_wrapper.rb
 - lib/danger-packwerk/private.rb
-- lib/danger-packwerk/private/default_offenses_formatter.rb
 - lib/danger-packwerk/private/deprecated_references.rb
+- lib/danger-packwerk/private/ownership_information.rb
+- lib/danger-packwerk/update/default_formatter.rb
+- lib/danger-packwerk/update/offenses_formatter.rb
 - lib/danger-packwerk/version.rb
 - lib/danger-packwerk/violation_diff.rb
 - lib/danger_plugin.rb
@@ -206,6 +224,8 @@ files:
 - sorbet/rbi/gems/builder@3.2.4.rbi
 - sorbet/rbi/gems/claide-plugins@0.9.2.rbi
 - sorbet/rbi/gems/claide@1.1.0.rbi
+- sorbet/rbi/gems/code_ownership@1.29.1.rbi
+- sorbet/rbi/gems/code_teams@1.0.0.rbi
 - sorbet/rbi/gems/coderay@1.1.3.rbi
 - sorbet/rbi/gems/colored2@3.1.2.rbi
 - sorbet/rbi/gems/concurrent-ruby@1.1.10.rbi
@@ -230,7 +250,6 @@ files:
 - sorbet/rbi/gems/faraday@1.10.2.rbi
 - sorbet/rbi/gems/git@1.12.0.rbi
 - sorbet/rbi/gems/i18n@1.12.0.rbi
-- sorbet/rbi/gems/json@2.6.2.rbi
 - sorbet/rbi/gems/kramdown-parser-gfm@1.1.0.rbi
 - sorbet/rbi/gems/kramdown@2.4.0.rbi
 - sorbet/rbi/gems/loofah@2.19.0.rbi

data/lib/danger-packwerk/private/default_offenses_formatter.rb

@@ -1,37 +0,0 @@
-# typed: strict
-
-module DangerPackwerk
-  module Private
-    class DefaultAddedOffensesFormatter
-      extend T::Sig
-
-      sig { params(violations: T::Array[BasicReferenceOffense]).returns(String) }
-      def self.format(violations)
-        violation = T.must(violations.first)
-        # We remove leading double colons as they feel like an implementation detail of packwerk.
-        constant_name = violation.class_name.gsub(/\A::/, '')
-        link_to_docs = '[the docs](https://github.com/Shopify/packwerk/blob/b647594f93c8922c038255a7aaca125d391a1fbf/docs/new_violation_flow_chart.pdf)'
-        disclaimer = "We noticed you ran `bin/packwerk update-deprecations`. Make sure to read through #{link_to_docs} for other ways to resolve. "
-        pluralized_violation = violations.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}?"
-
-        if violations.any?(&:dependency?) && violations.any?(&:privacy?)
-          <<~MESSAGE
-            Hi! It looks like the pack defining `#{constant_name}` considers this private API, and it's also not in the referencing pack's list of dependencies.
-            #{disclaimer}#{request_to_add_context}
-          MESSAGE
-        elsif violations.any?(&:dependency?)
-          <<~MESSAGE
-            Hi! It looks like the pack defining `#{constant_name}` is not in the referencing pack's list of dependencies.
-            #{disclaimer}#{request_to_add_context}
-          MESSAGE
-        else # violations.any?(&:privacy?)
-          <<~MESSAGE
-            Hi! It looks like the pack defining `#{constant_name}` considers this private API.
-            #{disclaimer}#{request_to_add_context}
-          MESSAGE
-        end
-      end
-    end
-  end
-end