Skip to content

Linter ​

tyrus lint reporta diagnósticos de estilo, correção, segurança, performance e arquitetura separados dos erros do compilador. O linter lê tyrus-lint.json na raiz do projeto quando ele existe; regras omitidas usam a severidade 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 e determinísticos e depois roda lint novamente. --format json emite relatórios legíveis por máquina. --max-warnings 0 é útil para CI. --explain <rule> imprime a documentação da regra no terminal. --init cria ou atualiza tyrus-lint.json sem alterar severidades configuradas. --default redefine o arquivo para os defaults internos.

Configuração ​

O arquivo é um objeto JSON plano que mapeia nomes de regras para severidades. Não existe extends, presets nem 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"
}
SeveridadeSignificado
offRegra desativada.
infoDiagnóstico informativo.
warnWarning; não falha CI por default.
errorErro; encerra com código 1.

Regras ​

RegraDefaultCategoriaAutofixResumo
api-no-verb-in-pathwarnstylenoAvisa quando paths de rota usam verbos de ação em vez de paths orientados a recurso.
api-prefer-resource-nounswarnstylenoAvisa quando paths de rota não parecem substantivos de recurso.
controller-must-send-responseerrorcorrectnessnoExige que todo caminho de sucesso do controller envie uma resposta.
controller-no-db-accesserrorsafetynoProíbe acesso direto ao banco em controllers.
controller-no-try-catchwarnsafetynoAvisa quando controllers capturam erros esperados em vez de delegar o mapeamento.
db-explicit-select-columnsinfostyleyesPrefere projeções explícitas em SELECT e expande campos da interface de resultado local.
db-no-extra-select-columnsinfoperformancenoAvisa quando uma consulta tipada seleciona colunas que não estão declaradas na interface de resultado.
exhaustive-matcherrorcorrectnessnoExige que match sobre tipos fechados cubra todos os casos.
http-no-raw-status-codewarnsafetynoSugere HttpStatus em vez de códigos numéricos crus em respostas.
no-duplicate-caseerrorcorrectnessnoDetecta cases duplicados em switch ou match.
no-duplicate-importserrorcorrectnessnoDetecta múltiplas declarações de import do mesmo módulo.
no-empty-blockwarnstylenoDetecta blocos vazios sem comentário explicativo.
no-empty-catchwarnsafetynoDetecta blocos catch vazios sem comentário explicativo.
no-floating-enumerrorcorrectnessnoProíbe valores f64/f128 em enums.
no-force-unwraperrorsafetynoProíbe unwrap forçado de optional com expr!.
no-heterogeneous-enumerrorcorrectnessnoProíbe misturar tipos primitivos de valor no mesmo enum.
no-implicit-enum-primitive-casterrorsafetynoExige casts as explícitos de enum para primitivos.
no-implicit-heavy-movewarnperformancenoAvisa sobre moves surpreendentes de valores grandes ou non-Copy.
no-layer-skipwarnsafetynoAvisa quando código API pula a camada route-controller-service-repository.
no-null-literalerrorcorrectnessnoProíbe a palavra-chave null; use T?, campos opcionais e ??.
no-shadowwarnstylenoDetecta bindings que sombreiam bindings externos.
no-string-concat-in-loopwarnperformancenoDetecta concatenação repetida de string dentro de loops.
no-uninitialized-variablewarncorrectnessnoExpõe diagnósticos de definite assignment para let x: T;.
no-unnecessary-allocationinfoperformancenoDetecta alocações claramente desnecessárias.
no-unnecessary-awaitwarnstyleyesDetecta e corrige delegação redundante com return await promise.
no-unnecessary-clonewarnperformancenoDetecta clones que poderiam ser substituídos por borrows.
no-upward-importserrorsafetynoProíbe camadas inferiores da API importarem camadas superiores.
no-unreachable-codeerrorcorrectnessnoDetecta código após return, break, continue ou throw.
no-unsafe-finallyerrorsafetynoDetecta mudanças de fluxo dentro de finally.
no-useless-null-checkwarncorrectnessnoDetecta checagens de null em valores que nunca podem ser null.
no-unused-functionswarncorrectnessnoDetecta funções não exportadas que nunca são chamadas.
no-unused-importswarncorrectnessyesDetecta e pode remover specifiers de import não usados.
no-unused-varswarncorrectnessnoDetecta variáveis não usadas; prefixe com _ quando intencional.
prefer-borrowinfoperformancenoSugere passar referências quando ownership não é necessário.
prefer-constwarnstyleyesSugere const para bindings que nunca são reatribuídos.
prefer-nullish-coalescinginfostylenoSugere ?? para padrões de fallback nullable.
repository-no-http-errorwarnsafetynoAvisa quando repositories dependem de HttpReply.
repository-only-db-accesserrorsafetynoRestringe acesso direto ao banco a módulos repository.
route-no-business-logicwarncomplexitynoAvisa quando módulos de rota contêm lógica de negócio.
service-no-replyerrorsafetynoProíbe services de dependerem de HttpReply.
use-caught-errorwarnsafetynoDetecta erros capturados que nunca são usados.

Match exaustivo ​

exhaustive-match exige que um match sobre um tipo fechado, uma tagged union, uma union literal ou um booleano, cubra todos os casos. Ele é aplicado pelo compilador como E0004, então reporta mesmo com a regra de lint desabilitada.

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 não usa o literal null em código normal. Expresse ausência com T?, campos opcionais, parâmetros opcionais e ??.

tyrus
interface Message {
    text?: string;
}

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

Arquitetura de API ​

Projetos criados ao escolher o target API nas perguntas de tyrus new recebem defaults de lint orientados a API. Módulos de rota declaram rotas, controllers traduzem fronteiras HTTP, services contêm comportamento de negócio e repositories concentram acesso direto ao banco.

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 ​

Regras expõem Quick Fixes quando a edição é determinística. prefer-const pode reescrever let para const; no-unused-imports pode remover specifiers de import não usados. Regras que exigem uma decisão de design, como renomear uma variável sombreada, reportam ajuda mas não inventam uma edição.

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

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

Regras de arquitetura intencionalmente não têm autofix

Regras como controller-no-db-access e service-no-reply identificam problemas de design. Elas exigem mover código para a camada correta, não uma edição mecânica.