Como testar arquivos de ajuda de consulta

Verifique se os CodeQL arquivos de ajuda de consulta são válidos visualizando-os como Markdown.

Quem pode usar esse recurso?

O CodeQL está disponível para os seguintes tipos de repositórios:

Neste artigo

Pré-requisitos

  • Os arquivos de ajuda de consulta (.qhelp) devem ter arquivos de consulta (.ql) com nomes de base idênticos.
  • Os arquivos de ajuda de consulta devem seguir a estrutura e o estilo padrão para a documentação da ajuda de consulta. Para obter mais informações, consulte o guia de estilo de ajuda de consulta no CodeQL repositório.

Visualizando seus arquivos de ajuda de consulta

  1. Para renderizar os arquivos de ajuda de consulta como Markdown, execute o seguinte comando:

    Shell
    codeql generate query-help <qhelp|query|dir|suite> --format=markdown [--output=<dir|file>]

    Para obter informações sobre as opções disponíveis para este comando, consulte gerar consulta-ajuda.

  2. Se você receber mensagens de aviso, revise-as e corrija-as, então reexecute o comando. Por padrão, a CodeQL CLI mensagem de aviso será impressa se:

    • Qualquer uma das ajudas de consulta é inválida
    • Algum dos arquivos .qhelp especificados no comando não tiver o mesmo nome base que um arquivo .ql que o acompanhe
    • Algum dos arquivos .ql especificados no comando não tiver o mesmo nome base que um arquivo .qhelp que o acompanhe

  3. Examine o Markdown renderizado em seu diretório de saída, arquivo ou terminal para verificar se os arquivos aparecem conforme o esperado.

Leitura adicional