mirror of
https://github.com/github/codeql.git
synced 2025-12-29 07:06:43 +01:00
e674759860
Update docs/codeql/codeql-for-visual-studio-code/customizing-settings.rst Co-authored-by: Felicity Chapman <felicitymay@github.com>
83 lines
4.0 KiB
ReStructuredText
83 lines
4.0 KiB
ReStructuredText
:tocdepth: 1
|
|
|
|
.. _customizing-settings:
|
|
|
|
Customizing settings
|
|
====================
|
|
|
|
You can edit the settings for the CodeQL extension to suit your needs.
|
|
|
|
About CodeQL extension settings
|
|
---------------------------------
|
|
|
|
The CodeQL extension comes with a number of settings that you can edit. These determine how the extension behaves, including: which version of the CodeQL CLI the extension uses, how the extension displays previous queries, and how it runs queries.
|
|
|
|
Editing settings
|
|
-----------------
|
|
|
|
1. Open the Extensions view and right click **CodeQL**.
|
|
|
|
2. Click **Extension Settings**.
|
|
|
|
.. image:: ../images/codeql-for-visual-studio-code/open-extension-settings.png
|
|
:width: 400
|
|
:alt: Open the CodeQL extension settings
|
|
|
|
3. Edit a setting. The new settings are saved automatically.
|
|
|
|
Choosing a version of the CodeQL CLI
|
|
--------------------------------------
|
|
|
|
The CodeQL extension uses the CodeQL CLI to run commands. If you already have the CLI installed and added to your ``PATH``, the extension uses that version. This might be the case if you create your own CodeQL databases instead of downloading them from GitHub.com. Otherwise, the extension automatically manages access to the executable of the CLI for you. For more information about creating databases, see ":ref:`Creating CodeQL databases <creating-codeql-databases>`" in the CLI help.
|
|
|
|
To override the default behavior and use a different CLI, you can specify the CodeQL CLI **Executable Path**.
|
|
|
|
Changing the labels of query history items
|
|
--------------------------------------------
|
|
|
|
The query history **Format** setting controls how the extension lists queries in the query history. By default, each item has a label with the following format::
|
|
|
|
%q on %d - %s, %r result count [%t]
|
|
|
|
- ``%q`` is the query name
|
|
- ``%d`` is the database name
|
|
- ``%s`` is a status string
|
|
- ``%r`` is the number of results
|
|
- ``%t`` is the time the query was run
|
|
|
|
To override the default label, you can specify a different format for the query history items.
|
|
|
|
|
|
Changing the retention period for query history items
|
|
-----------------------------------------------------
|
|
|
|
By default, items in the query history view are retained for 30 days. You can set a different time to live (TTL) by changing the "Code QL > Query History: TTL" setting. To retain items indefinitely, set the value to 0.
|
|
|
|
.. _configuring-settings-for-running-queries:
|
|
|
|
Configuring settings for running queries
|
|
-----------------------------------------
|
|
|
|
There are a number of settings for **Running Queries**. If your queries run too slowly and time out frequently, you may want to increase the memory.
|
|
|
|
.. include:: ../reusables/running-queries-debug.rst
|
|
|
|
To save query server logs in a custom location, edit the **Running Queries: Custom Log Directory** setting. If you use a custom log directory, the extension saves the logs permanently, instead of deleting them automatically after each workspace session. This is useful if you want to investigate these logs to improve the performance of your queries.
|
|
|
|
Configuring settings for testing queries
|
|
-----------------------------------------
|
|
|
|
To increase the number of threads used for testing queries, you can update the **Running Tests > Number Of Threads** setting.
|
|
|
|
To pass additional arguments to the CodeQL CLI when running tests, you can update the **Running Tests > Additional Test Arguments** setting. For more information about the available arguments, see "`test run <https://codeql.github.com/docs/codeql-cli/manual/test-run/>`_" in the CodeQL CLI help.
|
|
|
|
Configuring settings for telemetry and data collection
|
|
--------------------------------------------------------
|
|
|
|
You can configure whether the CodeQL extension collects telemetry data. This is disabled by default. For more information, see ":doc:`About telemetry in CodeQL for Visual Studio Code <about-telemetry-in-codeql-for-visual-studio-code>`."
|
|
|
|
Further reading
|
|
----------------
|
|
|
|
- `User and workspace settings <https://code.visualstudio.com/docs/getstarted/settings>`__ in the Visual Studio Code help
|
|
- ":ref:`CodeQL CLI <codeql-cli>`" |