@rsbuild/plugin-yaml

Import YAML files and convert them into JavaScript objects.

YAML is a data serialization language commonly used for writing configuration files.

Usage

Install:

npm add @rsbuild/plugin-yaml -D

Add plugin to your rsbuild.config.ts:

// rsbuild.config.ts
import { pluginYaml } from "@rsbuild/plugin-yaml";

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

Example

Suppose the project has the following code in example.yaml:

hello = "world"

[foo]
bar = "baz"

After using the YAML plugin, you can reference it as follows:

import example from "./example.yaml";

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

Type Declaration

When you import YAML files in TypeScript code, please create a src/env.d.ts file in your project and add the corresponding type declarations.

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

License

MIT.