Add prettier to pre-commit and apply it

Author: Pierre-Sassoulas

.github/CONTRIBUTING.md

@@ -6,9 +6,10 @@ Use `pre-commit install` to install the pre-commit hook for the repository.
 
 ### Creating a new formatter
 
-- Implement a Formatter by inheriting from ``pydocstringformatter.formatting.Formatter``
-- Add your new formatter to ``pydocstringformatter.formatting.FORMATTERS``
-- Choose a proper name because this will be user-facing: the name will be used for options of the CLI.
+- Implement a Formatter by inheriting from `pydocstringformatter.formatting.Formatter`
+- Add your new formatter to `pydocstringformatter.formatting.FORMATTERS`
+- Choose a proper name because this will be user-facing: the name will be used for
+  options of the CLI.
 
 ### Testing
 
@@ -18,9 +19,12 @@ To run all the tests:
 pytest
 ```
 
-To create test for a specific formatting option use the `tests/data/format` directory. For each `.py` file create a `.py.out` file with the expected output after formatting. The test suite will automatically pickup the new tests.
+To create test for a specific formatting option use the `tests/data/format` directory.
+For each `.py` file create a `.py.out` file with the expected output after formatting.
+The test suite will automatically pickup the new tests.
 
-To only run a specific test from that directory, for example `tests/data/format/multi_line/class_docstring.py`, use:
+To only run a specific test from that directory, for example
+`tests/data/format/multi_line/class_docstring.py`, use:
 
 ```shell
 pytest -k multi_line-class_docstring

.pre-commit-config.yaml

@@ -1,13 +1,13 @@
 exclude: "tests/data"
 repos:
--   repo: https://github.com/pre-commit/pre-commit-hooks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.1.0
     hooks:
-    -   id: trailing-whitespace
-    -   id: end-of-file-fixer
-    -   id: check-yaml
-    -   id: check-toml
--   repo: https://github.com/myint/autoflake
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+  - repo: https://github.com/myint/autoflake
     rev: v1.4
     hooks:
       - id: autoflake
@@ -17,37 +17,42 @@ repos:
           - --expand-star-imports
           - --remove-duplicate-keys
           - --remove-unused-variables
--   repo: https://github.com/asottile/pyupgrade
+  - repo: https://github.com/asottile/pyupgrade
     rev: v2.31.0
     hooks:
       - id: pyupgrade
         args: [--py38-plus]
--   repo: https://github.com/PyCQA/isort
+  - repo: https://github.com/PyCQA/isort
     rev: 5.10.1
     hooks:
       - id: isort
--   repo: https://github.com/psf/black
+  - repo: https://github.com/psf/black
     rev: 21.12b0
     hooks:
       - id: black
         args: [--quiet]
--   repo: https://github.com/PyCQA/flake8
+  - repo: https://github.com/PyCQA/flake8
     rev: 4.0.1
     hooks:
       - id: flake8
         additional_dependencies: [flake8-typing-imports==1.10.1]
--   repo: https://github.com/pycqa/pylint
+  - repo: https://github.com/pycqa/pylint
     rev: v2.12.2
     hooks:
-    -   id: pylint
+      - id: pylint
         args: ["--disable=import-error, cyclic-import"]
--   repo: https://github.com/pre-commit/mirrors-mypy
+  - repo: https://github.com/pre-commit/mirrors-mypy
     rev: v0.930
     hooks:
-    -   id: mypy
+      - id: mypy
         args: [--ignore-missing-imports]
         additional_dependencies: [pytest-stub==1.1.0]
--   repo: https://github.com/DanielNoord/pydocstringformatter
+  - repo: https://github.com/DanielNoord/pydocstringformatter
     rev: v0.2.0
     hooks:
-    -   id: pydocstringformatter
+      - id: pydocstringformatter
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v2.5.1
+    hooks:
+      - id: prettier
+        args: [--prose-wrap=always, --print-width=88]

.pre-commit-hooks.yaml

@@ -1,5 +1,5 @@
--   id: pydocstringformatter
-    name: pydocstringformatter
-    entry: pydocstringformatter
-    language: python
-    args: ["--write"]
+- id: pydocstringformatter
+  name: pydocstringformatter
+  entry: pydocstringformatter
+  language: python
+  args: ["--write"]

README.md

