spec-controller 0.1.195 → 0.1.197

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 +79 -57
  2. package/package.json +2 -2
package/dist/cli.js CHANGED
@@ -28477,58 +28477,63 @@ var init_messages4 = __esm({
28477
28477
  CoreMessage2[CoreMessage2["StepAccountingNotAppliedLabel"] = 102] = "StepAccountingNotAppliedLabel";
28478
28478
  CoreMessage2[CoreMessage2["StepAccountingNoWorkflowRead"] = 103] = "StepAccountingNoWorkflowRead";
28479
28479
  CoreMessage2[CoreMessage2["StepAccountingPlumbingLabel"] = 104] = "StepAccountingPlumbingLabel";
28480
- CoreMessage2[CoreMessage2["OutOfBalanceByFeatureHeading"] = 105] = "OutOfBalanceByFeatureHeading";
28481
- CoreMessage2[CoreMessage2["ScenarioClaimReconciliationsOutOfBalance"] = 106] = "ScenarioClaimReconciliationsOutOfBalance";
28482
- CoreMessage2[CoreMessage2["GroupedByFeature"] = 107] = "GroupedByFeature";
28483
- CoreMessage2[CoreMessage2["NotGroupedByFeature"] = 108] = "NotGroupedByFeature";
28484
- CoreMessage2[CoreMessage2["PhantomClaimReconciliations"] = 109] = "PhantomClaimReconciliations";
28485
- CoreMessage2[CoreMessage2["UnnamedClaimReconciliations"] = 110] = "UnnamedClaimReconciliations";
28486
- CoreMessage2[CoreMessage2["AndJoiner"] = 111] = "AndJoiner";
28487
- CoreMessage2[CoreMessage2["ByFeatureTableHeader"] = 112] = "ByFeatureTableHeader";
28488
- CoreMessage2[CoreMessage2["NoScnCodeScenarios"] = 113] = "NoScnCodeScenarios";
28489
- CoreMessage2[CoreMessage2["ClaimReconciliationsHeading"] = 114] = "ClaimReconciliationsHeading";
28490
- CoreMessage2[CoreMessage2["ClaimReconciliationTally"] = 115] = "ClaimReconciliationTally";
28491
- CoreMessage2[CoreMessage2["PhantomClaimTally"] = 116] = "PhantomClaimTally";
28492
- CoreMessage2[CoreMessage2["UnnamedClaimTally"] = 117] = "UnnamedClaimTally";
28493
- CoreMessage2[CoreMessage2["ExcludedScnOccurrences"] = 118] = "ExcludedScnOccurrences";
28494
- CoreMessage2[CoreMessage2["UntaggedScenarios"] = 119] = "UntaggedScenarios";
28495
- CoreMessage2[CoreMessage2["SharedScnCodes"] = 120] = "SharedScnCodes";
28496
- CoreMessage2[CoreMessage2["SharedScnCodeScenario"] = 121] = "SharedScnCodeScenario";
28497
- CoreMessage2[CoreMessage2["ClaimColumn"] = 122] = "ClaimColumn";
28498
- CoreMessage2[CoreMessage2["VerdictColumn"] = 123] = "VerdictColumn";
28499
- CoreMessage2[CoreMessage2["ReconcilingItemsColumn"] = 124] = "ReconcilingItemsColumn";
28500
- CoreMessage2[CoreMessage2["CiStepsColumn"] = 125] = "CiStepsColumn";
28501
- CoreMessage2[CoreMessage2["EvidenceCellKey"] = 126] = "EvidenceCellKey";
28502
- CoreMessage2[CoreMessage2["PendingItem"] = 127] = "PendingItem";
28503
- CoreMessage2[CoreMessage2["PendingItemFor"] = 128] = "PendingItemFor";
28504
- CoreMessage2[CoreMessage2["CheckStepNoOutcome"] = 129] = "CheckStepNoOutcome";
28505
- CoreMessage2[CoreMessage2["CheckStepSkipped"] = 130] = "CheckStepSkipped";
28506
- CoreMessage2[CoreMessage2["CheckStepEnded"] = 131] = "CheckStepEnded";
28507
- CoreMessage2[CoreMessage2["AmbiguousNamedStep"] = 132] = "AmbiguousNamedStep";
28508
- CoreMessage2[CoreMessage2["AmbiguousUnnamedStep"] = 133] = "AmbiguousUnnamedStep";
28509
- CoreMessage2[CoreMessage2["ManifestKindList"] = 134] = "ManifestKindList";
28510
- CoreMessage2[CoreMessage2["ManifestKindObject"] = 135] = "ManifestKindObject";
28511
- CoreMessage2[CoreMessage2["ManifestKindString"] = 136] = "ManifestKindString";
28512
- CoreMessage2[CoreMessage2["ManifestKindStringOrNull"] = 137] = "ManifestKindStringOrNull";
28513
- CoreMessage2[CoreMessage2["ManifestKindOfType"] = 138] = "ManifestKindOfType";
28514
- CoreMessage2[CoreMessage2["OutcomeSatisfied"] = 139] = "OutcomeSatisfied";
28515
- CoreMessage2[CoreMessage2["OutcomeMissing"] = 140] = "OutcomeMissing";
28516
- CoreMessage2[CoreMessage2["OutcomeFailing"] = 141] = "OutcomeFailing";
28517
- CoreMessage2[CoreMessage2["OutcomeWatermelon"] = 142] = "OutcomeWatermelon";
28518
- CoreMessage2[CoreMessage2["OutcomeNoScnCode"] = 143] = "OutcomeNoScnCode";
28519
- CoreMessage2[CoreMessage2["OutcomeDuplicateScnCode"] = 144] = "OutcomeDuplicateScnCode";
28520
- CoreMessage2[CoreMessage2["OutcomeCitesUnknownScenario"] = 145] = "OutcomeCitesUnknownScenario";
28521
- CoreMessage2[CoreMessage2["OutcomeCitesNoScenario"] = 146] = "OutcomeCitesNoScenario";
28522
- CoreMessage2[CoreMessage2["OutcomeNoEvidenceObligation"] = 147] = "OutcomeNoEvidenceObligation";
28523
- CoreMessage2[CoreMessage2["OutcomeBroken"] = 148] = "OutcomeBroken";
28524
- CoreMessage2[CoreMessage2["OutcomeBothMissing"] = 149] = "OutcomeBothMissing";
28525
- CoreMessage2[CoreMessage2["ObservationPassed"] = 150] = "ObservationPassed";
28526
- CoreMessage2[CoreMessage2["ObservationFailed"] = 151] = "ObservationFailed";
28527
- CoreMessage2[CoreMessage2["UnnamedClaimGroupCounts"] = 152] = "UnnamedClaimGroupCounts";
28528
- CoreMessage2[CoreMessage2["UnnamedClaimCiSteps"] = 153] = "UnnamedClaimCiSteps";
28529
- CoreMessage2[CoreMessage2["UnnamedClaimFailedNames"] = 154] = "UnnamedClaimFailedNames";
28530
- CoreMessage2[CoreMessage2["SeveralScnCodes"] = 155] = "SeveralScnCodes";
28531
- CoreMessage2[CoreMessage2["SharedScnCode"] = 156] = "SharedScnCode";
28480
+ CoreMessage2[CoreMessage2["StepAccountingCandidatesTerm"] = 105] = "StepAccountingCandidatesTerm";
28481
+ CoreMessage2[CoreMessage2["StepAccountingReconcilerTerm"] = 106] = "StepAccountingReconcilerTerm";
28482
+ CoreMessage2[CoreMessage2["StepAccountingExcludedTerm"] = 107] = "StepAccountingExcludedTerm";
28483
+ CoreMessage2[CoreMessage2["StepAccountingPlumbingTerm"] = 108] = "StepAccountingPlumbingTerm";
28484
+ CoreMessage2[CoreMessage2["StepAccountingAccountedForTerm"] = 109] = "StepAccountingAccountedForTerm";
28485
+ CoreMessage2[CoreMessage2["OutOfBalanceByFeatureHeading"] = 110] = "OutOfBalanceByFeatureHeading";
28486
+ CoreMessage2[CoreMessage2["ScenarioClaimReconciliationsOutOfBalance"] = 111] = "ScenarioClaimReconciliationsOutOfBalance";
28487
+ CoreMessage2[CoreMessage2["GroupedByFeature"] = 112] = "GroupedByFeature";
28488
+ CoreMessage2[CoreMessage2["NotGroupedByFeature"] = 113] = "NotGroupedByFeature";
28489
+ CoreMessage2[CoreMessage2["PhantomClaimReconciliations"] = 114] = "PhantomClaimReconciliations";
28490
+ CoreMessage2[CoreMessage2["UnnamedClaimReconciliations"] = 115] = "UnnamedClaimReconciliations";
28491
+ CoreMessage2[CoreMessage2["AndJoiner"] = 116] = "AndJoiner";
28492
+ CoreMessage2[CoreMessage2["ByFeatureTableHeader"] = 117] = "ByFeatureTableHeader";
28493
+ CoreMessage2[CoreMessage2["NoScnCodeScenarios"] = 118] = "NoScnCodeScenarios";
28494
+ CoreMessage2[CoreMessage2["ClaimReconciliationsHeading"] = 119] = "ClaimReconciliationsHeading";
28495
+ CoreMessage2[CoreMessage2["ClaimReconciliationTally"] = 120] = "ClaimReconciliationTally";
28496
+ CoreMessage2[CoreMessage2["PhantomClaimTally"] = 121] = "PhantomClaimTally";
28497
+ CoreMessage2[CoreMessage2["UnnamedClaimTally"] = 122] = "UnnamedClaimTally";
28498
+ CoreMessage2[CoreMessage2["ExcludedScnOccurrences"] = 123] = "ExcludedScnOccurrences";
28499
+ CoreMessage2[CoreMessage2["UntaggedScenarios"] = 124] = "UntaggedScenarios";
28500
+ CoreMessage2[CoreMessage2["SharedScnCodes"] = 125] = "SharedScnCodes";
28501
+ CoreMessage2[CoreMessage2["SharedScnCodeScenario"] = 126] = "SharedScnCodeScenario";
28502
+ CoreMessage2[CoreMessage2["ClaimColumn"] = 127] = "ClaimColumn";
28503
+ CoreMessage2[CoreMessage2["VerdictColumn"] = 128] = "VerdictColumn";
28504
+ CoreMessage2[CoreMessage2["ReconcilingItemsColumn"] = 129] = "ReconcilingItemsColumn";
28505
+ CoreMessage2[CoreMessage2["CiStepsColumn"] = 130] = "CiStepsColumn";
28506
+ CoreMessage2[CoreMessage2["EvidenceCellKey"] = 131] = "EvidenceCellKey";
28507
+ CoreMessage2[CoreMessage2["PendingItem"] = 132] = "PendingItem";
28508
+ CoreMessage2[CoreMessage2["PendingItemFor"] = 133] = "PendingItemFor";
28509
+ CoreMessage2[CoreMessage2["CheckStepNoOutcome"] = 134] = "CheckStepNoOutcome";
28510
+ CoreMessage2[CoreMessage2["CheckStepSkipped"] = 135] = "CheckStepSkipped";
28511
+ CoreMessage2[CoreMessage2["CheckStepEnded"] = 136] = "CheckStepEnded";
28512
+ CoreMessage2[CoreMessage2["AmbiguousNamedStep"] = 137] = "AmbiguousNamedStep";
28513
+ CoreMessage2[CoreMessage2["AmbiguousUnnamedStep"] = 138] = "AmbiguousUnnamedStep";
28514
+ CoreMessage2[CoreMessage2["ManifestKindList"] = 139] = "ManifestKindList";
28515
+ CoreMessage2[CoreMessage2["ManifestKindObject"] = 140] = "ManifestKindObject";
28516
+ CoreMessage2[CoreMessage2["ManifestKindString"] = 141] = "ManifestKindString";
28517
+ CoreMessage2[CoreMessage2["ManifestKindStringOrNull"] = 142] = "ManifestKindStringOrNull";
28518
+ CoreMessage2[CoreMessage2["ManifestKindOfType"] = 143] = "ManifestKindOfType";
28519
+ CoreMessage2[CoreMessage2["OutcomeSatisfied"] = 144] = "OutcomeSatisfied";
28520
+ CoreMessage2[CoreMessage2["OutcomeMissing"] = 145] = "OutcomeMissing";
28521
+ CoreMessage2[CoreMessage2["OutcomeFailing"] = 146] = "OutcomeFailing";
28522
+ CoreMessage2[CoreMessage2["OutcomeWatermelon"] = 147] = "OutcomeWatermelon";
28523
+ CoreMessage2[CoreMessage2["OutcomeNoScnCode"] = 148] = "OutcomeNoScnCode";
28524
+ CoreMessage2[CoreMessage2["OutcomeDuplicateScnCode"] = 149] = "OutcomeDuplicateScnCode";
28525
+ CoreMessage2[CoreMessage2["OutcomeCitesUnknownScenario"] = 150] = "OutcomeCitesUnknownScenario";
28526
+ CoreMessage2[CoreMessage2["OutcomeCitesNoScenario"] = 151] = "OutcomeCitesNoScenario";
28527
+ CoreMessage2[CoreMessage2["OutcomeNoEvidenceObligation"] = 152] = "OutcomeNoEvidenceObligation";
28528
+ CoreMessage2[CoreMessage2["OutcomeBroken"] = 153] = "OutcomeBroken";
28529
+ CoreMessage2[CoreMessage2["OutcomeBothMissing"] = 154] = "OutcomeBothMissing";
28530
+ CoreMessage2[CoreMessage2["ObservationPassed"] = 155] = "ObservationPassed";
28531
+ CoreMessage2[CoreMessage2["ObservationFailed"] = 156] = "ObservationFailed";
28532
+ CoreMessage2[CoreMessage2["UnnamedClaimGroupCounts"] = 157] = "UnnamedClaimGroupCounts";
28533
+ CoreMessage2[CoreMessage2["UnnamedClaimCiSteps"] = 158] = "UnnamedClaimCiSteps";
28534
+ CoreMessage2[CoreMessage2["UnnamedClaimFailedNames"] = 159] = "UnnamedClaimFailedNames";
28535
+ CoreMessage2[CoreMessage2["SeveralScnCodes"] = 160] = "SeveralScnCodes";
28536
+ CoreMessage2[CoreMessage2["SharedScnCode"] = 161] = "SharedScnCode";
28532
28537
  })(CoreMessage || (CoreMessage = {}));
