yaml

@rollup/plugin-yaml

🍣 A Rollup plugin which Converts YAML files to ES6 modules.

Requirements

This plugin requires an LTS Node version (v8.0.0+) and Rollup v1.20.0+.

Install

Using npm:

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

Usage

Create a rollup.config.js configuration file and import the plugin:

import yaml from '@rollup/plugin-yaml';

export default {
  input: 'src/index.js',
  output: {
    dir: 'output',
    format: 'cjs'
  },
  plugins: [yaml()]
};

Then call rollup either via the CLI or the API.

With an accompanying file src/index.js, the local heroes.yaml file would now be importable as seen below:

// src/index.js
import { batman } from './heroes.yaml';

console.log(`na na na na ${batman}`);

Options

exclude

Type: String | Array[...String]
Default: null

A minimatch pattern, or array of patterns, which specifies the files in the build the plugin should ignore. By default no files are ignored.

include

Type: String | Array(String)
Default: null

A minimatch pattern, or array of patterns, which specifies the files in the build the plugin should operate on. By default all files are targeted.

transform

Type: Function
Default: undefined

A function which can optionally mutate parsed YAML. The function should return the mutated object, or undefined which will make no changes to the parsed YAML.

yaml({
  transform(data) {
    if (Array.isArray(data)) {
      return data.filter(character => !character.batman);
    }
  }
});

Meta

CONTRIBUTING

LICENSE (MIT)