Migrating create-react-app from javascript to typescript
Create React App v2.1.0 was released today with TypeScript support today. That means you no longer need to eject or use the react-scripts-ts
fork; all you need to do if you have an existing Create React App project is install the required packages:
$ npm install --save typescript @types/node @types/react @types/react-dom @types/jest
$ # or
$ yarn add typescript @types/node @types/react @types/react-dom @types/jest
You can then simply rename .js
files to .ts
files to start using TypeScript.
(If you have an existing app using the create-react-app-typescript fork, here's a tutorial on how to port it to regular Create React App.)
UPDATE: create-react-app version 2.1.0 support typescript so for those of you who are starting from scratch you can use it to create new application with typescript, and according to the documentation it should be done with the following command:
$ npx create-react-app my-app --typescript
For existing projects, after updating to version 2.1.0, add the following packages to your project's dependencies with the following command:
$ npm install --save typescript @types/node @types/react @types/react-dom @types/jest
and then you can simply rename .js to .ts files.
I found a solution to migrate create-react-app from javascript to typescript, this way doesn't require eject.
- Create a temporary react project with typescript by running the command
create-react-app --scripts-version=react-scripts-ts
(Note - requirescreate-react-app
to be installed globally) - In your own project - under
package.json
file remove thereact-scripts
- Add
react-scripts-ts
to your project by running the commandyarn add react-scripts-ts
or if your are using npm thennpm install react-scripts-ts
. Or, add"react-scripts-ts": "2.8.0"
to package.json. - From the project you created in step 1 copy the files:
tsconfig.json, tsconfig.test.json tslint.json
to your own project - Under your own project, in
package.json
, under scripts section, changereact-scripts
instances toreact-scripts-ts
(should be understart
,build
,test
andeject
- Install the typings for react by installing the following modules using yarn or npm:
@types/node
,@types/react
and@types/react-dom
. Put indevDependencies
section if using package.json. - Change
index.js
file name toindex.tsx
- In your tsconfig.json file add the following configuration:
"allowSyntheticDefaultImports": true
- for more info
NOTE step 7 might require additional modification depends on what you have in your index.js file (if it depends on JS modules in the project).
Now you can run your project and it might work, for those of you who are getting error that contains You may need an appropriate loader to handle this file type
regarding .js files, it happens because babel doesn't know how to load .js file from .tsx files. What we need to do is to change the project configuration. The way I found doing it without running eject
is using react-app-rewired package. This package lets you configure external configuration which will be added/override the default project settings. What we'll do is using babel to load these type of files. Let's moved on:
Install the package
react-app-rewired
using yarn or npmIn your root folder (where
package.json
is located) create a new file with the nameconfig-overrides.js
Put this code in
config-overrides
file:var paths = require('react-scripts-ts/config/paths') module.exports = function override(config) { config.module.rules.push({ test: /\.(js|jsx)$/, include: paths.appSrc, loader: require.resolve('babel-loader'), options: { babelrc: false, presets: [require.resolve('babel-preset-react-app')], cacheDirectory: true, }, }) return config }
Edit package.json so the start/start-js
, build
, test
, and eject
scripts use react-app-rewired as shown in the project readme. E.g. "test": "react-app-rewired test --scripts-version react-scripts-ts --env=jsdom"
.
Now you can start you the project and the problem should be solved. You might need additional modifications depending on your project (additional types and so).
Hope it helps
As suggested here in the comments, it's possible to define: "compilerOptions": { "allowJs": true}
in your tsconfig.json file, so you can mix JS and TS without react-app-rewired. Thanks for mention this!