Repository files navigation

Scalafmt extension for almond

• JupyterLab >=2.0
• almond >=0.10.8

jupyter labextension install @almond-sh/scalafmt

This extension adds two commands in the JupyterLab command palette:

• Format current cell with scalafmt
• Format all code cells with scalafmt

Open the JupyterLab command palette, by clicking on the "Commands" tab in the left sidebar. Quicklyfind the almond-scalafmt commands above by typingfmt in the search box.

To revert the formatting in a cell, put the cursor in this cell, and hit the undo shortcut (Command + Z on macOS).

These commands work when using thealmond Scala kernel0.10.8, or a higher version.

Thejlpm command is JupyterLab's pinned version ofyarn that is installed with JupyterLab. You may useyarn ornpm in lieu ofjlpm below.

# Clone the repo to your local environment# Move to almond-scalafmt directory# Install dependenciesjlpm# Build Typescript sourcejlpm build# Link your development version of the extension with JupyterLabjupyter labextension install.# Rebuild Typescript source after making changesjlpm build# Rebuild JupyterLab after making any changesjupyter lab build

You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.

# Watch the source directory in another terminal tabjlpm watch# Run jupyterlab in watch mode in one terminal tabjupyter lab --watch

Now every change will be built locally and bundled into JupyterLab. Be sure to refresh your browser page after saving file changes to reload the extension (note: you'll need to wait for webpack to finish, which can take 10s+ at times).

Please report issues in thealmond repository rather than in the almond-scalafmt repository.

jupyter labextension uninstall almond-scalafmt