partforge 0.26.1 → 0.27.0

package/src/framework/verify-metrics.js

@@ -0,0 +1,51 @@
+// Metric registry: name → how to pull the value out of facts, whether a failure
+// is a hard gate or a warning, and the diagnostics attached to a non-pass check:
+// `hint` (required — the report contract promises one on every fail/warn),
+// `pattern` (optional stable ERROR-PATTERNS.md#<id>), `locate` (optional
+// [x,y,z] source). `manifoldOnly` facts are null on OCCT parts.
+//
+// This lives in framework/ rather than testing/ deliberately: the set of legal
+// `verify.expect` metrics is part of the PartDefinition CONTRACT, which both the
+// verify runner (testing) and the linter (partforge/lint) must agree on. Keeping
+// it here lets the linter import the vocabulary without reaching measure.js or
+// jobs.js, which pull in the geometry kernels. This module must stay import-free.
+export const SUBPART_METRICS = {
+  holes: { kind: "gate", manifoldOnly: true, extract: (s) => s.holes,
+    hint: "genus is wrong — an unintended tunnel exists or an intended bore is blocked; make cut tools pierce fully (overcut past the faces)" },
+  watertight: { kind: "gate", manifoldOnly: true, extract: (s) => s.watertight,
+    hint: "a boolean produced an open shell — check for coplanar faces or a cut that exactly grazes a surface",
+    pattern: "boolean-not-watertight" },
+  volume: { kind: "gate", extract: (s) => s.volume,
+    hint: "solid volume is out of range — a feature is missing, doubled, or a governing parameter is mis-scaled" },
+  surfaceArea: { kind: "gate", extract: (s) => s.surfaceArea,
+    hint: "surface area is out of range — detail features (facets, ribs, textures) are missing or doubled" },
+  triangleCount: { kind: "gate", extract: (s) => s.triangleCount,
+    hint: "triangle count is out of range — tessellation quality or feature count changed unexpectedly" },
+  bbox: { kind: "gate", extract: (s) => s.bbox,
+    hint: "bounding box is out of range — check the governing dimensions and the part's orientation" },
+  centerOfMass: { kind: "gate", extract: (s) => s.centerOfMass,
+    hint: "center of mass is outside the expected region — mass is distributed differently than intended; check feature placement or a mis-scaled sub-part" },
+  boundsMin: { kind: "gate", extract: (s) => s.bounds?.min,
+    hint: "the low corner is out of range — the part is positioned or oriented differently than expected" },
+  boundsMax: { kind: "gate", extract: (s) => s.bounds?.max,
+    hint: "the high corner is out of range — the part is positioned or oriented differently than expected" },
+  minWall: { kind: "warn", extract: (s) => s.minWall,
+    hint: "thinnest wall is at the reported location — increase the governing wall/thickness parameter or reduce the intersecting feature's depth",
+    pattern: "minwall-sliver-triangles",
+    locate: (s) => s.minWallAt },
+};
+export const VIEW_METRICS = {
+  bbox: { kind: "gate", extract: (r) => r.aggregate.bbox,
+    hint: "the assembled view exceeds its size limit — shrink the assembly or pick a process with a larger bed" },
+  volume: { kind: "gate", extract: (r) => r.aggregate.volume,
+    hint: "total assembly volume is out of range — a sub-part is missing, doubled, or mis-scaled" },
+  overlaps: { kind: "gate", extract: (r) => r.overlaps.length,
+    hint: "sub-parts interpenetrate near the reported location — adjust placement or add clearance in derive()",
+    locate: (r) => r.overlaps[0]?.location ?? null },
+  centerOfMass: { kind: "gate", extract: (r) => r.aggregate.centerOfMass,
+    hint: "the assembly's center of mass is outside the expected region — a sub-part is mis-placed or mis-scaled" },
+  boundsMin: { kind: "gate", extract: (r) => r.aggregate.bounds?.min,
+    hint: "the assembly's low corner is out of range — check placement or orientation" },
+  boundsMax: { kind: "gate", extract: (r) => r.aggregate.bounds?.max,
+    hint: "the assembly's high corner is out of range — check placement or orientation" },
+};

package/src/framework/worker.js

@@ -3,6 +3,7 @@
 // Each instance lazily imports only its own backend, so OCCT's ~11 MB WASM loads
 // only in the worker that needs it, and only on first use.
 import { handle } from "./jobs.js";
