Rules | ESLint Plugin Jupyter

📄️Rules

This section documents all rules currently provided by eslint-plugin-jupyter.

Ensure JupyterLab command registrations include a describedBy property.

Use Galata's document-opening helpers instead of separate Playwright actions to navigate the file browser's Open With menu.

Prefer Galata's page.filebrowser and page.notebook helpers over raw Playwright selectors for JupyterLab file browser interactions.

Prefer Galata's page.menu helper over raw Playwright selectors for JupyterLab main menu traversal.

Prefer the Galata page.notebook helper over raw Playwright selectors and keyboard shortcuts for notebook cell operations.

Prefer Galata's sidebar and activity helpers over raw Playwright selectors when opening sidebar tabs or activating main area tabs.

Store translation bundles under a name the translation extractor recognizes, such as trans.

Require JupyterLab translation messages to be written as literals at the call

Disallow calling PageConfig.getBaseUrl() outside of makeSettings().

Disallow enum in settings JSON schema files; use oneOf with const, title, and an explicit type instead.

Forbid concatenating dynamic values into JupyterLab translation messages.

Wrap user-facing text in a translation call such as trans.().

Ensure JupyterLab plugin activate arguments match the order and count of requires and optional tokens.

Ensure all JupyterFrontEndPlugin objects define a non-empty description property.

Prefix each plugin ID with the extension package name followed by :.

Load heavy dependencies when a plugin needs them, so they do not delay startup.

Pass this when connecting a signal that can outlive the receiving object, so disposal can remove the connection.

Require newly created disposable objects to be owned, returned, assigned to a

Require calls returning IDisposable to transfer ownership to a caller, field,

Disconnect from long-lived services when disposing the object that listens to them.

Require this as the second argument when a class method that uses this is connected to a Lumino signal.

Require expect.soft() for snapshot assertions that are not the last in a Playwright test block.

Use : for JupyterLab token IDs.