@produtype/core 0.31.0 → 0.33.1

package/README.md

@@ -174,7 +174,7 @@ prodkit plan ../my-app --output prodkit-plan.md
 
 _Generated from the analyzer itself — run `npm run docs:stacks` after changing a detector._
 
-- **Backend:** Express, Next.js, NestJS, Fastify, Hono, Elysia, Koa, AdonisJS, SvelteKit, Remix, Nuxt, Nitro, Astro, Django, Flask, FastAPI, Litestar, Sanic, Tornado, aiohttp, Starlette, Streamlit, Gradio, Dash, Chainlit, Gin, Echo, Fiber, chi, Gorilla, Beego, Go, Rails, Sinatra, Hanami, Roda, Grape, Ruby, Laravel, Symfony, Slim, CodeIgniter, CakePHP, Yii, PHP, ASP.NET Core, .NET
+- **Backend:** Express, Next.js, NestJS, Fastify, Hono, Elysia, Koa, AdonisJS, SvelteKit, Remix, Nuxt, Nitro, Astro, Django, Flask, FastAPI, aiohttp, Litestar, Sanic, Tornado, Starlette, Streamlit, Gradio, Dash, Chainlit, Gin, Echo, Fiber, chi, Gorilla, Beego, Go, Rails, Sinatra, Hanami, Roda, Grape, Ruby, Laravel, Symfony, Slim, CodeIgniter, CakePHP, Yii, PHP, ASP.NET Core, .NET
 - **Frontend:** React, Vite, Vue, Nuxt, Svelte, Angular, Astro, Solid, Qwik, Preact, Remix, htmx, Tailwind CSS, Electron
 - **Mobile:** Flutter, React Native, iOS (native), Android (native)
 - **Databases:** Postgres, MySQL, SQLite, SQL Server, MongoDB, Redis, Firestore, DynamoDB, Convex
@@ -188,6 +188,7 @@ How some of these are decided:
 - **Django** — manage.py, settings.py and urls.py together
 - **Flask** — the dependency, or an import in the source
 - **FastAPI** — the dependency, or an import in the source
+- **aiohttp** — aiohttp.web in the source — the dependency alone is a client
 - **Go** — a go.mod with no framework in it — net/http is a real answer
 - **Ruby** — a Gemfile with no web framework in it
 - **PHP** — PHP sources with no framework in composer.json

package/dist/analyzer/analyzeProject.js

