KNIME Scripting Editor Framework

Shared scripting editor components for KNIME Analytics Platform and a standalone generic scripting editor app.

Consuming this package

@knime/components is a peer dependency and is published as the exact version this repository builds against (its peerDependencies entry is catalog:, which pnpm resolves from pnpm-workspace.yaml at publish time).

Breaking change -- versions published after 0.0.139 require @knime/components 2.0; 0.0.139 and earlier required 1.46.7. Bump @knime/components to 2.0.0 in the consuming repository in the same step as @knime/scripting-editor. Staying on 1.x leaves two majors of @knime/components in the consumer's tree and the package manager reporting a peer-dependency mismatch.

Development

Prerequisites

• Node.js (see version in package.json)
• pnpm workspace (install from root: pnpm install)

Development Modes

Standalone Mode (Browser)

Develop with mocked backend services:

pnpm run dev:browser

Opens at http://localhost:5173/

KNIME Dialog Development Mode

Start KNIME Analytics Platform with:

-Dorg.knime.ui.dev.mode=true
-Dorg.knime.ui.dev.node.dialog.url=http://localhost:5173/

Run the development server:

pnpm run dev:knime

NOTE: The dialog served by the development server is only visible with the the dialog mode "Open in new window".

Build

Library:

pnpm run build:lib          # Production build
pnpm run build:lib:watch    # Watch mode

Application:

pnpm run build:app

Testing

pnpm run test:unit    # Run tests
pnpm run coverage     # Generate coverage

Code Quality

pnpm run lint
pnpm run format