Installations

npm install bun-plugin-yaml

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Node Version

18.8.0

NPM Version

9.5.1 Score

66.5

Supply Chain

88.1

Quality

75

Maintenance

100

Vulnerability

99.3

License

Releases

Unable to fetch releases

Contributors

1

Love this project? Help keep it running — sponsor us today! 🚀

Download Statistics

Total Downloads

2,086

Last Day

1

Last Week

6

Last Month

973

Last Year

1,624

Maintainers

1

Package Meta Information

Latest Version

0.0.1

Package Id

bun-plugin-yaml@0.0.1

Unpacked Size

2.97 kB

Size

1.44 kB

File Count

5

NPM Version

9.5.1

Node Version

18.8.0

Publised On

03 May 2023

Total Downloads

Cumulative downloads

Total Downloads

2,086

Last day

0%

1

Compared to previous day

Last week

-50%

6

Compared to previous week

Last month

5,021.1%

973

Compared to previous month

Last year

251.5%

1,624

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

1

js-yaml

Dev Dependencies

2

@types/js-yaml bun-types

Versions

`bun-plugin-yaml`

The official YAML plugin for Bun. Adds support for .yml/.yaml imports.

Installation

1bun 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:

1import yamlPlugin from "bun-plugin-yaml";
2
3Bun.build({
4  entrypoints: ["./index.tsx"],
5  // other config
6
7  plugins: [yamlPlugin()],
8});

You can now import .yaml files from your source code:

1import data from "./data.yaml";
2
3export function Component() {
4  return <div>{data.name}</div>;
5}

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:

1// yaml.ts
2import yamlPlugin from "bun-plugin-yaml";
3
4Bun.plugin(yamlPlugin());

Then preload it in your bunfig.toml:

1preload = ["./yaml.ts"]

TypeScript

By default VSCode/TypeScript will not recognize .yaml imports. To avoid import errors, add the following to your tsconfig.json:

1  {
2    "compilerOptions": {
3      "types": [
4        // other packages, e.g. "bun-types",
5+       "bun-plugin-yaml"
6      ]
7    }
8  }

Contributing

1$ bun install # project setup
2$ bun test # run tests

No vulnerabilities found.

No security vulnerabilities found.

npmpackage.info

Other packages similar to bun-plugin-yaml

bun-plugin-yaml

Installations

Developer Guide

Yes

ESM

18.8.0

9.5.1

Score

Releases

Unable to fetch releases

Contributors

Download Statistics

Maintainers

Package Meta Information

Total Downloads

2,086

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

`bun-plugin-yaml`

Installation

Bundler usage

Runtime usage

TypeScript

Contributing