Тестирование файлов справки по запросу

Убедитесь, что ваши файлы помощи по запросам CodeQL валидны, предварительно просматривая их как Markdown.

Кто может использовать эту функцию?

CodeQL доступен для следующих типов репозитория:

В этой статье

Предпосылки

  • Файлы помощи по запросу (.qhelp) должны содержать сопутствующие файлы запроса (.ql) с идентичными базовыми именами.
  • Файлы помощи по запросам должны соответствовать стандартной структуре и стилю документации по справке с запросами. Дополнительные сведения см. в руководстве по стилю справки по запросу в репозитории CodeQL.

Предварительный просмотр файлов помощи по запросу

  1. Чтобы отобразить файлы помощи по запросу в виде Markdown, выполните следующую команду:

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

    Для получения информации о доступных опциях этой команды см. АВТОЗАГОЛОВОК.

  2. Если вы получите предупреждающие сообщения, просмотрите их и исправите, затем запустите команду повторно. По умолчанию CodeQL CLI выводит предупреждение, если:

    • Любая помощь по запросам некорректна
    • Все .qhelp файлы, указанные в команде, не имеют того же базового имени, что и сопровождающий .ql файл.
    • Все .ql файлы, указанные в команде, не имеют того же базового имени, что и сопровождающий .qhelp файл.

  3. Просмотрите отрендеренный Markdown в вашей выводной директории, файле или терминале, чтобы убедиться, что ваши файлы отображаются как ожидается.

Дополнительные материалы

  •         [Файлы справки по запросу](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)