28533
28538
  SATISFIED = "Evidence Observation satisfies its Evidence Obligation";
28534
28539
  MISSING = "Evidence Observation is missing";
@@ -28645,6 +28650,11 @@ var init_messages4 = __esm({
28645
28650
  [CoreMessage.StepAccountingNotAppliedLabel]: (key, workflowsRead) => `Not applied, because each ${key} entry below names a workflow this run did not read (this run read ${workflowsRead}):`,
28646
28651
  [CoreMessage.StepAccountingNoWorkflowRead]: "no workflow",
28647
28652
  [CoreMessage.StepAccountingPlumbingLabel]: "GitHub plumbing:",
28653
+ [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: its result is an Evidence Observation named, with its step, on the row of Claim Reconciliations it posts to, so no list below names it.",
28654
+ [CoreMessage.StepAccountingReconcilerTerm]: "A Reconciler step runs this reconciliation or writes the step record it reads.",
28655
+ [CoreMessage.StepAccountingExcludedTerm]: "An Excluded step is one the target names a non-check under `specController.notChecks`, a GitHub plumbing step included.",
28656
+ [CoreMessage.StepAccountingPlumbingTerm]: "A GitHub plumbing step only sets up the job: it uses one of GitHub's own actions that check out the source, cache, set up a toolchain or move artefacts between jobs. A step that runs a command, an install included, is never plumbing.",
28657
+ [CoreMessage.StepAccountingAccountedForTerm]: "Accounted for is the sum of the five columns from Candidates to GitHub plumbing, in which each step read is counted once.",
28648
28658
  [CoreMessage.OutOfBalanceByFeatureHeading]: "### Out-of-balance by feature",
28649
28659
  [CoreMessage.ScenarioClaimReconciliationsOutOfBalance]: (outOfBalance, claimReconciliations) => `${outOfBalance} of ${claimReconciliations} Claim Reconciliation(s) of scenarios out of balance`,
28650
28660
  [CoreMessage.GroupedByFeature]: ", grouped by feature",
@@ -28659,8 +28669,8 @@ var init_messages4 = __esm({
28659
28669
  [CoreMessage.PhantomClaimTally]: (count) => `${count} Claim Reconciliation(s) for ${CITED_WITH_NO_SCENARIO}.`,
28660
28670
  [CoreMessage.UnnamedClaimTally]: (count) => `${count} Claim Reconciliation(s) for ${CITING_NO_SCENARIO}, aggregated into "${UNNAMED_CLAIM_ID}".`,
28661
28671
  [CoreMessage.ExcludedScnOccurrences]: (count) => `${count} @SCN ids seen in non-tag context, excluded: each is an @SCN code written in a feature file's prose, a comment or step text rather than as a tag, so it marks no scenario and raises no claim`,
28662
- [CoreMessage.UntaggedScenarios]: (count) => `${count} scenario(s) carry no @SCN tag`,
28663
- [CoreMessage.SharedScnCodes]: (scenarios, codes) => `The corpus holds ${scenarios} scenarios \u2014 ${codes} @SCN code(s) carried by more than one scenario:`,
28672
+ [CoreMessage.UntaggedScenarios]: (count) => `${count} scenario(s) carry no @SCN code`,
28673
+ [CoreMessage.SharedScnCodes]: (scenarios, codes) => `The corpus holds ${scenarios} scenarios \u2014 ${codes} @SCN code(s) carried by more than one scenario, each scenario named as \`feature file : scenario title\`:`,
28664
28674
  [CoreMessage.SharedScnCodeScenario]: (feature, title) => `this one is ${feature} : ${title}`,
28665
28675
  [CoreMessage.ClaimColumn]: "Claim",
28666
28676
  [CoreMessage.VerdictColumn]: "Verdict",
@@ -28668,11 +28678,14 @@ var init_messages4 = __esm({
28668
28678
  [CoreMessage.CiStepsColumn]: "CI steps",
28669
28679
  [CoreMessage.EvidenceCellKey]: [
28670
28680
  "Key: each evidence cell reads *obligation*/*observations*.",
28671
- "- The letter says the scenario's tags raise an Evidence Obligation of that kind: (F)itness, (U)nit, (I)ntegration, (E)2e, (P)erformance. `-` means none is raised, or the obligation is pending.",
28681
+ "- The letter says the scenario's tags raise an Evidence Obligation of that kind: (F)itness, (U)nit, (I)ntegration, (E)2e, (P)erformance. The table has a column only for a kind some row obligates or observes. `-` means none is raised, or the obligation is pending.",
28672
28682
  "- The number counts the Evidence Observations posted to the scenario for that kind. `-` means none.",
28673
28683
  "- For example, `U/2` is a unit obligation answered by two unit tests; `U/-` is a unit obligation that no unit test answered; `-/1` is one unit test citing a scenario that asks for no unit evidence, or whose unit evidence is pending.",
28674
28684
  "- A blank cell means neither; `\u2014` marks a row that is not a scenario of the corpus: a cited code no feature declares, or evidence that cites no scenario.",
28675
- "- In Reconciling items, `\u2014` means the row has no reconciling item."
28685
+ "- A row named `feature file : scenario title` is a scenario that carries no @SCN code. The run reads none of its tags, so its evidence cells are blank, and its reconciling item says that no Evidence Observation can link to it.",
28686
+ "- In Reconciling items, `\u2014` means the row has no reconciling item, and *untagged* means the scenario carries no tag that raises an Evidence Obligation, though it may carry an @SCN code.",
28687
+ "- On the unnamed claim's row, the counts after an item, such as `1 ran, 1 passed, 0 failed`, are of that item's own tests; a broken item stands alone and is counted in none.",
28688
+ "- CI steps names the CI steps behind each kind of quality check the row obligates or observes, whether or not any Evidence Observation of that kind ran for the row: `U/-` beside a step names the step that runs unit tests, none of which answered this row."
28676
28689
  ].join("\n"),
28677
28690
  [CoreMessage.PendingItem]: "pending",
28678
28691
  [CoreMessage.PendingItemFor]: (qualityCheckKind) => `pending: ${qualityCheckKind}`,
@@ -29069,7 +29082,7 @@ var init_errorsInTheInputs = __esm({
29069
29082
  });
29070
29083
 
29071
29084
  // ../core/dist/render/stepAccounting.js
29072
- var rowOf, jobRowsOf, totalRowOf, tableOf, WHAT_IT_IS, runnersListOf, reconcilerListOf, nonChecksListOf, workflowsReadOf, notAppliedListOf, plumbingListOf, stepAccountingSection;
29085
+ var rowOf, jobRowsOf, totalRowOf, STEP_ACCOUNTING_TERMS, tableOf, WHAT_IT_IS, runnersListOf, reconcilerListOf, nonChecksListOf, workflowsReadOf, notAppliedListOf, plumbingListOf, stepAccountingSection;
29073
29086
  var init_stepAccounting = __esm({
29074
29087
  "../core/dist/render/stepAccounting.js"() {
29075
29088
  "use strict";
@@ -29096,10 +29109,19 @@ var init_stepAccounting = __esm({
29096
29109
  const counts = rowOf([stepsRead, candidates, runners, reconciler, nonChecks, plumbing, accountedForOf(total)]);
29097
29110
  return [`| ${CORE_MESSAGES[CoreMessage.StepAccountingTotal]} | ${counts}`];
29098
29111
  };
29112
+ STEP_ACCOUNTING_TERMS = [
29113
+ CoreMessage.StepAccountingCandidatesTerm,
29114
+ CoreMessage.StepAccountingReconcilerTerm,
29115
+ CoreMessage.StepAccountingExcludedTerm,
29116
+ CoreMessage.StepAccountingPlumbingTerm,
29117
+ CoreMessage.StepAccountingAccountedForTerm
29118
+ ];
29099
29119
  tableOf = (accounting) => {
29100
29120
  if (accounting.byJob.length === 0)
29101
29121
  return [];
29102
29122
  return [
29123
+ ...STEP_ACCOUNTING_TERMS.map((term) => `- ${CORE_MESSAGES[term]}`),
29124
+ "",
29103
29125
  CORE_MESSAGES[CoreMessage.StepAccountingTableHeader],
29104
29126
  "| --- | --- | --- | --- | --- | --- | --- | --- | --- |",
29105
29127
  ...jobRowsOf(accounting),
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "spec-controller",
3
- "version": "0.1.195",
3
+ "version": "0.1.197",
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.195"
29
+ "@3f-consulting/spec-controller-core": "0.1.197"
30
30
  },
31
31
  "publishConfig": {
32
32
  "access": "public"