JavaScript
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.gitignore
LICENSE
README.md
index.js
package.json

README.md

YAML Loader

YAML loader for webpack.

Installation

npm install --save-dev yml-loader

Usage

// webpack.config.js

module.exports = {
  module: {
    loaders: [
      {
        test: /\.yml$/,
        loader: 'yml'
      }
    ]
  }
};

Multiple document loading

By adding a multiDocument option will make this possible.

%YAML 1.2
---
doc: 1
---
doc: 2
...

Blacklisting keys

When passed a keysToRemove query (Array of Strings) to remove keys from the loader output.

Given input file:

development:
  public_key: "this is needed on the client"
  private_key: "should be restricted to server"
prod:
  public_key: "also needed on the client"
  private_key: "missile launch codes ¯\_(ツ)_/¯"

And this loader config:

// webpack.config.js under module.exports.module:
loaders: [
  {
    test: /\.ya?ml$/,
    loader: 'yml',
    query: {
      // debug: true, // enable to display removed keys
      keysToRemove: ['private_key', ],
    },
  },
],

Will output:

{
  development: { public_key: 'this is needed on the client' },
  prod: { public_key: 'also needed on the client' }
}

License

MIT