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

Commit d9df690

Browse files
author
Ray Booysen
committed
docs(*): improve readability of the README.md
Some minor commits with grammar to improve readability of the README
1 parent bbe91d8 commit d9df690

File tree

1 file changed

+19
-20
lines changed

1 file changed

+19
-20
lines changed

README.md

+19-20
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
[![Build Status](https://travis-ci.org/s-panferov/awesome-typescript-loader.svg?branch=master)](https://travis-ci.org/s-panferov/awesome-typescript-loader)
55

66
TypeScript loader for Webpack. This project was started as a fork of https://github.com/andreypopp/typescript-loader.
7-
Thanks @andreypopp for the great project.
7+
Thanks to @andreypopp for the great project.
88

99
The main goal of this loader is to support the **watch** mode and *webpack-dev-server* with **incremental** compilation.
10-
Also there are a lot of problems in other TypeScript loaders that were fixed here.
10+
There are a lot of problems in other TypeScript loaders that are fixed here.
1111

1212
## Installation
1313

@@ -25,15 +25,15 @@ npm install awesome-typescript-loader --save-dev
2525
```javascript
2626
module.exports = {
2727

28-
// Currently we need to add '.ts' to resolve.extensions array.
28+
// Currently we need to add '.ts' to the resolve.extensions array.
2929
resolve: {
3030
extensions: ['', '.ts', '.webpack.js', '.web.js', '.js']
3131
},
3232

33-
// Source maps support (or 'inline-source-map' also works)
33+
// Source maps support ('inline-source-map' also works)
3434
devtool: 'source-map',
3535

36-
// Add loader for .ts files.
36+
// Add the loader for .ts files.
3737
module: {
3838
loaders: [
3939
{
@@ -45,15 +45,15 @@ module.exports = {
4545
};
4646
```
4747

48-
After that, you would be able to build TypeScript files with webpack.
48+
After that, you will be able to build TypeScript files with webpack.
4949

5050
## TS defaults
5151

5252
* target = 'es5'
5353

5454
## tsconfig.json
5555

56-
You can use tsconfig.json file to configure your compiler and loader:
56+
You can use the tsconfig.json file to configure your compiler and loader:
5757

5858
```
5959
{
@@ -71,8 +71,8 @@ You can use tsconfig.json file to configure your compiler and loader:
7171

7272
### compiler *(string) (default='typescript')*
7373

74-
Allows use of TypeScript compilers other than the official one. Should be
75-
set to the NPM name of the compiler, e.g. *ntypescript* or path to a `tsc` file.
74+
Allows use of TypeScript compilers other than the official one. Must be
75+
set to the NPM name of the compiler, e.g. *ntypescript* or the path to a `tsc` file.
7676
Note that the compiler must be installed in **your** project. You can also use
7777
nightly versions.
7878

@@ -82,35 +82,35 @@ Specify whether or not the loader emits webpacks's require type.
8282

8383
### library *(string) (default='es5' possible='es6')*
8484

85-
Allows use of library other than the `target`'s default one. Useful when you want to use ES6 library with ES5 target. Also you might use `library=es6` with Node.
85+
Allows the use of libraries other than the `target`'s default one. Useful when you want to use ES6 library with ES5 target. Additionally you might use `library=es6` with Node.
8686

8787
### instanceName *(string) (default='default')*
8888

89-
Allows to use several TypeScript compilers with different settings in one app. Just override `instanceName` to initialize another instance.
89+
Allows the use of several TypeScript compilers with different settings in one app. Override `instanceName` to initialize another instance.
9090

9191
### reEmitDependentFiles *(boolean) (default=false')*
9292

93-
Collect files dependency graph and re-emit all dependent files along with changed file.
93+
Collect file dependency graph and re-emit all dependent files along with the changed file.
9494

9595
### tsconfig *(string) (default='tsconfig.json')*
9696

97-
Specify path to a TS config file. Useful when you have multiple config files. This setting is useless *inside* TS config file.
97+
Specifies the path to a TS config file. This is useful when you have multiple config files. This setting is useless *inside* a TS config file.
9898

9999
### useWebpackText *(boolean) (default=false)*
100100

101-
Use this setting to force loader to use webpack's way to load files. Useful only with ts-jsx-loader. Builds may become slower.
101+
Use this setting to force the loader to use webpack's method of loading files. Useful only with ts-jsx-loader. Builds may become slower.
102102

103103
### externals *(array)*
104104

105105
Array of paths to .d.ts files that must be included in program. Useful with `rewriteImports`.
106106

107107
### doTypeCheck *(boolean) (default=true)*
108108

109-
Use this setting to disable type checking if you want.
109+
Use this setting to disable type checking.
110110

111111
### forkChecker *(boolean) (default=false)*
112112

113-
Do type checking in a separate process, so webpack don't need to wait. **Significantly** improves development workflow with tools like [react-hot-loader](https://github.com/gaearon/react-hot-loader).
113+
Do type checking in a separate process, so webpack doesn't need to wait. **Significantly** improves development workflow with tools like [react-hot-loader](https://github.com/gaearon/react-hot-loader).
114114

115115
Works only with `ForkCheckerPlugin`:
116116

@@ -136,7 +136,7 @@ Use pre-compiled files if any. Files must be named as `{filename}.js` and `{file
136136

137137
### useCache *(boolean) (default=false)*
138138

139-
Use internal file cache. Useful with Babel, when processing takes a long time to complete. Improves warm-up time.
139+
Use internal file cache. This is useful with Babel, when processing takes a long time to complete. Improves warm-up time.
140140

141141
### cacheDirectory *(string) (default='.awcache')*
142142

@@ -152,7 +152,7 @@ You can pass compiler options inside loader query string or in tsconfig file.
152152

153153
## Using with --watch or webpack-dev-server
154154

155-
This loader has support of both `--watch` and `webpack-dev-server` modes. It handles file dependencies
155+
This loader supports both `--watch` and `webpack-dev-server` modes. It handles file dependencies
156156
using internal webpack dependency markers. When you change a file, the loader recompiles all the dependencies.
157157

158158
## External Modules
@@ -169,8 +169,7 @@ import * as React from 'react';
169169

170170
## Internal Modules
171171

172-
This project doesn't aim to support internal modules, because it's hard to resolve dependencies for the watch
173-
mode if you use such modules. Of course, you can still use them without watch, but this function is **unstable**.
172+
This project doesn't aim to support internal modules, because it's hard to resolve dependencies for the watch mode. Of course, you can still use them without watch, but this function is **unstable**.
174173

175174
## Declaration files
176175

0 commit comments

Comments
 (0)