query format

Formato automático del código fuente QL.

¿Quién puede utilizar esta característica?

CodeQL está disponible para los siguientes tipos de repositorios:

Repositorios públicos en GitHub.com, consulte Términos y condiciones de CodeQL de GitHub.
Repositorios propiedad de la organización en GitHub Enterprise Cloud con GitHub Advanced Security habilitado

En este artículo

Note

En este contenido se describe la versión más reciente de CodeQL CLI. Para obtener más información sobre esta versión, consulta https://github.com/github/codeql-cli-binaries/releases.

Para ver detalles de las opciones disponibles para este comando en una versión anterior, ejecuta el comando con la opción --help en el terminal.

Sinopsis

Shell

codeql query format [--output=<file>] [--in-place] [--backup=<ext>] <options>... -- <file>...

codeql query format [--output=<file>] [--in-place] [--backup=<ext>] <options>... -- <file>...

Descripción

Formato automático del código fuente QL.

Opciones

Opciones principales

`<file>...`

Uno o varios archivos de código fuente .ql o .qll para aplicar formato automático. Se puede especificar un guion para leer desde la entrada estándar.

`-o, --output=<file>`

Escribe el código QL formateado en este archivo, en lugar de la secuencia de salida estándar. No se debe proporcionar si hay más de una entrada.

`-i, --[no-]in-place`

Sobrescribe cada archivo de entrada con una versión con formato de su contenido.

En lugar de escribir la salida, sale con el estado 1 si alguno de los archivos de entrada difieren del formato correcto. Se imprimirá un mensaje que indica qué archivos difieren como error estándar, a menos que también proporciones -qq.

`-b, --backup=<ext>`

Cuando se escriba un archivo que ya existe, cambia el nombre del archivo existente a copia de seguridad mediante la anexión de esta extensión a su nombre. Si el archivo de copia de seguridad ya existe, se eliminará de forma silenciosa.

`--no-syntax-errors`

Si el QL del archivo de entrada no es sintácticamente correcto, se finge que tiene el formato correcto. (Normalmente, este tipo de archivo provoca que el comando finalice con un mensaje de error).

Opciones comunes

`-h, --help`

Muestra este texto de ayuda.

`-J=<opt>`

[Avanzado] Asigna la opción a la JVM que ejecuta el comando.

(Ten en cuenta que las opciones que contienen espacios no se administrarán correctamente).

`-v, --verbose`

Aumenta incrementalmente el número de mensajes de progreso impresos.

`-q, --quiet`

Reduce incrementalmente el número de mensajes de progreso impresos.

`--verbosity=<level>`

[Avanzado] Establece explícitamente el nivel de detalle en errores, advertencias, progreso, progreso+, progreso++, progreso+++. Invalida -v y -q.

`--logdir=<dir>`

[Avanzado] Escribe registros detallados en uno o varios archivos del directorio especificado, con nombres generados que incluyen marcas de tiempo y el nombre del subcomando en ejecución.

(Para escribir un archivo de registro con un nombre sobre el que tienes control total, proporciona --log-to-stderr y redirige stderr como quieras).

`--common-caches=<dir>`

[Avanzado] Controla la ubicación de los datos en caché del disco que se conservarán entre varias ejecuciones de la CLI, como paquetes QL descargados y planes de consulta compilada. Si no se define explícitamente, se toma como predeterminado un directorio denominado .codeql en el directorio principal del usuario, que se creará en caso de que no exista.

Disponible desde la versión v2.15.2.