Skip to content

docs: clarify compiler setup for TypeScript 7 applications #2862

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
shreyam1008 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify compiler setup for TypeScript 7 applications #2862

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion docs/introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,19 @@ _Note: OpenAPI 2.x is supported with versions `5.x` and previous_
This library requires the latest version of [Node.js](https://nodejs.org) installed (20.x or higher recommended). With that present, run the following in your project:

```bash
npm i -D openapi-typescript typescript
npm i -D openapi-typescript typescript@5
```

::: warning TypeScript 7 applications

The generator needs the JavaScript compiler API provided by its TypeScript 5 peer dependency.
TypeScript 7.0 does not expose that API through `typescript`. Keep your application's TypeScript 7
compiler and run generation in a separate tooling package with `openapi-typescript` and
`typescript@5`. Your application can still type-check the generated types with TypeScript 7.
See [Node.js setup](./node.md#setup) for the compiler boundary when using custom transforms.

:::

And in your `tsconfig.json`, to load the types properly:

::: code-group
Expand Down
9 changes: 8 additions & 1 deletion docs/node.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,16 @@ The Node API may be useful if dealing with dynamically-created schemas, or you
## Setup

```bash
npm i --save-dev openapi-typescript typescript
npm i --save-dev openapi-typescript typescript@5
```

For applications using TypeScript 7, run the generator script in a separate tooling package with
these dependencies; leave the application's compiler unchanged. Import `typescript` from that
tooling package in custom transforms too: callbacks and returned AST nodes must use the same
JavaScript compiler API as the generator. Pass the generated source file, not compiler AST objects,
to the TypeScript 7 application. This is side-by-side tooling, not native TypeScript 7 API support.
See [TypeScript's side-by-side guidance](https://devblogs.microsoft.com/typescript/announcing-typescript-7-0/#running-side-by-side-with-typescript-6.0).

::: tip Recommended

For the best experience, use Node ESM by adding `"type": "module"` to `package.json` ([docs](https://nodejs.org/api/esm.html#enabling))
Expand Down
Loading