Elgato_dark/zammad
1
0
Fork 0
mirror of https://github.com/zammad/zammad synced 2026-05-24 09:48:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
zammad/.dev/agent_docs/frontend_patterns.md
Dominik Klein 90a305de04 Maintenance: Add some coding AI-Agent instruction improvements. 
Co-authored-by: Dusan Vuckovic <dv@zammad.com>
Co-authored-by: Dominik Klein <dk@zammad.com>
Co-authored-by: Florian Liebe <fl@zammad.com>
Co-authored-by: Benjamin Scharf <bs@zammad.com>
2026-03-23 22:16:08 +01:00

1.1 KiB
Raw Permalink Blame History

Frontend Patterns

Code Placement Rules

Code shared across both apps (desktop/mobile) lives in app/frontend/shared/. Code used across multiple pages within one app goes at the app level. Page-specific code stays in the page folder.

Pages cannot import from other pages (enforced by eslint). Move shared logic up to the app or shared level.

shared/entities/

Business logic per domain entity (e.g. ticket, user) lives in shared/entities/<entity>/. This includes entity-specific composables, GraphQL operations, object attribute stores, and types. Do not place components inside entity folders.

shared/components/ — CommonXYZ Convention

Shared components follow the CommonXYZ naming pattern. The folder name, Vue file name, and component name must match (e.g. CommonNotifications/CommonNotifications.vue). Related composables, types (types.ts), and sub-components live inside the same folder.

Auto-Generated Files — Never Edit

  • shared/graphql/types.ts
  • shared/types/config.ts
  • .ts files next to .graphql operation files (e.g. graphql/queries/, graphql/mutations/, graphql/subscriptions/)