@shortlink-org/portolan 0.2.0 → 0.2.1

package/package.json

@@ -2,7 +2,7 @@
   "name": "@shortlink-org/portolan",
   "description": "Generate a navigable architecture catalog from code and specifications.",
   "private": false,
-  "version": "0.2.0",
+  "version": "0.2.1",
   "type": "module",
   "license": "MIT",
   "homepage": "https://github.com/shortlink-org/portolan#readme",

package/scripts/local-api.mjs

@@ -18,7 +18,6 @@ import { tmpdir } from "node:os";
 import { createServer as createNetServer } from "node:net";
 import { basename, dirname, join, posix, relative, resolve, sep } from "node:path";
 
-import { publicSetupFrom } from "../src/lib/setup-info.ts";
 import { loadManifest } from "./manifest.mjs";
 import { builtinPluginNames } from "./builtin-plugins.mjs";
 import { installDeliveryPreset, planDeliveryPreset, publicDeliveryPreset } from "./delivery-presets.mjs";
@@ -726,7 +725,7 @@ export function writeProject(workspace, request) {
   return plan;
 }
 
-function setup(workspace) {
+function setup(workspace, publicSetupFrom) {
   const manifestText = readFileSync(join(workspace, "portolan.json"), "utf8");
   let report;
   try { report = JSON.parse(readFileSync(join(workspace, ".portolan/build-report.json"), "utf8")); } catch {}
@@ -1095,7 +1094,7 @@ function startProjectTrial(workspace, request) {
   catch (cause) { rmSync(prepared.holder, { recursive: true, force: true }); throw cause; }
 }
 
-export function localApiPlugin(workspace = process.cwd()) {
+export function localApiPlugin(workspace = process.cwd(), publicSetupFrom) {
   return {
     name: "portolan-local-api",
     apply: "serve",
@@ -1108,7 +1107,7 @@ export function localApiPlugin(workspace = process.cwd()) {
         try {
           if (req.method === "GET" && url.pathname === `${LOCAL_API_PREFIX}/status`) {
             const active = [...jobs.values()].find((job) => job.status === "running");
-            return send(res, 200, { local: true, workspace: realpathSync(workspace), setup: setup(workspace), activeRun: active ? { id: active.id, mode: active.mode } : null });
+            return send(res, 200, { local: true, workspace: realpathSync(workspace), setup: setup(workspace, publicSetupFrom), activeRun: active ? { id: active.id, mode: active.mode } : null });
           }
           if (req.method === "GET" && url.pathname === `${LOCAL_API_PREFIX}/delivery-presets`) {
             return send(res, 200, publicDeliveryPreset(planDeliveryPreset(workspace, url.searchParams.get("provider"))));
@@ -1151,7 +1150,7 @@ export function localApiPlugin(workspace = process.cwd()) {
             const result = writeProject(workspace, trial.projectRequest);
             trial.applied = true;
             const generation = input.generate ? startJob(workspace, "write", trial) : null;
-            return send(res, 201, { ...result, setup: setup(workspace), run: generation ? { runId: generation.id, mode: generation.mode } : null });
+            return send(res, 201, { ...result, setup: setup(workspace, publicSetupFrom), run: generation ? { runId: generation.id, mode: generation.mode } : null });
           }
           const disposeTrialMatch = url.pathname.match(/^\/__portolan\/projects\/trials\/([^/]+)\/dispose$/);
           if (disposeTrialMatch) {
@@ -1167,7 +1166,7 @@ export function localApiPlugin(workspace = process.cwd()) {
           }
           if (url.pathname === `${LOCAL_API_PREFIX}/projects`) {
             const result = writeProject(workspace, input);
-            return send(res, 201, { ...result, setup: setup(workspace) });
+            return send(res, 201, { ...result, setup: setup(workspace, publicSetupFrom) });
           }
           if (url.pathname === `${LOCAL_API_PREFIX}/runs`) {
             if ([...jobs.values()].some((job) => job.status === "running")) return send(res, 409, { error: "A generator run is already active." });

package/scripts/local-api.test.mjs

@@ -8,6 +8,7 @@ import { rmSync } from "node:fs";
 import { classifyRepositoryFailure, diffGeneratedFiles, discoverProject, forgetRepositoryCredential, inspectionRoot, localApiPath, planProject, readLocalSource, resolveRepositoryCommit, storeRepositoryCredential, summarizeProjectTrial, writeProject } from "./local-api.mjs";
 import { installDeliveryPreset, planDeliveryPreset, providerFromRemote, publicDeliveryPreset } from "./delivery-presets.mjs";
 
+const PACKAGE_VERSION = JSON.parse(readFileSync(new URL("../package.json", import.meta.url), "utf8")).version;
 const roots = [];
 afterEach(() => { for (const root of roots.splice(0)) rmSync(root, { recursive: true, force: true }); });
 
@@ -66,7 +67,7 @@ describe("local project setup", () => {
     const installed = installDeliveryPreset(root, { provider: "github", revision: preview.revision });
     expect(installed.written).toHaveLength(2);
     expect(installed.status).toBe("installed");
-    expect(readFileSync(join(root, ".github/workflows/portolan-check.yml"), "utf8")).toContain("shortlink-org/portolan@0.2.0");
+    expect(readFileSync(join(root, ".github/workflows/portolan-check.yml"), "utf8")).toContain(`shortlink-org/portolan@${PACKAGE_VERSION}`);
     expect(readFileSync(join(root, ".github/workflows/portolan-pages.yml"), "utf8")).toContain("base: /${{ github.event.repository.name }}/");
     expect(installDeliveryPreset(root, { provider: "github", revision: installed.revision }).written).toEqual([]);
   });

package/scripts/package-smoke.mjs

@@ -2,16 +2,32 @@
 // This catches accidental cwd coupling before the same package reaches npm.
 
 import { execFileSync } from "node:child_process";
-import { existsSync, mkdirSync, mkdtempSync, rmSync, writeFileSync } from "node:fs";
+import { existsSync, mkdirSync, mkdtempSync, renameSync, rmSync, symlinkSync, writeFileSync } from "node:fs";
 import { tmpdir } from "node:os";
 import { resolve } from "node:path";
 import { fileURLToPath } from "node:url";
 
 const root = resolve(fileURLToPath(new URL("..", import.meta.url)));
-const cli = resolve(root, "cli/portolan.mjs");
 const fixture = mkdtempSync(resolve(tmpdir(), "portolan-package-smoke-"));
+const install = mkdtempSync(resolve(tmpdir(), "portolan-package-install-"));
 
 try {
+  // Exercise the tarball from a real node_modules path. Node permits native
+  // TypeScript stripping in a checkout but rejects it below node_modules, so
+  // invoking the source-tree CLI did not catch broken published entry graphs.
+  const tarball = execFileSync("npm", ["pack", "--ignore-scripts", "--pack-destination", install], {
+    cwd: root,
+    encoding: "utf8",
+    stdio: ["ignore", "pipe", "inherit"],
+  }).trim().split("\n").at(-1);
+  const scope = resolve(install, "node_modules/@shortlink-org");
+  mkdirSync(scope, { recursive: true });
+  execFileSync("tar", ["-xzf", resolve(install, tarball), "-C", scope]);
+  const installed = resolve(scope, "portolan");
+  renameSync(resolve(scope, "package"), installed);
+  symlinkSync(resolve(root, "node_modules"), resolve(installed, "node_modules"), process.platform === "win32" ? "junction" : "dir");
+  const cli = resolve(installed, "cli/portolan.mjs");
+
   writeFileSync(resolve(fixture, "package.json"), '{"name":"package-smoke","version":"1.0.0"}\n');
   writeFileSync(resolve(fixture, "README.md"), "# Package smoke\n");
   // A Go domain layout: init should notice it and wire the extractor without being asked.
@@ -34,6 +50,7 @@ try {
   console.log("package smoke: init, generate, check, and build passed outside the repository");
 } finally {
   rmSync(fixture, { recursive: true, force: true });
+  rmSync(install, { recursive: true, force: true });
 }
 
 function run(command, args) {

package/vite.config.ts

@@ -152,7 +152,11 @@ export default defineConfig({
     __PROJECT_PREVIEW__: JSON.stringify(env.PORTOLAN_PROJECT_PREVIEW === "1"),
   },
   plugins: [
-    localApiPlugin(workspace),
+    // Inject the TypeScript projection from the staged Vite config rather than
+    // importing it from local-api.mjs. The latter is also loaded directly by
+    // `portolan init` from the published package, and Node does not strip
+    // TypeScript below node_modules.
+    localApiPlugin(workspace, publicSetupFrom),
     siteDocsPlugin(workspace),
     react(),
     tailwindcss(),