@xriptjs/typegen

Generate TypeScript type definitions from xript manifests.

Install

npm install @xriptjs/typegen

CLI

npx xript-typegen manifest.json              # print to stdout
npx xript-typegen manifest.json -o types.d.ts  # write to file

Generates .d.ts files with full JSDoc, namespace support, and hook type definitions from a manifest.

API

import { generateTypes, generateTypesFromFile } from "@xriptjs/typegen";

const dts = generateTypes({
  xript: "0.1",
  name: "my-app",
  bindings: {
    greet: {
      description: "Returns a greeting.",
      params: [{ name: "name", type: "string" }],
      returns: "string",
    },
  },
});

console.log(dts);
// => declare function greet(name: string): string;

generateTypes(manifest, options?): string

Generates TypeScript declarations from a manifest object.

Options:

• header: custom header comment (replaces the default auto-generated header)

generateTypesFromFile(path, options?): Promise<{ content: string; filePath: string }>

Reads a manifest JSON file and generates TypeScript declarations.

What it generates

• declare function for top-level bindings
• declare namespace for namespace bindings (with nesting)
• interface for custom types with fields
• type aliases for enum types
• declare namespace hooks with handler signatures and phased hook namespaces
• JSDoc with @param, @deprecated, and @remarks annotations

Documentation

xript.dev: full docs, manifest specification, and examples.

License

MIT