@produtype/core 0.54.0 → 0.56.0

package/dist/planner/buildPlan.js

@@ -167,9 +167,18 @@ function sortStates(states) {
     }
     return ordered;
 }
-function summarizePlan(tasks, actionableFindingCount) {
+function summarizePlan(tasks, actionableFindingCount, inconclusive) {
     if (tasks.length === 0) {
-        return 'ProdKit found no actionable remediation tasks from the current deterministic findings.';
+        /**
+         * An empty plan means two different things and said one sentence for both.
+         *
+         * "Found no actionable remediation tasks" reads as "there is nothing to do". On a
+         * repository this analyzer could not read, there is nothing to do *because it
+         * could not look* — and that is the opposite advice.
+         */
+        return inconclusive
+            ? 'No plan: too little of this repository could be read to say what it needs.'
+            : 'ProdKit found no actionable remediation tasks from the current deterministic findings.';
     }
     const quickWins = tasks.filter((task) => task.effort === 'small' && (task.risk === 'low' || task.risk === 'medium')).length;
     const highRisk = tasks.filter((task) => task.risk === 'high').length;
@@ -234,7 +243,7 @@ function buildPlan(report) {
         generatedAt: new Date().toISOString(),
         score: report.overallScore,
         maturityLevel: report.maturityLevel,
-        summary: summarizePlan(tasks, actionableFindings.length),
+        summary: summarizePlan(tasks, actionableFindings.length, report.inconclusive),
         phases,
         tasks,
         quickWins,

package/dist/report/categoryScores.d.ts

@@ -17,6 +17,8 @@ export interface CategoryScore {
     assessedCount: number;
     criticalCount: number;
     highCount: number;
+    /** Checks in this category that reached no verdict. */
+    unknownCount: number;
     /** True when nothing in the analysis touched this category, so the score is not evidence of health. */
     notAssessed: boolean;
 }

package/dist/report/categoryScores.js

@@ -112,6 +112,14 @@ function buildCategoryScores(findings) {
             verifiedCount: assessed.filter((finding) => finding.status === 'passed').length,
             /** Checks in this category that reached a verdict either way. */
             assessedCount: assessed.length,
+            /**
+             * Checks in this category that did not.
+             *
+             * "Taking payments: 1 check verified, nothing outstanding" appeared under "what
+             * already works" on the strength of one check out of eleven in that category.
+             * The count that stops the misreading is the one that was missing.
+             */
+            unknownCount: categoryFindings.filter((finding) => finding.status === 'unknown').length,
             criticalCount: actionable.filter((finding) => finding.severity === 'critical').length,
             highCount: actionable.filter((finding) => finding.severity === 'high').length,
             /**

package/dist/report/executiveSummary.js

@@ -66,8 +66,26 @@ const DAYS_BY_SEVERITY = {
     low: 0.5,
     info: 0,
 };
-function estimateEffort(findings, profile) {
-    if (!profile)
+function estimateEffort(findings, profile, inconclusive) {
+    /**
+     * "Nothing outstanding to estimate" is a claim about the work, and a report that
+     * could not read the repository has no basis for it.
+     *
+     * A Python transcription script whose verdict says "ProdKit could not judge this
+     * project" was told there was nothing to do. It is the last number in the report and
+     * the same mistake as all the others: an empty list of findings read as an empty
+     * list of problems.
+     */
+    if (inconclusive)
+        return 'Not estimated: too little of this repository could be read.';
+    /**
+     * The inconclusive-inference profile is no profile.
+     *
+     * It carries an empty capability set, so estimating against it measures the observed
+     * findings and calls the answer an estimate of the gap. The sentence for having no
+     * profile already exists and is the true one.
+     */
+    if (!profile || profile.selectedProfile === 'auto')
         return 'Not estimated without a product profile.';
     const open = findings.filter((f) => f.status !== 'passed' && f.status !== 'unknown');
     if (open.length === 0)
@@ -211,7 +229,22 @@ function buildStrengths(categoryScores, findings) {
     const strengths = strongCategories.slice(0, 3).map((entry) => {
         const label = CATEGORY_LABEL[entry.category];
         const checks = entry.verifiedCount === 1 ? '1 check' : `${entry.verifiedCount} checks`;
-        return `${label}: ${checks} verified, nothing outstanding`;
+        /**
+         * The coverage, not a claim of completeness.
+         *
+         * "Taking payments: 1 check verified, nothing outstanding" told a reader their
+         * billing was in good shape on the strength of one check. Forty-nine of ninety
+         * strengths across the verification corpus read that way. "Nothing outstanding"
+         * means "no finding among the checks that ran", and in a category where one check
+         * ran and ten did not, that is a sentence about this analyzer rather than about
+         * the product.
+         *
+         * Saying how many did not run is what stops the misreading, and it costs four
+         * words.
+         */
+        return entry.unknownCount > 0
+            ? `${label}: ${checks} verified, ${entry.unknownCount} not assessed`
+            : `${label}: ${checks} verified`;
     });
     if (strengths.length === 0 && passed.length > 0) {
         strengths.push(`${passed.length} individual ${passed.length === 1 ? 'check' : 'checks'} already pass`);
@@ -250,7 +283,7 @@ function buildExecutiveSummary(args) {
          * the same praise.
          */
         strengths: args.inconclusive ? [] : buildStrengths(args.categoryScores, args.findings),
-        estimatedEffort: estimateEffort(args.findings, args.profile),
+        estimatedEffort: estimateEffort(args.findings, args.profile, args.inconclusive),
         scoreExplanation,
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@produtype/core",
-  "version": "0.54.0",
+  "version": "0.56.0",
   "description": "Deterministic CLI and library that analyzes a web application repository and reports how far it is from production-ready for the kind of product it is meant to be.",
   "license": "MIT",
   "bin": {