Skip to content

Commit d066f15

Browse files
authored
fix: test master branch release process works-no code changes (#290)
1 parent 40f167c commit d066f15

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,24 @@
11
# Fork TS Checker Webpack Plugin
22

33
[![npm version](https://img.shields.io/npm/v/fork-ts-checker-webpack-plugin.svg)](https://www.npmjs.com/package/fork-ts-checker-webpack-plugin)
4+
45
[![npm beta version](https://img.shields.io/npm/v/fork-ts-checker-webpack-plugin/beta.svg)](https://www.npmjs.com/package/fork-ts-checker-webpack-plugin)
6+
57
[![build status](https://travis-ci.org/Realytics/fork-ts-checker-webpack-plugin.svg?branch=master)](https://travis-ci.org/Realytics/fork-ts-checker-webpack-plugin)
8+
69
[![downloads](http://img.shields.io/npm/dm/fork-ts-checker-webpack-plugin.svg)](https://npmjs.org/package/fork-ts-checker-webpack-plugin)
10+
711
[![commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
12+
813
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
14+
915
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
1016

11-
Webpack plugin that runs typescript type checker on a separate process.
17+
Webpack plugin that runs TypeScript type checker on a separate process.
1218

1319
## Installation
1420

15-
This plugin requires minimum **webpack 2.3**, **typescript 2.1** and optionally **tslint 4.0**
21+
This plugin requires minimum **webpack 2.3**, **TypeScript 2.1** and optionally **tslint 4.0**
1622

1723
```sh
1824
npm install --save-dev fork-ts-checker-webpack-plugin
@@ -53,19 +59,19 @@ these trees with tslint. It can be scaled with a multi-process mode to utilize m
5359

5460
## Modules resolution
5561

56-
It's very important to be aware that **this plugin uses [typescript](https://github.com/Microsoft/TypeScript)'s, not
62+
It's very important to be aware that **this plugin uses [TypeScript](https://github.com/Microsoft/TypeScript)'s, not
5763
[webpack](https://github.com/webpack/webpack)'s modules resolution**. It means that you have to setup `tsconfig.json` correctly. For example
5864
if you set `files: ['./src/someFile.ts']` in `tsconfig.json`, this plugin will check only `someFile.ts` for semantic errors. It's because
59-
of performance. The goal of this plugin is to be _as fast as possible_. With typescript's module resolution we don't have to wait for webpack
65+
of performance. The goal of this plugin is to be _as fast as possible_. With TypeScript's module resolution we don't have to wait for webpack
6066
to compile files (which traverses dependency graph during compilation) - we have a full list of files from the begin.
6167

62-
To debug typescript's modules resolution, you can use `tsc --traceResolution` command.
68+
To debug TypeScript's modules resolution, you can use `tsc --traceResolution` command.
6369

6470
## TSLint
6571

6672
If you have installed [tslint](https://palantir.github.io/tslint), you can enable it by setting `tslint: true` or
6773
`tslint: './path/to/tslint.json'`. We recommend changing `defaultSeverity` to a `"warning"` in `tslint.json` file.
68-
It helps to distinguish lints from typescript's diagnostics.
74+
It helps to distinguish lints from TypeScript's diagnostics.
6975

7076
## Options
7177

@@ -110,7 +116,7 @@ It helps to distinguish lints from typescript's diagnostics.
110116
We recommend to set this to `false` in projects where type checking is faster than webpack's build - it's better for integration with other plugins. Another scenario where you might want to set this to `false` is if you use the `overlay` functionality of `webpack-dev-server`.
111117
112118
- **ignoreDiagnostics** `number[]`:
113-
List of typescript diagnostic codes to ignore.
119+
List of TypeScript diagnostic codes to ignore.
114120
115121
- **ignoreLints** `string[]`:
116122
List of tslint rule names to ignore.
@@ -161,9 +167,9 @@ new ForkTsCheckerWebpackPlugin({
161167
[Vue section](https://github.com/Realytics/fork-ts-checker-webpack-plugin#vue) further down for information on how to correctly setup your project.
162168

163169
- **useTypescriptIncrementalApi** `boolean`:
164-
If true, the plugin will use incremental compilation API introduced in typescript 2.7. In this mode you can only have 1
170+
If true, the plugin will use incremental compilation API introduced in TypeScript 2.7. In this mode you can only have 1
165171
worker, but if the changes in your code are small (like you normally have when you work in 'watch' mode), the compilation
166-
may be much faster, even compared to multi-threaded compilation. Defaults to `true` when working with typescript 3+ and `false` when below 3. The default can be overridden by directly specifying a value.
172+
may be much faster, even compared to multi-threaded compilation. Defaults to `true` when working with TypeScript 3+ and `false` when below 3. The default can be overridden by directly specifying a value.
167173

168174
- **measureCompilationTime** `boolean`:
169175
If true, the plugin will measure the time spent inside the compilation code. This may be useful to compare modes,

0 commit comments

Comments
 (0)