GitHub - jupyterlab-contrib/jupyterlab_code_formatter: A JupyterLab plugin to facilitate invocation of code formatters. (original) (raw)

A JupyterLab plugin to facilitate invocation of code formatters.

Documentation: Hosted on ReadTheDocs

Demo

Quick Start

I recommend you going to the documentation site, but this should work too.

1. Install the package

pip install jupyterlab-code-formatter

1. Install some supported formatters (isort+black are default for Python)

NOTE: Install black and isort,

JL code formatter is configured to invoke isort and black by default

pip install black isort

1. Restart JupyterLab

This plugin includes a server plugin, restart JupyterLab if you have followed the above steps while it's running.

1. Configure plugin

To configure which/how formatters are invoked, see configuration.

Getting help

If you don't use Discord then feel free to open a GitHub issue, do note I am a bit slower in responding in GitHub.

Your Support

I could really use your support in giving me a star on GitHub, recommending features or fixing bugs.

• Recommending features via GitHub Issues
• Submitting your PR on GitHub

Contributors

This extension was originally developed and maintained by @ryantam626. Massive thanks to the below list of people who made past contributions to the project!

License

This project is licensed under the terms of the MIT LICENSE .