YAML Types and Language Service Plugin

@yaml-js/typescript is a comprehensive library that provides TypeScript types for importing *.yaml and *.yml files, along with a TypeScript language service plugin to enable IntelliSense for YAML files.

Features

TypeScript Types: Import *.yaml and *.yml files with TypeScript types.
IntelliSense: Get code completion and IntelliSense for YAML files in your TypeScript projects.
- Schema-based Completion: Code completion based on the schema file specified in the YAML file.
- Data-based Completion: If no schema file is specified, code completion will be based on the actual data.

Installation

To install @yaml-js/typescript, you can use either npm or yarn:

npm install @yaml-js/typescript --save-dev
or
yarn add -D @yaml-js/typescript

Usage

To enable the TypeScript language service plugin, add the following to your tsconfig.json:

{
  "compilerOptions": {
    "plugins": [
      {
        "name": "@yaml-js/typescript"
      }
    ]
  }
}

Contributing

We welcome contributions to the any project at YAML-JS! To get started:

Fork the repository.
Clone your fork: git clone https://github.com/yaml-js/typescript.git
Create a new branch: git checkout -b feature-name
Make your changes.
Ensure your commit messages follow the Conventional Commits specification.
Verify if the continuous integration tasks will succeed before committing your code changes by running:
```
yarn pre-commit
```
Commit your changes: git commit -m 'feat: add new feature'
Push to the branch: git push origin feature-name
Open a pull request.

Please ensure your code adheres to the project's coding standards and includes appropriate tests (note that code coverage minimum threshold is set to 80%).

License

This project is licensed under the MIT License. See the LICENSE file for more information.

Acknowledgements

Vite - The blazing fast frontend tooling.
YAML - A human-friendly data serialization standard.
yaml library - This fantastic library made our job easier by not having to build a YAML parser