esbuild-yaml
v1.2.0
Published
An esbuild plugin, that allows imports of YAML files
Downloads
7,168
Maintainers
Readme
esbuild-yaml
📦 Installation
npm install --save-dev esbuild-yaml esbuild
📚 Usage
Add this to your build file
import { build } from "esbuild";
import { YAMLPlugin } from "esbuild-yaml";
const yourConfig = {};
build({
...yourConfig,
plugins: [
YAMLPlugin()
]
});
TypeScript
If you are using TypeScript, you need to add the following to your tsconfig.json
file:
{
"compilerOptions": {
"types": [
"esbuild-yaml/types"
]
}
}
📖 Examples
// build.js
import { build } from "esbuild";
import { YAMLPlugin } from "esbuild-yaml";
const yourConfig = {};
build({
...yourConfig,
plugins: [
YAMLPlugin()
]
});
# config.yaml
name: esbuild-yaml
version: 1.0.0
// index.ts
import config from "./config.yaml"; // this will be converted to a JSON object
import configRaw from "./config.yaml?raw"; // this will be the raw YAML string
console.log(config); // { name: "esbuild-yaml", version: "1.0.0" }
console.log(configRaw); // name: esbuild-yaml\nversion: 1.0.0
📄 License
Published under MIT License.