https://github.com/si3nloong/svelte-dts-gen

Svelte TypedDefinition Generator
https://github.com/si3nloong/svelte-dts-gen

dts jsdoc svelte-dts svelte3 typescript

Last synced: 6 months ago
JSON representation

Svelte TypedDefinition Generator

• Host: GitHub
• URL: https://github.com/si3nloong/svelte-dts-gen
• Owner: si3nloong
• License: mit
• Created: 2022-12-14T10:36:53.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-16T10:21:46.000Z (over 2 years ago)
• Last Synced: 2025-02-14T02:29:34.931Z (8 months ago)
• Topics: dts, jsdoc, svelte-dts, svelte3, typescript
• Language: JavaScript
• Homepage:
• Size: 63.5 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Svelte dts generator

> Create the Typescript declaration files for your Svelte library and project.

[![npm version](https://badge.fury.io/js/svelte-dts-gen.svg)](https://www.npmjs.com/package/svelte-dts-gen)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/si3nloong/svelte-dts-gen/blob/master/LICENSE)

[![Node.js CI](https://github.com/si3nloong/svelte-dts-gen/workflows/Matrix%20Testing/badge.svg)](https://github.com/si3nloong/svelte-dts-gen/actions/workflows/test.yml)

## Requirement

- Nodejs ^18.0.0

## Installation

```console

npm i svelte-dts-gen

```

## How it works

The `svelte-dts-gen` interpret the properties, events and slot properties in the svelte code, using typescript and svelte compiler to generate the **TypeScript Declaration** files. `svelte-dts-gen` will generate the declaration based on typescript type, jsdoc, or javascript default type.

## License

[svelte-dts-gen](https://github.com/si3nloong/svelte-dts-gen) is 100% free and open-source, under the [MIT license](https://github.com/si3nloong/svelte-dts-gen/blob/main/LICENSE).

## Big Thanks To

Thanks to these awesome companies for their support of Open Source developers ❤

[![GitHub](https://jstools.dev/img/badges/github.svg)](https://github.com/open-source)

[![NPM](https://jstools.dev/img/badges/npm.svg)](https://www.npmjs.com/)

Inspired by [svelte-dts](https://github.com/si3nloong/svelte-dts-gen).