Top-Level Customization Reference

You can configure overall behavior of Code Analyzer, such as the location of the log folder and the root directory of the configuration options.

For configuration and reference information about specific engines, see:

Top-Level Configuration Reference

Field	Type	Description
`config_root`	string	The absolute folder path to which all other path values in this configuration may be relative to. If unspecified, or if specified as null, then the value is automatically chosen to be the parent folder of your Code Analyzer configuration file if it exists, or the current working directory otherwise. Default value is `null`.
`log_folder`	string	Folder where to store log files. May be an absolute path or a path relative to config_root. If unspecified, or if specified as null, then the value is automatically chosen to be your machine’s default temporary directory. Default value is `null`.
`log_level`	number	Level at which to log messages to log files. Possible values are: 1 or ‘Error’ - Includes only error messages in the log. 2 or ‘Warn’ - Includes warning and error messages in the log. 3 or ‘Info’ - Includes informative, warning, and error messages in the log. 4 or ‘Debug’ - Includes debug, informative, warning, and error messages in the log. 5 or ‘Fine’ - Includes fine detail, debug, informative, warning, and error messages in the log. If unspecified, or if specified as null, then the ‘Debug’ log level will be used. Default value is `4`.
`rules`	object	Rule override settings of the format rules.{engine_name}.{rule_name}.{property_name} = {override_value} where: {engine_name} is the name of the engine containing the rule that you want to override. {rule_name} is the name of the rule that you want to override. {property_name} can either be: ‘severity’ - [Optional] The severity level value that you want to use to override the default severity level for the rule Possible values: 1 or ‘Critical’, 2 or ‘High’, 3 or ‘Moderate’, 4 or ‘Low’, 5 or ‘Info' 'tags’ - [Optional] The string array of tag values that you want to use to override the default tags for the rule ’disabled’ - [Optional] Boolean value to disable the rule for all files. When set to true, the rule will not run during analysis Default value is `{}`. ---- [Example usage]: --------------------- rules: eslint: sort-vars: severity: “Info” tags: [“Recommended”, “Suggestion”] regex: NoTrailingWhiteSpace: disabled: true -------------------------------------------
`engines`	object	Engine specific custom configuration settings of the format engines.{engine_name}.{property_name} = {value} where: {engine_name} is the name of the engine containing the setting that you want to override. {property_name} is the name of a property that you would like to override. Each engine may have its own set of properties available to help customize that particular engine’s behavior. Default value is `{}`.
`ignores`	object	Configuration for ignoring files during analysis. files: An array of glob patterns specifying files to exclude from scanning. Default value is `{"files": []}`. ---- [Example usage]: --------------------- ignores: files: - “/node_modules/” - ”*/.test.js” -------------------------------------------
`suppressions`	object	Configuration for inline and bulk suppressions. disable_suppressions: Boolean to disable processing of suppression markers. {file_path}: Array of bulk suppression rules for specific files or folders. Default value is `{"disable_suppressions": false}`. ---- [Example usage]: --------------------- suppressions: disable_suppressions: false “src/legacy.js”: - rule_selector: “eslint:no-console” max_suppressed_violations: 5 -------------------------------------------