n8n-conventions

Reference n8n development conventions for TypeScript, testing, and backend structure.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides essential guidelines and quick references for developing within the n8n ecosystem, ensuring consistency and adherence to best practices.

Core Features & Use Cases

  • Coding Standards: Enforces TypeScript, error handling, and frontend conventions.
  • Backend Structure: Outlines the Controller-Service-Repository pattern and dependency injection.
  • Testing & Commands: Specifies testing tools and essential pre-commit commands.
  • Use Case: A new developer joining the n8n project can use this Skill to quickly understand the established patterns for writing new nodes or contributing to the frontend.

Quick Start

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

Frequently Asked Questions about n8n-conventions

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

FAQPage Schema
What are the development conventions for contributing to n8n?

n8n development conventions enforce TypeScript standards, error handling, frontend rules, backend structure, and testing patterns. Following these guidelines ensures consistency and adherence to established architectural principles when contributing to the n8n project.

How do I structure the backend when developing n8n nodes?

To structure the n8n backend, use the Controller-Service-Repository pattern along with dependency injection. This architectural convention maintains separation of concerns and ensures scalable, maintainable code within the n8n ecosystem.

What testing tools and pre-commit commands are required for n8n development?

n8n testing conventions specify dedicated testing tools and essential pre-commit commands to validate code before submission. Running these checks ensures your TypeScript and frontend code adheres to the project's established quality standards.

Does n8n development require specific TypeScript error handling patterns?

Yes, n8n development requires specific TypeScript error handling patterns to maintain robustness. The conventions provide a quick reference for these critical rules, ensuring your code handles errors consistently across frontend and backend components.

Can I use this reference to understand both frontend and backend n8n patterns?

Yes, this reference covers both frontend and backend n8n patterns. It outlines coding standards for TypeScript and frontend development, while also detailing backend structure conventions for comprehensive project adherence.

Why should I follow n8n coding standards instead of general TypeScript conventions?

Following n8n coding standards ensures your contributions match the project's specific architectural principles and tooling. General TypeScript conventions may lack the required Controller-Service-Repository structure and error handling patterns established within the n8n ecosystem.