diff --git a/README.md b/README.md index e9fc7ff..40c1570 100644 --- a/README.md +++ b/README.md @@ -44,36 +44,37 @@ This gives you the power to prioritize our work and support the project contribu ## Table of Contents - [Type Definitions & Complementary Libraries](#type-definitions--complementary-libraries) -- [React Types Cheatsheet](#react-types-cheatsheet) 🌟 __NEW__ +- [React Types Cheatsheet](#react-types-cheatsheet) - [Component Typing Patterns](#component-typing-patterns) - [Stateless Components - SFC](#stateless-components---sfc) - - [Stateful Components - Class](#stateful-components---class) 📝 __UPDATED__ + - [Stateful Components - Class](#stateful-components---class) - [Generic Components](#generic-components) - - [Render Props](#render-props) 🌟 __NEW__ - - [Higher-Order Components](#higher-order-components) 📝 __UPDATED__ + - [Render Props](#render-props) + - [Higher-Order Components](#higher-order-components) - [Redux Connected Components](#redux-connected-components) - [Redux](#redux) - - [Action Creators](#action-creators) 📝 __UPDATED__ - - [Reducers](#reducers) 📝 __UPDATED__ + - [Action Creators](#action-creators) + - [Reducers](#reducers) - [State with Type-level Immutability](#state-with-type-level-immutability) - [Typing reducer](#typing-reducer) - [Testing reducer](#testing-reducer) - - [Store Configuration](#store-configuration) 📝 __UPDATED__ - - [Async Flow](#async-flow) 📝 __UPDATED__ + - [Store Configuration](#store-configuration) + - [Async Flow](#async-flow) - [Selectors](#selectors) - [Tools](#tools) + - [Tools Npm Scripts](#tools-npm-scripts) - [TSLint](#tslint) - [Jest](#jest) - [Enzyme](#enzyme) - - [Living Style Guide](#living-style-guide) 🌟 __NEW__ - - [Common Npm Scripts](#common-npm-scripts) + - [Living Style Guide](#living-style-guide) + - [Recompose](#recompose) 🌟 __NEW__ - [Recipes](#recipes) - [tsconfig.json](#tsconfigjson) - [Vendor Types Augmentation](#vendor-types-augmentation) - [Default and Named Module Exports](#default-and-named-module-exports) - [FAQ](#faq) - [Tutorials](#tutorials) -- [Contributors](#contributors) +- [Contributors](#contributors) 🌟 __NEW__ --- @@ -1111,6 +1112,23 @@ export const getFilteredTodos = createSelector(getTodos, getTodosFilter, (todos, --- # Tools +> Common tools for TypeScript projects + +## Tools Npm Scripts +> Tools related npm scripts shared across projects +``` +"lint": "tslint -p ./", +"tsc": "tsc -p ./ --noEmit", +"tsc:watch": "tsc -p ./ --noEmit -w", +"pretest": "npm run lint & npm run tsc", +"test": "jest --config jest.config.json", +"test:watch": "jest --config jest.config.json --watch", +"test:update": "jest --config jest.config.json -u", +``` + +[⇧ back to top](#table-of-contents) + +--- ## TSLint @@ -1178,6 +1196,8 @@ export const getFilteredTodos = createSelector(getTodos, getTodosFilter, (todos, [⇧ back to top](#table-of-contents) +--- + ## Jest > Installation @@ -1223,9 +1243,10 @@ window.localStorage = { Object.values = () => []; ``` - [⇧ back to top](#table-of-contents) +--- + ## Enzyme > Installation @@ -1250,16 +1271,15 @@ configure({ adapter: new Adapter() }); [⇧ back to top](#table-of-contents) -## Common Npm Scripts -> Common TS-related npm scripts shared across projects -``` -"lint": "tslint -p ./", -"tsc": "tsc -p ./ --noEmit", -"tsc:watch": "tsc -p ./ --noEmit -w", -"pretest": "npm run lint & npm run tsc", -"test": "jest --config jest.config.json", -"test:watch": "jest --config jest.config.json --watch", -"test:update": "jest --config jest.config.json -u", +--- + +## Recompose + +> Installation +`npm i recompose` + +```tsx +// WIP ``` [⇧ back to top](#table-of-contents) diff --git a/docs/markdown/3_tools.md b/docs/markdown/3_tools.md index cfbf63d..69ef57f 100644 --- a/docs/markdown/3_tools.md +++ b/docs/markdown/3_tools.md @@ -1,4 +1,21 @@ # Tools +> Common tools for TypeScript projects + +## Tools Npm Scripts +> Tools related npm scripts shared across projects +``` +"lint": "tslint -p ./", +"tsc": "tsc -p ./ --noEmit", +"tsc:watch": "tsc -p ./ --noEmit -w", +"pretest": "npm run lint & npm run tsc", +"test": "jest --config jest.config.json", +"test:watch": "jest --config jest.config.json --watch", +"test:update": "jest --config jest.config.json -u", +``` + +[⇧ back to top](#table-of-contents) + +--- ## TSLint @@ -66,6 +83,8 @@ [⇧ back to top](#table-of-contents) +--- + ## Jest > Installation @@ -111,9 +130,10 @@ window.localStorage = { Object.values = () => []; ``` - [⇧ back to top](#table-of-contents) +--- + ## Enzyme > Installation @@ -138,16 +158,15 @@ configure({ adapter: new Adapter() }); [⇧ back to top](#table-of-contents) -## Common Npm Scripts -> Common TS-related npm scripts shared across projects -``` -"lint": "tslint -p ./", -"tsc": "tsc -p ./ --noEmit", -"tsc:watch": "tsc -p ./ --noEmit -w", -"pretest": "npm run lint & npm run tsc", -"test": "jest --config jest.config.json", -"test:watch": "jest --config jest.config.json --watch", -"test:update": "jest --config jest.config.json -u", +--- + +## Recompose + +> Installation +`npm i recompose` + +```tsx +// WIP ``` [⇧ back to top](#table-of-contents) diff --git a/docs/markdown/_toc.md b/docs/markdown/_toc.md index 05df687..79f4e74 100644 --- a/docs/markdown/_toc.md +++ b/docs/markdown/_toc.md @@ -1,32 +1,33 @@ ## Table of Contents - [Type Definitions & Complementary Libraries](#type-definitions--complementary-libraries) -- [React Types Cheatsheet](#react-types-cheatsheet) 🌟 __NEW__ +- [React Types Cheatsheet](#react-types-cheatsheet) - [Component Typing Patterns](#component-typing-patterns) - [Stateless Components - SFC](#stateless-components---sfc) - - [Stateful Components - Class](#stateful-components---class) 📝 __UPDATED__ + - [Stateful Components - Class](#stateful-components---class) - [Generic Components](#generic-components) - - [Render Props](#render-props) 🌟 __NEW__ - - [Higher-Order Components](#higher-order-components) 📝 __UPDATED__ + - [Render Props](#render-props) + - [Higher-Order Components](#higher-order-components) - [Redux Connected Components](#redux-connected-components) - [Redux](#redux) - - [Action Creators](#action-creators) 📝 __UPDATED__ - - [Reducers](#reducers) 📝 __UPDATED__ + - [Action Creators](#action-creators) + - [Reducers](#reducers) - [State with Type-level Immutability](#state-with-type-level-immutability) - [Typing reducer](#typing-reducer) - [Testing reducer](#testing-reducer) - - [Store Configuration](#store-configuration) 📝 __UPDATED__ - - [Async Flow](#async-flow) 📝 __UPDATED__ + - [Store Configuration](#store-configuration) + - [Async Flow](#async-flow) - [Selectors](#selectors) - [Tools](#tools) + - [Tools Npm Scripts](#tools-npm-scripts) - [TSLint](#tslint) - [Jest](#jest) - [Enzyme](#enzyme) - - [Living Style Guide](#living-style-guide) 🌟 __NEW__ - - [Common Npm Scripts](#common-npm-scripts) + - [Living Style Guide](#living-style-guide) + - [Recompose](#recompose) 🌟 __NEW__ - [Recipes](#recipes) - [tsconfig.json](#tsconfigjson) - [Vendor Types Augmentation](#vendor-types-augmentation) - [Default and Named Module Exports](#default-and-named-module-exports) - [FAQ](#faq) - [Tutorials](#tutorials) -- [Contributors](#contributors) +- [Contributors](#contributors) 🌟 __NEW__