Skip to content
This repository was archived by the owner on Jan 26, 2019. It is now read-only.

Commit 5d26cfc

Browse files
committed
Bring readme back
1 parent 46029ba commit 5d26cfc

File tree

1 file changed

+137
-5
lines changed

1 file changed

+137
-5
lines changed

README.md

Lines changed: 137 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,139 @@
1-
# react-scripts
1+
# `react-scripts-ts` [![npm version](https://badge.fury.io/js/react-scripts-ts.svg)](https://badge.fury.io/js/react-scripts-ts) [![Build Status](https://travis-ci.org/wmonk/create-react-app-typescript.svg?branch=master)](https://travis-ci.org/wmonk/create-react-app-typescript)
22

3-
This package includes scripts and configuration used by [Create React App](https://github.com/facebookincubator/create-react-app).<br>
4-
Please refer to its documentation:
3+
Create React apps (with Typescript) with no build configuration.
54

6-
* [Getting Started](https://github.com/facebookincubator/create-react-app/blob/master/README.md#getting-started) – How to create a new app.
7-
* [User Guide](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App.
5+
* [Getting Started](#tldr) – How to create a new app.
6+
* [User Guide](https://github.com/wmonk/create-react-app-typescript/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with react scripts ts.
7+
8+
_Do you know react and want to try out typescript? Or do you know typescript and want to try out react?_ Get all the benefits from `create-react-app` but you use typescript! 🚀
9+
10+
## tl;dr
11+
12+
```sh
13+
npm install -g create-react-app
14+
15+
create-react-app my-app --scripts-version=react-scripts-ts
16+
cd my-app/
17+
npm start
18+
```
19+
20+
## Migration
21+
22+
In general, most upgrades won't require any migration steps to work, but if you experience problems after an upgrade, please file an issue, and we'll add it to the list of migration steps below.
23+
24+
### From `<2.5.0` to `>=2.5.0`
25+
26+
Version `2.5.0` introduces a new config file for jest, that is necessary for the tests to run. If you were previously running a version older than `v2.5.0` and upgraded to `v2.5.0` or newer, you need to manually add the new file, or else you'll get an error similar to this when trying to run your tests:
27+
28+
```javascript
29+
Test suite failed to run
30+
31+
{
32+
"messageText": "Cannot read file 'C:\\[project]\\tsconfig.test.json': ENOENT: no such file or directory, open 'C:\\[project]\\tsconfig.test.json'.",
33+
"category": 1,
34+
"code": 5012
35+
}
36+
```
37+
38+
To fix this, create a new file *in the root of the project* called `tsconfig.test.json`, and paste [the content of this file into it](https://raw.githubusercontent.com/wmonk/create-react-app-typescript/master/packages/react-scripts/template/tsconfig.test.json). Everything should work now. For more info, please see [this issue](https://github.com/wmonk/create-react-app-typescript/issues/141).
39+
40+
## Changelog
41+
42+
### 2.12.0
43+
* Update typescript to 2.6.2
44+
45+
### 2.11.0
46+
* Upgrade to [`react-scripts@1.0.17`](https://github.com/facebookincubator/create-react-app/releases/tag/v1.0.17)
47+
48+
### 2.10.0
49+
* README updates - StefanSchoof
50+
* README updates - DorianGrey
51+
* Add support for fork-ts-checker-webpack-plugin - johnnyreilly
52+
53+
### 2.9.0 - UNPUBLISHED
54+
This included changes that were not published by the facebook upstream, so was unpublished.
55+
56+
### 2.8.0
57+
* Update typescript to 2.5.3 - @nicolaserny
58+
59+
### 2.7.0
60+
* Merge react-scripts@1.0.13 - @JohnNilsson
61+
* Fix git tempalte - @hktonylee
62+
* Provide migration docs - @JReinhold
63+
* Updated dependencies - @swengorschewski
64+
* Fix tslint config - @comerc
65+
66+
### 2.6.0
67+
* Merge react-scripts@1.0.10 - @wmonk
68+
* Update component template - @pelotom
69+
70+
### 2.5.0
71+
* Support dynamic imports - thanks @nicolaserny, @DorianGrey
72+
* Fix up tsconfig - thanks @js-n
73+
* Fix readme typo - thanks @adambowles
74+
* Move to ts-jest - thanks @DorianGrey
75+
76+
### 2.4.0
77+
* Upgrade typescript to 2.4 and ts-loader to 2.2.1 - thanks @frederickfogerty
78+
* Fix readme typo - thanks @wrongway4you
79+
80+
### 2.3.2
81+
* Fix `typescript` version to 2.3.x until 2.4 @types are fixed
82+
83+
### 2.3.1
84+
85+
* All tsc to parse config (for `extend`) - Thanks to @DorianGrey
86+
* Fix various jest issues - thanks to @zinserjan
87+
* Fix code coverage - thanks to @zinserjan
88+
89+
### 2.2.0
90+
* Upgrade to [`react-scripts@1.0.6`](https://github.com/facebookincubator/create-react-app/)
91+
92+
### 2.1.0
93+
* Update to `tslint@5.2.0` - thanks to @mindjuice
94+
* Fix test setup issue - thanks to @jonmpqts
95+
* Add `source-map-loader` - thanks to @Place1
96+
* Update to `typescript@2.3.3` - thanks to @sjdweb
97+
98+
### 2.0.1
99+
* Fix issue with jest finding test files
100+
101+
### 2.0.0
102+
* Upgrade to [`react-scripts@1.x.x`](https://github.com/facebookincubator/create-react-app/blob/0d1521aabf5a0201ea1bcccc33e286afe048f820/CHANGELOG.md)
103+
104+
### 1.4.0
105+
* Upgrade to typescript@2.3.2 - thanks to @patrick91
106+
* Add tests around react-scripts-ts - thanks to @migerh
107+
108+
### 1.3.0
109+
* Upgrade to typescript@2.2.2 - thanks to @jeremistadler
110+
111+
### 1.1.8
112+
* Fix regression where no `@types` were being installed on init
113+
114+
### 1.1.7
115+
* Merge facebookincubator/create-react-app@0.9.5 into react-scripts-ts
116+
* Merge facebookincubator/create-react-app@0.9.4 into react-scripts-ts
117+
* Merge facebookincubator/create-react-app@0.9.3 into react-scripts-ts
118+
* Merge facebookincubator/create-react-app@0.9.2 into react-scripts-ts
119+
* Merge facebookincubator/create-react-app@0.9.1 into react-scripts-ts
120+
121+
### 1.1.6
122+
* Merge facebookincubator/create-react-app@0.9.0 into react-scripts-ts
123+
124+
### 1.0.6
125+
* Add missing `cli-highlight` dependency
126+
127+
### 1.0.5
128+
* Print file names when running `npm run build`
129+
* Add support for `setupTest.ts`
130+
* Highlight source code when erroring in `npm run build`
131+
132+
### 1.0.4
133+
* Change mentions of `eslint` to `tslint`
134+
135+
### 1.0.3
136+
* Remove hidden character from `tsconfig.json`
137+
138+
### 1.0.2
139+
* Copy `typescriptTransform.js` when running `npm run eject`

0 commit comments

Comments
 (0)