1.0.1 • Published 11 months ago

@rsbuild/plugin-toml v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
11 months ago

@rsbuild/plugin-toml

An Rsbuild plugin to import TOML files and convert them to JavaScript objects.

TOML is a semantically explicit, easy-to-read configuration file format.

Usage

Install:

npm add @rsbuild/plugin-toml -D

Add plugin to your rsbuild.config.ts:

// rsbuild.config.ts
import { pluginToml } from "@rsbuild/plugin-toml";

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

Example

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

hello = "world"

[foo]
bar = "baz"

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

import example from "./example.toml";

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

Options

esModule

By default, @rsbuild/plugin-toml generates JS modules that use the ES modules syntax. If you want to generate a CommonJS module, you can set the esModule option to false.

  • Type: boolean
  • Default: true
  • Example:
pluginToml({
  exModule: false,
});

Type Declaration

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

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

License

MIT.

0.7.2

1 year ago

0.7.1

1 year ago

0.7.4

1 year ago

0.7.3

1 year ago

0.7.0

1 year ago

0.7.10

1 year ago

1.0.1

11 months ago

1.0.0

1 year ago

0.7.0-beta.8

1 year ago

0.7.0-beta.9

1 year ago

0.7.0-beta.7

1 year ago

0.7.9

1 year ago

0.7.6

1 year ago

0.7.5

1 year ago

0.7.8

1 year ago

0.7.7

1 year ago

0.7.0-beta.6

1 year ago

0.7.0-beta.5

1 year ago

0.7.0-beta.4

1 year ago

0.7.0-beta.1

1 year ago

0.7.0-beta.2

1 year ago

0.7.0-beta.3

1 year ago

0.7.0-beta.0

1 year ago

0.6.15

1 year ago

0.6.14

1 year ago

0.6.12

1 year ago

0.6.13

1 year ago

0.6.10

1 year ago

0.6.11

1 year ago

0.6.9

1 year ago

0.6.8

1 year ago

0.6.7

1 year ago

0.6.6

1 year ago

0.6.5

1 year ago

0.6.4

1 year ago

0.6.3

1 year ago

0.6.2

1 year ago

0.6.1

1 year ago

0.6.0

1 year ago

0.5.8

1 year ago

0.5.9

1 year ago

0.5.6

1 year ago

0.5.7

1 year ago

0.5.5

1 year ago

0.5.4

1 year ago

0.5.3

1 year ago

0.5.2

1 year ago

0.5.0

1 year ago

0.5.1

1 year ago

0.4.15

1 year ago

0.4.14

1 year ago

0.4.13

1 year ago

0.4.12

1 year ago

0.4.11

1 year ago

0.4.10

1 year ago

0.4.9

1 year ago

0.4.8

1 year ago

0.4.7

1 year ago

0.4.5

1 year ago

0.4.6

1 year ago

0.4.4

1 year ago

0.4.3

1 year ago

0.4.2

1 year ago

0.4.1

1 year ago

0.4.0

1 year ago

0.3.11

1 year ago

0.3.10

1 year ago

0.3.9

1 year ago

0.3.8

1 year ago

0.3.7

1 year ago

0.3.6

1 year ago

0.3.5

1 year ago

0.3.4

1 year ago

0.3.3

1 year ago

0.3.2

2 years ago

0.3.1

2 years ago

0.3.0

2 years ago

0.2.18

2 years ago