typebox-genx

typebox-genx (TypeBox Generator eXtended) is a code generation tool that extends @sinclair/typebox-codegen package with import functionality

Installation

Install via Bun:

1bun install @toil/typebox-genx

Install via Node:

1npm install @toil/typebox-genx

Before starting

This lib is very very very very unstable and some parts of planned functionality aren't available.

Lib work bad with scopes and i mean you have separate files for types

Supports only 1 type of import by line. Any of these code variants are valid:

[!WARNING] Now you can only import with import {...} from "...". Also you can use "type".

1import type { ClientOpts } from "@vot.js/node";
2// or
3// import { ClientOpts as RenamedOpts } from "@vot.js/node";
4// or
5import { Client, type ClientOpts } from "@vot.js/node";
6// or
7// import * as Client from "@vot.js/node";
8// and many more

These code variants unsupported:

1import Client, { ClientOpts } from "@vot.js/node";
2// or
3import "@vot.js/node";

Now typeof variable unsupported too

Getting started

The library class provides several methods:

1const genx = new GenX({
2  root: path.join(__dirname),
3  includeNearbyFiles: true,
4});
5
6// read from input dir and write to output
7await genx.generateByDir(
8  path.join(__dirname, "src/types"),
9  path.join(__dirname, "dist"),
10);
11
12// read file and return result to variable
13const codeByFile = await genx.generateByFile(
14  path.join(__dirname, "src/types/with.ts"),
15);
16
17// read string and return result to variable
18const raw = `import type { RequestMethod } from "@toil/translate/types/providers/base";
19
20export type Test = {
21  method: RequestMethod;
22};`;
23
24const codeByStr = await genx.generateByCode(raw);
25
26// clear saved imports and depends list if needed
27genx.clearData();
28
29// create client for enabled workspaces
30const genxw = new GenX({
31  root: path.join(__dirname, "packages", "packageA"),
32  workspaceRoot: path.join(__dirname),
33});
34
35await genx.generateByDir(
36  path.join(__dirname, "packages", "packageA"),
37  path.join(__dirname, "dist"),
38);

Build

To build, you must have:

• Bun

Don't forget to install the dependencies:

1bun install

Start building:

1bun build:all

Tests

The library has minimal test coverage to check its performance.

Run the tests:

1bun test