rule-options

What problem does it solve?

This Skill provides a detailed guide on how to add or modify rule options in SonarJS, enabling precise control over the code quality and security analysis.

Core Features & Use Cases

• Rule Option Configuration: Detailed instructions on managing fields array, UI visibility, and Java check class configuration.
• Architecture Overview: Understand the rule options flow through SonarQube and gRPC for different integration paths.
• Key Files: Understand the purpose of files like rule.ts, meta.ts, config.ts, and generated-meta.ts.
• Fields Array: Learn about the fields array in config.ts and how it defines options for SonarQube integration.
• Visibility in SonarQube: Make options visible in SonarQube UI by providing descriptions.
• Configuration Shapes: Explore object-style and primitive configurations for ESLint and SonarQube.
• Type Parsing: Understand how gRPC parses string params based on default types.
• JSON Schema vs fields: Differentiate between JSON Schema and fields for ESLint validation and SQ UI integration.
• Adding Options to an Existing Rule: Step-by-step process to add options to a rule.
• Java Check Class: Learn about the configurations() method in Java check classes.

Quick Start

Use the rule-options skill to get started with configuring SonarJS rules and enhancing code quality.