Skip to content

Linter ​

tyrus lint reporta diagnósticos de estilo, corrección, seguridad, performance y arquitectura separados de los errores del compilador. El linter lee tyrus-lint.json en la raíz del proyecto cuando existe; las reglas omitidas usan su severidad default interna.

Comandos ​

shell
tyrus lint
tyrus lint --fix
tyrus lint --format json
tyrus lint --max-warnings 0
tyrus lint --explain no-unused-vars
tyrus lint --init
tyrus lint --default

--fix aplica fixes seguros y determinísticos y luego ejecuta lint de nuevo. --format json emite reportes legibles por máquina. --max-warnings 0 es útil para CI. --explain <rule> imprime la documentación de la regla en el terminal. --init crea o actualiza tyrus-lint.json sin cambiar severidades configuradas. --default redefine el archivo a los defaults internos.

Configuración ​

El archivo es un objeto JSON plano que mapea nombres de reglas a severidades. No existe extends, presets ni wrapper rules.

json
{
  "no-unused-vars": "warn",
  "no-unused-imports": "warn",
  "prefer-const": "warn",
  "no-unreachable-code": "error",
  "no-empty-block": "warn",
  "no-force-unwrap": "error",
  "no-null-literal": "error",
  "exhaustive-match": "error",
  "no-duplicate-case": "error",
  "no-shadow": "warn"
}
SeveridadSignificado
offRegla desactivada.
infoDiagnóstico informativo.
warnWarning; no falla CI por default.
errorError; termina con código 1.

Reglas ​

ReglaDefaultCategoríaAutofixResumen
api-no-verb-in-pathwarnstylenoAvisa cuando paths de ruta usan verbos de acción en lugar de paths orientados a recurso.
api-prefer-resource-nounswarnstylenoAvisa cuando paths de ruta no parecen sustantivos de recurso.
controller-must-send-responseerrorcorrectnessnoExige que todo camino exitoso del controller envíe una respuesta.
controller-no-db-accesserrorsafetynoProhíbe acceso directo a la base de datos en controllers.
controller-no-try-catchwarnsafetynoAvisa cuando controllers capturan errores esperados en lugar de delegar el mapeo.
db-explicit-select-columnsinfostyleyesPrefiere proyecciones explícitas en SELECT y expande campos de la interfaz de resultado local.
db-no-extra-select-columnsinfoperformancenoAdvierte cuando una consulta tipada selecciona columnas que no están declaradas en la interfaz de resultado.
exhaustive-matcherrorcorrectnessnoExige que match sobre tipos cerrados cubra todos los casos.
http-no-raw-status-codewarnsafetynoSugiere HttpStatus en lugar de códigos numéricos crudos en respuestas.
no-duplicate-caseerrorcorrectnessnoDetecta cases duplicados en switch o match.
no-duplicate-importserrorcorrectnessnoDetecta múltiples declaraciones de import del mismo módulo.
no-empty-blockwarnstylenoDetecta bloques vacíos sin comentario explicativo.
no-empty-catchwarnsafetynoDetecta bloques catch vacíos sin comentario explicativo.
no-floating-enumerrorcorrectnessnoProhíbe valores f64/f128 en enums.
no-force-unwraperrorsafetynoProhíbe unwrap forzado de optional con expr!.
no-heterogeneous-enumerrorcorrectnessnoProhíbe mezclar tipos primitivos de valor en un mismo enum.
no-implicit-enum-primitive-casterrorsafetynoExige casts as explícitos de enum a primitivos.
no-implicit-heavy-movewarnperformancenoAvisa sobre moves sorprendentes de valores grandes o non-Copy.
no-layer-skipwarnsafetynoAvisa cuando código API salta la capa route-controller-service-repository.
no-null-literalerrorcorrectnessnoProhíbe la palabra clave null; usa T?, campos opcionales y ??.
no-shadowwarnstylenoDetecta bindings que sombrean bindings externos.
no-string-concat-in-loopwarnperformancenoDetecta concatenación repetida de string dentro de loops.
no-uninitialized-variablewarncorrectnessnoExpone diagnósticos de definite assignment para let x: T;.
no-unnecessary-allocationinfoperformancenoDetecta asignaciones claramente innecesarias.
no-unnecessary-awaitwarnstyleyesDetecta y corrige delegación redundante con return await promise.
no-unnecessary-clonewarnperformancenoDetecta clones que podrían reemplazarse por borrows.
no-upward-importserrorsafetynoProhíbe que capas inferiores de API importen capas superiores.
no-unreachable-codeerrorcorrectnessnoDetecta código después de return, break, continue o throw.
no-unsafe-finallyerrorsafetynoDetecta cambios de flujo dentro de finally.
no-useless-null-checkwarncorrectnessnoDetecta checks de null en valores que nunca pueden ser null.
no-unused-functionswarncorrectnessnoDetecta funciones no exportadas que nunca se llaman.
no-unused-importswarncorrectnessyesDetecta y puede eliminar specifiers de import no usados.
no-unused-varswarncorrectnessnoDetecta variables no usadas; usa prefijo _ cuando sea intencional.
prefer-borrowinfoperformancenoSugiere pasar referencias cuando ownership no es necesario.
prefer-constwarnstyleyesSugiere const para bindings que nunca se reasignan.
prefer-nullish-coalescinginfostylenoSugiere ?? para patrones de fallback nullable.
repository-no-http-errorwarnsafetynoAvisa cuando repositories dependen de HttpReply.
repository-only-db-accesserrorsafetynoRestringe acceso directo a la base de datos a módulos repository.
route-no-business-logicwarncomplexitynoAvisa cuando módulos de ruta contienen lógica de negocio.
service-no-replyerrorsafetynoProhíbe que services dependan de HttpReply.
use-caught-errorwarnsafetynoDetecta errores capturados que nunca se usan.

