@produtype/core 0.69.0 → 0.71.0

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, aiohttp, Litestar, Sanic, Tornado, Starlette, Streamlit, Gradio, Dash, Chainlit, Gin, Echo, Fiber, chi, Gorilla, Beego, Go, Axum, Actix Web, Rocket, Warp, Tide, Poem, Salvo, Tower HTTP, Spring Boot, Quarkus, Micronaut, Ktor, Javalin, Vert.x, Dropwizard, Helidon, 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, Axum, Actix Web, Rocket, Warp, Tide, Poem, Salvo, Tower HTTP, Hyper, Spring Boot, Quarkus, Micronaut, Ktor, Javalin, Vert.x, Dropwizard, Helidon, 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

package/dist/analyzer/blockComments.d.ts

@@ -0,0 +1,21 @@
+/**
+ * The lines of a C-family file that sit inside a block comment.
+ *
+ * The comment rule reads one line at a time and looks for a marker at its start:
+ * a double slash, a slash-star, a lone star. A block comment written without a
+ * leading star on every line has no marker to find, and neither does code that
+ * somebody commented out by wrapping the whole thing. In AsteroidsJS a wrapped
+ * `localStorage.setItem('highScores', ...)` was cited as evidence that the game
+ * saves progress; the function it belongs to is switched off.
+ *
+ * It is the same defect the Python docstrings had, in the languages where the marker
+ * usually is there and sometimes is not.
+ *
+ * Counting the delimiters is not enough, and measuring that was the point. A first
+ * pass said 135 citations across the corpus, and the second example it offered was
+ * live code: a glob like star-star-slash-star-dot-ts, and a slash-star inside a
+ * shader string, both look like an opening. So this walks the file properly —
+ * through single quotes, double quotes, template literals and line comments — and
+ * only then decides.
+ */
+export declare function blockCommentLines(file: string, text: string): Set<number>;

package/dist/analyzer/blockComments.js

@@ -0,0 +1,91 @@
+"use strict";
+/**
+ * The lines of a C-family file that sit inside a block comment.
+ *
+ * The comment rule reads one line at a time and looks for a marker at its start:
+ * a double slash, a slash-star, a lone star. A block comment written without a
+ * leading star on every line has no marker to find, and neither does code that
+ * somebody commented out by wrapping the whole thing. In AsteroidsJS a wrapped
+ * `localStorage.setItem('highScores', ...)` was cited as evidence that the game
+ * saves progress; the function it belongs to is switched off.
+ *
+ * It is the same defect the Python docstrings had, in the languages where the marker
+ * usually is there and sometimes is not.
+ *
+ * Counting the delimiters is not enough, and measuring that was the point. A first
+ * pass said 135 citations across the corpus, and the second example it offered was
+ * live code: a glob like star-star-slash-star-dot-ts, and a slash-star inside a
+ * shader string, both look like an opening. So this walks the file properly —
+ * through single quotes, double quotes, template literals and line comments — and
+ * only then decides.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.blockCommentLines = blockCommentLines;
+const C_FAMILY = /\.(ts|tsx|js|jsx|mjs|cjs|go|java|cs|rs|php|scala|kt|swift|c|cc|cpp|h)$/i;
+function blockCommentLines(file, text) {
+    const inside = new Set();
+    if (!C_FAMILY.test(file))
+        return inside;
+    if (!text.includes('/*'))
+        return inside;
+    let line = 1;
+    let state = 'code';
+    let escaped = false;
+    for (let i = 0; i < text.length; i++) {
+        const character = text[i];
+        const next = text[i + 1];
+        if (character === '\n') {
+            line++;
+            if (state === 'line-comment')
+                state = 'code';
+            if (state === 'single' || state === 'double')
+                state = 'code';
+            if (state === 'block-comment')
+                inside.add(line);
+            escaped = false;
+            continue;
+        }
+        if (escaped) {
+            escaped = false;
+            continue;
+        }
+        switch (state) {
+            case 'code':
+                if (character === '/' && next === '/') {
+                    state = 'line-comment';
+                    i++;
+                }
+                else if (character === '/' && next === '*') {
+                    state = 'block-comment';
+                    i++;
+                }
+                else if (character === "'")
+                    state = 'single';
+                else if (character === '"')
+                    state = 'double';
+                else if (character === '`')
+                    state = 'template';
+                break;
+            case 'block-comment':
+                if (character === '*' && next === '/') {
+                    state = 'code';
+                    i++;
+                }
+                break;
+            case 'single':
+            case 'double':
+            case 'template':
+                if (character === '\\')
+                    escaped = true;
+                else if ((state === 'single' && character === "'")
+                    || (state === 'double' && character === '"')
+                    || (state === 'template' && character === '`')) {
+                    state = 'code';
+                }
+                break;
+            default:
+                break;
+        }
+    }
+    return inside;
+}

package/dist/analyzer/catalogue.js

@@ -59,6 +59,8 @@ exports.RUST_BACKEND_FRAMEWORKS = [
     ['poem', ['poem']],
     ['salvo', ['salvo']],
     ['tower-http', ['tower-http']],
+    // What a Rust service uses when it uses no framework: the HTTP layer itself.
+    ['hyper', ['hyper']],
 ];
 /**
  * JVM frameworks, read from pom.xml and build.gradle alike.
@@ -211,6 +213,7 @@ const LABELS = {
     poem: 'Poem',
     salvo: 'Salvo',
     'tower-http': 'Tower HTTP',
+    hyper: 'Hyper',
     rust: 'Rust',
     rails: 'Rails',
     sinatra: 'Sinatra',

package/dist/analyzer/detectBackend.js

@@ -109,24 +109,28 @@ async function detectBackend(ctx) {
             evidence.push({ type: 'dependency', value: dep });
     }
     /** Rust, read from Cargo.toml. */
