openpencil/tests/engine/tools/cli.test.ts
Danila Poyarkov aa86873dd7
test: typecheck the test suites and fix what that found (#896)
* 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
2026-10-05 12:42:38 +00:00

232 lines
7.1 KiB
TypeScript

import { expect, setDefaultTimeout, test } from 'bun:test'
import * as v from 'valibot'
import { cliSourcePath, repoPath } from '#tests/helpers/paths'
import { heavy } from '#tests/helpers/test-utils'
setDefaultTimeout(30_000)
const CLI = cliSourcePath('index.ts')
const FIXTURE = repoPath('tests/fixtures/gold-preview.fig')
async function evalCode(
code: string
): Promise<{ stdout: string; stderr: string; exitCode: number }> {
const proc = Bun.spawn([process.execPath, CLI, 'eval', FIXTURE, '--code', code, '--json'], {
stdout: 'pipe',
stderr: 'pipe'
})
const [stdout, stderr] = await Promise.all([
new Response(proc.stdout).text(),
new Response(proc.stderr).text()
])
const exitCode = await proc.exited
return { stdout: stdout.trim(), stderr: stderr.trim(), exitCode }
}
const RecordJSON = v.pipe(v.string(), v.parseJson(), v.record(v.string(), v.unknown()))
const SolidFills = v.array(v.object({ color: v.object({ r: v.number() }) }))
function parseRecord(stdout: string): Record<string, unknown> {
return v.parse(RecordJSON, stdout)
}
heavy('CLI tool operations via eval', () => {
test('create and read back a node', async () => {
const { stdout, exitCode } = await evalCode(`
const r = figma.createRectangle()
r.name = 'TestRect'
r.x = 100
r.y = 200
r.resize(300, 150)
return r.toJSON()
`)
expect(exitCode).toBe(0)
const result = parseRecord(stdout)
expect(result.name).toBe('TestRect')
expect(result.x).toBe(100)
expect(result.y).toBe(200)
expect(result.width).toBe(300)
expect(result.height).toBe(150)
})
test('set fill on a node', async () => {
const { stdout, exitCode } = await evalCode(`
const r = figma.createRectangle()
r.resize(50, 50)
r.fills = [{ type: 'SOLID', color: { r: 1, g: 0, b: 0, a: 1 }, opacity: 1, visible: true }]
return { fills: r.fills }
`)
expect(exitCode).toBe(0)
const result = parseRecord(stdout)
const fills = v.parse(SolidFills, result.fills)
expect(fills.length).toBe(1)
expect(fills[0].color.r).toBe(1)
})
test('set layout on a frame', async () => {
const { stdout, exitCode } = await evalCode(`
const f = figma.createFrame()
f.resize(300, 200)
f.layoutMode = 'VERTICAL'
f.itemSpacing = 16
f.paddingLeft = 20
f.paddingRight = 20
f.paddingTop = 20
f.paddingBottom = 20
return {
layoutMode: f.layoutMode,
itemSpacing: f.itemSpacing,
paddingLeft: f.paddingLeft
}
`)
expect(exitCode).toBe(0)
const result = parseRecord(stdout)
expect(result.layoutMode).toBe('VERTICAL')
expect(result.itemSpacing).toBe(16)
expect(result.paddingLeft).toBe(20)
})
test('create component from node', async () => {
const { stdout, exitCode } = await evalCode(`
const f = figma.createFrame()
f.name = 'Button'
f.resize(200, 48)
const comp = figma.createComponentFromNode(f)
return { name: comp.name, type: comp.type }
`)
expect(exitCode).toBe(0)
const result = parseRecord(stdout)
expect(result.name).toBe('Button')
expect(result.type).toBe('COMPONENT')
})
test('group and ungroup nodes', async () => {
const { stdout, exitCode } = await evalCode(`
const r1 = figma.createRectangle()
r1.resize(50, 50)
const r2 = figma.createRectangle()
r2.resize(50, 50)
const group = figma.group([r1, r2], figma.currentPage)
const groupType = group.type
const childCount = group.children.length
figma.ungroup(group)
const ungrouped = figma.getNodeById(group.id)
return { groupType, childCount, ungroupedExists: ungrouped !== null }
`)
expect(exitCode).toBe(0)
const result = parseRecord(stdout)
expect(result.groupType).toBe('GROUP')
expect(result.childCount).toBe(2)
expect(result.ungroupedExists).toBe(false)
})
test('find nodes by type on fixture', async () => {
const { stdout, exitCode } = await evalCode(`
const texts = figma.currentPage.findAllWithCriteria({ types: ['TEXT'] })
return { count: texts.length, hasTexts: texts.length > 0 }
`)
expect(exitCode).toBe(0)
const result = parseRecord(stdout)
expect(result.hasTexts).toBe(true)
expect(result.count).toBeGreaterThan(0)
})
test('clone a node', async () => {
const { stdout, exitCode } = await evalCode(`
const r = figma.createRectangle()
r.name = 'Original'
r.resize(100, 100)
const clone = r.clone()
return {
same: r.id === clone.id,
cloneName: clone.name,
cloneWidth: clone.width
}
`)
expect(exitCode).toBe(0)
const result = parseRecord(stdout)
expect(result.same).toBe(false)
expect(result.cloneName).toBe('Original')
expect(result.cloneWidth).toBe(100)
})
test('reparent node into frame', async () => {
const { stdout, exitCode } = await evalCode(`
const frame = figma.createFrame()
frame.resize(300, 300)
const rect = figma.createRectangle()
rect.resize(50, 50)
frame.appendChild(rect)
return {
parentId: rect.parent?.id,
isChild: frame.children.some(c => c.id === rect.id)
}
`)
expect(exitCode).toBe(0)
const result = parseRecord(stdout)
expect(result.isChild).toBe(true)
})
test('set constraints', async () => {
const { stdout, exitCode } = await evalCode(`
const r = figma.createRectangle()
r.resize(100, 100)
r.constraints = { horizontal: 'CENTER', vertical: 'STRETCH' }
return r.constraints
`)
expect(exitCode).toBe(0)
const result = parseRecord(stdout)
expect(result.horizontal).toBe('CENTER')
expect(result.vertical).toBe('STRETCH')
})
test('set effects', async () => {
const { stdout, exitCode } = await evalCode(`
const f = figma.createFrame()
f.resize(100, 100)
f.effects = [{
type: 'DROP_SHADOW',
color: { r: 0, g: 0, b: 0, a: 0.25 },
offset: { x: 0, y: 4 },
radius: 8,
spread: 0,
visible: true,
blendMode: 'NORMAL'
}]
return { count: f.effects.length, type: f.effects[0].type }
`)
expect(exitCode).toBe(0)
const result = parseRecord(stdout)
expect(result.count).toBe(1)
expect(result.type).toBe('DROP_SHADOW')
})
test('list variables from fixture', async () => {
const { stdout, exitCode } = await evalCode(`
const vars = figma.getLocalVariables()
const cols = figma.getLocalVariableCollections()
return { variables: vars.length, collections: cols.length }
`)
expect(exitCode).toBe(0)
const result = parseRecord(stdout)
expect(typeof result.variables).toBe('number')
expect(typeof result.collections).toBe('number')
})
test('switch page', async () => {
const { stdout, exitCode } = await evalCode(`
const pages = figma.root.children
const first = pages[0]
figma.currentPage = first
return { page: figma.currentPage.name, pageCount: pages.length }
`)
expect(exitCode).toBe(0)
const result = parseRecord(stdout)
expect(result.page).toBeTruthy()
expect(result.pageCount).toBeGreaterThanOrEqual(1)
})
})