+import { lintPart } from "../lint.js";
 
 async function manifoldKernels() {
   const [{ default: Module }, { createManifoldKernel }] = await Promise.all([
@@ -48,6 +49,14 @@ export function runWorker(part) {
   }
 
   self.onmessage = async (e) => {
+    // Lint is geometry-free by construction, so answer it before touching — or
+    // booting — a kernel. handle() in jobs.js takes an already-booted kernel, and
+    // the branches below await that boot, so routing lint through them would drag
+    // in OCCT's ~11 MB WASM to run a check that never calls the kernel at all.
+    if (e.data?.type === "lint") {
+      postMessage({ type: "lint-report", report: lintPart(part, { params: e.data.params }) });
+      return;
+    }
     let kernel;
     if (backend === "manifold") {
       await booting;

package/src/lint.js

@@ -0,0 +1,3 @@
+// Public entry for `partforge/lint`. Deliberately separate from `partforge/testing`,
+// whose entry pulls in the WASM kernels and cannot load in a browser sandbox.
+export { lintPart, RULES } from "./framework/lint/index.js";

package/src/testing/verify.js

@@ -5,52 +5,11 @@ import { resolveProfile } from "./dfm-profiles.js";
 import { expandCases } from "./cases.js";
 import { subPartReadKeys, relevanceHash, RELEVANT_ALL } from "../framework/param-deps.js";
 import { resolveParams } from "../framework/jobs.js";
+import { SUBPART_METRICS, VIEW_METRICS } from "../framework/verify-metrics.js";
 
-// Metric registry: name → how to pull the value out of facts, whether a failure
-// is a hard gate or a warning, and the diagnostics attached to a non-pass check:
-// `hint` (required — the report contract promises one on every fail/warn),
-// `pattern` (optional stable ERROR-PATTERNS.md#<id>), `locate` (optional
-// [x,y,z] source). `manifoldOnly` facts are null on OCCT parts.
-export const SUBPART_METRICS = {
-  holes: { kind: "gate", manifoldOnly: true, extract: (s) => s.holes,
-    hint: "genus is wrong — an unintended tunnel exists or an intended bore is blocked; make cut tools pierce fully (overcut past the faces)" },
-  watertight: { kind: "gate", manifoldOnly: true, extract: (s) => s.watertight,
-    hint: "a boolean produced an open shell — check for coplanar faces or a cut that exactly grazes a surface",
-    pattern: "boolean-not-watertight" },
-  volume: { kind: "gate", extract: (s) => s.volume,
-    hint: "solid volume is out of range — a feature is missing, doubled, or a governing parameter is mis-scaled" },
-  surfaceArea: { kind: "gate", extract: (s) => s.surfaceArea,
-    hint: "surface area is out of range — detail features (facets, ribs, textures) are missing or doubled" },
-  triangleCount: { kind: "gate", extract: (s) => s.triangleCount,
-    hint: "triangle count is out of range — tessellation quality or feature count changed unexpectedly" },
-  bbox: { kind: "gate", extract: (s) => s.bbox,
-    hint: "bounding box is out of range — check the governing dimensions and the part's orientation" },
-  centerOfMass: { kind: "gate", extract: (s) => s.centerOfMass,
-    hint: "center of mass is outside the expected region — mass is distributed differently than intended; check feature placement or a mis-scaled sub-part" },
-  boundsMin: { kind: "gate", extract: (s) => s.bounds?.min,
-    hint: "the low corner is out of range — the part is positioned or oriented differently than expected" },
-  boundsMax: { kind: "gate", extract: (s) => s.bounds?.max,
-    hint: "the high corner is out of range — the part is positioned or oriented differently than expected" },
-  minWall: { kind: "warn", extract: (s) => s.minWall,
-    hint: "thinnest wall is at the reported location — increase the governing wall/thickness parameter or reduce the intersecting feature's depth",
-    pattern: "minwall-sliver-triangles",
-    locate: (s) => s.minWallAt },
-};
-export const VIEW_METRICS = {
-  bbox: { kind: "gate", extract: (r) => r.aggregate.bbox,
-    hint: "the assembled view exceeds its size limit — shrink the assembly or pick a process with a larger bed" },
-  volume: { kind: "gate", extract: (r) => r.aggregate.volume,
-    hint: "total assembly volume is out of range — a sub-part is missing, doubled, or mis-scaled" },
-  overlaps: { kind: "gate", extract: (r) => r.overlaps.length,
-    hint: "sub-parts interpenetrate near the reported location — adjust placement or add clearance in derive()",
-    locate: (r) => r.overlaps[0]?.location ?? null },
-  centerOfMass: { kind: "gate", extract: (r) => r.aggregate.centerOfMass,
-    hint: "the assembly's center of mass is outside the expected region — a sub-part is mis-placed or mis-scaled" },
-  boundsMin: { kind: "gate", extract: (r) => r.aggregate.bounds?.min,
-    hint: "the assembly's low corner is out of range — check placement or orientation" },
-  boundsMax: { kind: "gate", extract: (r) => r.aggregate.bounds?.max,
-    hint: "the assembly's high corner is out of range — check placement or orientation" },
-};
+// Re-exported for backwards compatibility: the registries moved to framework/ so
+// the linter can read the metric vocabulary without importing a geometry kernel.
+export { SUBPART_METRICS, VIEW_METRICS };
 
 // An expectation is a bare expression (string/number/boolean) or { expr, hint }.
 const normalizeExpectation = (spec) =>