add-constant

Add a global constant / enum

helpers/constants.js is the single source of truth for global constants. No magic strings: any string literal that is — or is likely to be — used in more than one place (locales, statuses, types, roles, enum-like values) must be defined once here and referenced. Never hardcode 'ADMIN', 'PENDING', or 'en' in actions/tasks/models — use ADMIN_ROLE.ADMIN, the status constant, LOCALE.EN, etc. Read README "helpers/constants.js".

When the constant changes feature behavior, schema, authorization, or API contracts, include its values and migration compatibility in the approved plan before editing. Confirm affected features have complete structure with yarn repair <Feature> --dry-run, then yarn repair <Feature>; use generators for any missing feature scaffolding.

Example: defaultValue: 'en' → defaultValue: constants.LOCALE.EN; joi...default('en') → .default(LOCALE.EN). If a constant for the value doesn't exist yet, add it (below) rather than typing the literal.

Rules

• Constant names are ALL_CAPS_WITH_UNDERSCORES.
• Dual-export pattern — every enum-style constant is exported in two forms, defined as an adjacent pair:
  • Object (singular name) — for value lookup in code (autocomplete, typo-safe).
  • Array (plural name) — for Joi validation (joi.string().valid(...XS)) and iteration.

  // order statuses
  ORDER_STATUS:  { PENDING: 'PENDING', ACTIVE: 'ACTIVE', COMPLETED: 'COMPLETED' }, // object — lookup
  ORDER_STATUSES: ['PENDING', 'ACTIVE', 'COMPLETED'],                              // array — validation
  

• Naming the pair: prefer natural singular/plural (WEEKDAY/WEEKDAYS, PRODUCT_TYPE/PRODUCT_TYPES). Fall back to an _ARR suffix only when the plural is awkward (POST_GENERATED_BY / POST_GENERATED_BY_ARR). Don't mix conventions arbitrarily.
• Group related constants under a comment header; keep the object/array pair adjacent; order alphabetically within a group.