Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/simonkovtyk/esbuild-plugin-typescript
The plugin enhances the build process by seamlessly integrating TypeScript, offering powerful features like type checking, automatic generation of .d.ts files, and ensuring robust type safety throughout.
https://github.com/simonkovtyk/esbuild-plugin-typescript
declarations dts dts-generator esbuild esbuild-plugin esbuild-plugins ts tsc type-check type-safe type-safety types typescript
Last synced: 14 days ago
JSON representation
The plugin enhances the build process by seamlessly integrating TypeScript, offering powerful features like type checking, automatic generation of .d.ts files, and ensuring robust type safety throughout.
- Host: GitHub
- URL: https://github.com/simonkovtyk/esbuild-plugin-typescript
- Owner: simonkovtyk
- License: mit
- Created: 2024-09-14T08:32:02.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-09-26T20:52:56.000Z (3 months ago)
- Last Synced: 2024-11-28T11:45:36.676Z (24 days ago)
- Topics: declarations, dts, dts-generator, esbuild, esbuild-plugin, esbuild-plugins, ts, tsc, type-check, type-safe, type-safety, types, typescript
- Language: TypeScript
- Homepage:
- Size: 24.4 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
TypeScript Plugin
The plugin enhances the build process by seamlessly integrating TypeScript, offering powerful features like type checking, automatic generation of .d.ts files, and ensuring robust type safety throughout.
Add a ⭐ to this repository — *it motivates me a lot!*
## ⚡️ Getting started
Simply install this package with your package manager.
````shell
npm install -D esbuild-plugin-typescript
````
📦 other package manager
Here are examples for installing the package with other package manager.
> 💾 **yarn**
> ````shell
> yarn add -D esbuild-plugin-typescript
> ````
> 💾 **pnpm**
> ````shell
> pnpm install -D esbuild-plugin-typescript
> ````
Looks good so far 🔥 — now you have installed the latest version!
## 💡 Introduction
This esbuild plugin integrates TypeScript, generating .d.ts files and performing type checks based on the user's tsconfig.json. It uses the TypeScript compiler API to ensure strict type checks that
esbuild alone can't provide.
During the build, TypeScript is compiled to JavaScript while .d.ts files are created simultaneously. The plugin runs tsc in a subprocess to handle type checking
independently from esbuild’s fast bundling. This ensures type safety without sacrificing performance. It respects the user's configuration, ensuring compatibility with various project setups.
## 🔧 Usage
```typescript
typescriptPlugin(options);
```
This function needs to be called inside the esbuild configuration in order to use this plugin. It will provide the plugin inside the build process of esbuild.
Show an example of the integration
````typescript
esbuild.build({
// some configuration...
plugins: [
typescriptPlugin();
// more plugins here...
]
})
````
Show an example of the configuration
````typescript
typescriptPlugin({
// configure here
});
````
### Properties
#### ``overridePathToTsconfig``
> Default: ``undefined`` (esbuild's tsconfig file)
A ``string`` that determines the path to the tsconfig.
Show an example
````typescript
typescriptPlugin({
overridePathToTsconfig: "libs/my-lib/tsconfig.json" // any path allowed
});
````
### Returns
Type: ``Plugin``
An instance of this plugin, that will be used by esbuild automatically.
## License
The MIT License (MIT) - Please have a look at the [License](https://github.com/simonkovtyk/esbuild-plugin-typescript/blob/main/LICENSE) file for more details.
## Contributing
Want to contribute to an open-source project on GitHub but unsure where to start? Check out this comprehensive step-by-step guide on how to contribute effectively!
From forking the repository to creating pull requests, this guide walks you through every stage of the process, helping you make a successful contribution to this GitHub project. Start collaborating,
learn new skills, and make an impact on this project!
[See here](https://github.com/simonkovtyk/esbuild-plugin-typescript/blob/main/docs/guides/HOW_TO_CONTRIBUTE.md) for the contribute guide at GitHub.
GitHub [@simonkovtyk](https://github.com/simonkovtyk)