spec-controller 0.1.221 → 0.1.223

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/cli.js +27 -26
  2. package/package.json +2 -2
package/dist/cli.js CHANGED
@@ -28322,19 +28322,19 @@ var init_messages4 = __esm({
28322
28322
  CoreMessage2[CoreMessage2["ReconcilerStep"] = 74] = "ReconcilerStep";
28323
28323
  CoreMessage2[CoreMessage2["ReconcilerReconciles"] = 75] = "ReconcilerReconciles";
28324
28324
  CoreMessage2[CoreMessage2["ReconcilerRecords"] = 76] = "ReconcilerRecords";
28325
- CoreMessage2[CoreMessage2["StepExcluded"] = 77] = "StepExcluded";
28325
+ CoreMessage2[CoreMessage2["StepNonCheck"] = 77] = "StepNonCheck";
28326
28326
  CoreMessage2[CoreMessage2["StepAccountingHeading"] = 78] = "StepAccountingHeading";
28327
28327
  CoreMessage2[CoreMessage2["StepAccountingTableHeader"] = 79] = "StepAccountingTableHeader";
28328
28328
  CoreMessage2[CoreMessage2["StepAccountingTotal"] = 80] = "StepAccountingTotal";
28329
28329
  CoreMessage2[CoreMessage2["StepAccountingRunnersLabel"] = 81] = "StepAccountingRunnersLabel";
28330
28330
  CoreMessage2[CoreMessage2["StepAccountingReconcilerLabel"] = 82] = "StepAccountingReconcilerLabel";
28331
- CoreMessage2[CoreMessage2["StepAccountingExcludedLabel"] = 83] = "StepAccountingExcludedLabel";
28331
+ CoreMessage2[CoreMessage2["StepAccountingNonChecksLabel"] = 83] = "StepAccountingNonChecksLabel";
28332
28332
  CoreMessage2[CoreMessage2["StepAccountingNotAppliedLabel"] = 84] = "StepAccountingNotAppliedLabel";
28333
28333
  CoreMessage2[CoreMessage2["StepAccountingNoWorkflowRead"] = 85] = "StepAccountingNoWorkflowRead";
28334
28334
  CoreMessage2[CoreMessage2["StepAccountingPlumbingLabel"] = 86] = "StepAccountingPlumbingLabel";
28335
28335
  CoreMessage2[CoreMessage2["StepAccountingCandidatesTerm"] = 87] = "StepAccountingCandidatesTerm";
28336
28336
  CoreMessage2[CoreMessage2["StepAccountingReconcilerTerm"] = 88] = "StepAccountingReconcilerTerm";
28337
- CoreMessage2[CoreMessage2["StepAccountingExcludedTerm"] = 89] = "StepAccountingExcludedTerm";
28337
+ CoreMessage2[CoreMessage2["StepAccountingNonChecksTerm"] = 89] = "StepAccountingNonChecksTerm";
28338
28338
  CoreMessage2[CoreMessage2["StepAccountingPlumbingTerm"] = 90] = "StepAccountingPlumbingTerm";
28339
28339
  CoreMessage2[CoreMessage2["StepAccountingAccountedForTerm"] = 91] = "StepAccountingAccountedForTerm";
28340
28340
  CoreMessage2[CoreMessage2["OutOfBalanceByFeatureHeading"] = 92] = "OutOfBalanceByFeatureHeading";
@@ -28504,20 +28504,20 @@ var init_messages4 = __esm({
28504
28504
  [CoreMessage.ReconcilerStep]: (step, whatItIs) => `${step} \u2014 the reconciler: ${whatItIs}.`,
28505
28505
  [CoreMessage.ReconcilerReconciles]: "this step runs the reconciliation this report is",
28506
28506
  [CoreMessage.ReconcilerRecords]: "this step writes the step record the reconciliation reads",
28507
- [CoreMessage.StepExcluded]: (entry) => `${entry} \u2014 excluded: the target names this step a non-check.`,
28507
+ [CoreMessage.StepNonCheck]: (entry) => `${entry} \u2014 a non-check: the target names it under \`specController.notChecks\`.`,
28508
28508
  [CoreMessage.StepAccountingHeading]: "### Step accounting",
28509
- [CoreMessage.StepAccountingTableHeader]: "| Workflow | Job | Steps read | Candidates | Runners | Reconciler | Excluded | GitHub plumbing | Accounted for |",
28509
+ [CoreMessage.StepAccountingTableHeader]: "| Workflow | Job | Steps read | Candidates | Runners | Reconciler | Non-checks | GitHub plumbing | Accounted for |",
28510
28510
  [CoreMessage.StepAccountingTotal]: "Total",
28511
28511
  [CoreMessage.StepAccountingRunnersLabel]: "Runners:",
28512
28512
  [CoreMessage.StepAccountingReconcilerLabel]: "Reconciler:",
28513
- [CoreMessage.StepAccountingExcludedLabel]: "Excluded:",
28513
+ [CoreMessage.StepAccountingNonChecksLabel]: "Non-checks:",
28514
28514
  [CoreMessage.StepAccountingNotAppliedLabel]: (key, workflowsRead) => `Not applied, because each ${key} entry below names a workflow this run did not read (this run read ${workflowsRead}):`,
28515
28515
  [CoreMessage.StepAccountingNoWorkflowRead]: "no workflow",
28516
28516
  [CoreMessage.StepAccountingPlumbingLabel]: "GitHub plumbing:",
28517
- [CoreMessage.StepAccountingCandidatesTerm]: "A Candidate is a step read that is not a Runner, Reconciler, Excluded or GitHub plumbing step. It is read as a fitness function, and no list below names it.",
28517
+ [CoreMessage.StepAccountingCandidatesTerm]: "A Candidate is a step read that is not a Runner, Reconciler, Non-check or GitHub plumbing step. It is read as a fitness function, and no list below names it.",
28518
28518
  [CoreMessage.StepAccountingReconcilerTerm]: "A Reconciler step runs this reconciliation or writes the step record it reads.",
28519
- [CoreMessage.StepAccountingExcludedTerm]: "An Excluded step is one the target names a non-check under `specController.notChecks`, unless it is a Reconciler step. A GitHub plumbing step named there is Excluded too.",
28520
- [CoreMessage.StepAccountingPlumbingTerm]: "A GitHub plumbing step is one that is neither a Reconciler nor an Excluded step and uses one of GitHub's own actions `actions/checkout`, `actions/cache`, `actions/upload-artifact`, `actions/download-artifact` or `actions/setup-*`. A step that runs a command, an install included, is never plumbing.",
28519
+ [CoreMessage.StepAccountingNonChecksTerm]: "A Non-check is a step the target names under `specController.notChecks`, unless it is a Reconciler step. A GitHub plumbing step named there is a Non-check too.",
28520
+ [CoreMessage.StepAccountingPlumbingTerm]: "A GitHub plumbing step is one that is neither a Reconciler nor a Non-check step and uses one of GitHub's own actions `actions/checkout`, `actions/cache`, `actions/upload-artifact`, `actions/download-artifact` or `actions/setup-*`. A step that runs a command, an install included, is never plumbing.",
28521
28521
  [CoreMessage.StepAccountingAccountedForTerm]: "Accounted for is the sum of the five columns from Candidates to GitHub plumbing, in which each step read is counted once.",
28522
28522
  [CoreMessage.OutOfBalanceByFeatureHeading]: "### Out-of-balance by feature",
28523
28523
  [CoreMessage.ScenarioClaimReconciliationsOutOfBalance]: (outOfBalance, claimReconciliations) => `${outOfBalance} of ${claimReconciliations} Claim Reconciliation(s) of scenarios out of balance`,
@@ -28743,8 +28743,8 @@ var init_messages_en = __esm({
28743
28743
  "configuration-wrong-kind": "{entry} is {is} where {reads} is read, so this run read it as absent.",
28744
28744
  "configuration-unknown-key": "{key} is not a key the specController block reads, so this run read nothing from it.",
28745
28745
  "runner-key-not-a-layer": "{key} \u2014 not a layer: the runner block is keyed by the four layers, and this key excludes nothing.",
28746
- "not-checks-entry-matches-no-step": "{key} entry {entry} matches no step of the workflows this run read, so it excludes nothing.",
28747
- "not-checks-entry-not-a-step-name": "{key} entry {entry} does not name a step as `<workflow file>:<job id>:<step name>`, so it excludes nothing.",
28746
+ "not-checks-entry-matches-no-step": "{key} entry {entry} matches no step of the workflows this run read, so it makes no step a non-check.",
28747
+ "not-checks-entry-not-a-step-name": "{key} entry {entry} does not name a step as `<workflow file>:<job id>:<step name>`, so it makes no step a non-check.",
28748
28748
  "manifest-kind-list": "a list",
28749
28749
  "manifest-kind-object": "an object",
28750
28750
  "manifest-kind-string": "a string",
@@ -31833,7 +31833,7 @@ var init_stepAccounting = __esm({
31833
31833
  STEP_ACCOUNTING_TERMS = [
31834
31834
  CoreMessage.StepAccountingCandidatesTerm,
31835
31835
  CoreMessage.StepAccountingReconcilerTerm,
31836
- CoreMessage.StepAccountingExcludedTerm,
31836
+ CoreMessage.StepAccountingNonChecksTerm,
31837
31837
  CoreMessage.StepAccountingPlumbingTerm,
31838
31838
  CoreMessage.StepAccountingAccountedForTerm
31839
31839
  ];
@@ -31875,8 +31875,8 @@ var init_stepAccounting = __esm({
31875
31875
  if (nonChecks.length === 0)
31876
31876
  return [];
31877
31877
  return [
31878
- CORE_MESSAGES[CoreMessage.StepAccountingExcludedLabel],
31879
- ...nonChecks.map((step) => `- ${CORE_MESSAGES[CoreMessage.StepExcluded](codeSpan(step))}`),
31878
+ CORE_MESSAGES[CoreMessage.StepAccountingNonChecksLabel],
31879
+ ...nonChecks.map((step) => `- ${CORE_MESSAGES[CoreMessage.StepNonCheck](codeSpan(step))}`),
31880
31880
  ""
31881
31881
  ];
31882
31882
  };
@@ -32201,16 +32201,6 @@ function ledgerTallyLines(totals) {
32201
32201
  }
32202
32202
  return lines;
32203
32203
  }
32204
- function censusLines(codes, scenarios) {
32205
- if (codes?.excludedOccurrences === void 0)
32206
- return [];
32207
- const lines = [`- ${CORE_MESSAGES[CoreMessage.ExcludedScnOccurrences](codes.excludedOccurrences)}`];
32208
- const untagged = (codes.untaggedScenarios ?? []).length;
32209
- if (untagged > 0)
32210
- lines.push(`- ${CORE_MESSAGES[CoreMessage.UntaggedScenarios](untagged)}`);
32211
- lines.push(...sharedScnCodeLines(codes.sharedScnCodes ?? [], scenarios));
32212
- return lines;
32213
- }
32214
32204
  function sharedScnCodeLines(shared, scenarios) {
32215
32205
  if (shared.length === 0)
32216
32206
  return [];
@@ -32240,7 +32230,7 @@ function ledgerTableLines(claims, columns, stepsByQualityCheckKind) {
32240
32230
  function renderReport(report, inputNames, exitCodeOf2) {
32241
32231
  return SECTIONS.flatMap((section) => section(report, inputNames, exitCodeOf2)).join("\n");
32242
32232
  }
32243
- var reported, RESULT_MESSAGE, titleSection, runIntegritySection, summarySection, EVIDENCE_RECONCILIATION_COLUMNS, EVIDENCE_RECONCILIATION_TERMS, evidenceReconciliationSection, byFeatureSection, ledgerSection, SECTIONS;
32233
+ var reported, RESULT_MESSAGE, titleSection, runIntegritySection, summarySection, EVIDENCE_RECONCILIATION_COLUMNS, EVIDENCE_RECONCILIATION_TERMS, evidenceReconciliationSection, byFeatureSection, ledgerSection, scenarioCodeFactsSection, SECTIONS;
32244
32234
  var init_markdown = __esm({
32245
32235
  "../core/dist/render/markdown.js"() {
32246
32236
  "use strict";
@@ -32365,13 +32355,23 @@ var init_markdown = __esm({
32365
32355
  CORE_MESSAGES[CoreMessage.ClaimReconciliationsHeading],
32366
32356
  "",
32367
32357
  ...ledgerTallyLines(report.summary.evidenceReconciliation.claimReconciliations),
32368
- ...censusLines(report.summary.scenarioCodes, scenarioRows.length),
32369
32358
  "",
32370
32359
  ...evidenceKeyLines(columns),
32371
32360
  ...ledgerTableLines(claims, columns, report.summary.evidenceObservations?.byQualityCheckKind ?? []),
32372
32361
  ""
32373
32362
  ];
32374
32363
  };
32364
+ scenarioCodeFactsSection = (report) => {
32365
+ const codes = report.summary.scenarioCodes;
32366
+ if (codes?.excludedOccurrences === void 0)
32367
+ return [];
32368
+ const lines = [`- ${CORE_MESSAGES[CoreMessage.ExcludedScnOccurrences](codes.excludedOccurrences)}`];
32369
+ const untagged = (codes.untaggedScenarios ?? []).length;
32370
+ if (untagged > 0)
32371
+ lines.push(`- ${CORE_MESSAGES[CoreMessage.UntaggedScenarios](untagged)}`);
32372
+ lines.push(...sharedScnCodeLines(codes.sharedScnCodes ?? [], report.claimReconciliations.filter(isScenario).length));
32373
+ return [...lines, ""];
32374
+ };
32375
32375
  SECTIONS = [
32376
32376
  titleSection,
32377
32377
  provenanceSection,
@@ -32380,6 +32380,7 @@ var init_markdown = __esm({
32380
32380
  summarySection,
32381
32381
  (report, _inputNames, exitCodeOf2) => runVerdictSection(report, exitCodeOf2),
32382
32382
  scenarioCodesCleanStatement,
32383
+ scenarioCodeFactsSection,
32383
32384
  evidenceReconciliationSection,
32384
32385
  evidenceObservationsSection,
32385
32386
  stepAccountingSection,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "spec-controller",
3
- "version": "0.1.221",
3
+ "version": "0.1.223",
4
4
  "description": "Reconcile the behaviour your scenarios name against the evidence that actually ran — the deterministic `balance` CLI.",
5
5
  "keywords": [
6
6
  "reconciliation",
@@ -26,7 +26,7 @@
26
26
  "fast-xml-parser": "^5.11.2",
27
27
  "ts-json-schema-generator": "^2.9.0",
28
28
  "yaml": "^2.9.0",
29
- "@3f-consulting/spec-controller-core": "0.1.221"
29
+ "@3f-consulting/spec-controller-core": "0.1.223"
30
30
  },
31
31
  "publishConfig": {
32
32
  "access": "public"