@@ -1,8 +1,14 @@
-[![PyPI pyversions](https://img.shields.io/pypi/pyversions/pydocstringformatter.svg)](https://pypi.python.org/pypi/pydocstringformatter/) [![Coverage Status](https://coveralls.io/repos/github/DanielNoord/pydocstringformatter/badge.svg?branch=main)](https://coveralls.io/github/DanielNoord/pydocstringformatter?branch=main) [![Tests](https://github.com/DanielNoord/pydocstringformatter/actions/workflows/tests.yaml/badge.svg?branch=main)](https://github.com/DanielNoord/pydocstringformatter/actions/workflows/tests.yaml) [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/DanielNoord/pydocstringformatter/main.svg)](https://results.pre-commit.ci/latest/github/DanielNoord/pydocstringformatter/main)
+[![PyPI pyversions](https://img.shields.io/pypi/pyversions/pydocstringformatter.svg)](https://pypi.python.org/pypi/pydocstringformatter/)
+[![Coverage Status](https://coveralls.io/repos/github/DanielNoord/pydocstringformatter/badge.svg?branch=main)](https://coveralls.io/github/DanielNoord/pydocstringformatter?branch=main)
+[![Tests](https://github.com/DanielNoord/pydocstringformatter/actions/workflows/tests.yaml/badge.svg?branch=main)](https://github.com/DanielNoord/pydocstringformatter/actions/workflows/tests.yaml)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/DanielNoord/pydocstringformatter/main.svg)](https://results.pre-commit.ci/latest/github/DanielNoord/pydocstringformatter/main)
 
 # Pydocstringformatter
 
-A tool to automatically format Python docstrings that tries to follow recommendations from [`PEP 8`](https://www.python.org/dev/peps/pep-0008/) and [`PEP 257`](https://www.python.org/dev/peps/pep-0257/). See [What it does](#what-it-does) for currently supported auto-formatting.
+A tool to automatically format Python docstrings that tries to follow recommendations
+from [`PEP 8`](https://www.python.org/dev/peps/pep-0008/) and
+[`PEP 257`](https://www.python.org/dev/peps/pep-0257/). See
+[What it does](#what-it-does) for currently supported auto-formatting.
 
 ## How to install
 
@@ -26,24 +32,28 @@ options:
 
 ### Configuration
 
-Pydocstringformatter will also read any configuration added to the `[tool.pydocstringformatter]` section of a `pyproject.toml` file.
+Pydocstringformatter will also read any configuration added to the
+`[tool.pydocstringformatter]` section of a `pyproject.toml` file.
 
 ## Pre-commit
 
-Pydocstringformatter can also be used as a [pre-commit hook](https://pre-commit.com). Add the following to your `.pre-commit-config.yaml` file:
+Pydocstringformatter can also be used as a [pre-commit hook](https://pre-commit.com).
+Add the following to your `.pre-commit-config.yaml` file:
 
 ```yaml
--   repo: https://github.com/DanielNoord/pydocstringformatter
-    rev: SPECIFY VERSION HERE
-    hooks:
-    -   id: pydocstringformatter
+- repo: https://github.com/DanielNoord/pydocstringformatter
+  rev: SPECIFY VERSION HERE
+  hooks:
+    - id: pydocstringformatter
 ```
 
 ## What it does
 
-The following examples show what pydocstringformatter will pick up on. All _bad_ examples will be rewritten to follow the _good_ patterns.
+The following examples show what pydocstringformatter will pick up on. All _bad_
+examples will be rewritten to follow the _good_ patterns.
 
-**PEP 8: _Note that most importantly, the """ that ends a multiline docstring should be on a line by itself:_**
+**PEP 8: _Note that most importantly, the """ that ends a multiline docstring should be
+on a line by itself:_**
 
 ```python
 # Bad
@@ -56,7 +66,6 @@ multi-line docstring
 """
 ```
 
-
 **PEP 256: _The closing quotes are on the same line as the opening quotes_**
 
 For consistency this rule also gets applied to multi-line docstrings
@@ -86,4 +95,5 @@ multi-line docstring
 
 ## Development
 
-For development and contributing guidelines please see [`Contributing`](https://github.com/DanielNoord/pydocstringformatter/blob/main/.github/CONTRIBUTING.md).
+For development and contributing guidelines please see
+[`Contributing`](https://github.com/DanielNoord/pydocstringformatter/blob/main/.github/CONTRIBUTING.md).