sapphi-red/vite-plugin-toml

A plugin for rollup/vite to import a toml file.

vite-plugin-toml

Toml file plugin for rollup/vite.

The name starts with vite-plugin-, but this is a historical reason. This plugin does support rollup too.

Uses toml-eslint-parser package for parsing. Supports Toml 1.0.0.

Install

npm i -D vite-plugin-toml # yarn add -D vite-plugin-toml

Add plugin in vite.config.js.

import { ViteToml } from 'vite-plugin-toml'

export default {
  plugins: [ViteToml()]
}

Options

• namedExports (default: false)

Enable named exports.

Typescript

I recommend using typescript-plugin-toml.

Alternatively, add this global declaration.

declare module '*.toml' {
  const value: unknown
  export default value
}

Example

test.toml

key = 'value'

index.ts

import test from './test.toml'

console.log(test.key) // 'value'