Skip to main content

Настройка параметров

Вы можете редактировать настройки CodeQL расширения for Visual Studio Code под свои нужды.

О настройках в расширении CodeQL для Visual Studio Code

Вы можете изменить множество настроек для CodeQL расширения Visual Studio Code , включая:

  • Какую версию CodeQL CLI расширения использует?
  • Как расширение отображает предыдущие запросы.
  • Как расширение выполняет запросы.

Настройки редактирования CodeQL расширения

  1. Откройте просмотр «Расширения» и кликните правой кнопкой CodeQL мыши, затем нажмите «Настройки расширения».

    Снимок экрана: представление "Расширения" с меню правой кнопкой мыши и "Параметры расширения", описанные в темно-оранжевый цвет.

  2. В окне "Параметры" измените параметры по мере необходимости. Новые параметры сохраняются автоматически.

    Снимок экрана: окно параметров расширения CodeQL для VS Code, отображаемое в VS Code.

Совет

В качестве альтернативы можно отредактировать настройки в формате JSON, открыв VS Code Command Palette и выбрав Preferences: Open User Settings (JSON)».

Выбор версии CodeQL CLI

Чтобы обойти стандартное поведение и использовать конкретную версию CodeQL CLI, вы можете указать CodeQL CLI «Исполняемый путь» в настройках расширения и указать его на вашу существующую копию CodeQL CLI. То есть файл с именем codeql (Linux и macOS) или codeql.exe (Windows). Дополнительные сведения о поведении по умолчанию см. в разделе Управление CLI CodeQL в расширении VS Code.

Изменение меток элементов журнала запросов

Параметр журнала запросов "Формат" определяет, как расширение перечисляет запросы в журнале запросов. По умолчанию каждый элемент имеет метку со следующим форматом:

QUERY-NAME on DATABASE-NAME - QUERY-STATUS NUMBER-OF-RESULTS [QUERY-RUNTIME]

Чтобы переопределить метку по умолчанию, можно указать другой формат для элементов журнала запросов.

Изменение срока хранения элементов журнала запросов

По умолчанию элементы в представлении "Журнал запросов" хранятся в течение 30 дней. Можно задать другое время жизни (TTL), изменив параметр "Журнал запросов: Ttl". Чтобы сохранить элементы на неопределенный срок, задайте значение 0.

Настройка параметров локального выполнения запросов

В разделе "Выполнение запросов" существует ряд параметров. Например, если запросы выполняются слишком медленно и часто истекает время ожидания, может потребоваться увеличить память, изменив параметр "Выполнение запросов: память".

Если вы хотите проверить производительность запросов, включите параметр "Выполнение запросов: отладка", чтобы включить количество времени и кортежей. Это будет отображаться в логах на CodeQL вкладке «Сервер запросов» в виде «Вывод». Количество кортежей полезно, так как оно указывает размер предикатов , вычисляемых запросом.

Чтобы сохранить журналы сервера запросов в пользовательском расположении, измените параметр "Выполнение запросов: Пользовательский каталог журналов". Если вы используете пользовательский каталог журналов, расширение сохраняет журналы безвозвратно, а не автоматически удаляет их после каждого сеанса рабочей области. Это полезно, если вы хотите исследовать эти журналы, чтобы повысить производительность запросов.

Настройка параметров для анализа вариантов

Вы также можете редактировать элементы, отображаемые в виде «Репозитории анализа вариантов», отредактировав файл в вашем Visual Studio Code рабочем пространстве под названием databases.json. Этот файл содержит представление JSON всех элементов, отображаемых в представлении. Чтобы открыть databases.json файл в окне редактора, щелкните значок { } в правом верхнем углу представления "Репозитории анализа вариантов". Затем в представлении можно увидеть структурированное представление репозиториев, организаций и списков. Рассмотрим пример.

{
  "version": 1,
  "databases": {
    "variantAnalysis": {
      "repositoryLists": [
        {
          "name": "My favorite JavaScript repos",
          "repositories": [
            "facebook/react",
            "babel/babel",
            "angular/angular"
          ]
        }
      ],
      "owners": [
        "microsoft"
      ],
      "repositories": [
        "apache/hadoop"
      ]
    }
  },
  "selected": {
    "kind": "variantAnalysisSystemDefinedList",
    "listName": "top_10"
  }
}

Вы можете изменить элементы, отображаемые в представлении, или добавить новые элементы, напрямую изменив этот файл.

Настройка параметров для добавления баз данных

Чтобы автоматически добавить папки источника базы данных в рабочую область, можно включить параметр "Добавление баз данных: добавление источника базы данных в рабочую область".

Этот флажок по умолчанию снят. Можно включить параметр, если вы регулярно просматриваете исходный код баз данных (например, чтобы просмотреть абстрактное дерево синтаксиса кода). Дополнительные сведения см. в разделе Изучение структуры исходного кода.

Примечание.

Если вы находитесь в рабочей области с одной папкой, добавление папок источника базы данных приведет к перезагрузке рабочей области в виде нескольких корневых рабочих областей. Это может привести к сбросу журналов запросов и списков баз данных.

Перед включением этого параметра рекомендуется сохранить рабочую область в качестве много корневой рабочей области. Для получения дополнительной информации см. раздел «Многокорневые рабочие пространства » в Visual Studio Code документации.

Настройка параметров для локального тестирования запросов

Чтобы увеличить количество потоков, используемых для тестирования запросов, можно обновить параметр "Выполнение тестов: количество потоков".

Чтобы передавать дополнительные аргументы CodeQL CLI при запуске тестов, можно обновить параметр «Running Tests: Additional Test Arguments». Дополнительные сведения о доступных аргументах см. в разделе тестовое выполнение.

Настройка параметров для телеметрии и сбора данных

Вы можете настроить, собирает ли расширение CodeQL телеметрические данные. Эта функция отключена по умолчанию. Дополнительные сведения см. в разделе Телеметрия в CodeQL для Visual Studio Code.

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

  •         [Настройки пользователя и рабочего пространства](https://code.visualstudio.com/docs/configure/settings) в Visual Studio Code документации