n8n:conventions

Provides development guidelines for n8n automation workflows, including TypeScript, Vue 3, Vitest, and Playwright.

Updated Jul 3, 2026
One-click install
npx skills add https://github.com/Rub-git/n8n-auto --skill n8n-conventions-rub-git
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: n8n:conventions
Source: https://github.com/Rub-git/n8n-auto/tree/main/.agents/skills/conventions
Command: npx skills add https://github.com/Rub-git/n8n-auto --skill n8n-conventions-rub-git

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill provides quick reference for the patterns and guidelines followed in the n8n development ecosystem, making it easier for developers to follow best practices and understand the architecture.

Core Features & Use Cases

  • TypeScript Guidelines: Offers recommendations on TypeScript best practices and alternatives to avoid deprecated methods.
  • Error Handling Standards: Specifies the proper way to handle errors, emphasizing the use of the UnexpectedError class.
  • Frontend Development: Includes instructions on the use of Vue 3 Composition API and CSS variables.
  • Backend Architecture: Defines the recommended architecture, including controller, service, and repository patterns.
  • Testing: Details the testing frameworks and methods used, like Vitest and Playwright.
  • Database: Specifies the supported databases and usage guidelines for the app and DB nodes.
  • Deployment Commands: Provides examples of deployment-related commands for building and linting.

Quick Start

Use this skill to quickly find guidelines and best practices for developing within the n8n ecosystem.

Frequently Asked Questions about n8n:conventions

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What are the best practices for TypeScript in n8n development?

n8n development guidelines recommend specific TypeScript patterns and alternatives to avoid deprecated methods. Following these standards ensures maintainable AI automation workflows and consistent code architecture.

How should I handle errors when building n8n workflows?

Error handling in n8n workflows should utilize the `UnexpectedError` class. This standardized approach ensures consistent error management across your AI automation workflows and backend services.

Does n8n use Vue 3 for frontend development?

Yes, n8n frontend development uses Vue 3 Composition API and CSS variables. The guidelines specify this architecture for building user interfaces within the n8n ecosystem.

What testing frameworks are recommended for n8n?

n8n testing guidelines recommend using Vitest and Playwright. These frameworks support the testing methods detailed in the development conventions for both unit and end-to-end testing.

What backend architecture pattern does n8n follow?

n8n backend architecture follows the controller, service, and repository pattern. This defined structure separates concerns and organizes the server-side logic for AI automation workflows.

What databases are supported for n8n app and DB nodes?

n8n specifies supported databases and usage guidelines for the app and DB nodes. These conventions ensure proper database support and integration within your automation workflows.