@produtype/core 0.30.0 → 0.32.0

package/dist/analyzer/analyzeProject.js

@@ -556,9 +556,12 @@ async function analyzeProject(projectPath) {
         }
     }
     const npmDeps = {};
+    const runtimeNpmDeps = {};
     for (const workspace of workspaces) {
         mergeDeps(npmDeps, workspace.packageJson?.dependencies);
         mergeDeps(npmDeps, workspace.packageJson?.devDependencies);
+        // Kept apart for one question only: whether this repository serves requests.
+        mergeDeps(runtimeNpmDeps, workspace.packageJson?.dependencies);
     }
     /**
      * What the code imports, when nothing declared it.
@@ -606,6 +609,7 @@ async function analyzeProject(projectPath) {
     const ctx = {
         root,
         files: { all: allFiles, source: sourceFiles, config: configFiles, unreadable: unreadableLanguages(allFiles) },
+        runtimeNpmDeps,
         packageJson,
         pythonDeps,
         phpDeps: unique(phpDeps),

package/dist/analyzer/detectBackend.js

@@ -8,8 +8,20 @@ const catalogue_1 = require("./catalogue");
 async function detectBackend(ctx) {
     const frameworks = [];
     const evidence = [];
+    /**
+     * Shipped, not merely present.
+     *
+     * axios declares `express` in devDependencies to run a test server against itself,
+     * and was read as having a backend — which kept a library out of the `library`
+     * profile. A server framework the product does not ship with is a fixture. The
+     * fallback below still reads the source, so a project that runs Express without
+     * declaring it is found anyway.
+     *
+     * Not one repository in the local corpus declares a backend framework only in
+     * devDependencies, so this changes nothing there and fixes a public library.
+     */
     // Express
-    if ((0, detectContext_1.hasDep)(ctx, 'express')) {
+    if ((0, detectContext_1.hasRuntimeDep)(ctx, 'express')) {
         frameworks.push('express');
         evidence.push({ type: 'dependency', value: 'express' });
     }
@@ -30,7 +42,7 @@ async function detectBackend(ctx) {
     // frontend-only meant an application with server routes, sessions and database
     // access was scored as though it had none of them.
     for (const [framework, dep] of catalogue_1.NODE_BACKEND_FRAMEWORKS) {
-        if ((0, detectContext_1.hasDep)(ctx, dep)) {
+        if ((0, detectContext_1.hasRuntimeDep)(ctx, dep)) {
             frameworks.push(framework);
             evidence.push({ type: 'dependency', value: dep });
         }

package/dist/analyzer/detectContext.d.ts

@@ -38,9 +38,25 @@ export interface DetectContext {
     swiftDeps: string[];
     /** Lowercased combined dependency map (deps + devDeps). */
     npmDeps: Record<string, string>;
+    /**
+     * Dependencies the product ships with, without the ones it only builds and tests with.
+     *
+     * `npmDeps` merges both, which is right for almost every question — React in
+     * devDependencies still means React — and wrong for one: a server framework. axios
+     * declares `express` in devDependencies to run a test server, and was read as having
+     * a backend, which kept it out of the `library` profile it plainly belongs to.
+     */
+    runtimeNpmDeps: Record<string, string>;
     workspaces: WorkspaceManifest[];
 }
 export declare function hasDep(ctx: DetectContext, name: string): boolean;
+/**
+ * Declared as something the product runs on, not merely something present.
+ *
+ * Used for server frameworks only. A test server in devDependencies is a fixture; the
+ * question "does this repository serve requests" is answered by what it ships.
+ */
+export declare function hasRuntimeDep(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

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.hasDep = hasDep;
+exports.hasRuntimeDep = hasRuntimeDep;
 exports.hasAnyDep = hasAnyDep;
 exports.hasPyDep = hasPyDep;
 exports.hasAnyPyDep = hasAnyPyDep;
@@ -15,6 +16,15 @@ exports.hasAnyDotnetDep = hasAnyDotnetDep;
 function hasDep(ctx, name) {
     return Object.prototype.hasOwnProperty.call(ctx.npmDeps, name.toLowerCase());
 }
+/**
+ * Declared as something the product runs on, not merely something present.
+ *
+ * Used for server frameworks only. A test server in devDependencies is a fixture; the
+ * question "does this repository serve requests" is answered by what it ships.
+ */
+function hasRuntimeDep(ctx, name) {
+    return Object.prototype.hasOwnProperty.call(ctx.runtimeNpmDeps, 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,7 +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.
  *
@@ -30,8 +33,69 @@ const TEST_FILE = /(^|\/)(tests?|__tests__|spec)\/|\.(test|spec)\.[cm]?[jt]sx?$|
 function collect(files, pattern, limit = 3) {
     return files.filter((file) => pattern.test(file)).slice(0, limit);
 }
+/**
+ * Generators whose whole job is to build a documentation website.
+ *
+ * A package with a docs site in its repository was being read as whatever that site is
+ * built with. zod is a validation library and came back a client application; vite came
+ * back a client application; ruff — a linter written in Rust, with every packaging
+ * signal present — came back a static site, read from its React playground. Five public
+ * libraries out of five, all for this reason.
+ *
+ * The site that documents a product is not the product.
+ */
+const DOCS_GENERATORS = [
+    '@docusaurus/core', 'vitepress', 'nextra', '@astrojs/starlight', 'vuepress', 'docz',
+    'docsify-cli', 'mintlify', '@11ty/eleventy', 'mkdocs', 'mkdocs-material', 'sphinx',
+];
+/**
+ * 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.
+ */
+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;
+    /**
+     * Whether the front end in this repository is its documentation rather than its product.
+     *
+     * Two ways to know, and both have to be about the front end specifically. A docs
+     * generator in the dependencies says so outright. Failing that, every front-end file
+     * living under a directory named for documentation says the same thing more quietly —
+     * and *every* matters: one component under `examples/` beside an application is an
+     * example, while an application that is entirely under `examples/` does not exist.
+     */
+    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) => exports.DOCS_DIRECTORIES.test(file));
+    const documentationSite = docsGenerators.length > 0 || frontendAllInDocs;
     const licenseFiles = collect(all, LICENSE_FILE);
     const declaredLicense = typeof ctx.packageJson?.license === 'string';
     const licenseEvidence = [
@@ -70,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;
@@ -96,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 },
         },
         {
@@ -119,6 +215,21 @@ async function detectPackaging(ctx) {
             evidence: licenseEvidence,
             details: { files: licenseFiles.length, declared: declaredLicense },
         },
+        {
+            /**
+             * A site that documents the product, as distinct from the product.
+             *
+             * Its own detector rather than a flag on the stack, because it is evidence a
+             * reader can check: either a generator in the manifest or the directory every
+             * front-end file sits in.
+             */
+            key: 'docs.site',
+            present: documentationSite,
+            evidence: docsGenerators.length > 0
+                ? docsGenerators.map((dep) => ({ type: 'dependency', value: dep }))
+                : frontendFiles.slice(0, 5).map((file) => ({ type: 'file', value: file, file })),
+            details: { generators: docsGenerators, frontendFiles: frontendFiles.length, allUnderDocs: frontendAllInDocs },
+        },
         {
             key: 'docs.readme',
             present: readmeFiles.length > 0,

package/dist/expectations/profileSignals.d.ts

@@ -49,6 +49,22 @@ export interface ProfileFacts {
     gameEngine: boolean;
     /** A manifest that names and versions this, so something else can depend on it. */
     publishable: boolean;
+    /**
+     * The front end in this repository is its documentation, not its product.
+     *
+     * zod, axios, vite and ruff were all read from their docs sites: five public libraries
+     * out of five, none identified as a library. The site that documents a product is not
+     * 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;
@@ -28,6 +47,8 @@ function readFacts(analysis) {
         containerised: present('deployment.docker'),
         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'),
@@ -184,7 +205,18 @@ const RULES = [
          * project serves requests, and a package is not served.
          */
         profile: 'library',
-        admissible: (f) => f.publishable && f.entrypoints && !f.frontend && !f.backend && f.mobilePlatforms.length === 0,
+        /**
+         * A front end that is documentation does not make a package an application.
+         *
+         * The gate used to be "no front end at all", which is right for a plain package and
+         * wrong for every library with a docs site — which is to say, every library anybody
+         * has heard of. A backend still disqualifies: a package is not served.
+         */
+        admissible: (f) => f.publishable
+            && f.entrypoints
+            && (!f.frontend || f.documentationSite)
+            && !f.productBackend
+            && f.mobilePlatforms.length === 0,
         signals: [
             { identifies: true, label: 'a manifest that names and versions it', weight: 3, holds: (f) => f.publishable },
             { identifies: true, label: 'an entry point for something else to import', weight: 2, holds: (f) => f.entrypoints },

package/package.json

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