cleaning docs

Author: piotrwitek

README.md

@@ -41,7 +41,7 @@ You should check Playground Project located in the `/playground` folder. It is a
 - [Extras](#extras)
   - [tsconfig.json](#tsconfigjson)
   - [tslint.json](#tslintjson)
-  - [jest.config.json](#jestconfigjson)  
+  - [jest.config.json](#jestconfigjson)
   - [Default and Named Module Exports](#default-and-named-module-exports)
   - [Vendor Types Augmentation](#vendor-types-augmentation)
   - [Npm Scripts](#npm-scripts)
@@ -76,7 +76,7 @@ npm i -D @types/react @types/react-dom @types/react-redux
 
 # React Types Cheatsheet
 
-#### `React.StatelessComponent<P>` or alias `React.SFC<P>` 
+#### `React.StatelessComponent<P>` or alias `React.SFC<P>`
 Stateless functional components
 ```tsx
 const MyComponent: React.SFC<MyComponentProps> = ...
@@ -114,7 +114,7 @@ const elementOnly: JSX.Element =  <div /> || <MyComponent />;
 [⇧ back to top](#table-of-contents)
 
 #### `React.CSSProperties`
-Type-safety for styles using css-in-js 
+Type-safety for styles using css-in-js
 ```tsx
 const styles: React.CSSProperties = { flexDirection: 'row', ...
 ```
@@ -507,7 +507,7 @@ export default (() => (
 
 ## Redux Connected Components
 
-### Caveat with `bindActionCreators` 
+### Caveat with `bindActionCreators`
 **If you try to use `connect` or `bindActionCreators` explicitly and want to type your component callback props as `() => void` this will raise compiler errors. I happens because `bindActionCreators` typings will not map the return type of action creators to `void`, due to a current TypeScript limitations.**
 
 A decent alternative I can recommend is to use `() => any` type, it will work just fine in all possible scenarios and should not cause any typing problems whatsoever. All the code examples in the Guide with `connect` are also using this pattern.
@@ -913,7 +913,7 @@ export const epics = combineEpics(addTodoToast);
 
 ---
 
-## Selectors 
+## Selectors
 
 ### "reselect"
 
@@ -1107,7 +1107,7 @@ export const actions = {
       "esSpecCompliant": true
     }],
     "triple-equals": [true, "allow-null-check"],
-    "type-literal-delimiter": true,    
+    "type-literal-delimiter": true,
     "typedef": [true,"parameter", "property-declaration"],
     "variable-name": [true, "ban-keywords", "check-format", "allow-pascal-case", "allow-leading-underscore"],
     // tslint-react
@@ -1180,7 +1180,7 @@ import Select from '@src/components/select';
 ### Vendor Types Augmentation
 > Strategies to fix issues coming from broken "vendor type declarations" files (*.d.ts)
 
-#### Augmenting library internal type declarations - using relative import resolution 
+#### Augmenting library internal type declarations - using relative import resolution
 ```ts
 // added missing autoFocus Prop on Input component in "antd@2.10.0" npm package
 declare module '../node_modules/antd/lib/input/Input' {
@@ -1194,7 +1194,7 @@ declare module '../node_modules/antd/lib/input/Input' {
 
 #### Augmenting library public type declarations - using node module import resolution
 ```ts
-// fixed broken public type declaration in "rxjs@5.4.1" npm package 
+// fixed broken public type declaration in "rxjs@5.4.1" npm package
 import { Operator } from 'rxjs/Operator';
 import { Observable } from 'rxjs/Observable';
 
@@ -1274,7 +1274,7 @@ class StatefulCounterWithInitialCount extends React.Component<Props, State> {
 class StatefulCounter extends React.Component<Props, State> {
 // handlers using Class Fields with arrow functions
   handleIncrement = () => {
-    this.setState({ count: this.state.count + 1 }); 
+    this.setState({ count: this.state.count + 1 });
   };
   ...
 }
@@ -1286,7 +1286,7 @@ class StatefulCounter extends React.Component<Props, State> {
 
 # Roadmap
 - extend HOC section with more advanced examples [#5](../../issues/5)  
-- investigate typing patterns for generic component children [#7](../../issues/7)
+- investigate typing patterns for generic component children [#7](../../issues/7)  
 
 [⇧ back to top](#table-of-contents)
 
@@ -1302,10 +1302,10 @@ yarn run lint
 
 # run type-checking in playground
 yarn run tsc
-  
+
 # re-generate `README.md` from repo root
 sh ./generate.sh
-# or 
+# or
 node ./generator/bin/generate-readme.js
 ```
 

docs/markdown/1_react.md

@@ -1,6 +1,6 @@
 # React Types Cheatsheet
 
-#### `React.StatelessComponent<P>` or alias `React.SFC<P>` 
+#### `React.StatelessComponent<P>` or alias `React.SFC<P>`
 Stateless functional components
 ```tsx
 const MyComponent: React.SFC<MyComponentProps> = ...
@@ -38,7 +38,7 @@ const elementOnly: JSX.Element =  <div /> || <MyComponent />;
 [⇧ back to top](#table-of-contents)
 
 #### `React.CSSProperties`
-Type-safety for styles using css-in-js 
+Type-safety for styles using css-in-js
 ```tsx
 const styles: React.CSSProperties = { flexDirection: 'row', ...
 ```
@@ -134,7 +134,7 @@ Adds error handling using componentDidCatch to any component
 
 ## Redux Connected Components
 
-### Caveat with `bindActionCreators` 
+### Caveat with `bindActionCreators`
 **If you try to use `connect` or `bindActionCreators` explicitly and want to type your component callback props as `() => void` this will raise compiler errors. I happens because `bindActionCreators` typings will not map the return type of action creators to `void`, due to a current TypeScript limitations.**
 
 A decent alternative I can recommend is to use `() => any` type, it will work just fine in all possible scenarios and should not cause any typing problems whatsoever. All the code examples in the Guide with `connect` are also using this pattern.

docs/markdown/2_redux.md

@@ -118,7 +118,7 @@ When creating the store, use rootReducer. This will set-up a **strongly typed St
 
 ---
 
-## Selectors 
+## Selectors
 
 ### "reselect"
 

docs/markdown/4_extras.md

@@ -105,7 +105,7 @@
       "esSpecCompliant": true
     }],
     "triple-equals": [true, "allow-null-check"],
-    "type-literal-delimiter": true,    
+    "type-literal-delimiter": true,
     "typedef": [true,"parameter", "property-declaration"],
     "variable-name": [true, "ban-keywords", "check-format", "allow-pascal-case", "allow-leading-underscore"],
     // tslint-react
@@ -178,7 +178,7 @@ import Select from '@src/components/select';
 ### Vendor Types Augmentation
 > Strategies to fix issues coming from broken "vendor type declarations" files (*.d.ts)
 
-#### Augmenting library internal type declarations - using relative import resolution 
+#### Augmenting library internal type declarations - using relative import resolution
 ```ts
 // added missing autoFocus Prop on Input component in "antd@2.10.0" npm package
 declare module '../node_modules/antd/lib/input/Input' {
@@ -192,7 +192,7 @@ declare module '../node_modules/antd/lib/input/Input' {
 
 #### Augmenting library public type declarations - using node module import resolution
 ```ts
-// fixed broken public type declaration in "rxjs@5.4.1" npm package 
+// fixed broken public type declaration in "rxjs@5.4.1" npm package
 import { Operator } from 'rxjs/Operator';
 import { Observable } from 'rxjs/Observable';
 

docs/markdown/5_faq.md

@@ -37,7 +37,7 @@ class StatefulCounterWithInitialCount extends React.Component<Props, State> {
 class StatefulCounter extends React.Component<Props, State> {
 // handlers using Class Fields with arrow functions
   handleIncrement = () => {
-    this.setState({ count: this.state.count + 1 }); 
+    this.setState({ count: this.state.count + 1 });
   };
   ...
 }

docs/markdown/6_end.md

@@ -1,6 +1,6 @@
 # Roadmap
 - extend HOC section with more advanced examples [#5](../../issues/5)  
-- investigate typing patterns for generic component children [#7](../../issues/7)
+- investigate typing patterns for generic component children [#7](../../issues/7)  
 
 [⇧ back to top](#table-of-contents)
 
@@ -16,10 +16,10 @@ yarn run lint
 
 # run type-checking in playground
 yarn run tsc
-  
+
 # re-generate `README.md` from repo root
 sh ./generate.sh
-# or 
+# or
 node ./generator/bin/generate-readme.js
 ```
 

docs/markdown/_intro.md

@@ -1,6 +1,9 @@
 # React & Redux in TypeScript - Static Typing Guide
+
 **_"This guide is about to teach you how to leverage [Type Inference](https://www.typescriptlang.org/docs/handbook/type-inference.html), [Generics](https://www.typescriptlang.org/docs/handbook/generics.html) and other [Advanced Types](https://www.typescriptlang.org/docs/handbook/advanced-types.html) as much as possible to write the minimal amount of type annotations needed for your JavaScript code to be completely Type Safe"_** - this will make sure you get all the benefits of Static Typing and your productivity won't be slowed down by adding excess type annotations.
 
+[![Join the chat at https://gitter.im/react-redux-typescript-guide/Lobby](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/react-redux-typescript-guide/Lobby)  
+
 > #### _Found it usefull? Want more updates?_ [**Give it a :star2:**](https://github.com/piotrwitek/react-redux-typescript-patterns/stargazers)  
 
 ### Goals

docs/markdown/_toc.md

@@ -20,7 +20,7 @@
 - [Extras](#extras)
   - [tsconfig.json](#tsconfigjson)
   - [tslint.json](#tslintjson)
-  - [jest.config.json](#jestconfigjson)  
+  - [jest.config.json](#jestconfigjson)
   - [Default and Named Module Exports](#default-and-named-module-exports)
   - [Vendor Types Augmentation](#vendor-types-augmentation)
   - [Npm Scripts](#npm-scripts)