.png)
3 months ago
7
Import .yaml files in TypeScript 5+ with autocomplete and type checking.
Install the plugin:
npm install --save-dev typescript-yaml-plugin
Update your tsconfig.json:
{
"compilerOptions": {
"plugins": [{ "name": "typescript-yaml-plugin" }]
}
}
Start importing YAML files! 🎉
import schema from './schema.yaml';
Make sure your editor is using the workspace version of TypeScript (the one where the plugin is installed). To do this:
- Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P)
- Run TypeScript: Select TypeScript Version
- Choose Use Workspace Version
- This plugin uses the yaml package under the hood. Supported features and limitations are fully inherited from that library.
- This plugin is only for editor support (autocomplete and type-checking). It does not make .yaml files work at runtime. To actually be able to import YAML files in your running code, you’ll need to pair this with a runtime plugin that handles .yaml files like bun-plugin-yaml or vite-plugin-yaml, depending on your runtime.
- This plugin was inspired by typescript-plugin-yaml, which is no longer maintained and does not support TypeScript 5+.
Issues and PRs are welcome!
