Liking cljdoc? Tell your friends :D

systems.thoughtfull.assay.baseline.interface

Compare a workspace with a baseline, such as the branch a pull request will merge into, so that CI can fail on what a change introduces rather than on problems that were already there.

A function violation that was in base is still new when the change made it worse, so a change can't make an already complex function more complex unnoticed.

Compare a workspace with a baseline, such as the branch a pull request
will merge into, so that CI can fail on what a change introduces rather
than on problems that were already there.

A function violation that was in base is still new when the change made
it worse, so a change can't make an already complex function more
complex unnoticed.
raw docstring

changed-bricksclj

(changed-bricks measurements changed-files)

Names of the bricks in measurements whose source files are among changed-files (paths relative to the workspace root).

Names of the bricks in measurements whose source files are among
changed-files (paths relative to the workspace root).
raw docstring

compare-reportsclj

(compare-reports base head changed-files)

Compare head with base, two reports of :bricks, :violations, and :edges. Returns head with:

  • each violation's :status set to :new (in a changed brick and not in base, or a function violation whose value got worse since base, its message ending with what the value was), :existing (also in base), or :indirect (not in base, but in a brick that did not change, as when a statistical threshold moves); a :historical? violation, from history rather than code, is :existing; and its :base-value set to the metric's value in base;
  • each of its :edges that base doesn't have marked :new? true;
  • :comparison, a map of :changed-bricks (a set of names), :base-metrics (brick name to metrics), and :resolved (violations in base but not in head).

Violations are matched by brick, metric, and :subject (a function name or finding), so a function that moves is still the same.

Compare head with base, two reports of :bricks, :violations, and :edges.
Returns head with:

- each violation's :status set to :new (in a changed brick and not in
  base, or a function violation whose value got worse since base, its
  message ending with what the value was), :existing (also in base), or
  :indirect (not in base, but in a brick that did not change, as when a
  statistical threshold moves); a :historical? violation, from history
  rather than code, is :existing; and its :base-value set to the
  metric's value in base;
- each of its :edges that base doesn't have marked :new? true;
- :comparison, a map of :changed-bricks (a set of names), :base-metrics
  (brick name to metrics), and :resolved (violations in base but not in
  head).

Violations are matched by brick, metric, and :subject (a function name
or finding), so a function that moves is still the same.
raw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
←Move to previous article
→Move to next article
Ctrl+/Jump to the search field
× close