-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #699 from microsoft/babel_tsc
Adds a doc for babel + tsc in a project
- Loading branch information
Showing
2 changed files
with
49 additions
and
0 deletions.
There are no files selected for viewing
48 changes: 48 additions & 0 deletions
48
packages/handbook-v1/en/tutorials/Babel with TypeScript.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
--- | ||
title: Using Babel with TypeScript | ||
layout: docs | ||
permalink: /docs/handbook/tutorials/babel-with-typescript.html | ||
oneline: How to create a hybrid Babel + TypeScript project | ||
--- | ||
|
||
# Babel vs `tsc` for TypeScript | ||
|
||
When making a modern JavaScript project, you might ask yourself what the right way to convert files from TypeScript to JavaScript. | ||
|
||
A lot of the time the answer is _"it depends"_, or _"someone may have decided for you"_ depending on the project. If you are building your project with an existing framework like [tsdx](https://www.npmjs.com/package/tsdx), [Angular](https://angular.io/), [NestJS](https://nestjs.com/) or any framework mentioned in the [Getting Started](/docs/home) then this decision is handled for you. | ||
|
||
However, a useful heuristic could be: | ||
|
||
- Is your build output mostly the same as your source input files? Use `tsc` | ||
- Do you need a build pipeline with multiple potential outputs? Use `babel` for transpiling and `tsc` for type checking | ||
|
||
## Babel for transpiling, `tsc` for types | ||
|
||
This is a common pattern for projects with existing build infrastructure which may have been ported from a JavaScript codebase to TypeScript. | ||
|
||
This technique is a hybrid approach, using Babel's [preset-typescript](https://babeljs.io/docs/en/babel-preset-typescript) to generate your JS files, and then using TypeScript to do type checking and `.d.ts` file generation. | ||
|
||
By using babel's support for TypeScript, you get the ability to work with existing build pipelines and are more likely to have a faster JS emit time because Babel does not type check your code. | ||
|
||
#### Type Checking and d.ts file generation | ||
|
||
The downside to using babel is that you don't get type checking during the transition from TS to JS. This can mean that type errors which you miss in your editor could sneak through into production code. | ||
|
||
In addition to that, Babel cannot create `.d.ts` files for your TypeScript which can make it harder to work with your project if it is a library. | ||
|
||
To fix these issues, you would probably want to set up a command to type check your project using TSC. This likely means duplicating some of your babel config into a corresponding [`tsconfig.json`](/tconfig) and ensuring these flags are enabled: | ||
|
||
```json | ||
"compilerOptions": { | ||
// Ensure that .d.ts files are created by tsc, but not .js files | ||
"declaration": true, | ||
"emitDeclarationOnly": true, | ||
// Ensure that Babel can safely transpile files in the TypeScript project | ||
"isolatedModules": true | ||
} | ||
``` | ||
|
||
For more information on these flags: | ||
|
||
- [`isolatedModules`](/tsconfig#isolatedModules) | ||
- [`declaration`](/tsconfig#declaration), [`emitDeclarationOnly`](/tsconfig#emitDeclarationOnly) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters