@spec added(Presubmit.Commit.t(), pattern()) :: [String.t()]

Paths of files added by the commit.

@spec added_lines(Presubmit.Commit.t(), pattern()) :: [
  {String.t(), pos_integer(), String.t()}
]

Lines added by the commit as {path, line_number, text}, for files matching pattern. Line numbers refer to the after tree.

@spec additions(Presubmit.Commit.t()) :: non_neg_integer()

Total lines added across the commit.

@spec after_paths(Presubmit.Commit.t(), pattern()) :: [String.t()]

Paths in the after tree matching pattern, sorted.

@spec before_paths(Presubmit.Commit.t(), pattern()) :: [String.t()]

Paths in the before tree matching pattern, sorted.

@spec behaviour_changed?(Presubmit.Commit.t(), source_pattern()) :: boolean()

Whether any function's body changed or any function was added or removed, in files matching pattern.

Docs, specs, attributes, and formatting do not count, which makes this the right trigger for "code changes need test changes".

@spec changes(Presubmit.Commit.t(), [Presubmit.FileChange.status()] | :any, pattern()) ::
  [
    Presubmit.FileChange.t()
  ]

Changes whose status is one of statuses and whose path matches pattern.

@spec deletions(Presubmit.Commit.t()) :: non_neg_integer()

Total lines removed across the commit.

@spec elixir_diff(Presubmit.Commit.t()) :: Presubmit.Source.Diff.t()

The structural diff of the commit's Elixir source.

@spec exists?(Presubmit.Commit.t(), String.t()) :: boolean()

Whether path exists in the after tree.

@spec formatting_only?(Presubmit.Commit.t()) :: boolean()

Whether the commit only changes whitespace: no files added, removed, or renamed, and every modified file's non-whitespace bytes are unchanged.

@spec function_changes(Presubmit.Commit.t(), source_pattern()) :: %{
  added: [Presubmit.Source.Facts.Function.t()],
  removed: [Presubmit.Source.Facts.Function.t()],
  body_changed: [
    {Presubmit.Source.Facts.Function.t(), Presubmit.Source.Facts.Function.t()}
  ]
}

Functions added, removed, and body-changed in files matching pattern. A body change is matched against the function's file after the change.

@spec functions_added(Presubmit.Commit.t(), source_pattern()) :: [
  Presubmit.Source.Facts.Function.t()
]

Functions the commit adds in files matching pattern, public and private.

@spec functions_removed(Presubmit.Commit.t(), source_pattern()) :: [
  Presubmit.Source.Facts.Function.t()
]

Functions the commit removes from files matching pattern, public and private.

@spec has_message?(Presubmit.Commit.t()) :: boolean()

Whether this change set carries a commit message.

@spec message!(Presubmit.Commit.t()) :: Presubmit.Message.t()

The parsed message, raising Presubmit.NoMessageError if there is none.

@spec modified(Presubmit.Commit.t(), pattern()) :: [String.t()]

Paths of files whose contents changed in place.

@spec module_facts_added(Presubmit.Commit.t(), source_pattern()) :: [
  Presubmit.Source.Facts.Module.t()
]

Facts for every module the commit adds in files matching pattern.

@spec modules_added(Presubmit.Commit.t(), source_pattern()) :: [module()]

Modules the commit defines in files matching pattern that did not exist before (renames excluded).

@spec modules_removed(Presubmit.Commit.t(), source_pattern()) :: [module()]

Modules that existed before the commit and do not after (renames excluded).

@spec modules_renamed(Presubmit.Commit.t()) :: [{module(), module()}]

{old, new} module names for modules the commit renamed.

@spec public_api_changed?(Presubmit.Commit.t()) :: boolean()

Whether the commit adds or removes any API function the project ships.

@spec public_api_diff(Presubmit.Commit.t()) :: %{
  added: [{module(), atom(), arity()}],
  removed: [{module(), atom(), arity()}]
}

API functions (public, not @doc false) the commit adds to and removes from the code the project ships, as {module, name, arity}.

Only files matching :shipped count (see the moduledoc), so test support and fixtures compiled only under MIX_ENV=test are not public API. A function whose arity set changes shows up as removed at the old arity and added at the new one.

@spec removed(Presubmit.Commit.t(), pattern()) :: [String.t()]

Paths of files deleted by the commit.

@spec removed_lines(Presubmit.Commit.t(), pattern()) :: [
  {String.t(), pos_integer(), String.t()}
]

Lines removed by the commit as {path, line_number, text}. Line numbers refer to the before tree and the path is the before path.

@spec renamed(Presubmit.Commit.t(), pattern()) :: [{String.t(), String.t()}]

{old_path, new_path} pairs for renamed files; pattern matches either side.

@spec subject(Presubmit.Commit.t()) :: String.t()

The subject line.

@spec touched(Presubmit.Commit.t(), pattern()) :: [String.t()]

Every path the commit touches, matching pattern.

Renames contribute both their old and new paths.

@spec touches?(Presubmit.Commit.t(), pattern()) :: boolean()

Whether the commit touches any path matching pattern.

@spec trailer(Presubmit.Commit.t(), String.t()) :: [String.t()]

Values of the trailer key (case-insensitive).

@spec trailers(Presubmit.Commit.t()) :: [Presubmit.Message.trailer()]

All trailers as {key, value} pairs.

@spec unparsed(Presubmit.Commit.t()) :: [{String.t(), term()}]

Elixir files the commit could not parse, with the parser's reason.