TypeScript support using Babel 7 #4837

brunolemos · 2018-07-29T21:07:14Z

Adds TypeScript support.

Closes #4146
Closes #2815

The user can just rename .js to .tsx and it will work.

To enable type checking, the user needs to create a tsconfig.json file at the root directory and install the typescript fork-ts-checker-webpack-plugin dependencies. It will appear at the same console as the build one. Another option is to install only typescript and run npx tsc -w on a new terminal tab instead.

Includes

Support .ts and .tsx file extensions
Support type checking using fork-ts-checker-webpack-plugin (opt in)
Support media imports json, bmp, gif, jpeg, jpg, png and svg
Support typescript option on react-app babel preset to enable/disable @babel/preset-typescript (enabled by default, just like flow)
Update docs
Basic test

These items were included, but removed per review suggestion

~~TSLint support using fork-ts-checker-webpack-plugin~~ (#4837 (comment), #4837 (comment))
~~ESLint support for TypeScript files using typescript-eslint-parser~~ (#4837 (comment))
~~Support tsconfig.prod.json and tslint.prod.json~~ (#4837 (comment))
~~Automatically enable flow or typescript presets by detecting .flowconfig and tsconfig.json~~
~~Prevent enabling both flow and typescript in the same project~~

Pending suggestions (help wanted!)

~~Fix build test not passing even though it's correct (#5440)~~
Add more advanced tests
~~Use async: true on type checking? (would need to fix errors not showing up)~~ (it's ok for this first iteration)
~~Make sure ESLint works great on tsx files~~
~~Make sure there are no conflicts between typescript preset and flow plugin because both are being enabled together by default~~ (none were found or reported by now)
Automatically generate a tsconfig.json when typescript is imported for the first time?
Check and force some tsconfig.json options like isolatedModules: true?
~~Remove typescript dependency? (will probably need to change something on fork-ts-checker-webpack-plugin, because it isn't working without it)~~
Re-run type checking after changing files that webpack is not watching? (#4837 (comment))
~~Enable type checking on test files using ts-jest? (#4837 (comment))~~ (no)

Screenshot

type TestType = 'a' | 'b'
const x: TestType = 123

How to try this PR while it's not merged

Clone
- git clone git@github.com:brunolemos/create-react-app.git
- cd create-react-app
- git checkout next-typescript
Compile
- yarn
Create Link
- cd packages/react-scripts/
- yarn link
Create New Project
- cd ~/your/projects/folder
- npx create-react-app app-name
- cd app-name
Use Link
- yarn link react-scripts
Setup TypeScript
- Follow the steps from the readme: Adding TypeScript
Finish
- yarn start
- Have fun with types 🎉

ianschmitz · 2018-07-30T01:48:48Z

One way to fix image imports TS error:

https://github.com/wmonk/create-react-app-typescript/blob/e4b1f9424fa14f7aae7f0cbf5fd64e18dd273527/packages/react-scripts/template/images.d.ts

However this doesn't take into account the recent improvements made in CRA 2.0 such as #3718

brunolemos · 2018-07-30T21:26:55Z

@iainbeeston thanks! I added an index.d.ts file fixing jpg, png and svg.
It also includes typings for the svg ReactComponent.

We currently only have one template folder so this way the index.d.ts will be available on non-typescript projects as well, not sure if that's a problem. Maybe it's a good thing, because it adds autocomplete to js projects as well.

frankwallis · 2018-08-13T09:29:38Z

packages/react-scripts/template/index.d.ts

@@ -0,0 +1,12 @@
+declare module '*.jpg'


I don't think this file should be called index.d.ts as this name will conflict with the automatically generated typings file for index.ts. In my projects I normally call this file externals.d.ts or similar but I don't really mind what it is called.

frankwallis · 2018-08-13T09:32:36Z

packages/react-scripts/template/index.d.ts

+declare module '*.png'
+
+declare module '*.svg' {
+  import * as React from 'react'


To be consistent with index.js this should be import React from 'react'. This does assume that esModuleInterop: true is specified in tsconfig.json but I think this is best practice for new projects as it means that typescript and babel are more closely aligned.

frankwallis · 2018-08-13T09:32:41Z

packages/react-scripts/template/index.d.ts

+declare module '*.svg' {
+  import * as React from 'react'
+
+  export const ReactComponent: React.SFC<React.SVGProps<SVGSVGElement>>


I'm interested to know why this is needed?

frankwallis · 2018-08-13T09:34:28Z

packages/react-scripts/template/src/App.test.js

@@ -1,5 +1,7 @@
+import 'jest';


An alternative to adding this import is to add types: [ 'jest' ] to tsconfig.json

I don't believe either should be needed. Typescript should pick up the node_modules/@types definitions automatically without any extra effort.

frankwallis · 2018-08-13T09:40:02Z

packages/react-scripts/template/README.md

+```json
+{
+  "compilerOptions": {
+    "target": "ESNEXT",


nit: capitalization

samuelcastro · 2018-10-19T22:37:29Z

@brunolemos I saw that these items were removed:

TSLint support using fork-ts-checker-webpack-plugin
ESLint support for TypeScript files using typescript-eslint-parser

Any reasons why? Which one should we use, would tslint make more sense since it's typescript? And last, how to use it with tslint?

brunolemos · 2018-10-20T11:52:19Z

@samuelcastro: I saw that these items were removed, any reasons why?

TL/DR, ESLint was not enabled on ts files because it requires typescript-eslint-parser which is still not mature and has a big Help Wanted! banner in the readme, which could cause maintainability issues for the CRA team. It also targets specific versions of typescript which could prevent users from upgrading. (#4837 (comment), #4837 (comment))

TSLint built-in support was removed because CRA itself does not lint style preferences, but only critical things like undeclared variable names and typescript already has good defaults for this. Also, the user can run tslint on their own with no problem. (#4837 (comment))

stunaz · 2018-10-20T15:51:42Z

Great! Now what? Release, shall we?

packages/react-scripts/scripts/utils/createJestConfig.js

alexdor · 2018-10-21T16:39:31Z

Huge thanks to @brunolemos for all his effort and of course huge thanks to the team of create react app : ) Can't wait for this to be released : )

brunolemos · 2018-10-21T16:54:38Z

IT'S MERGED 🎉🎉🎉
Thanks everyone for the motivation and reviews, and thanks @Timer for merging!

EDIT: Just tweeted about it

💙

RIP21 · 2018-10-21T19:05:19Z

Amazing stuff! :) Finally :)

noahjohn9259 · 2018-10-22T08:03:41Z

Many thanks to @brunolemos for your efforts.. Looking forward for the release :)

johnnyreilly · 2018-10-22T08:07:48Z

I'm so happy this has merged!

A future improvement could be strongly typed JSON support by setting this option in tsconfig.json:

	"resolveJsonModule": true

veeral-patel · 2018-10-22T23:43:01Z

Awesome. Thank you!

Timer · 2018-10-23T00:57:37Z

I've locked this PR since it's high profile and to keep notification spam low. We'll post updates here when we have them.

Please file any concerns as new issues, thanks!

Timer · 2018-10-30T04:32:40Z

TypeScript is now officially supported as of Create React App 2.1. Read the release notes to get started!

facebook-github-bot added the CLA Signed label Jul 29, 2018

brunolemos mentioned this pull request Jul 29, 2018

RFC: Zero-config TypeScript with Babel 7 #4146

Closed

brunolemos force-pushed the brunolemos:next-typescript branch 3 times, most recently Jul 29, 2018

brunolemos mentioned this pull request Jul 29, 2018

TypeScript support #2815

Closed

brunolemos force-pushed the brunolemos:next-typescript branch 6 times, most recently Aug 9, 2018

brunolemos mentioned this pull request Aug 10, 2018

Migrate react-scripts to v2 wmonk/create-react-app-typescript#284

Open

brunolemos force-pushed the brunolemos:next-typescript branch 10 times, most recently to f33e0ca Aug 10, 2018

frankwallis reviewed Aug 13, 2018

View changes

packages/react-scripts/template/README.md Outdated

```json

{

"compilerOptions": {

"target": "ESNEXT",

This comment has been minimized.

Sign in to view

frankwallis Aug 13, 2018

nit: capitalization

iansu mentioned this pull request Oct 19, 2018

Typescript directly with babel7 #5489

Closed

brunolemos force-pushed the brunolemos:next-typescript branch 2 times, most recently Oct 20, 2018

brunolemos force-pushed the brunolemos:next-typescript branch Oct 20, 2018

TypeScript support

Verified

This commit was signed with a verified signature.

brunolemos Bruno Lemos

GPG key ID: 56ECEA49AAC4CE9F Learn about signing commits

Loading status checks…

506d173

brunolemos force-pushed the brunolemos:next-typescript branch to 506d173 Oct 20, 2018

Timer merged commit 88aef11 into facebook:master Oct 21, 2018
1 of 2 checks passed

1 of 2 checks passed

continuous-integration/appveyor/pr AppVeyor build failed
Details

continuous-integration/travis-ci/pr The Travis CI build passed
Details

Timer mentioned this pull request Oct 21, 2018

Ensure TypeScript files outside of build are not checked for build errors #5509

Closed

yordis reviewed Oct 21, 2018

View changes

packages/react-scripts/scripts/utils/createJestConfig.js Show resolved Hide resolved

This was referenced Oct 21, 2018

Fix peer dependencies wmonk/create-react-app-typescript#387

Closed

Replace TSLint with eslint-config-react-app-ts wmonk/create-react-app-typescript#388

Closed

kdnk mentioned this pull request Oct 22, 2018

[Public] Frontend Night #23 wantedly/frontend-night#23

Closed

eps1lon mentioned this pull request Oct 22, 2018

[docs] AppBar and Textfield demos in TypeScript mui-org/material-ui#13229

Merged

2 of 2 tasks complete

ianschmitz mentioned this pull request Oct 22, 2018

[WIP] TypeScript final touches #5514

Closed

0 of 3 tasks complete

brunolemos mentioned this pull request Oct 22, 2018

Enable TypeScript json module resolver #5531

Merged

facebook locked as resolved and limited conversation to collaborators Oct 23, 2018

brunolemos deleted the brunolemos:next-typescript branch Oct 23, 2018

facebook / create-react-app

TypeScript support using Babel 7 #4837

TypeScript support using Babel 7 #4837

brunolemos commented Jul 29, 2018 •

edited

ianschmitz commented Jul 30, 2018

brunolemos commented Jul 30, 2018 •

edited

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

samuelcastro commented Oct 19, 2018 •

edited

brunolemos commented Oct 20, 2018 •

edited

stunaz commented Oct 20, 2018

alexdor commented Oct 21, 2018

brunolemos commented Oct 21, 2018 •

edited

RIP21 commented Oct 21, 2018

noahjohn9259 commented Oct 22, 2018

johnnyreilly commented Oct 22, 2018

veeral-patel commented Oct 22, 2018

Timer commented Oct 23, 2018 •

edited

Timer commented Oct 30, 2018

facebook / create-react-app

Sponsor facebook/create-react-app

TypeScript support using Babel 7 #4837

TypeScript support using Babel 7 #4837

Conversation

brunolemos commented Jul 29, 2018 • edited

Includes

These items were included, but removed per review suggestion

Pending suggestions (help wanted!)

Screenshot

How to try this PR while it's not merged

ianschmitz commented Jul 30, 2018

brunolemos commented Jul 30, 2018 • edited

This comment has been minimized.

frankwallis Aug 13, 2018

This comment has been minimized.

frankwallis Aug 13, 2018 • edited

This comment has been minimized.

frankwallis Aug 13, 2018

This comment has been minimized.

frankwallis Aug 13, 2018

This comment has been minimized.

ianschmitz Aug 13, 2018 Collaborator

This comment has been minimized.

frankwallis Aug 13, 2018

samuelcastro commented Oct 19, 2018 • edited

brunolemos commented Oct 20, 2018 • edited

stunaz commented Oct 20, 2018

alexdor commented Oct 21, 2018

brunolemos commented Oct 21, 2018 • edited

RIP21 commented Oct 21, 2018

noahjohn9259 commented Oct 22, 2018

johnnyreilly commented Oct 22, 2018

veeral-patel commented Oct 22, 2018

Timer commented Oct 23, 2018 • edited

Timer commented Oct 30, 2018

brunolemos commented Jul 29, 2018 •

edited

brunolemos commented Jul 30, 2018 •

edited

frankwallis Aug 13, 2018 •

edited

ianschmitz Aug 13, 2018
Collaborator

samuelcastro commented Oct 19, 2018 •

edited

brunolemos commented Oct 20, 2018 •

edited

brunolemos commented Oct 21, 2018 •

edited

Timer commented Oct 23, 2018 •

edited