-    let namedRustFramework = false;
     for (const [framework, deps] of catalogue_1.RUST_BACKEND_FRAMEWORKS) {
         const hits = (0, detectContext_1.hasAnyRuntimeRustDep)(ctx, deps);
         if (!hits.length)
             continue;
-        namedRustFramework = true;
         frameworks.push(framework);
         for (const dep of hits)
             evidence.push({ type: 'dependency', value: dep });
     }
-    // Same reasoning as Go: a crate that serves requests from the standard library and a
-    // hand-rolled loop is still a backend, and a Cargo.toml alone is not.
-    if (!namedRustFramework
-        && languageShare(ctx, /\.rs$/) >= MINIMUM_BACKEND_SHARE
-        && ctx.files.all.some((f) => /(^|\/)Cargo\.toml$/.test(f))) {
-        frameworks.push('rust');
-        evidence.push({ type: 'note', value: 'a Cargo manifest with no web framework named in it' });
-    }
+    /**
+     * No fallback for Rust, and removing it is a correction of my own over-reach.
+     *
+     * This was written to mirror Go's, whose justification is that plenty of production
+     * services use `net/http` and nothing else. Rust's standard library has no HTTP
+     * server at all, so the mirror does not hold: a crate with no web framework is
+     * overwhelmingly a library, a parser or a command-line tool.
+     *
+     * ruff is the measurement. A linter with `Cargo.toml` at its root reported
+     * `backend: rust`, and "a backend disqualifies a library" then profiled it as a
+     * client application — so teaching this analyzer to read Rust made it worse at
+     * reading the best-known Rust project in the corpus. `hyper` joins the framework
+     * list instead: it is what a Rust service uses when it uses no framework.
+     */
     /** Ruby, read from the Gemfile. */
     let namedRubyFramework = false;
     for (const [framework, deps] of catalogue_1.RUBY_BACKEND_FRAMEWORKS) {

package/dist/utils/textSearch.js

@@ -7,6 +7,7 @@ exports.anyIncludes = anyIncludes;
 const readTextFileSafe_1 = require("./readTextFileSafe");
 const developmentOnly_1 = require("../analyzer/developmentOnly");
 const proseLines_1 = require("../analyzer/proseLines");
+const blockComments_1 = require("../analyzer/blockComments");
 /**
  * A line that declares a pattern rather than doing anything.
  *
@@ -106,9 +107,11 @@ function matchLines(text, needles, file = '') {
     const testOnly = (0, developmentOnly_1.testOnlyLines)(file, text);
     /** A Python docstring is prose with no line marker to recognise it by. */
     const prose = (0, proseLines_1.proseLines)(file, text);
+    /** Code somebody switched off by wrapping it, which has no marker on its lines. */
+    const commented = (0, blockComments_1.blockCommentLines)(file, text);
     for (let i = 0; i < lines.length; i++) {
         const line = lines[i];
-        if (testOnly.has(i + 1) || prose.has(i + 1))
+        if (testOnly.has(i + 1) || prose.has(i + 1) || commented.has(i + 1))
             continue;
         if (line.length > MAX_CITABLE_LINE)
             continue;
@@ -139,9 +142,10 @@ async function searchInFiles(root, files, needles, limit = 25) {
         const lines = text.split(/\r?\n/);
         const testOnly = (0, developmentOnly_1.testOnlyLines)(file, text);
         const prose = (0, proseLines_1.proseLines)(file, text);
+        const commented = (0, blockComments_1.blockCommentLines)(file, text);
         for (let i = 0; i < lines.length; i++) {
             const line = lines[i];
-            if (testOnly.has(i + 1) || prose.has(i + 1))
+            if (testOnly.has(i + 1) || prose.has(i + 1) || commented.has(i + 1))
                 continue;
             if (line.length > MAX_CITABLE_LINE)
                 continue;

package/package.json

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