#JSON

Rsbuild 支持在代码中引用 JSON 文件，也支持引用 YAML 和 TOML 文件并将其转换为 JSON 格式。

#JSON 文件

你可以直接在 JavaScript 文件中引用 JSON 文件。

#示例

{
  "name": "foo",
  "items": [1, 2]
}

import example from './example.json';

console.log(example.name); // 'foo';
console.log(example.items); // [1, 2];

#具名引用

Rsbuild 同样支持通过 named import 来引用 JSON 文件：

import { name } from './example.json';

console.log(name); // 'foo';

#YAML 文件

YAML 是一种数据序列化语言，通常用于编写配置文件。

Rsbuild 提供了 @rsbuild/plugin-yaml，在注册插件后，你可以在 JavaScript 中引用 .yaml 或 .yml 文件，它们会被自动转换为 JavaScript 对象。

import { pluginYaml } from '@rsbuild/plugin-yaml';

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

#示例

---
hello: world
foo:
  bar: baz

import example from './example.yaml';

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

#TOML 文件

TOML 是一种语义明显、易于阅读的配置文件格式。

Rsbuild 提供了 @rsbuild/plugin-toml，在注册插件后，你可以在 JavaScript 中引用 .toml 文件，它会被自动转换为 JavaScript 对象。

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

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

#示例

hello = "world"

[foo]
bar = "baz"

import example from './example.toml';

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

#类型声明

当你在 TypeScript 代码中引用 YAML 或 TOML 文件时，可以使用以下任一方法添加类型声明：

• 方法一：如果项目里安装了 @rsbuild/core 包，你可以在 tsconfig.json 中添加 @rsbuild/core 提供的 预设类型：

{
  "compilerOptions": {
    "types": ["@rsbuild/core/types"]
  }
}

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

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