Commit 6dba815
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
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
25 | | - | |
| 25 | + | |
| 26 | + | |
26 | 27 | | |
27 | 28 | | |
28 | | - | |
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
| |||
0 commit comments