Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nkt/yml-loader
YAML loader for webpack
https://github.com/nkt/yml-loader
webpack-loader yaml yml
Last synced: 4 months ago
JSON representation
YAML loader for webpack
- Host: GitHub
- URL: https://github.com/nkt/yml-loader
- Owner: nkt
- License: mit
- Created: 2016-07-26T16:08:54.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T22:38:01.000Z (about 2 years ago)
- Last Synced: 2024-09-30T23:03:16.261Z (4 months ago)
- Topics: webpack-loader, yaml, yml
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/yml-loader
- Size: 16.6 KB
- Stars: 20
- Watchers: 3
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
YAML Loader
===========
YAML loader for [webpack](https://webpack.github.io).
Installation
------------
```
npm install --save-dev yml-loader
```
Usage
-----
```js
// webpack.config.js
module.exports = {
module: {
loaders: [
{
test: /\.yml$/,
loader: 'yml'
}
]
}
};
```
Multiple document loading
-------------------------
By adding a `multiDocument` option will make this possible.
```yaml
%YAML 1.2
---
doc: 1
---
doc: 2
...
```
Blacklisting keys
-----------------
When passed a `keysToRemove` query (`Array` of `String`s) to remove keys from the loader output.
Given input file:
```yaml
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:
```js
// 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:
```js
{
development: { public_key: 'this is needed on the client' },
prod: { public_key: 'also needed on the client' }
}
```
License
-------
[MIT](LICENSE)