Skip to content

Commit 3ef9535

Browse files
committed
WIP
1 parent f6402d3 commit 3ef9535

File tree

3 files changed

+84
-44
lines changed

3 files changed

+84
-44
lines changed

README.md

+42-22
Original file line numberDiff line numberDiff line change
@@ -44,36 +44,37 @@ This gives you the power to prioritize our work and support the project contribu
4444

4545
## Table of Contents
4646
- [Type Definitions & Complementary Libraries](#type-definitions--complementary-libraries)
47-
- [React Types Cheatsheet](#react-types-cheatsheet) 🌟 __NEW__
47+
- [React Types Cheatsheet](#react-types-cheatsheet)
4848
- [Component Typing Patterns](#component-typing-patterns)
4949
- [Stateless Components - SFC](#stateless-components---sfc)
50-
- [Stateful Components - Class](#stateful-components---class) 📝 __UPDATED__
50+
- [Stateful Components - Class](#stateful-components---class)
5151
- [Generic Components](#generic-components)
52-
- [Render Props](#render-props) 🌟 __NEW__
53-
- [Higher-Order Components](#higher-order-components) 📝 __UPDATED__
52+
- [Render Props](#render-props)
53+
- [Higher-Order Components](#higher-order-components)
5454
- [Redux Connected Components](#redux-connected-components)
5555
- [Redux](#redux)
56-
- [Action Creators](#action-creators) 📝 __UPDATED__
57-
- [Reducers](#reducers) 📝 __UPDATED__
56+
- [Action Creators](#action-creators)
57+
- [Reducers](#reducers)
5858
- [State with Type-level Immutability](#state-with-type-level-immutability)
5959
- [Typing reducer](#typing-reducer)
6060
- [Testing reducer](#testing-reducer)
61-
- [Store Configuration](#store-configuration) 📝 __UPDATED__
62-
- [Async Flow](#async-flow) 📝 __UPDATED__
61+
- [Store Configuration](#store-configuration)
62+
- [Async Flow](#async-flow)
6363
- [Selectors](#selectors)
6464
- [Tools](#tools)
65+
- [Tools Npm Scripts](#tools-npm-scripts)
6566
- [TSLint](#tslint)
6667
- [Jest](#jest)
6768
- [Enzyme](#enzyme)
68-
- [Living Style Guide](#living-style-guide) 🌟 __NEW__
69-
- [Common Npm Scripts](#common-npm-scripts)
69+
- [Living Style Guide](#living-style-guide)
70+
- [Recompose](#recompose) 🌟 __NEW__
7071
- [Recipes](#recipes)
7172
- [tsconfig.json](#tsconfigjson)
7273
- [Vendor Types Augmentation](#vendor-types-augmentation)
7374
- [Default and Named Module Exports](#default-and-named-module-exports)
7475
- [FAQ](#faq)
7576
- [Tutorials](#tutorials)
76-
- [Contributors](#contributors)
77+
- [Contributors](#contributors) 🌟 __NEW__
7778

7879
---
7980

@@ -1111,6 +1112,23 @@ export const getFilteredTodos = createSelector(getTodos, getTodosFilter, (todos,
11111112
---
11121113
11131114
# Tools
1115+
> Common tools for TypeScript projects
1116+
1117+
## Tools Npm Scripts
1118+
> Tools related npm scripts shared across projects
1119+
```
1120+
"lint": "tslint -p ./",
1121+
"tsc": "tsc -p ./ --noEmit",
1122+
"tsc:watch": "tsc -p ./ --noEmit -w",
1123+
"pretest": "npm run lint & npm run tsc",
1124+
"test": "jest --config jest.config.json",
1125+
"test:watch": "jest --config jest.config.json --watch",
1126+
"test:update": "jest --config jest.config.json -u",
1127+
```
1128+
1129+
[⇧ back to top](#table-of-contents)
1130+
1131+
---
11141132
11151133
## TSLint
11161134
@@ -1178,6 +1196,8 @@ export const getFilteredTodos = createSelector(getTodos, getTodosFilter, (todos,
11781196
11791197
[⇧ back to top](#table-of-contents)
11801198
1199+
---
1200+
11811201
## Jest
11821202
11831203
> Installation
@@ -1223,9 +1243,10 @@ window.localStorage = {
12231243
Object.values = () => [];
12241244
```
12251245
1226-
12271246
[⇧ back to top](#table-of-contents)
12281247
1248+
---
1249+
12291250
## Enzyme
12301251
12311252
> Installation
@@ -1250,16 +1271,15 @@ configure({ adapter: new Adapter() });
12501271
12511272
[⇧ back to top](#table-of-contents)
12521273
1253-
## Common Npm Scripts
1254-
> Common TS-related npm scripts shared across projects
1255-
```
1256-
"lint": "tslint -p ./",
1257-
"tsc": "tsc -p ./ --noEmit",
1258-
"tsc:watch": "tsc -p ./ --noEmit -w",
1259-
"pretest": "npm run lint & npm run tsc",
1260-
"test": "jest --config jest.config.json",
1261-
"test:watch": "jest --config jest.config.json --watch",
1262-
"test:update": "jest --config jest.config.json -u",
1274+
---
1275+
1276+
## Recompose
1277+
1278+
> Installation
1279+
`npm i recompose`
1280+
1281+
```tsx
1282+
// WIP
12631283
```
12641284
12651285
[⇧ back to top](#table-of-contents)

docs/markdown/3_tools.md

+30-11
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,21 @@
11
# Tools
2+
> Common tools for TypeScript projects
3+
4+
## Tools Npm Scripts
5+
> Tools related npm scripts shared across projects
6+
```
7+
"lint": "tslint -p ./",
8+
"tsc": "tsc -p ./ --noEmit",
9+
"tsc:watch": "tsc -p ./ --noEmit -w",
10+
"pretest": "npm run lint & npm run tsc",
11+
"test": "jest --config jest.config.json",
12+
"test:watch": "jest --config jest.config.json --watch",
13+
"test:update": "jest --config jest.config.json -u",
14+
```
15+
16+
[⇧ back to top](#table-of-contents)
17+
18+
---
219

320
## TSLint
421

@@ -66,6 +83,8 @@
6683

6784
[⇧ back to top](#table-of-contents)
6885

86+
---
87+
6988
## Jest
7089

7190
> Installation
@@ -111,9 +130,10 @@ window.localStorage = {
111130
Object.values = () => [];
112131
```
113132

114-
115133
[⇧ back to top](#table-of-contents)
116134

135+
---
136+
117137
## Enzyme
118138

119139
> Installation
@@ -138,16 +158,15 @@ configure({ adapter: new Adapter() });
138158

139159
[⇧ back to top](#table-of-contents)
140160

141-
## Common Npm Scripts
142-
> Common TS-related npm scripts shared across projects
143-
```
144-
"lint": "tslint -p ./",
145-
"tsc": "tsc -p ./ --noEmit",
146-
"tsc:watch": "tsc -p ./ --noEmit -w",
147-
"pretest": "npm run lint & npm run tsc",
148-
"test": "jest --config jest.config.json",
149-
"test:watch": "jest --config jest.config.json --watch",
150-
"test:update": "jest --config jest.config.json -u",
161+
---
162+
163+
## Recompose
164+
165+
> Installation
166+
`npm i recompose`
167+
168+
```tsx
169+
// WIP
151170
```
152171

153172
[⇧ back to top](#table-of-contents)

docs/markdown/_toc.md

+12-11
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,33 @@
11
## Table of Contents
22
- [Type Definitions & Complementary Libraries](#type-definitions--complementary-libraries)
3-
- [React Types Cheatsheet](#react-types-cheatsheet) 🌟 __NEW__
3+
- [React Types Cheatsheet](#react-types-cheatsheet)
44
- [Component Typing Patterns](#component-typing-patterns)
55
- [Stateless Components - SFC](#stateless-components---sfc)
6-
- [Stateful Components - Class](#stateful-components---class) 📝 __UPDATED__
6+
- [Stateful Components - Class](#stateful-components---class)
77
- [Generic Components](#generic-components)
8-
- [Render Props](#render-props) 🌟 __NEW__
9-
- [Higher-Order Components](#higher-order-components) 📝 __UPDATED__
8+
- [Render Props](#render-props)
9+
- [Higher-Order Components](#higher-order-components)
1010
- [Redux Connected Components](#redux-connected-components)
1111
- [Redux](#redux)
12-
- [Action Creators](#action-creators) 📝 __UPDATED__
13-
- [Reducers](#reducers) 📝 __UPDATED__
12+
- [Action Creators](#action-creators)
13+
- [Reducers](#reducers)
1414
- [State with Type-level Immutability](#state-with-type-level-immutability)
1515
- [Typing reducer](#typing-reducer)
1616
- [Testing reducer](#testing-reducer)
17-
- [Store Configuration](#store-configuration) 📝 __UPDATED__
18-
- [Async Flow](#async-flow) 📝 __UPDATED__
17+
- [Store Configuration](#store-configuration)
18+
- [Async Flow](#async-flow)
1919
- [Selectors](#selectors)
2020
- [Tools](#tools)
21+
- [Tools Npm Scripts](#tools-npm-scripts)
2122
- [TSLint](#tslint)
2223
- [Jest](#jest)
2324
- [Enzyme](#enzyme)
24-
- [Living Style Guide](#living-style-guide) 🌟 __NEW__
25-
- [Common Npm Scripts](#common-npm-scripts)
25+
- [Living Style Guide](#living-style-guide)
26+
- [Recompose](#recompose) 🌟 __NEW__
2627
- [Recipes](#recipes)
2728
- [tsconfig.json](#tsconfigjson)
2829
- [Vendor Types Augmentation](#vendor-types-augmentation)
2930
- [Default and Named Module Exports](#default-and-named-module-exports)
3031
- [FAQ](#faq)
3132
- [Tutorials](#tutorials)
32-
- [Contributors](#contributors)
33+
- [Contributors](#contributors) 🌟 __NEW__

0 commit comments

Comments
 (0)