Pular para o conteúdo principal

bactopia-docs

Valida a desatualização de documentos de referência em um repositório Bactopia.

Duas verificações são executadas em cada arquivo .md sob [b]--docs-path[/b]:

[b]Padrões obsoletos (D0xx)[/b]: correspondências de regex com entradas de [b]--patterns-file[/b] — frases removidas por migrações anteriores (ex.: flattenPaths, o formato de emissão de 4 canais).

[b]Asserções de verdade absoluta (D1xx)[/b]: contagens (D101-D103), versão do Nextflow (D104), referências de CLI do bactopia-py (D105), IDs de regras de lint (D106), alvos de links markdown (D108).

Suprima uma regra em uma única linha com <!-- bactopia-docs: ignore D0xx --> (ou uma lista separada por vírgulas).

Encerra com 1 se alguma falha (FAIL) for encontrada.

Uso

bactopia-docs [OPTIONS]

Opções Obrigatórias

OpçãoTipoPadrãoDescrição
--bactopia-path, -bSTRINGDiretório onde o repositório Bactopia está armazenado

Opções de Validação

OpçãoTipoPadrãoDescrição
--docs-pathSTRING.claude/docsDiretório de documentação relativo a --bactopia-path
--patterns-fileSTRINGdata/docs-patterns.ymlYAML de padrões obsoletos relativo a --bactopia-path
--bactopia-py-pathPATHCaminho para o repositório bactopia-py (para verificações de CLI D105 / regras de lint D106). Padrão: <bactopia-path>/../bactopia-py
--skip-path-checkBOOLfalseIgnorar a resolução de alvos de links markdown D108
--validateBOOLfalseExecutar validação (ação padrão; flag aceita para paridade com bactopia-citations)

Opções de Saída

OpçãoTipoPadrãoDescrição
--jsonBOOLfalseEmitir resultados como JSON
--plain-text, -pBOOLfalseDesativar formatação rica

Opções Adicionais

OpçãoTipoPadrãoDescrição
--verboseBOOLfalseImprimir texto relacionado a depuração
--silentBOOLfalseApenas erros críticos serão exibidos
--version, -VBOOLfalseExibir a versão e sair.