mirror of
https://github.com/zitadel/zitadel.git
synced 2025-12-12 12:29:04 +00:00
36 lines
796 B
Markdown
36 lines
796 B
Markdown
|
|
# ZITADEL TypeScript Config
|
||
|
|
|
||
|
|
This package provides the TypeScript configuration used by ZITADEL projects. It includes a set of rules and settings to ensure consistent TypeScript configuration across all ZITADEL codebases.
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
To install the package, use npm or yarn:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
npm install @zitadel/tsconfig
|
||
|
|
```
|
||
|
|
|
||
|
|
or
|
||
|
|
|
||
|
|
```sh
|
||
|
|
yarn add @zitadel/tsconfig
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
To use the TypeScript configuration in your project, extend it in your `tsconfig.json` file:
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"extends": "@zitadel/tsconfig/tsup.json"
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
|
||
|
|
For detailed documentation and configuration options, please refer to the [TypeScript documentation](https://www.typescriptlang.org/docs/).
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
Contributions are welcome! Please read the contributing guidelines before getting started.
|