Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/cabralpinto/typescript-yaml-plugin

TypeScript Language Service plugin for YAML

https://github.com/cabralpinto/typescript-yaml-plugin

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (9.5%) to scientific vocabulary

Keywords

typescript typescript-5 typescript-language-server-plugin typescript-plugin yaml
Last synced: 9 months ago · JSON representation

Repository

TypeScript Language Service plugin for YAML

Basic Info
Statistics
  • Stars: 24
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
typescript typescript-5 typescript-language-server-plugin typescript-plugin yaml
Created 10 months ago · Last pushed 10 months ago

https://github.com/cabralpinto/typescript-yaml-plugin/blob/main/ 

# typescript-yaml-plugin

[![npm](https://img.shields.io/npm/v/typescript-yaml-plugin/latest.svg)](https://npmjs.com/package/typescript-yaml-plugin)
[![license](https://img.shields.io/npm/l/typescript-yaml-plugin)](https://github.com/cabralpinto/typescript-yaml-plugin/blob/main/LICENSE)
[![ts](https://img.shields.io/badge/TypeScript-5.x-blue)](https://www.typescriptlang.org/)

Import `.yaml` files in TypeScript 5+ with autocomplete and type checking.

![Example](https://raw.githubusercontent.com/cabralpinto/typescript-yaml-plugin/refs/heads/main/assets/image.png)

## Usage

Install the plugin:

 ```bash
 npm install --save-dev typescript-yaml-plugin
 ```

Update your tsconfig.json:

```json
{
  "compilerOptions": {
    "plugins": [{ "name": "typescript-yaml-plugin" }]
  }
}
```

Start importing YAML files! 

```ts
import schema from './schema.yaml';
```

### VSCode Users

Make sure your editor is using the workspace version of TypeScript (the one where the plugin is installed). To do this:

1. Open the Command Palette (`Ctrl+Shift+P` or `Cmd+Shift+P`)
2. Run `TypeScript: Select TypeScript Version`
3. Choose `Use Workspace Version`

## Notes

- This plugin uses the [`yaml`](https://www.npmjs.com/package/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, youll need to pair this with a runtime plugin that handles `.yaml` files like [`bun-plugin-yaml`](https://www.npmjs.com/package/bun-plugin-yaml)
or [`@modyfi/vite-plugin-yaml`](https://www.npmjs.com/package/@modyfi/vite-plugin-yaml), depending on your runtime.
- This plugin was inspired by [`typescript-plugin-yaml`](https://github.com/await-ovo/typescript-plugin-yaml), which is no longer maintained and does not support TypeScript 5+.

## Contributing

Issues and PRs are welcome!

Owner

  • Name: João Cabral Pinto
  • Login: cabralpinto
  • Kind: user

GitHub Events

Total
  • Issues event: 1
  • Watch event: 10
  • Push event: 9
  • Create event: 1
Last Year
  • Issues event: 1
  • Watch event: 10
  • Push event: 9
  • Create event: 1

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 1
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 1
  • Total pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • choephix (1)
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • npm 442 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 6
  • Total maintainers: 1
npmjs.org: typescript-yaml-plugin

TypeScript Language Service plugin for YAML

  • Versions: 6
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 442 Last month
Rankings
Dependent repos count: 24.1%
Average: 29.4%
Dependent packages count: 34.7%
Maintainers (1)
cabralpinto
Last synced: 9 months ago

Dependencies

.github/workflows/publish.yaml actions
  • actions/checkout v4 composite
  • actions/setup-node v4 composite
package-lock.json npm
  • @types/node 24.2.0 development
  • prettier 3.6.2 development
  • undici-types 7.10.0 development
  • typescript 5.9.2
  • yaml 2.8.1
package.json npm
  • @types/node ^24.2.0 development
  • prettier ^3.6.2 development
  • typescript ^5.9.2
  • yaml ^2.8.1