alighasami
3d5eaf9445
Security: Sync from Public / sync-from-public (push) Has been cancelled
Test: Benchmark Nightly / build (push) Has been cancelled
Test: Benchmark Nightly / Notify Cats on failure (push) Has been cancelled
CI: Python / Checks (push) Has been cancelled
Test: Evals Python / Workflow Comparison Python (push) Has been cancelled
Util: Check Docs URLs / check-docs-urls (push) Has been cancelled
Test: Visual Storybook / Cloudflare Pages (push) Has been cancelled
Test: E2E Performance / build-and-test-performance (push) Has been cancelled
Test: Workflows Nightly / Run Workflow Tests (push) Has been cancelled
Util: Cleanup CI Docker Images / Delete stale CI images (push) Has been cancelled
Test: Benchmark Destroy Env / build (push) Has been cancelled
Util: Update Node Popularity / update-popularity (push) Has been cancelled
Test: E2E Coverage Weekly / Coverage Tests (push) Has been cancelled
99 lines
2.4 KiB
Markdown
99 lines
2.4 KiB
Markdown
---
|
|
name: n8n-conventions
|
|
description: Quick reference for n8n patterns. Full docs /AGENTS.md
|
|
---
|
|
|
|
# n8n Quick Reference
|
|
|
|
**📚 Full Documentation:**
|
|
- **General:** `/AGENTS.md` - Architecture, commands, workflows
|
|
- **Frontend:** `/packages/frontend/AGENTS.md` - CSS variables, timing
|
|
|
|
Use this skill when you need quick reminders on critical patterns.
|
|
|
|
## Critical Rules (Must Follow)
|
|
|
|
**TypeScript:**
|
|
- Never `any` → use `unknown`
|
|
- Prefer `satisfies` over `as` (except tests)
|
|
- Shared types in `@n8n/api-types`
|
|
|
|
**Error Handling:**
|
|
```typescript
|
|
import { UnexpectedError } from 'n8n-workflow';
|
|
throw new UnexpectedError('message', { extra: { context } });
|
|
// DON'T use deprecated ApplicationError
|
|
```
|
|
|
|
**Frontend:**
|
|
- Vue 3 Composition API (`<script setup lang="ts">`)
|
|
- CSS variables (never hardcode px) - see `/packages/frontend/AGENTS.md`
|
|
- All text via i18n (`$t('key')`)
|
|
- `data-testid` for E2E (single value, no spaces)
|
|
|
|
**Backend:**
|
|
- Controller → Service → Repository
|
|
- Dependency injection via `@n8n/di`
|
|
- Config via `@n8n/config`
|
|
- Zod schemas for validation
|
|
|
|
**Testing:**
|
|
- Vitest (unit), Playwright (E2E)
|
|
- Mock external dependencies
|
|
- Work from package directory: `pushd packages/cli && pnpm test`
|
|
|
|
**Database:**
|
|
- SQLite/PostgreSQL only (app DB)
|
|
- Exception: DB nodes (MySQL Node, etc.) can use DB-specific features
|
|
|
|
**Commands:**
|
|
```bash
|
|
pnpm build > build.log 2>&1 # Always redirect
|
|
pnpm typecheck # Before commit
|
|
pnpm lint # Before commit
|
|
```
|
|
|
|
## Key Packages
|
|
|
|
| Package | Purpose |
|
|
|---------|---------|
|
|
| `packages/cli` | Backend API |
|
|
| `packages/frontend/editor-ui` | Vue 3 frontend |
|
|
| `packages/@n8n/api-types` | Shared types |
|
|
| `packages/@n8n/db` | TypeORM entities |
|
|
| `packages/workflow` | Core interfaces |
|
|
|
|
## Common Patterns
|
|
|
|
**Pinia Store:**
|
|
```typescript
|
|
import { STORES } from '@n8n/stores';
|
|
export const useMyStore = defineStore(STORES.MY_STORE, () => {
|
|
const state = shallowRef([]);
|
|
return { state };
|
|
});
|
|
```
|
|
|
|
**Vue Component:**
|
|
```vue
|
|
<script setup lang="ts">
|
|
type Props = { title: string };
|
|
const props = defineProps<Props>();
|
|
</script>
|
|
```
|
|
|
|
**Service:**
|
|
```typescript
|
|
import { Service } from '@n8n/di';
|
|
import { Config } from '@n8n/config';
|
|
|
|
@Service()
|
|
export class MyService {
|
|
constructor(private readonly config: Config) {}
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
📖 **Need more details?** Read `/AGENTS.md` and `/packages/frontend/AGENTS.md`
|