Decide daw_i18n/v1 resource file location for daw-lua-common #47

Closed
opened 2026-08-13 21:53:25 +02:00 by michael · 1 comment
Owner

Goal

Decide where daw_i18n/v1 resource files for daw-lua-common live, and
in what shape, before any error site in this library can reference a
resource_id.

Background

daw-project-standard.json documents a general per-module convention
(i18n/en.lua, i18n/de.lua) for the older berhtjan-core label model
({en=..., de=...} contribution labels). Whether that convention
applies as-is to daw_i18n/v1 resource files is not yet decided.
Discovery/collection of daw_i18n/v1 resources across independently
developed modules is explicitly out of scope of the daw_i18n/v1
contract itself and remains an open architecture question.

daw-lua-common is a library, not a host program with a
contribution.json/module structure -- the existing per-module i18n/
convention was designed for domain/UI modules, not for a shared
library with ~171 error sites spread across 37 Lua files. Whether
that means one file for the whole library, one file per source file,
or something else is exactly what this issue needs to settle.

Scope

  • Decide file location and granularity for daw_i18n/v1 resources
    owned by daw-lua-common (single library-wide file vs. per-file vs.
    other split)
  • Canonical English resource file MUST exist and be complete per
    daw_i18n/v1 (language="en", canonical=true)
  • German (de) resource file, may be a partial subset per daw_i18n/v1
  • Confirm this decision does not depend on the still-open
    cross-module discovery/collection question -- daw-lua-common can
    fix its own file location even before that broader question is
    resolved, as long as the shape is daw_i18n/v1-conformant

Acceptance criteria

  • File location and granularity decided and documented
    (daw-lua-common README or a docs/ note)
  • Canonical en resource file exists (may start empty/skeleton)
  • de resource file exists (may start empty/partial)
  • Decision does not preempt or contradict the still-open
    DAW-wide discovery/collection question

Blocks

DAW/daw-lua-common#48 (resource_id for all daw_error/v1 sites -- filed
as a separate issue, blocked by this one)

DAW/daw-contracts daw_i18n/v1 (contract.json, specification.md)

## Goal Decide where daw_i18n/v1 resource files for daw-lua-common live, and in what shape, before any error site in this library can reference a resource_id. ## Background daw-project-standard.json documents a general per-module convention (`i18n/en.lua`, `i18n/de.lua`) for the older berhtjan-core label model ({en=..., de=...} contribution labels). Whether that convention applies as-is to daw_i18n/v1 resource files is not yet decided. Discovery/collection of daw_i18n/v1 resources across independently developed modules is explicitly out of scope of the daw_i18n/v1 contract itself and remains an open architecture question. daw-lua-common is a library, not a host program with a contribution.json/module structure -- the existing per-module i18n/ convention was designed for domain/UI modules, not for a shared library with ~171 error sites spread across 37 Lua files. Whether that means one file for the whole library, one file per source file, or something else is exactly what this issue needs to settle. ## Scope - Decide file location and granularity for daw_i18n/v1 resources owned by daw-lua-common (single library-wide file vs. per-file vs. other split) - Canonical English resource file MUST exist and be complete per daw_i18n/v1 (language="en", canonical=true) - German (de) resource file, may be a partial subset per daw_i18n/v1 - Confirm this decision does not depend on the still-open cross-module discovery/collection question -- daw-lua-common can fix its own file location even before that broader question is resolved, as long as the shape is daw_i18n/v1-conformant ## Acceptance criteria - [ ] File location and granularity decided and documented (daw-lua-common README or a docs/ note) - [ ] Canonical en resource file exists (may start empty/skeleton) - [ ] de resource file exists (may start empty/partial) - [ ] Decision does not preempt or contradict the still-open DAW-wide discovery/collection question ## Blocks DAW/daw-lua-common#48 (resource_id for all daw_error/v1 sites -- filed as a separate issue, blocked by this one) ## Related DAW/daw-contracts daw_i18n/v1 (contract.json, specification.md)
Author
Owner

Decision: one i18n/ directory per repo root (daw-lua-common/i18n/en.lua, de.lua), regardless of internal submodule split. Same convention as host programs and modules -- no separate per-submodule i18n dirs, even if daw-lua-common is internally split further.

Host-side text override (host overrides a lib/module resource_id) is a related but separate topic, filed as DAW/daw-modul-berhtjan-core#13 .

Decision: one i18n/ directory per repo root (daw-lua-common/i18n/en.lua, de.lua), regardless of internal submodule split. Same convention as host programs and modules -- no separate per-submodule i18n dirs, even if daw-lua-common is internally split further. Host-side text override (host overrides a lib/module resource_id) is a related but separate topic, filed as DAW/daw-modul-berhtjan-core#13 .
michael 2026-08-14 13:21:09 +02:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
DAW/daw-lua-common#47
No description provided.