Run pre-commit on all files

2020-07-21 09:37:15 +02:00 · 2020-07-21 09:37:15 +02:00 · ec0f449ede
commit ec0f449ede
parent 4af5a19d79
22 changed files with 125 additions and 36 deletions
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@ -13,4 +13,6 @@ repos:
    rev: v1.4.0
    hooks:
    -   id: doctoc
-        args: --title "## Table of Contents"
+        args:
+          - --title
+          - "## Table of Contents"
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@ -1,3 +1,12 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+## Table of Contents
+
+- [Contributing](#contributing)
+  - [Install pre-commit hooks](#install-pre-commit-hooks)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Contributing

 ## Install pre-commit hooks
--- a/README.md
+++ b/README.md
@ -1,7 +1,6 @@
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-
-# Table of Contents
+## Table of Contents

 - [Professional Programming - about this list](#professional-programming---about-this-list)
  - [Contributing to this list](#contributing-to-this-list)
--- a/antipatterns/README.md
+++ b/antipatterns/README.md
@ -1,7 +1,6 @@
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-
-# Table of Contents
+## Table of Contents

 - [Antipatterns](#antipatterns)

--- a/antipatterns/code-antipatterns.md
+++ b/antipatterns/code-antipatterns.md
@ -1,7 +1,6 @@
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-
-# Table of Contents
+## Table of Contents

 - [Antipatterns](#antipatterns)
  - [Strict email validation](#strict-email-validation)
--- a/antipatterns/database-antipatterns.md
+++ b/antipatterns/database-antipatterns.md
@ -1,7 +1,6 @@
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-
-# Table of Contents
+## Table of Contents

 - [Database anti-patterns](#database-anti-patterns)
  - [Using `VARCHAR` instead of `TEXT` (PostgreSQL)](#using-varchar-instead-of-text-postgresql)
--- a/antipatterns/error-handling-antipatterns.md
+++ b/antipatterns/error-handling-antipatterns.md
@ -1,7 +1,6 @@
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-
-# Table of Contents
+## Table of Contents

 - [Error handling anti-patterns](#error-handling-anti-patterns)
  - [Hiding exceptions](#hiding-exceptions)
--- a/antipatterns/mvcs-antipatterns.md
+++ b/antipatterns/mvcs-antipatterns.md
@ -1,7 +1,6 @@
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-
-# Table of Contents
+## Table of Contents

 - [MVCS Antipatterns](#mvcs-antipatterns)
  - [Creating entities for association tables](#creating-entities-for-association-tables)
--- a/antipatterns/python-antipatterns.md
+++ b/antipatterns/python-antipatterns.md
@ -1,7 +1,6 @@
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-
-# Table of Contents
+## Table of Contents

 - [Python Antipatterns](#python-antipatterns)
  - [Redundant type checking](#redundant-type-checking)
--- a/antipatterns/python-examples/reraise_exceptions_bad.py
+++ b/antipatterns/python-examples/reraise_exceptions_bad.py
@ -1,19 +1,21 @@
 from collections import namedtuple

-Bread = namedtuple('Bread', 'color')
+Bread = namedtuple("Bread", "color")
+

 class ToastException(Exception):
    pass

+
 def toast(bread):
    try:
        put_in_toaster(bread)
    except:
-        raise ToastException('Could not toast bread')
+        raise ToastException("Could not toast bread")


 def put_in_toaster(bread):
-    brad.color = 'light_brown'  # Note the typo
+    brad.color = "light_brown"  # Note the typo


-toast(Bread('yellow'))
+toast(Bread("yellow"))
--- a/antipatterns/python-examples/reraise_exceptions_good.py
+++ b/antipatterns/python-examples/reraise_exceptions_good.py
@ -1,20 +1,22 @@
 from collections import namedtuple

-Bread = namedtuple('Bread', 'color')
+Bread = namedtuple("Bread", "color")
+

 class ToastException(Exception):
    pass

+
 def toast(bread):
    try:
        put_in_toaster(bread)
    except:
-        print 'Got exception while trying to toast'
+        print("Got exception while trying to toast")
        raise


 def put_in_toaster(bread):
-    brad.color = 'light_brown'  # Note the typo
+    brad.color = "light_brown"  # Note the typo


-toast(Bread('yellow'))
+toast(Bread("yellow"))
--- a/antipatterns/scalability-antipatterns.md
+++ b/antipatterns/scalability-antipatterns.md
@ -1,7 +1,6 @@
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-
-# Table of Contents
+## Table of Contents

 - [Not paging a database query](#not-paging-a-database-query)
 - [Returning whole objects where primary key would suffice](#returning-whole-objects-where-primary-key-would-suffice)
--- a/antipatterns/sqlalchemy-antipatterns.md
+++ b/antipatterns/sqlalchemy-antipatterns.md
@ -1,7 +1,6 @@
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-
-# Table of Contents
+## Table of Contents

 - [SQLAlchemy Anti-Patterns](#sqlalchemy-anti-patterns)
  - [Abusing lazily loaded relationships](#abusing-lazily-loaded-relationships)
--- a/antipatterns/sqlalchemy-examples/exists.py
+++ b/antipatterns/sqlalchemy-examples/exists.py
@ -4,13 +4,13 @@ from sqlalchemy.orm import sessionmaker
 from sqlalchemy.ext.declarative import declarative_base


-engine = create_engine('sqlite:///:memory:', echo=True)
+engine = create_engine("sqlite:///:memory:", echo=True)
 Session = sessionmaker(bind=engine)
 Base = declarative_base()


 class Toaster(Base):
-    __tablename__ = 'toasters'
+    __tablename__ = "toasters"

    id = Column(Integer, primary_key=True)
    name = Column(String)
--- a/antipatterns/tests-antipatterns.md
+++ b/antipatterns/tests-antipatterns.md
@ -1,7 +1,6 @@
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-
-# Table of Contents
+## Table of Contents

 - [Test antipatterns](#test-antipatterns)
  - [Testing implementation](#testing-implementation)
--- a/feature-flags.md
+++ b/feature-flags.md
@ -1,7 +1,6 @@
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-
-# Table of Contents
+## Table of Contents

 - [Why use feature flags?](#why-use-feature-flags)
  - [Should feature flags be used for everything?](#should-feature-flags-be-used-for-everything)
--- a/glossary.md
+++ b/glossary.md
@ -1,10 +1,9 @@
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-
-# Table of Contents
+## Table of Contents

 - [Glossary](#glossary)
-  - [Second system effect](#second-system-effect)
+    - [Second system effect](#second-system-effect)

 <!-- END doctoc generated TOC please keep comment here to allow auto update -->

--- a/training/front-end/00-intro.md
+++ b/training/front-end/00-intro.md
@ -1,3 +1,16 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+## Table of Contents
+
+- [Introduction to front-end programming](#introduction-to-front-end-programming)
+  - [Goal of this training](#goal-of-this-training)
+  - [Prerequisites](#prerequisites)
+  - [To do before the course](#to-do-before-the-course)
+  - [Curriculum](#curriculum)
+  - [Inspiration](#inspiration)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Introduction to front-end programming

 ## Goal of this training
--- a/training/front-end/01-modern-javascript-typescript.md
+++ b/training/front-end/01-modern-javascript-typescript.md
@ -1,3 +1,43 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+## Table of Contents
+
+- [Modern JavaScript/TypeScript](#modern-javascripttypescript)
+  - [Quirks](#quirks)
+    - [Printing and interacting with the console](#printing-and-interacting-with-the-console)
+    - [Comparing scalar, arrays, and objects](#comparing-scalar-arrays-and-objects)
+      - [Always use triple comparators (`===`) instead of double (`==`)](#always-use-triple-comparators--instead-of-double-)
+      - [Comparing non-scalar](#comparing-non-scalar)
+    - [`Object` methods](#object-methods)
+      - [`Object.assign`, spread operator](#objectassign-spread-operator)
+    - [`Array` methods](#array-methods)
+      - [`Array.includes` (ES7)](#arrayincludes-es7)
+  - [Object literals, assignment and destructuring](#object-literals-assignment-and-destructuring)
+    - [Objects](#objects)
+    - [Array](#array)
+  - [`let` and `const`](#let-and-const)
+  - [Arrow functions](#arrow-functions)
+    - [How `this` works in arrow functions](#how-this-works-in-arrow-functions)
+    - [Best practices](#best-practices)
+  - [Classes](#classes)
+    - [Prototypal inheritance](#prototypal-inheritance)
+  - [Template literals](#template-literals)
+    - [Template tags](#template-tags)
+  - [Loops](#loops)
+    - [`for... of`](#for-of)
+  - [Promises](#promises)
+    - [Creating a promise](#creating-a-promise)
+    - [Consuming a promise](#consuming-a-promise)
+    - [Chaining promises](#chaining-promises)
+  - [Async functions](#async-functions)
+  - [Modules](#modules)
+  - [TypeScript](#typescript)
+    - [Differences between TypeScript and JavaScript](#differences-between-typescript-and-javascript)
+    - [An introduction to TypeScript's type system](#an-introduction-to-typescripts-type-system)
+  - [References](#references)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Modern JavaScript/TypeScript

 Note: run code quickly with https://codesandbox.io/s/
--- a/training/front-end/02-react.md
+++ b/training/front-end/02-react.md
@ -1,3 +1,15 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+## Table of Contents
+
+- [An introduction to React](#an-introduction-to-react)
+  - [The inspiration for React](#the-inspiration-for-react)
+  - [React components](#react-components)
+  - [An introduction to state management in React application](#an-introduction-to-state-management-in-react-application)
+  - [Testing React applications](#testing-react-applications)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # An introduction to React

 ## The inspiration for React
--- a/training/front-end/03-css-html-restart.md
+++ b/training/front-end/03-css-html-restart.md
@ -1,3 +1,14 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+## Table of Contents
+
+- [CSS & HTML: restart](#css--html-restart)
+  - [An intro to modern technologies and methodologies](#an-intro-to-modern-technologies-and-methodologies)
+  - [Topics](#topics)
+    - [Accessibility](#accessibility)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # CSS & HTML: restart

 ## An intro to modern technologies and methodologies
--- a/training/front-end/04-front-end-development-practices.md
+++ b/training/front-end/04-front-end-development-practices.md
@ -1,3 +1,13 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+## Table of Contents
+
+- [Front-end development practices](#front-end-development-practices)
+  - [Testing](#testing)
+  - [Code style](#code-style)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Front-end development practices

 ## Testing