Skip to content

Latest commit

 

History

History
70 lines (44 loc) · 2.61 KB

README.md

File metadata and controls

70 lines (44 loc) · 2.61 KB

A JupyterLab plugin to facilitate invocation of code formatters.

Binder npm version npm downloads code style Github Actions Status


Documentation: Hosted on GitHub Pages


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.


Your Support

I could really use your support in giving me a star on GitHub, recommending features, fixing bugs or maybe even providing monetary support!


Contributors

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.