isabella232 / rollup-plugin-yaml

This module has moved and is now available at @rollup/plugin-yaml / https://github.com/rollup/plugins

Moved

This module has moved and is now available at @rollup/plugin-yaml. Please update your dependencies. This repository is no longer maintained.

rollup-plugin-yaml

Convert .yaml and .yml files to ES6 modules:

// import a single property from a YAML file
import { foo } from './config.yaml';

// import the whole file as an object
import config from './config.yaml';

Installation

npm install --save-dev rollup-plugin-yaml

Usage

import { rollup } from 'rollup';
import yaml from 'rollup-plugin-yaml';

rollup({
  entry: 'main.js',
  plugins: [
    yaml({
      // All YAML files will be parsed by default,
      // but you can also specifically include/exclude files
      include: 'node_modules/**',  // Default: undefined
      exclude: [ 'node_modules/foo/**', 'node_modules/bar/**' ],  // Default: undefined
      // optionally mutate parsed yaml with a transform function.
      // The transform function may either:
      // - return an updated version of the yaml content
      // - return `undefined`, and mutate the yaml content directly
      transform(data) {
        if (Array.isArray(data))
          return data.filter((element) => !element.private);
      }
    })
  ]
});

License

MIT