Skip to content

AGENTS.md

Latest commit

 

History

History
104 lines (80 loc) · 3.76 KB

AGENTS.md

File metadata and controls

104 lines (80 loc) · 3.76 KB

CRM — Project Context

What this project is

Frappe CRM frontend. Vue 3 + frappe-ui. The backend is Frappe Python. Scripts in frontend/ only; Python in crm/ (Frappe app). No build step for Form Scripts — they run as evaluated strings in the browser.

Where to read before working

Task Read first
What are we building next PLAN.md
Stable API contracts (setFieldProperty, formDialog, helpers) SPEC.md
Why code is the way it is (decisions, bugs fixed, history) ARCHIVE.md
Form scripting user guide feats/form-scripting/guide.md
formDialog() API reference feats/form-scripting/form-dialog.md

Key files

Scripting engine

File Role
frontend/src/data/document.js useDocument — loads doc, wires script, patches save.submit, exposes triggers
frontend/src/data/script.js getScript — fetches Form Script records, evaluates class via new Function, injects helpers, setupHelperMethods
frontend/src/utils/scriptHelpers.js createDocProxy, getClassNames — extracted pure helpers

Field rendering

File Role
frontend/src/components/FieldLayout/FieldLayout.vue Tab/section/column layout. Accepts context prop for standalone mode (no useDocument)
frontend/src/components/FieldLayout/Field.vue Renders a single field. Calls useDocument unless fieldLayoutContext is injected
frontend/src/components/FieldLayout/Section.vue Section with CollapsibleSection
frontend/src/components/FieldLayout/Column.vue Column wrapper

Form dialog system

File Role
frontend/src/components/Modals/FieldLayoutDialog.vue Dialog shell + standalone FieldLayout + local reactive doc
frontend/src/components/Modals/FieldLayoutDialogContainer.vue Renders dialog entries from reactive array
frontend/src/utils/renderFieldLayoutDialog.js formDialog() — pushes to array, returns Promise
frontend/src/components/Modals/GlobalModals.vue Mounts FieldLayoutDialogContainer + other app-wide modals

Field transforms & validation

File Role
frontend/src/utils/fieldTransforms.js processField(), findMissingMandatory(), parseLinkFilters() — pure, tested
frontend/src/utils/expressions.js evaluateDependsOnValue(), evaluateExpression()

Meta & stores

File Role
frontend/src/stores/meta.js getMeta(doctype) — fetches DocType meta, exposes getFields(), formatters
frontend/src/stores/global.js $dialog, $socket, makeCall

Tests

cd frontend
yarn test:run      # single run
yarn test          # watch mode
  • 118 tests · ~250ms — all must pass before committing
  • Location: frontend/tests/unit/
  • Only pure utility functions are unit-tested (no Vue component tests yet)
  • Add tests in tests/unit/ when adding pure logic to src/utils/

Commit style

feat: short description
fix: short description
refactor: short description
test: short description
docs: short description

Multiple logical commits per PR — one commit per coherent change, not one giant commit. Pre-commit hooks run prettier + eslint + oxlint automatically. If they modify a file, git add the file again and re-commit.

Docs structure

PLAN.md          — future only (phases 3B, 4, 5, 6)
SPEC.md          — stable contracts
ARCHIVE.md       — completed phases + decision rationale
feats/           — user-facing feature docs
archives/        — old docs preserved verbatim

When a phase completes: move its spec from PLAN.md to ARCHIVE.md, update SPEC.md if the API surface changed.