Skip to content

Commit

Permalink
nogo: Add documentation about the _base key
Browse files Browse the repository at this point in the history
  • Loading branch information
DolceTriade committed Dec 3, 2022
1 parent 25b1133 commit 16bcbca
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions go/nogo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,9 @@ contain the following key-value pairs:
| ``flag.Value`` specified by the analyzer. |
+----------------------------+---------------------------------------------------------------------+

``nogo`` also supports a special key to specify the same config for all analyzers, even if they are
not explicitly specified called ``_base``. See below for an example of its usage.

Example
^^^^^^^

Expand All @@ -216,6 +219,12 @@ on a command line driver.
.. code:: json
{
"_base": {
"description": "Base config that all subsequent analyzers, even unspecified will inherit.",
"exclude_files": {
"third_party/": "exclude all third_party code for all analyzers"
}
},
"importunsafe": {
"exclude_files": {
"src/foo\\.go": "manually verified that behavior is working-as-intended",
Expand Down

0 comments on commit 16bcbca

Please sign in to comment.