aa86873dd7
* build: typecheck the test suites Tests were in no TypeScript program: no tsconfig included tests/** or packages/*/tests/**, and bun strips types without checking them, so a fixture could drop a required field and keep passing until something read it. @types/bun moves to the root because it was installed per package only, and #cli-tests/* joins the paths the root config already carries. * test: fix the type errors the test suites were hiding Typechecking the tests turned up 1123 errors. Most were ordinary strictness, but some were real: `NodeChange` bound to Figma's plugin typings rather than the Kiwi codec in thirteen .fig tests, materializeInstance was called with six arguments against five so the blobs and source children were dropped, CanvasKit pixels were written to a plain object that never reached WASM, and assertions were made through accessors that do not exist, so they asserted nothing. Fixtures that had quietly lost a required field now carry it, nullable results are narrowed through the existing expectDefined helper rather than assumed, and stand-ins for CanvasKit and the editor go through one named helper instead of an unexplained cast at each site. No test was deleted, skipped, or weakened, and no `any`, non-null assertion, or ts-expect-error was introduced. * docs: record what typechecking the tests established Pins the app program's global types with an assertion rather than a note, since an unpinned types list lets any root @types package decide which platform src/** is judged against. The two environment faults that look like code regressions — Vite's dependency pre-bundle outliving a package rebuild, and heavy .fig suites failing under load — go to the development docs, where an explanation belongs. * fix: align @types/bun and keep node types resolvable when extended The root manifest declared a newer @types/bun than every package, which check:monorepo rejects, and pinning the app program's types left them unresolvable from a config that extends this one out of tree. * fix: fail the test typecheck when the compiler itself fails The gate matched diagnostics by substring, so a compiler or config failure that named no test file printed a pass while having checked nothing. Diagnostics are now split by whether they name a file: an unscoped one is the run failing and stops the gate, a test file's is a finding, and a source file's stays out by design. Also drops the parameter planComponentConstruction never read, and makes the inner-shadow verification script exit non-zero when it renders no image instead of logging and succeeding. * chore: merge master into tests-typecheck
68 lines
2.2 KiB
TypeScript
68 lines
2.2 KiB
TypeScript
import { FigmaAPI, SceneGraph } from '@open-pencil/core'
|
|
import type { FigmaNodeProxy } from '@open-pencil/core'
|
|
import type { Color, Fill, Stroke } from '@open-pencil/scene-graph'
|
|
|
|
export function createAPI(): FigmaAPI {
|
|
return new FigmaAPI(new SceneGraph())
|
|
}
|
|
|
|
/**
|
|
* Reads a proxy through Figma's `InstanceNode` surface. The proxy installs the instance accessors
|
|
* on its prototype but only the node types in `figma-api/node-types` spell them out, so a proxy
|
|
* handed back by `createInstance()` or `wrapNode()` needs the node type naming them.
|
|
*/
|
|
export function asInstanceNode(node: FigmaNodeProxy): FigmaNodeProxy & InstanceNode {
|
|
return node as FigmaNodeProxy & InstanceNode
|
|
}
|
|
|
|
/** The text counterpart of {@link asInstanceNode}. */
|
|
export function asTextNode(node: FigmaNodeProxy): FigmaNodeProxy & TextNode {
|
|
return node as FigmaNodeProxy & TextNode
|
|
}
|
|
|
|
/**
|
|
* The component counterpart of {@link asInstanceNode}, which also names the node a rejection path
|
|
* is handed when the runtime guard, not the type, is what the test exercises.
|
|
*/
|
|
export function asComponentNode(node: FigmaNodeProxy): FigmaNodeProxy & ComponentNode {
|
|
return node as FigmaNodeProxy & ComponentNode
|
|
}
|
|
|
|
/**
|
|
* Names `api.currentPage` as a page. The boolean-operation entry points only take Figma's node
|
|
* types, while the current-page proxy is typed by its selection alone.
|
|
*/
|
|
export function asPageNode(
|
|
page: FigmaNodeProxy & { selection: FigmaNodeProxy[] }
|
|
): FigmaNodeProxy & PageNode {
|
|
return page as FigmaNodeProxy & PageNode
|
|
}
|
|
|
|
/**
|
|
* A solid paint that satisfies both the OpenPencil `Fill` and the Figma `SolidPaint` shape, as the
|
|
* node proxies expose the intersection of the two.
|
|
*/
|
|
export function solidFill(
|
|
color: Color,
|
|
overrides: { opacity?: number; visible?: boolean } = {}
|
|
): Fill & SolidPaint {
|
|
return {
|
|
type: 'SOLID',
|
|
color,
|
|
opacity: overrides.opacity ?? 1,
|
|
visible: overrides.visible ?? true
|
|
}
|
|
}
|
|
|
|
/** The stroke counterpart of {@link solidFill}. */
|
|
export function solidStroke(
|
|
color: Color,
|
|
stroke: { weight: number; align: Stroke['align']; opacity?: number; visible?: boolean }
|
|
): Stroke & SolidPaint {
|
|
return {
|
|
...solidFill(color, stroke),
|
|
weight: stroke.weight,
|
|
align: stroke.align
|
|
}
|
|
}
|