https://github.com/Modyfi/vite-plugin-yaml

Transform a YAML file to a JS object
https://github.com/Modyfi/vite-plugin-yaml

vite vite-plugin yaml

Last synced: about 2 months ago
JSON representation

Transform a YAML file to a JS object

• Host: GitHub
• URL: https://github.com/Modyfi/vite-plugin-yaml
• Owner: Modyfi
• Created: 2022-02-23T20:59:46.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-03T17:20:09.000Z (6 months ago)
• Last Synced: 2024-07-19T07:11:29.739Z (about 2 months ago)
• Topics: vite, vite-plugin, yaml
• Language: TypeScript
• Homepage:
• Size: 163 KB
• Stars: 68
• Watchers: 2
• Forks: 17
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• fucking-awesome-vite - @modyfi/vite-plugin-yaml - Transform YAML files to ESM with schema validation and error reporting. (Plugins / Framework-agnostic Plugins)
• awesome-vite - @modyfi/vite-plugin-yaml - Transform YAML files to ESM with schema validation and error reporting. (Plugins / Framework-agnostic Plugins)

README

        
[![Pipeline](https://github.com/Modyfi/vite-plugin-yaml/actions/workflows/pipeline.yml/badge.svg)](https://github.com/Modyfi/vite-plugin-yaml/actions/workflows/pipeline.yml)

# 🧹 vite-plugin-yaml

Transforms a YAML file into a JS object.

## 🚀 Install

```

npm install -D @modyfi/vite-plugin-yaml

# or

# yarn add -D @modyfi/vite-plugin-yaml

# or

# pnpm i -D @modyfi/vite-plugin-yaml

```

## 🦄 Usage

Add `ViteYAML` to `vite.config.js / vite.config.ts`:

```ts

// vite.config.js / vite.config.ts

import ViteYaml from '@modyfi/vite-plugin-yaml';

export default {

  plugins: [

    ViteYaml(), // you may configure the plugin by passing in an object with the options listed below

  ],

};

```

Then you can simply import yaml files like you would any other file:

```ts

import YamlContent from './your.yaml';

console.log(YamlContent.example);

```

Do note that you may have to include the file type in your import.

### 🔦 TypeScript support

The recommended way to add type definitions for `.yaml` or `.yml` modules is via a `tsconfig.json` file.

```ts

// tsconfig.json

{

  "compilerOptions": {

    ...

    "types": [

      ...

      "@modyfi/vite-plugin-yaml/modules"

      ],

  }

}

```

You may also add type definitions without `tsconfig`:

```ts

// vite-env.d.ts

/// 

```

## 🐛 Options

```ts

/**

 * A minimatch pattern, or array of patterns, which specifies the files in the build the plugin should operate on.

 *

 * By default all files are targeted.

 */

include?: FilterPattern;

/**

 * A minimatch pattern, or array of patterns, which specifies the files in the build the plugin should ignore.

 *

 * By default no files are ignored.

 */

exclude?: FilterPattern;

/**

 * Schema used to parse yaml files.

 *

 * @see https://github.com/nodeca/js-yaml/blob/49baadd52af887d2991e2c39a6639baa56d6c71b/README.md#load-string---options-

 */

schema?: Schema;

/**

 * A boolean to determine if JSON object should be serialized.

 *

 * @see https://www.npmjs.com/package/tosource for the motivation behind serialization of JSON.

 */

raw?: boolean;

/**

 * A function that will be called for error reporting.

 *

 * Defaults to `console.warn()`.

 */

onWarning?: (warning: YAMLException) => void;

```