Personalización de la configuración

Acerca de la configuración de la extensión CodeQL para la extensión Visual Studio Code.

Puede realizar numerosos cambios en la configuración de la extensión CodeQL para la extensión Visual Studio Code, entre ellos:

La versión de CodeQL CLI que utiliza la extensión.
Cómo muestra la extensión las consultas anteriores.
Cómo ejecuta la extensión las consultas.

Edición de la configuración

Abra la vista “Extensiones” y haga clic con el botón derecho en CodeQL y, a continuación, haga clic en Configuración de la extensión.
En la ventana Configuración, edite la configuración según sea necesario. La nueva configuración se guarda automáticamente.

Nota: Como alternativa, puede editar la configuración en formato JSON abriendo VS Code Command Palette y seleccionando Preferencias: Abrir configuración de usuario (JSON).

Selección de una versión de CodeQL CLI

Para invalidar el comportamiento predeterminado y usar una versión específica de CodeQL CLI, puede especificar la “Ruta de acceso ejecutable” de CodeQL CLI en la configuración de extensión y apuntar a la copia existente de CodeQL CLI. Es decir, el archivo denominado codeql (Linux y macOS) o codeql.exe (Windows). Para obtener más información sobre el comportamiento predeterminado, consulte “Configuración del acceso a la CLI de CodeQL”.

Cambio de las etiquetas de los elementos del historial de consultas

La configuración “Formato” del historial de consultas controla la manera en la que la extensión enumera las consultas en el historial de consultas. De forma predeterminada, cada elemento tiene una etiqueta con el formato siguiente:

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

Para invalidar la etiqueta predeterminada, puede especificar un formato diferente para los elementos del historial de consultas.

Cambio del período de retención de los elementos del historial de consultas

De forma predeterminada, los elementos de la vista “Historial de consultas” se conservan durante 30 días. Puede establecer un período de vida diferente (TTL) cambiando la configuración “Historial de consultas: Ttl”. Para conservar elementos indefinidamente, establezca el valor en 0.

Configuración de opciones para ejecutar consultas localmente

Hay una serie de opciones de configuración en “Ejecutar consultas”. Por ejemplo, si las consultas se ejecutan demasiado lentamente y se agota el tiempo de espera con frecuencia, es posible que desee aumentar la memoria cambiando la configuración “Ejecución de consultas: memoria”.

Si desea examinar el rendimiento de las consultas, habilite la configuración “Ejecución de consultas: depurar” para incluir los recuentos de tiempo y tupla. A continuación, se mostrará en los registros de la pestaña “Servidor de consultas” de CodeQL de la vista “Resultado”. El recuento de tuplas es útil porque indica el tamaño de los predicados calculados por la consulta.

Para guardar los registros del servidor de consultas en una ubicación personalizada, edite la configuración “Ejecución de consultas: personalizar directorio de registros”. Si usa un directorio de registros personalizado, la extensión guarda los registros de forma permanente, en lugar de eliminarlos automáticamente después de cada sesión del área de trabajo. Esto resulta útil si desea investigar estos registros para mejorar el rendimiento de las consultas.

Configuración de opciones para el análisis de variantes

Existe una serie de opciones de configuración en “Análisis de variantes” que puede usar para definir o editar listas de repositorios de GitHub para el análisis de variantes y cambiar a un repositorio de controlador diferente. Para obtener información sobre el propósito y los requisitos de un repositorio de controlador, consulte “Ejecución de consultas CodeQL a gran escala con análisis de variantes de varios repositorios”.

También puede editar los elementos que se muestran en la vista “Repositorios de análisis variantes” mediante la edición de un archivo en el área de trabajo de Visual Studio Code denominado databases.json. Este archivo contiene una representación JSON de todos los elementos mostrados en la vista. Para abrir el archivo databases.json en una ventana del editor, haga clic en el icono { } de la parte superior derecha de la vista “Repositorios de análisis de variantes”. A continuación, puede ver una representación estructurada de los repositorios, las organizaciones y las listas en la vista. Por ejemplo:

{
  "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"
  }
}

Puede cambiar los elementos que se muestran en la vista o agregar nuevos elementos editando directamente este archivo.

Configuración de opciones para agregar bases de datos

Para agregar automáticamente carpetas de origen de base de datos al área de trabajo, puede habilitar la opción “Agregar bases de datos: Agregar origen de base de datos al área de trabajo”.

Este valor está deshabilitado de forma predeterminada. Es posible que desee habilitar la configuración si examina periódicamente el código fuente de las bases de datos (por ejemplo, para ver el árbol de sintaxis abstracta del código). Para obtener más información, vea «Exploración de la estructura del código fuente».

Si está en un área de trabajo de una sola carpeta, agregar carpetas de origen de base de datos hará que el área de trabajo se vuelva a cargar como un área de trabajo con varias raíces. Esto puede hacer que el historial de consultas y las listas de bases de datos se restablezcan.

Antes de habilitar esta configuración, se recomienda guardar el área de trabajo como un área de trabajo con varias raíces. Para más información, consulte Áreas de trabajo con varias raíces en la documentación de Visual Studio Code.

Configuración de usuario y área de trabajo en la documentación de Visual Studio Code

Personalización de la configuración

En este artículo