Skip to content

Commit 6dba815

Browse files
committed
fix(core): reword JSDoc import example to avoid boundary-check false positive
`packages/core/src/idFactories.ts` contained a `@example`-style JSDoc code block with `import { LoopIdSchema } from "@loop-engine/core";` illustrating where the schema lives. `scripts/check-boundary.ts` uses a source-agnostic regex that matches `import ... from '...'` without stripping comments, so it read the docstring as a real self-import of `@loop-engine/core` and failed the `dependency-declarations` check on the first CI run of this branch. Reworded the example to remove the materialized `import` statement while preserving the "use `*Schema` from this same package" signal: * If runtime validation is needed (e.g., constraining the format of a * `LoopId`), use the corresponding `*Schema` from `./schemas` directly * (exported from this same package): * * ```ts * const id = LoopIdSchema.parse(input); // throws on invalid * ``` No runtime or type-signature change; docstring-only edit. `pnpm check-boundary` passes locally (6/6 green). The underlying tooling hazard (regex false-positives on any JSDoc `import ... from` example anywhere in the workspace) is logged as F-PB-18 against a post-Branch-A cleanup; not in scope for this merge. Surface-Reconciliation-Id: SR-019 (release)
1 parent b48c59f commit 6dba815

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

packages/core/src/idFactories.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ import type {
2222
* spell their intent at the type level.
2323
*
2424
* If runtime validation is needed (e.g., constraining the format of a
25-
* `LoopId`), use the corresponding `*Schema` from `./schemas` directly:
25+
* `LoopId`), use the corresponding `*Schema` from `./schemas` directly
26+
* (exported from this same package):
2627
*
2728
* ```ts
28-
* import { LoopIdSchema } from "@loop-engine/core";
2929
* const id = LoopIdSchema.parse(input); // throws on invalid
3030
* ```
3131
*

0 commit comments

Comments
 (0)