Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/herberttn/vite-plugin-typescript-transform
Applies the TypeScript compiler during vite's transform build phase.
https://github.com/herberttn/vite-plugin-typescript-transform
decorators ecmascript transform typescript vite vite-plugin
Last synced: 8 days ago
JSON representation
Applies the TypeScript compiler during vite's transform build phase.
- Host: GitHub
- URL: https://github.com/herberttn/vite-plugin-typescript-transform
- Owner: herberttn
- License: mit
- Created: 2023-07-02T23:17:33.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-17T00:17:44.000Z (6 months ago)
- Last Synced: 2024-10-28T06:32:14.476Z (12 days ago)
- Topics: decorators, ecmascript, transform, typescript, vite, vite-plugin
- Language: TypeScript
- Homepage:
- Size: 17.6 KB
- Stars: 16
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- fucking-awesome-vite - vite-plugin-typescript-transform - Applies the TypeScript compiler during Vite's transform build phase. (Plugins / Framework-agnostic Plugins)
- awesome-vite - vite-plugin-typescript-transform - Applies the TypeScript compiler during Vite's transform build phase. (Plugins / Framework-agnostic Plugins)
README
vite-plugin-typescript-transform
---
[![ci][badge-workflow-ci]][badge-workflow-ci-link]
[![npm][badge-npm]][badge-npm-link]
[![license][badge-license]][badge-license-link]
[badge-license]: https://img.shields.io/github/license/herberttn/vite-plugin-typescript-transform?style=flat-square
[badge-license-link]: ./LICENSE.md
[badge-npm]: https://img.shields.io/npm/v/vite-plugin-typescript-transform?logo=npm&style=flat-square
[badge-npm-link]: https://www.npmjs.com/package/vite-plugin-typescript-transform
[badge-workflow-ci]: https://img.shields.io/github/actions/workflow/status/herberttn/vite-plugin-typescript-transform/ci.yml?branch=main&label=ci&logo=github&style=flat-square
[badge-workflow-ci-link]: https://github.com/herberttn/vite-plugin-typescript-transform/actions/workflows/ci.yml
Applies the TypeScript compiler during Vite transform build phase.
This plugin may allow the use of language features not yet supported by [`vite's`][link-to-vite] default compiler, [`esbuild`][link-to-esbuild].
[link-to-ecmascript-decorators]: https://tc39.es/proposal-decorators
[link-to-esbuild]: https://www.npmjs.com/package/esbuild
[link-to-nodejs]: https://nodejs.org
[link-to-typescript-v5-announcement]: https://devblogs.microsoft.com/typescript/announcing-typescript-5-0
[link-to-typescript]: https://www.npmjs.com/package/typescript
[link-to-vite]: https://www.npmjs.com/package/vite
[link-to-options]: ./src/types.ts#L4
### Install
```shell
npm install --save-dev vite-plugin-typescript-transform
```
### Options
See the [`Options`][link-to-options] interface and its inline documentation.
### Warning
This plugin does not change or disable any of [`vite's`][link-to-vite] compiler/features/options. It only transpiles the code using the [`typescript`][link-to-typescript] compiler and lets [`vite`][link-to-vite] move on with the transpiled code.
### Transform ECMAScript decorators
The new [ECMAScript decorators][link-to-ecmascript-decorators] are not supported by [`esbuild`][link-to-esbuild] (yet), but they are supported by [`typescript`][link-to-typescript] since `v5` ([see the announcement][link-to-typescript-v5-announcement]). This example down-levels the new decorators into code that is usable in runtimes that do not yet support it.
```typescript
import ts from 'typescript';
import { defineConfig } from 'vite';
import { vitePluginTypescriptTransform } from 'vite-plugin-typescript-transform';
export default defineConfig({
// ...your vite configuration
plugins: [
vitePluginTypescriptTransform({
enforce: 'pre',
filter: {
files: {
include: /\.ts$/,
},
},
tsconfig: {
override: {
target: ts.ScriptTarget.ES2021,
},
},
}),
],
});
```