@typed-macro/test-utils

For basic concepts, see documentation for typed-macro.

Utils

TestTransformer

TestTransformer is a wrapper of the Transformer inside the Runtime.

1type TestTransformer = {
2  (ctx: TestTransformerContext): string
3  (code: string): string
4}

Here is an example about using TestTransformer with Jest:

1import {
2  createTestEnvContext,
3  createTestTransformer,
4} from '@typed-macro/test-utils'
5
6const devEnv = createTestEnvContext({ dev: true })
7const transform = createTestTransformer({
8  macros: {
9    '@macros': [...someMacros],
10  },
11})
12expect(transform(`...some code`)).toMatchSnapshot()
13expect(transform({ code: `...some code`, env: devEnv })).toMatchSnapshot()

TestTypeRenderer

TestTypeRenderer is a wrapper of the type renderer in Runtime, returning the result as a string rather than writing to a file.

Here is an example about using TestTypeRenderer with Jest:

1import { createTestTypeRenderer } from '@typed-macro/test-utils'
2
3const yourExports = {
4  '@load': {
5    macros: [...someMacros],
6  },
7  '@helper': {
8    code: `export const a = 1`,
9    customTypes: `export const a: number`,
10  },
11}
12const render = createTestTypeRenderer()
13expect(render(yourExports)).toMatchSnapshot()

TestRuntime

TestRuntime is a wrapper of the Runtime with more options and more friendly methods for test.

1const runtime = createTestRuntime({
2  provider: [yourProvider],
3  env: createTestEnvContext({ dev: false }),
4})
5
6expect(await runtime.transform(`...`, 'test.ts')).toMatchSnapshot()