esm-loader-yaml

[Node.js ESModule Loader][node-loaders] for importing YAML files as modules.

Warning! This uses experimental Node.js features and flags,
whose API will likely change. This code may be helpful for development and
testing, but should not be used in production.

Usage

``sh
npm install --save-dev esm-loader-yaml
`

You may have code which imports .yaml files:

`yaml


data.yaml


- name: Vito
`

`js
// index.js
import data from './data.yaml'
console.log(data) // { "name": "Vito" }
`

$3

`sh


node >= 20.7

cat << EOF > ./register.js
import { register } from 'node:module'
register('esm-loader-yaml', import.meta.url)
EOF
NODE_OPTIONS="--import ./register.js" node index.js

node < 20.7

NODE_OPTIONS="--loader esm-loader-yaml" node index.js
`

$3

This loader can be configured, and chained with other loaders, using
[node-esm-loader][node-esm-loader].

`sh
npm install --save-dev node-esm-loader
`

`js
// .loaderrc.js
export default {
loaders: ['esm-loader-yaml'],
}
`

`sh


node >= 20.7

NODE_OPTIONS="--import node-esm-loader/register" node index.js

node < 20.7

NODE_OPTIONS="--loader node-esm-loader" node index.js
`

#### Options

##### Debug

`js
// .loaderrc.js
export default {
loaders: [
{
loader: 'esm-loader-yaml',
options: {
debug: true,
},
},
],
}
``

License

[MIT][mit-license]

Author

Larry Maccherone @lmaccherone

[mit-license]: https://mit-license.org/
[node-esm-loader]: https://github.com/sebamarynissen/node-esm-loader#readme
[node-loaders]: https://nodejs.org/api/esm.html#loaders