Match exhaustivo ​

exhaustive-match exige que un match sobre un tipo cerrado, una tagged union, una union literal o un booleano, cubra todos los casos. Es aplicado por el compilador como E0004, así que reporta incluso con la regla de lint deshabilitada.

tyrus
type Result = { tag: "success"; data: string } | { tag: "error"; code: i32 };

const handle = (result: Result): void => {
    match (result) {
        ({ tag: "success", data }) => {
            print(data); // "data value"
        }
        ({ tag: "error", code }) => {
            print(code); // error code
        }
    }
};

Código nullable ​

tyrus no usa el literal null en código normal. Expresa ausencia con T?, campos opcionales, parámetros opcionales y ??.

tyrus
interface Message {
    text?: string;
}

const message: Message = {};
const text: string = message.text ?? "default";

Arquitectura de API ​

Los proyectos creados al elegir el target API en las preguntas de tyrus new reciben defaults de lint orientados a API. Los módulos de ruta declaran rutas, los controllers traducen fronteras HTTP, los services contienen comportamiento de negocio y los repositories concentran acceso directo a la base de datos.

tyrus
import { HttpReply, HttpStatus } from "tyrus:http";

interface CreatedUserResponse {
    ok: boolean;
}

export const createUserController = (request: EmptyRequest, reply: HttpReply<CreatedUserResponse>): void => {
    reply.status(HttpStatus.Created).send({ ok: true });
};

Quick Fixes ​

Las reglas exponen Quick Fixes cuando la edición es determinística. prefer-const puede reescribir let a const; no-unused-imports puede eliminar specifiers de import no usados. Las reglas que exigen una decisión de diseño, como renombrar una variable sombreada, reportan ayuda pero no inventan una edición.

diff
- import { readFileSync, writeFileSync } from "tyrus:fs";
+ import { readFileSync } from "tyrus:fs";

const text = readFileSync("README.md");

Las reglas de arquitectura intencionalmente no tienen autofix

Reglas como controller-no-db-access y service-no-reply identifican problemas de diseño. Exigen mover código a la capa correcta, no una edición mecánica.