TypeScript Support#

Takomo supports custom configuration written in TypeScript. By default, it looks for a takomo.ts file in the project root. If found, this file is compiled using esbuild and executed to apply any customizations.

You can control this behavior through the esbuild property in your takomo.yml file:

Examples#

Use a custom entry point:

esbuild:
  entryPoint: src/index.ts

Disable TypeScript support:

esbuild:
  enabled: false

Customizing Project Configuration#

The entry point file (typically takomo.ts) must export a default function of type TakomoConfigProvider.
This function returns a TakomoConfig object containing your project's custom configuration.

Example#

import { HandlebarsTemplateEngineProvider, TakomoConfigProvider } from "takomo"

const provider: TakomoConfigProvider = async () => ({
  schemaProviders: [ 
    // Custom schema providers
  ],
  hookProviders: [
    // Custom hook providers
  ],
  resolverProviders: [
    // Custom resolver providers
  ],
  templateEngineProvider: new HandlebarsTemplateEngineProvider(),
})

export default provider