TOML 插件#

用于引用 TOML 文件，并将其转换为 JavaScript 对象。

快速开始#

安装插件#

你可以通过如下的命令安装插件:

npm add @rsbuild/plugin-toml -D

注册插件#

你可以在 rsbuild.config.ts 文件中注册插件：

import { pluginToml } from '@rsbuild/plugin-toml';

export default {
  plugins: [pluginToml()],
};

示例#

比如项目中有以下代码：

hello = "world"

[foo]
bar = "baz"

在使用 TOML 插件后，你可以通过如下方式引用：

import example from './example.toml';

console.log(example.hello); // 'world';
console.log(example.foo); // { bar: 'baz' };

类型声明#

当你在 TypeScript 代码中引用 TOML 文件时，请在项目中创建 src/env.d.ts 文件，并添加相应的类型声明。

• 方法一：如果项目里安装了 @rsbuild/core 包，你可以直接引用 @rsbuild/core 提供的类型声明：

/// <reference types="@rsbuild/core/types" />

• 方法二：手动添加需要的类型声明：

declare module '*.toml' {
  const content: Record<string, any>;
  export default content;
}