Skip to content

naming.md

Latest commit

 

History

History
52 lines (36 loc) · 2 KB

naming.md

File metadata and controls

52 lines (36 loc) · 2 KB
Raw
title Naming Conventions
order 3

Naming Conventions

Code-facing naming rules for NeoWiki development. Domain vocabulary is defined in the Glossary; this page covers names that never reach users.

Data access and selection

  • <X>Lookup — a read-only data-access interface (e.g. SubjectLookup).
  • <X>Repository — a read-write data-access interface (e.g. SubjectRepository).
  • <X>Picker — a UI component for selecting an existing X (e.g. SchemaPicker).

A UI component never shares its name with a data-access interface.

"Store"

Always qualify which store is meant:

  • Pinia store — a frontend state store, e.g. SubjectStore (ADR 30).
  • Graph Store — a configured projection target (Glossary).
  • A concrete technology name ("SPARQL store", "triple store") only when the statement is about that technology.

Bare "store" is ambiguous across these three; write the qualified form in identifiers, docs, and discussion.

Registry

<X>Registry is reserved for extension-point lookup tables (PropertyTypeRegistry, ViewTypeRegistry). Pinia stores follow registry semantics (ADR 30) but are not named Registry.

Vue component suffixes

Components are named noun-first with a role suffix:

  • <X>Display — renders an X read-only.
  • <X>Input — a form control for entering a value.
  • <X>Editor — edits an existing X.
  • <X>Creator — creates a new X.
  • <X>Picker — selects an existing X.
  • <X>Dialog — a modal container; combined as <X><Role>Dialog (e.g. SubjectCreatorDialog).

Known collisions, unresolved

Do not add new uses of these names until the linked decision lands:

  • RelationType currently names both the graph edge label and the relation Property Type (#630).
  • Neo4jPlugin vs GraphDatabasePlugin: which concept "Plugin" names is unsettled (#1001).