@@ -87,7 +87,24 @@ function parseRequirements(text) {
 function normalizePyDepSpec(spec) {
     return spec.split(/[\s<>=!~;[(]/)[0].trim().toLowerCase();
 }
+/**
+ * What a Python package installs by default, and what it merely offers.
+ *
+ * `[project.optional-dependencies]` and `[dependency-groups]` are extras: a library that
+ * integrates with FastAPI declares it there, and nobody installing the library gets a
+ * web server. langchain and llama_index declare four web frameworks between them that
+ * way, and were read as web applications — costing langchain the `library` profile and
+ * earning it fifteen high findings about GDPR, billing and tenant isolation.
+ *
+ * Mirrors what `dependencies` and `devDependencies` already do for npm.
+ */
+function parsePyprojectRuntime(text) {
+    return parsePyprojectSections(text, true);
+}
 function parsePyproject(text) {
+    return parsePyprojectSections(text, false);
+}
+function parsePyprojectSections(text, runtimeOnly) {
     if (!text)
         return [];
     const deps = [];
@@ -105,8 +122,8 @@ function parsePyproject(text) {
         }
         // Poetry-style tables: each key of the section is a dependency name.
         const isPoetryDepsSection = section === 'tool.poetry.dependencies'
-            || section === 'tool.poetry.dev-dependencies'
-            || /^tool\.poetry\.group\.[^.]+\.dependencies$/.test(section);
+            || (!runtimeOnly && (section === 'tool.poetry.dev-dependencies'
+                || /^tool\.poetry\.group\.[^.]+\.dependencies$/.test(section)));
         if (isPoetryDepsSection) {
             const match = line.match(/^([A-Za-z0-9_.-]+)\s*=/);
             if (match && match[1].toLowerCase() !== 'python')
@@ -114,9 +131,10 @@ function parsePyproject(text) {
             continue;
         }
         // PEP 621 / uv style: dependency specs live inside string arrays.
-        const isDepArraySection = section === 'project.optional-dependencies'
-            || section === 'dependency-groups'
-            || section === 'tool.uv';
+        const isDepArraySection = !runtimeOnly
+            && (section === 'project.optional-dependencies'
+                || section === 'dependency-groups'
+                || section === 'tool.uv');
         if (section === 'project' || isDepArraySection || inDependencyArray) {
             if (line.includes('include-group'))
                 continue;
@@ -366,10 +384,16 @@ async function analyzeProject(projectPath) {
             requirementsDeps: parseRequirements(reqText),
             pyprojectPath: pyprojectFiles.includes(pyprojectPath) ? pyprojectPath : undefined,
             pyprojectDeps: parsePyproject(pyprojectText),
+            pyprojectRuntimeDeps: parsePyprojectRuntime(pyprojectText),
             lockfiles: wsLockfiles,
         });
     }
     const pythonDeps = unique(workspaces.flatMap((w) => [...w.requirementsDeps, ...w.pyprojectDeps]));
+    /**
+     * `requirements.txt` has no notion of an extra, so everything in it counts as shipped.
+     * Only pyproject distinguishes the two.
+     */
+    const runtimePythonDeps = unique(workspaces.flatMap((w) => [...w.requirementsDeps, ...w.pyprojectRuntimeDeps]));
     /**
      * Composer requirements. A published PHP application in the corpus reported a
      * backend of "unknown" because nothing read this file, while 57 source files sat
@@ -577,6 +601,14 @@ async function analyzeProject(projectPath) {
         const imported = await (0, importedDependencies_1.pythonImports)(root, sourceFiles);
         if (imported.length > 0) {
             pythonDeps.push(...imported);
+            /**
+             * An import is use, not an offer.
+             *
+             * These count as shipped as well as present. A repository with no manifest at all
+             * — one `main.py` that imports streamlit — declares nothing optional, and treating
+             * its imports as extras made a Streamlit application unreadable.
+             */
+            runtimePythonDeps.push(...imported);
             inferredDependencySources.push('Python imports');
         }
     }
@@ -610,6 +642,7 @@ async function analyzeProject(projectPath) {
         root,
         files: { all: allFiles, source: sourceFiles, config: configFiles, unreadable: unreadableLanguages(allFiles) },
         runtimeNpmDeps,
+        runtimePythonDeps,
         packageJson,
         pythonDeps,
         phpDeps: unique(phpDeps),

package/dist/analyzer/catalogue.js

@@ -69,7 +69,6 @@ exports.PYTHON_BACKEND_FRAMEWORKS = [
     ['litestar', 'litestar'],
     ['sanic', 'sanic'],
     ['tornado', 'tornado'],
-    ['aiohttp', 'aiohttp'],
     ['starlette', 'starlette'],
     /**
      * These serve an application over HTTP without calling themselves web frameworks,
@@ -248,6 +247,16 @@ function supportedStacks() {
             { id: 'django', label: 'Django', detectedFrom: 'manage.py, settings.py and urls.py together' },
             { id: 'flask', label: 'Flask', detectedFrom: 'the dependency, or an import in the source' },
             { id: 'fastapi', label: 'FastAPI', detectedFrom: 'the dependency, or an import in the source' },
+            {
+                id: 'aiohttp',
+                label: 'aiohttp',
+                /**
+                 * Listed separately because the dependency alone does not settle it: aiohttp is
+                 * a client as often as a server, and thousands of packages depend on it to make
+                 * requests. `aiohttp.web` is what says it is being served.
+                 */
+                detectedFrom: 'aiohttp.web in the source — the dependency alone is a client',
+            },
             ...entries(exports.PYTHON_BACKEND_FRAMEWORKS.map(([id]) => id)),
             ...entries(exports.GO_BACKEND_FRAMEWORKS.map(([id]) => id)),
             { id: 'go', label: 'Go', detectedFrom: 'a go.mod with no framework in it — net/http is a real answer' },

package/dist/analyzer/detectBackend.js

@@ -150,14 +150,40 @@ async function detectBackend(ctx) {
     }
     // Python backend frameworks detected purely from dependencies. Django, Flask and
     // FastAPI have their own blocks below because each also has a source-level fallback.
+    /**
+     * Shipped, not offered as an extra — the Python half of the same rule.
+     *
+     * llama_index declares tornado, starlette, flask and fastapi among its optional
+     * integrations, and was read as running all four.
+     */
     for (const [framework, dep] of catalogue_1.PYTHON_BACKEND_FRAMEWORKS) {
-        if ((0, detectContext_1.hasPyDep)(ctx, dep)) {
+        if ((0, detectContext_1.hasRuntimePyDep)(ctx, dep)) {
             frameworks.push(framework);
             evidence.push({ type: 'dependency', value: dep });
         }
     }
+    /**
+     * aiohttp is a client as often as it is a server.
+     *
+     * Thousands of packages depend on it to make HTTP requests; langchain is one, and was
+     * read as having a backend because of it — which cost it the `library` profile and
+     * earned it fifteen high findings about GDPR, billing and tenant isolation. The
+     * dependency says the library is present. Only `aiohttp.web` says it is being served.
+     *
+     * The source alone is enough, as elsewhere: a project that serves without declaring
+     * the dependency is still serving.
+     */
+    if ((0, detectContext_1.hasRuntimePyDep)(ctx, 'aiohttp')) {
+        const serving = await (0, textSearch_1.searchInFiles)(ctx.root, ctx.files.source.filter((file) => /\.py$/.test(file)), [/aiohttp\.web/, /web\.Application\(/, /web\.RouteTableDef/, /from aiohttp import web/], 3);
+        if (serving.length) {
+            frameworks.push('aiohttp');
+            for (const match of serving) {
+                evidence.push({ type: 'snippet', value: match.snippet, file: match.file, line: match.line });
+            }
+        }
+    }
     // Flask
-    if ((0, detectContext_1.hasPyDep)(ctx, 'flask')) {
+    if ((0, detectContext_1.hasRuntimePyDep)(ctx, 'flask')) {
         frameworks.push('flask');
         evidence.push({ type: 'dependency', value: 'flask' });
     }
@@ -171,7 +197,7 @@ async function detectBackend(ctx) {
         }
     }
     // FastAPI
-    if ((0, detectContext_1.hasPyDep)(ctx, 'fastapi')) {
+    if ((0, detectContext_1.hasRuntimePyDep)(ctx, 'fastapi')) {
         frameworks.push('fastapi');
         evidence.push({ type: 'dependency', value: 'fastapi' });
     }
@@ -192,7 +218,7 @@ async function detectBackend(ctx) {
     const settingsFile = ctx.files.all.find((f) => f.endsWith('settings.py'));
     if (settingsFile)
         djangoSignals.push({ type: 'file', value: settingsFile });
-    if ((0, detectContext_1.hasPyDep)(ctx, 'django'))
+    if ((0, detectContext_1.hasRuntimePyDep)(ctx, 'django'))
         djangoSignals.push({ type: 'dependency', value: 'django' });
     if (ctx.files.all.some((f) => f.endsWith('urls.py'))) {
         djangoSignals.push({ type: 'file', value: ctx.files.all.find((f) => f.endsWith('urls.py')) });

package/dist/analyzer/detectContext.d.ts

@@ -7,6 +7,8 @@ export interface WorkspaceManifest {
     requirementsDeps: string[];
     pyprojectPath?: string;
     pyprojectDeps: string[];
+    /** Of those, the ones installed by default rather than offered as an extra. */
+    pyprojectRuntimeDeps: string[];
     lockfiles: string[];
 }
 export interface DetectContext {
@@ -47,6 +49,14 @@ export interface DetectContext {
      * a backend, which kept it out of the `library` profile it plainly belongs to.
      */
     runtimeNpmDeps: Record<string, string>;
+    /**
+     * Python packages installed by default, without the extras.
+     *
+     * A library that integrates with FastAPI declares it under
+     * `[project.optional-dependencies]`, and nobody installing the library gets a web
+     * server. Used for the same single question as `runtimeNpmDeps`.
+     */
+    runtimePythonDeps: string[];
     workspaces: WorkspaceManifest[];
 }
 export declare function hasDep(ctx: DetectContext, name: string): boolean;
@@ -57,6 +67,8 @@ export declare function hasDep(ctx: DetectContext, name: string): boolean;
  * question "does this repository serve requests" is answered by what it ships.
  */
 export declare function hasRuntimeDep(ctx: DetectContext, name: string): boolean;
+/** The Python counterpart: shipped, not merely offered as an extra. */
+export declare function hasRuntimePyDep(ctx: DetectContext, name: string): boolean;
 export declare function hasAnyDep(ctx: DetectContext, names: string[]): string[];
 export declare function hasPyDep(ctx: DetectContext, name: string): boolean;
 export declare function hasAnyPyDep(ctx: DetectContext, names: string[]): string[];

package/dist/analyzer/detectContext.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.hasDep = hasDep;
 exports.hasRuntimeDep = hasRuntimeDep;
+exports.hasRuntimePyDep = hasRuntimePyDep;
 exports.hasAnyDep = hasAnyDep;
 exports.hasPyDep = hasPyDep;
 exports.hasAnyPyDep = hasAnyPyDep;
@@ -25,6 +26,10 @@ function hasDep(ctx, name) {
 function hasRuntimeDep(ctx, name) {
     return Object.prototype.hasOwnProperty.call(ctx.runtimeNpmDeps, name.toLowerCase());
 }
+/** The Python counterpart: shipped, not merely offered as an extra. */
+function hasRuntimePyDep(ctx, name) {
+    return ctx.runtimePythonDeps.includes(name.toLowerCase());
+}
 function hasAnyDep(ctx, names) {
     return names.filter((n) => hasDep(ctx, n));
 }

package/dist/analyzer/detectPackaging.d.ts

@@ -1,3 +1,13 @@
 import type { DetectorResult } from './types';
 import type { DetectContext } from './detectContext';
+/**
+ * Where a documentation site lives when it has no generator of its own.
+ *
+ * A hand-built docs site or a playground sits in a directory named for what it is. This
+ * is only consulted for the front-end files: a `docs/` folder full of Markdown says
+ * nothing either way, and a repository whose application happens to live under `www/`
+ * is not caught because the question asked is whether *every* front-end file is in one
+ * of these.
+ */
+export declare const DOCS_DIRECTORIES: RegExp;
 export declare function detectPackaging(ctx: DetectContext): Promise<DetectorResult[]>;

package/dist/analyzer/detectPackaging.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DOCS_DIRECTORIES = void 0;
 exports.detectPackaging = detectPackaging;
 const readTextFileSafe_1 = require("../utils/readTextFileSafe");
 const detectContext_1 = require("./detectContext");
+const readTextFileSafe_2 = require("../utils/readTextFileSafe");
 /**
  * Whether a project is fit to be installed and depended on by someone else.
  *
@@ -55,8 +57,29 @@ const DOCS_GENERATORS = [
  * is not caught because the question asked is whether *every* front-end file is in one
  * of these.
  */
-const DOCS_DIRECTORIES = /^(docs?|website|playground|examples?|demo|www)\//i;
+exports.DOCS_DIRECTORIES = /(^|\/)(docs?|website|playground|examples?|demo|www)\//i;
 const FRONTEND_FILE = /\.(tsx|jsx|vue|svelte|astro)$/;
+/**
+ * The published package inside a workspace, if there is one.
+ *
+ * Named, versioned, not private — the three things npm requires to accept a publish.
+ * A workspace full of private example applications has none, and gets the honest answer
+ * that nothing here is published.
+ */
+async function findPublishedMember(ctx) {
+    const members = ctx.files.all
+        .filter((file) => /(^|\/)package\.json$/.test(file) && file !== 'package.json')
+        .slice(0, 60);
+    for (const file of members) {
+        const manifest = await (0, readTextFileSafe_2.readJsonSafe)(ctx.root, file);
+        if (!manifest)
+            continue;
+        const named = typeof manifest.name === 'string' && typeof manifest.version === 'string';
+        if (named && manifest.private !== true)
+            return { path: file, manifest };
+    }
+    return null;
+}
 async function detectPackaging(ctx) {
     const all = ctx.files.all;
     /**
@@ -71,7 +94,7 @@ async function detectPackaging(ctx) {
     const docsGenerators = [...(0, detectContext_1.hasAnyDep)(ctx, DOCS_GENERATORS), ...(0, detectContext_1.hasAnyPyDep)(ctx, DOCS_GENERATORS)];
     const frontendFiles = ctx.files.source.filter((file) => FRONTEND_FILE.test(file));
     const frontendAllInDocs = frontendFiles.length > 0
-        && frontendFiles.every((file) => DOCS_DIRECTORIES.test(file));
+        && frontendFiles.every((file) => exports.DOCS_DIRECTORIES.test(file));
     const documentationSite = docsGenerators.length > 0 || frontendAllInDocs;
     const licenseFiles = collect(all, LICENSE_FILE);
     const declaredLicense = typeof ctx.packageJson?.license === 'string';
@@ -111,7 +134,33 @@ async function detectPackaging(ctx) {
      * it starts; `types` is how a TypeScript consumer finds it. A Python package says the
      * same thing through `[project.scripts]` or a `packages` argument in setup.py.
      */
-    const pkg = (ctx.packageJson ?? {});
+    const rootPkg = (ctx.packageJson ?? {});
+    /**
+     * In a monorepo the root manifest is not the package.
+     *
+     * zod's root is `private: true` with `workspaces: ["packages/*"]`, no name, no version
+     * and no entry point; `zod` itself is `packages/zod/package.json`, named, versioned
+     * and exported. Reading only the root made the most downloaded validation library on
+     * npm a repository that publishes nothing — and vite the same.
+     *
+     * The published package is looked for among the members, and the first one that is
+     * named, versioned and not private is what this repository ships. Its manifest is
+     * what the evidence points at, so a reader can open the file the claim rests on rather
+     * than a root that says nothing.
+     */
+    /**
+     * Three ways to say the same thing.
+     *
+     * npm and yarn declare workspaces inside `package.json`; pnpm puts them in
+     * `pnpm-workspace.yaml`. Reading only the first meant vite — whose root has no
+     * `workspaces` field at all — was never looked into, and came back as a repository
+     * that publishes nothing.
+     */
+    const workspaceRoot = Array.isArray(rootPkg.workspaces)
+        || (typeof rootPkg.workspaces === 'object' && rootPkg.workspaces !== null)
+        || all.some((file) => /^(pnpm-workspace\.yaml|lerna\.json|nx\.json|turbo\.json)$/.test(file));
+    const publishedMember = workspaceRoot ? await findPublishedMember(ctx) : null;
+    const pkg = publishedMember?.manifest ?? rootPkg;
     const nodeEntrypoints = ['main', 'module', 'exports', 'bin'].filter((key) => pkg[key] !== undefined);
     const hasTypes = pkg.types !== undefined || pkg.typings !== undefined;
     const isPrivate = pkg.private === true;
@@ -137,7 +186,13 @@ async function detectPackaging(ctx) {
             key: 'packaging.manifest',
             present: hasManifest,
             complete: hasManifest && (named || pythonEntrypoints),
-            evidence: hasManifest ? [{ type: 'note', value: named ? 'a manifest with a name and a version' : 'a package manifest' }] : [],
+            evidence: hasManifest
+                ? [
+                    publishedMember
+                        ? { type: 'file', value: `${publishedMember.path} names and versions the published package`, file: publishedMember.path }
+                        : { type: 'note', value: named ? 'a manifest with a name and a version' : 'a package manifest' },
+                ]
+                : [],
             details: { named, described, sourced, private: isPrivate },
         },
         {

package/dist/expectations/profileSignals.d.ts

@@ -57,6 +57,14 @@ export interface ProfileFacts {
      * the product.
      */
     documentationSite: boolean;
+    /**
+     * A server the product ships, as distinct from one its documentation or playgrounds run.
+     *
+     * zod's only workspace with a backend is `packages/docs`. vite's are ten directories
+     * under `playground/`. Both were excluded from the `library` profile by a backend
+     * neither of them ships.
+     */
+    productBackend: boolean;
     /** Somewhere for a consumer to import: main, module, exports, bin, a console script. */
     entrypoints: boolean;
     packagedLicense: boolean;

package/dist/expectations/profileSignals.js

@@ -2,6 +2,25 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.readFacts = readFacts;
 exports.scoreProfiles = scoreProfiles;
+const detectPackaging_1 = require("../analyzer/detectPackaging");
+/**
+ * Whether any backend in this repository belongs to the product.
+ *
+ * A workspace under `docs/`, `playground/` or `examples/` that runs a server is running
+ * it to demonstrate or test something. vite has ten such workspaces, every one of them
+ * an Express server, and none of them vite.
+ *
+ * Where no workspace declares a backend but the repository does, the signal came from
+ * the root and belongs to the product: there is nowhere else for it to come from.
+ */
+function hasProductBackend(analysis) {
+    if (analysis.stack.backend.length === 0)
+        return false;
+    const withBackend = analysis.workspaceStacks.filter((workspace) => workspace.backend.length > 0);
+    if (withBackend.length === 0)
+        return true;
+    return withBackend.some((workspace) => !detectPackaging_1.DOCS_DIRECTORIES.test(`${workspace.root}/`));
+}
 function readFacts(analysis) {
     const sourceHints = analysis.files.source.join('\n');
     const present = (key) => analysis.detectors[key]?.present === true;
@@ -29,6 +48,7 @@ function readFacts(analysis) {
         gameEngine: present('game.engine'),
         publishable: complete('packaging.manifest'),
         documentationSite: present('docs.site'),
+        productBackend: hasProductBackend(analysis),
         entrypoints: present('packaging.entrypoints'),
         packagedLicense: present('packaging.license'),
         tests: present('quality.tests'),
@@ -195,7 +215,7 @@ const RULES = [
         admissible: (f) => f.publishable
             && f.entrypoints
             && (!f.frontend || f.documentationSite)
-            && !f.backend
+            && !f.productBackend
             && f.mobilePlatforms.length === 0,
         signals: [
             { identifies: true, label: 'a manifest that names and versions it', weight: 3, holds: (f) => f.publishable },

package/package.json

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