@importable/yaml

Importable YAML allows you to import YAML files with strong typing based on import attributes (presently import assertions).

1import config from './config.yml' with { type: 'yaml' }
2
3console.assert(config.doe === 'a deer, a female deer')

Installation

1npm install importable @importable/yaml

To support YAML from the TypeScript server, add @importable/yaml to tsconfig.json:

1{
2  "compilerOptions": {
3    "plugins": [
4      {
5        "name": "importable",
6        "plugins": [
7          "@importable/yaml"
8        ]
9      }
10    ]
11  }
12}

Integrations

• Integration with Vite
• Integration with Astro
• Integration with Next

Vite Integration

To support YAML within Vite, add @importable/yaml to vite.config.js:

1import { defineConfig } from 'vite'
2import importableYAML from '@importable/yaml/vite'
3
4export default defineConfig({
5  plugins: [
6    importableYAML()
7  ]
8})

Astro Integration

To support YAML within Astro, add @importable/yaml to astro.config.js:

1import { defineConfig } from 'astro'
2import importableYAML from '@importable/yaml/astro'
3
4export default defineConfig({
5  integrations: [
6    importableYAML()
7  ]
8})

Next Integration

To support YAML within Next, add @importable/next to next.config.js:

1const withYaml = require('@importable/yaml/next');
2
3module.exports = withYaml({
4  // existing NextJS config
5});

License

Code original to this project is licensed under the CC0-1.0 License.