Skip to content

Latest commit

 

History

History
78 lines (53 loc) · 2.48 KB

README.md

File metadata and controls

78 lines (53 loc) · 2.48 KB
Raw

almond-scalafmt

Github Actions Status npm version

Scalafmt extension for almond

Demo

Requirements

  • JupyterLab >= 2.0
  • almond >= 0.10.8

Install

jupyter labextension install @almond-sh/scalafmt

Usage

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. Quickly find the almond-scalafmt commands above by typing fmt 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 the almond Scala kernel 0.10.8, or a higher version.

Contributing

Install

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Move to almond-scalafmt directory

# Install dependencies
jlpm
# Build Typescript source
jlpm build
# Link your development version of the extension with JupyterLab
jupyter labextension install .
# Rebuild Typescript source after making changes
jlpm build
# Rebuild JupyterLab after making any changes
jupyter 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 tab
jlpm watch
# Run jupyterlab in watch mode in one terminal tab
jupyter 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).

Reporting issues

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

Uninstall

jupyter labextension uninstall almond-scalafmt