Prueba de archivos de ayuda de consulta

Asegúrese de que los archivos auxiliares de consulta de CodeQL sean válidos al previsualizarlos como Markdown.

¿Quién puede utilizar esta característica?

CodeQL está disponible para los siguientes tipos de repositorios:

En este artículo

Prerrequisitos

  • Los archivos de ayuda de consulta (.qhelp) deben tener archivos de consulta adjuntos (.ql) con nombres base idénticos.
  • Los archivos de ayuda de consulta deben seguir la estructura estándar y el estilo de la documentación de ayuda de consulta. Para obtener más información, consulta la guía de estilo de la ayuda de consulta en el repositorio de CodeQL.

Vista previa de los archivos de ayuda de consulta

  1. Para representar los archivos de ayuda de consulta como Markdown, ejecute el siguiente comando:

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

    Para obtener información sobre las opciones disponibles para este comando, vea generar ayuda de consultas.

  2. Si recibe algún mensaje de advertencia, revise y corrijalos, vuelva a ejecutar el comando. De forma predeterminada, la CodeQL CLI imprimirá un mensaje de advertencia si:

    • Cualquiera de la ayuda de consulta no es válida
    • Los archivos .qhelp especificados en el comando no tienen el mismo nombre base que el archivo .ql que los acompaña.
    • Los archivos .ql especificados en el comando no tienen el mismo nombre base que el archivo .qhelp que los acompaña.

  3. Revise el Markdown renderizado en su directorio de salida, archivo o terminal para comprobar que sus archivos aparecen como se espera.

Lectura adicional

  •         [Archivos de ayuda de consulta](https://codeql.github.com/docs/writing-codeql-queries/query-help-files/#query-help-files)

  •         [AUTOTITLE](/code-security/codeql-cli/codeql-cli-manual/generate-query-help)