Repository files navigation

n8n-utils is a collection of utilities for developing onn8n, the workflow automation tool.

Launch n8n inside VSCode, with hot reload for changes during node development. Accessible via the Command Palette:n8n-utils: Launch n8n in VSCode.

View the tree of node params in a node or resource file on the extension'sNode Params tab. Navigate quickly to the param in the open editor. Accessible via the Command Palette:n8n-utils: Navigate to node parameter.

View the list of controller endpoints in thecli package on the extension'sn8n controllers tab. Navigate quickly to a controller or endpoint. Accessible via the Command Palette:n8n-utils: Navigate to controller endpoint.

Hover over references to env vars likeconfig.getEnv('MY_VAR') andprocess.env.MY_VAR references to view their current values, with annotations specifying if they have been overridden, if they are part of the schema, and if they remain with the schema default value.

View the list of locally stored workflows on the extension'sStored workflows tab. Node types are linked through VSCode's definition provider to the node class, allowing for peeking definitions and jumping to definition with F12.

Hover over any node class with a comment icon to view a summary of the node's stats, including overall popularity and resource and operation usage.

• Launcher requires a local database with no owner account set up.
• Node param navigator supports*.node.ts and*Description.ts files.
• n8n endpoint navigator supports*.controller.ts files.
• Env vars tooltips may only access env vars provided via the VSCode terminal.
• Node stats are only available for the n8n team and require adding"n8n-utils.nodeStats.token": "<token>" to.vscode/settings.json. Find the token in the internal vault underVSCode extension. Node stats are cached for seven days.

To develop this extension:

1. At root dir, runnpm run watch
2. PressF5 to launch debugger at new window with Extension Development Host (EDH)
3. Make a change at root dir
4. Presscmd+shift+F5 to restart debugger at new window with EDH
5. View logs inDebug Console at root dir window

Note: Installnpm install -g vsce

1. vsce package to package extension. This will create an untracked.vsix file, used in the next step.
2. Publish withvsce publish <major|minor|patch>. This will commit with a message like1.2.3, update the versions inpackage.json andpackage-lock.json, and create a new tag likev1.2.3.
3. Push andrelease on GitHub.

© 2023 Iván Ovejero

Distributed under theMIT License.