@zfig/yaml-loader


YAML file support for zfig.

Install

``bash
npm install zfig @zfig/yaml-loader
`

Usage

Import for side-effects to enable YAML config files:

`typescript
import "@zfig/yaml-loader";
import { resolve } from "zfig";

const config = resolve(configSchema, { configPath: "./config.yaml" });
`

How It Works

On import, registers loaders for .yaml and .yml extensions:

`typescript
registerLoader(".yaml", loadYaml);
registerLoader(".yml", loadYaml);
`

After import, resolve() automatically handles YAML files.

API

$3

Parses a YAML file and returns its contents.

`typescript
import { loadYaml } from "@zfig/yaml-loader";

const data = loadYaml("./config.yaml");
// { db: { host: "localhost", port: 5432 } }
`

Returns:
- Record - parsed YAML content
- undefined - if file doesn't exist

Throws:
- ConfigError - if YAML syntax is invalid

Examples

$3

`yaml


config.yaml

logging:
level: info
`

$3

`typescript
import "@zfig/yaml-loader";
import { schema, field, resolve } from "zfig";
import { z } from "zod";

const configSchema = schema({
db: {
host: field({ type: z.string(), default: "localhost" }),
port: field({ type: z.number(), default: 5432 }),
},
logging: {
level: field({ type: z.enum(["debug", "info", "warn", "error"]) }),
},
});

const config = resolve(configSchema, { configPath: "./config.yaml" });
`

$3

`typescript
import { loadYaml } from "@zfig/yaml-loader";

const data = loadYaml("./config.yml");
if (data) {
console.log(data.db.host);
}
``

License

MIT