You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/codeql/codeql-cli/extractor-options.rst
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,11 +37,11 @@ Each extractor defines its own set of configuration options. To find out which o
37
37
}
38
38
}
39
39
40
-
The extractor option names and descriptions are listed under ``extractor_options``. Each option may contain the following fields::
40
+
The extractor option names and descriptions are listed under ``extractor_options``. Each option may contain the following fields:
41
41
42
-
- ``title`` (required): The title of the option
43
-
- ``description`` (required): The description of the option
44
-
- ``type`` (required): The type of the option, which can be
42
+
* ``title`` (required): The title of the option
43
+
* ``description`` (required): The description of the option
44
+
* ``type`` (required): The type of the option, which can be
45
45
46
46
* ``string``: indicating that the option can have a single string value
47
47
* ``array``: indicating that the option can have a sequence of string values
@@ -50,22 +50,22 @@ The extractor option names and descriptions are listed under ``extractor_options
50
50
* ``pattern`` (optional): The regular expression patterns that all values of the option should match. Note that the extractor may impose additional constraints on option values that are not or cannot be expressed in this regular expression pattern. Such constraints, if they exist, would be explained under the description field.
51
51
* ``properties`` (optional): A map from extractor option names in the option group to the corresponding extractor option descriptions. This field can only be present for option groups. For example, options of ``object`` type.
52
52
53
-
In the example above, the extractor declares two options::
53
+
In the example above, the extractor declares two options:
54
54
55
55
* ``option1`` is a ``string`` option with value matching ``[a-z]+``
56
56
* ``group1.option2`` is an ``array`` option with values matching ``[1-9][0-9]*``
57
57
58
58
Setting extractor options with the CodeQL CLI
59
59
---------------------------------------------
60
60
61
-
The CodeQL CLI supports setting extractor options in subcommands that directly or indirectly invoke extractors. These commands are::
61
+
The CodeQL CLI supports setting extractor options in subcommands that directly or indirectly invoke extractors. These commands are:
62
62
63
63
* ``codeql database create``
64
64
* ``codeql database start-tracing``
65
65
* ``codeql database trace-command``
66
66
* ``codeql database index-files``
67
67
68
-
When running these subcommands, you can set extractor options with the ``--extractor-option`` CLI option. For example::
68
+
When running these subcommands, you can set extractor options with the ``--extractor-option`` CLI option. For example:
@@ -76,7 +76,7 @@ Using ``--extractor-option`` to assign an extractor option that does not exist i
76
76
77
77
The CodeQL CLI accepts multiple ``--extractor-option`` options in the same invocation. If you set a ``string`` extractor option multiple times, the last option value overwrites all previous ones. If you set an `array` extractor option multiple times, all option values are concatenated in order.
78
78
79
-
You can also specify extractor option names without the extractor name. For example::
79
+
You can also specify extractor option names without the extractor name. For example:
@@ -86,7 +86,7 @@ If you do not specify an extractor name, the extractor option settings will appl
86
86
Setting extractor options from files
87
87
------------------------------------
88
88
89
-
You can also set extractor options through a file. The CodeQL CLI subcommands that accept ``--extractor-option`` also accept ``--extractor-options-file``, which has a required argument of the path to a YAML file (with extension ``.yaml`` or ``.yml``) or a JSON file (with extension ``.json``). For example::
89
+
You can also set extractor options through a file. The CodeQL CLI subcommands that accept ``--extractor-option`` also accept ``--extractor-options-file``, which has a required argument of the path to a YAML file (with extension ``.yaml`` or ``.yml``) or a JSON file (with extension ``.json``). For example:
0 commit comments