adamchainz / blacken-docs

Run `black` on python code blocks in documentation files
MIT License
630 stars 41 forks source link

More general `.pre-commit-hooks.yaml` for Jupyter Notebooks #297

Open jamesbraza opened 8 months ago

jamesbraza commented 8 months ago

Description

black-jupyter integrates Jupyter notebooks into the hook's targets.

https://github.com/adamchainz/blacken-docs/blob/1.16.0/.pre-commit-hooks.yaml#L6 should be using types_or over files:

-    files: '\.(rst|md|markdown|py|tex)$'
+    # text encompasses rst, md, tex
+    types_or: [rst, markdown, tex, python, pyi, jupyter]

To discover what to input to types_or, use https://github.com/pre-commit/identify:

> identify-cli hi.rst
["file", "non-executable", "rst", "text"]
jamesbraza commented 8 months ago

Related: https://github.com/adamchainz/blacken-docs/issues/240