n8n-conventions

Provides quick reference for n8n development conventions and best practices across frontend and backend codebases.

Updated Jan 12, 2026
One-click install
npx skills add https://github.com/greptileai/n8n-mirror --skill n8n-conventions-greptileai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: n8n-conventions
Source: https://github.com/greptileai/n8n-mirror/tree/main/.claude/skills/n8n-conventions
Command: npx skills add https://github.com/greptileai/n8n-mirror --skill n8n-conventions-greptileai

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides quick access to essential coding conventions and best practices for n8n development, ensuring consistency and maintainability across the project.

Core Features & Use Cases

  • Coding Standards: Enforces TypeScript rules, error handling patterns, and frontend best practices (Vue 3, CSS variables, i18n).
  • Backend Structure: Outlines the Controller-Service-Repository pattern and dependency injection usage.
  • Testing Guidelines: Specifies testing frameworks (Vitest, Playwright) and common commands.
  • Use Case: A new developer joining the n8n team can use this skill to quickly understand the established patterns for writing new backend services or frontend components.

Quick Start

Consult the n8n-conventions skill for guidance on TypeScript error handling.

Frequently Asked Questions about n8n-conventions

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

FAQPage Schema
What are the standard conventions for n8n backend architecture and TypeScript?

n8n backend conventions require the Controller-Service-Repository pattern, dependency injection, and strict TypeScript rules. Following these patterns ensures consistency and maintainability across the project's codebase.

How do I handle error handling and testing in an n8n codebase?

For n8n error handling and testing, use Vitest and Playwright frameworks. The conventions provide critical rules for error handling patterns and specify common command-line patterns for running build, type checking, and linting tasks.

Does n8n frontend development use Vue 3 and CSS variables?

Yes, n8n frontend development uses Vue 3 alongside CSS variables and i18n. The conventions outline specific best practices to ensure frontend components remain consistent and maintainable across the project.

What databases does n8n support and what testing frameworks are required?

n8n supports SQLite and PostgreSQL databases. The required testing frameworks are Vitest for unit tests and Playwright for end-to-end testing, ensuring comprehensive coverage across frontend and backend codebases.

How do I quickly reference build, type checking, and linting commands for n8n?

To reference n8n build, type checking, and linting commands, consult the conventions skill. It details common command-line patterns needed to maintain code quality and execute standard development workflows.

What is the best way to structure a new n8n backend service?

The best way to structure an n8n backend service is using the Controller-Service-Repository pattern with dependency injection. This ensures your new code matches established project conventions and maintains architectural integrity.