Skip to content

Convenciones de nombres

Este documento define una convención única para mantener consistencia entre páginas, componentes, variables y templates.

Resumen rápido

TipoConvención
Archivos (YAML/HTML)kebab-case
URLskebab-case
Identificadores (name, props, fields, variables)camelCase
Keywords del sistema (type, scope, etc.)UPPERCASE
Variables de sistemaSNAKE_CASE con prefijo _

Excepción: funciones de la API Lua del runtime

Las funciones provistas por el runtime (por ejemplo send_mail, sql_to_vars, get_datetime) deben escribirse con su nombre oficial, aunque estén en snake_case.

Esta excepción aplica solo a nombres de funciones API del sistema. Las variables y nombres de negocio en tus scripts siguen la regla de camelCase.

Archivos en general (yaml, lua, html, etc)

Se recomienda usar kebab-case para nombres de archivo ya que es compatible con URLs, es fácil de leer y es un estándar web moderno.

El nombre de archivo de la página se corresponde directamente con al url que se muestra en el navegador.

text
customer-list.yaml
invoice-detail.yaml
user-profile.yaml

Nombre de componente (propiedad name)

Usar camelCase.

yaml
name: customerTable
name: submitButton

Variables

Usar camelCase para las variables de negocio.

text
customerList
selectedCustomerId

Nombres de campos en consultas

Se recomienda usar camelCase ya que muchas veces los nombres de los campos pasan a variables automáticamente (caso de LIST y FORM).

lua
var result = sql([[
    SELECT id, patient_name AS patientName
    FROM patients WHERE name = 'Jones'
]])