Add config description for the suppression property

Author: namrata111f

packages/code-analyzer-core/src/config.ts

@@ -227,6 +227,12 @@ export class CodeAnalyzerConfig {
                     valueType: 'object',
                     defaultValue: { files: [] },
                     wasSuppliedByUser: !deepEquals(this.config.ignores, DEFAULT_CONFIG.ignores)
+                },
+                suppressions: {
+                    descriptionText: getMessage('ConfigFieldDescription_suppressions'),
+                    valueType: 'object',
+                    defaultValue: { disable_suppressions: false },
+                    wasSuppliedByUser: !deepEquals(this.config.suppressions, DEFAULT_CONFIG.suppressions)
                 }
             }
         };
@@ -260,6 +266,13 @@ export class CodeAnalyzerConfig {
         return !this.config.suppressions.disable_suppressions;
     }
 
+    /**
+     * Returns the suppressions configuration object.
+     */
+    public getSuppressions(): Suppressions {
+        return this.config.suppressions;
+    }
+
     /**
      * Returns the absolute path folder where all path based values within the configuration may be relative to.
      *     Typically, this is set as the folder where a configuration file was loaded from, but doesn't have to be.

packages/code-analyzer-core/src/index.ts

@@ -8,7 +8,8 @@ export type {
     EngineOverrides,
     Ignores,
     RuleOverrides,
-    RuleOverride
+    RuleOverride,
+    Suppressions
 } from "./config"
 
 

packages/code-analyzer-core/src/messages.ts

@@ -61,6 +61,14 @@ const MESSAGE_CATALOG : MessageCatalog = {
         `    - "**/*.test.js"\n` +
         `-------------------------------------------`,
 
+    ConfigFieldDescription_suppressions:
+        `Configuration for inline suppression markers in source code.\n` +
+        `  disable_suppressions: Boolean to disable processing of suppression markers.\n` +
+        `---- [Example usage]: ---------------------\n` +
+        `suppressions:\n` +
+        `  disable_suppressions: false\n` +
+        `-------------------------------------------`,
+
     GenericEngineConfigOverview:
         `%s ENGINE CONFIGURATION`,