Registry / serialization / esbuild-plugin-yaml-import

esbuild-plugin-yaml-import

library0.1.1jsnpmunverified

An esbuild plugin that allows importing YAML files directly in your code. Version 0.1.1, maintained by linbudu599. It uses JS-YAML under the hood to parse YAML content into JSON, then leverages esbuild's built-in JSON loader. Key differentiators: simple setup, minimal configuration, support for transforming content before or after parsing, and TypeScript type declarations. Suitable for small to medium projects needing YAML import capability in esbuild. Release cadence is low; last update was a while ago. Compared to alternatives like 'esbuild-plugin-yaml', it offers transform hooks and direct JS-YAML configuration.

serialization

npm install esbuild-plugin-yaml-import

github ↗package ↗

INSTALL

IMPORT

SIG · ESBUILD-PLUGIN-YAM

esbuild-plugin-yaml-import

serializationjavascriptv0.1.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default (or yaml plugin function)

✓ import yaml from 'esbuild-plugin-yaml-import'

✗ import { yaml } from 'esbuild-plugin-yaml-import'

The package exports a single default function. Named import does not exist.

Options type

✓ import type { Options } from 'esbuild-plugin-yaml-import'

For TypeScript users, you can import the Options type for configuration.

CommonJS require

✓ const yaml = require('esbuild-plugin-yaml-import')

✗ const { yaml } = require('esbuild-plugin-yaml-import')

CommonJS require returns the default export directly, not an object.

Demonstrates basic setup: import esbuild and the plugin, then add it to plugins array. After bundling, you can import .yaml files as objects.

import { build } from 'esbuild'; import yamlPlugin from 'esbuild-plugin-yaml-import'; // Sample YAML file: config.yaml // name: John // age: 30 build({ entryPoints: ['src/index.ts'], bundle: true, outfile: 'dist/bundle.js', plugins: [yamlPlugin()], }).catch(() => process.exit(1));

Debug

Known issues

gotchaPlugin only works with '.yaml' and '.yml' file extensions. Other YAML-like extensions are not recognized.

fix

Ensure your YAML files have .yaml or .yml extension.

affects: >=0.0.0

gotchaWhen using transformContent or transformParsed options, be aware that async functions are not supported; they must be synchronous.

fix

Use synchronous transformations only.

affects: >=0.0.0

gotchaIf esbuild version is less than ^0.11.19, the plugin may fail due to API incompatibility.

fix

Update esbuild to version 0.11.19 or later.

affects: >=0.0.0

Errors

Common errors & fixes

Error: Cannot find module 'esbuild-plugin-yaml-import'

Package not installed or not in node_modules.

fix

Run npm install esbuild-plugin-yaml-import --save-dev

TypeError: yaml is not a function

Importing the plugin incorrectly (e.g., named import instead of default).

fix

Use import yaml from 'esbuild-plugin-yaml-import'

Build failed with error: Unexpected token ':' in file '...'

YAML file is malformed or has invalid syntax.

fix

Validate YAML content with a linter.

Upgrade

Version history

0.1.1latest on npm

Audit

Dependencies

esbuildrequiredPeer dependency; plugin integrates with esbuild's build system.

js-yamlrequiredUses js-yaml for parsing YAML files.

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/linbudu599/nx-plugins ↗

packagehttps://www.npmjs.com/package/esbuild-plugin-yaml-import ↗