@produtype/core 1.1.1 → 1.2.0

package/dist/cli.js

@@ -47,6 +47,7 @@ const markdownPlan_1 = require("./planner/markdownPlan");
 const jsonPlan_1 = require("./planner/jsonPlan");
 const pathUtils_1 = require("./utils/pathUtils");
 const version_1 = require("./version");
+const backendOrigin_1 = require("./report/backendOrigin");
 /**
  * The profiles this tool actually has, read from the same table the analyzer uses.
  *
@@ -130,7 +131,7 @@ function summarize(report) {
         'ProdKit Analysis Summary',
         `Project: ${report.projectPath}`,
         `Detected frontend: ${report.detectedStack.frontend.join(', ') || 'unknown'}`,
-        `Detected backend: ${report.detectedStack.backend.join(', ') || 'unknown'}`,
+        `Detected backend: ${report.detectedStack.backend.join(', ') || 'unknown'}${(0, backendOrigin_1.backendOrigin)(report.detectedStack) ? ` (${(0, backendOrigin_1.backendOrigin)(report.detectedStack)})` : ''}`,
         `Detected databases: ${report.detectedStack.databases.join(', ') || 'unknown'}`,
         // Named on their own line rather than folded into the databases list. A reader
         // whose data layer is entirely Supabase needs to see that the tool recognised

package/dist/report/backendOrigin.d.ts

@@ -0,0 +1,18 @@
+import type { StackInfo } from '../analyzer/types';
+/**
+ * Where a backend lives, when it does not live in the product.
+ *
+ * marktext is an Electron editor and its report said "Detected backend: next". The
+ * Next application is `packages/website`, its marketing site. yaak is a Tauri client
+ * and said `hono`, which is a plugin in `plugins-external/`.
+ *
+ * Dropping those from the stack was tried and refused: a test holds the decision that
+ * the servers are really there and are merely not the product's, and that decision has
+ * its reasoning written down. What misleads is not the list — it is the sentence, which
+ * names a framework and says nothing about whose it is.
+ *
+ * So the sentence says. Only when *every* workspace with a backend is a documentation,
+ * playground or example directory: a repository with a real server beside its docs site
+ * has a backend of its own, and gets no annotation.
+ */
+export declare function backendOrigin(stack: StackInfo): string | undefined;

package/dist/report/backendOrigin.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.backendOrigin = backendOrigin;
+const detectPackaging_1 = require("../analyzer/detectPackaging");
+/**
+ * Where a backend lives, when it does not live in the product.
+ *
+ * marktext is an Electron editor and its report said "Detected backend: next". The
+ * Next application is `packages/website`, its marketing site. yaak is a Tauri client
+ * and said `hono`, which is a plugin in `plugins-external/`.
+ *
+ * Dropping those from the stack was tried and refused: a test holds the decision that
+ * the servers are really there and are merely not the product's, and that decision has
+ * its reasoning written down. What misleads is not the list — it is the sentence, which
+ * names a framework and says nothing about whose it is.
+ *
+ * So the sentence says. Only when *every* workspace with a backend is a documentation,
+ * playground or example directory: a repository with a real server beside its docs site
+ * has a backend of its own, and gets no annotation.
+ */
+function backendOrigin(stack) {
+    if (stack.backend.length === 0)
+        return undefined;
+    const withBackend = stack.workspaces.filter((workspace) => workspace.backend.length > 0);
+    if (withBackend.length === 0)
+        return undefined;
+    if (withBackend.some((workspace) => !detectPackaging_1.DOCS_DIRECTORIES.test(`${workspace.root}/`)))
+        return undefined;
+    const roots = [...new Set(withBackend.map((workspace) => workspace.root))];
+    return `in ${roots.join(', ')} — documentation or examples, not the product itself`;
+}

package/dist/report/markdownReport.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.renderMarkdown = renderMarkdown;
 const readingDepth_1 = require("../analyzer/readingDepth");
+const backendOrigin_1 = require("./backendOrigin");
 function profileSummary(report) {
     const profile = report.productProfile;
     if (!profile) {
@@ -232,7 +233,7 @@ function renderMarkdown(report) {
         '## Detected Stack',
         '',
         `- Frontend: ${report.detectedStack.frontend.join(', ') || 'unknown'}`,
-        `- Backend: ${report.detectedStack.backend.join(', ') || 'unknown'}`,
+        `- Backend: ${report.detectedStack.backend.join(', ') || 'unknown'}${originNote(report)}`,
         `- Databases: ${report.detectedStack.databases.join(', ') || 'unknown'}`,
         `- Languages: ${report.detectedStack.languages.join(', ') || 'unknown'}`,
         `- Package manager: ${report.detectedStack.packageManager}`,
@@ -309,3 +310,8 @@ function renderMarkdown(report) {
         appendix,
     ].join('\n');
 }
+/** The parenthetical that says whose backend it is, or nothing. */
+function originNote(report) {
+    const origin = (0, backendOrigin_1.backendOrigin)(report.detectedStack);
+    return origin ? ` (${origin})` : '';
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@produtype/core",
-  "version": "1.1.1",
+  "version": "1.2.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": {