blob: 556a67bbaff8a1c7313ac805895aa198727fd954 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
# `bun-plugin-yaml`
The official YAML plugin for Bun. Adds support for `.yml`/`.yaml` imports.
## Installation
```sh
bun add bun-plugin-yaml -d
```
## Bundler usage
This plugin can be used to support `.yaml` loaders in Bun's bundler by passing it into the `plugins` array:
```ts
import yamlPlugin from "bun-plugin-yaml";
Bun.build({
entrypoints: ["./index.tsx"],
// other config
plugins: [yamlPlugin()],
});
```
You can now import `.yaml` files from your source code:
```ts
import data from "./data.yaml";
export function Component() {
return <div>{data.name}</div>;
}
```
The contents of the `.yaml` file will be inlined into your bundle.
## Runtime usage
To use as a runtime plugin, create a file that registers the plugin:
```ts
// yaml.ts
import yamlPlugin from "bun-plugin-yaml";
Bun.plugin(yamlPlugin());
```
Then preload it in your `bunfig.toml`:
```toml
preload = ["./yaml.ts"]
```
## TypeScript
By default VSCode/TypeScript will not recognize `.yaml` imports. To avoid import errors, add the following to your `tsconfig.json`:
```json-diff
{
"compilerOptions": {
"types": [
// other packages, e.g. "bun-types",
+ "bun-plugin-yaml"
]
}
}
```
## Contributing
```bash
$ bun install # project setup
$ bun test # run tests
```
|
