projen 0.103.4 → 0.103.5

package/lib/sonarqube/rust.d.ts

@@ -0,0 +1,37 @@
+import type { IConstruct } from "constructs";
+import { SonarqubeProperties } from "./sonarqube";
+import type { SonarqubePropertiesOptions } from "./sonarqube";
+/**
+ * Options for `SonarqubeRustProperties`.
+ *
+ * Extends base options with Rust-specific defaults.
+ */
+export interface SonarqubeRustPropertiesOptions extends SonarqubePropertiesOptions {
+}
+/**
+ * A SonarQube configuration preset for Rust projects.
+ *
+ * Provides sensible defaults for Rust analysis:
+ * - `sonar.language` = `rust`
+ * - `sonar.sources` = `src`
+ * - `sonar.tests` = `tests`
+ * - `sonar.sourceEncoding` = `UTF-8`
+ * - `sonar.profile` = `Sonar Way`
+ * - `sonar.scm.provider` = `git`
+ * - Typical exclusions for `coverage`, test, and `target` dirs
+ * - `sonar.rust.lcov.reportPaths` = `target/lcov.info`
+ * - `sonar.rust.clippy.enabled` = `false`
+ * - `sonar.rust.clippyReport.reportPaths` = `target/clippy.json`
+ *
+ * All defaults can be overridden via options. Nested options (e.g. `coverage`,
+ * `rust`) are deep-merged with the defaults, so overriding one nested field
+ * does not drop the other defaults in that subtree.
+ *
+ * @example
+ * new SonarqubeRustProperties(project, {
+ *   projectKey: 'my-org_my-rust-project',
+ * });
+ */
+export declare class SonarqubeRustProperties extends SonarqubeProperties {
+    constructor(scope: IConstruct, options: SonarqubeRustPropertiesOptions);
+}

package/lib/sonarqube/rust.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SonarqubeRustProperties = void 0;
+const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
+const sonarqube_1 = require("./sonarqube");
+const util_1 = require("../util");
+/**
+ * A SonarQube configuration preset for Rust projects.
+ *
+ * Provides sensible defaults for Rust analysis:
+ * - `sonar.language` = `rust`
+ * - `sonar.sources` = `src`
+ * - `sonar.tests` = `tests`
+ * - `sonar.sourceEncoding` = `UTF-8`
+ * - `sonar.profile` = `Sonar Way`
+ * - `sonar.scm.provider` = `git`
+ * - Typical exclusions for `coverage`, test, and `target` dirs
+ * - `sonar.rust.lcov.reportPaths` = `target/lcov.info`
+ * - `sonar.rust.clippy.enabled` = `false`
+ * - `sonar.rust.clippyReport.reportPaths` = `target/clippy.json`
+ *
+ * All defaults can be overridden via options. Nested options (e.g. `coverage`,
+ * `rust`) are deep-merged with the defaults, so overriding one nested field
+ * does not drop the other defaults in that subtree.
+ *
+ * @example
+ * new SonarqubeRustProperties(project, {
+ *   projectKey: 'my-org_my-rust-project',
+ * });
+ */
+class SonarqubeRustProperties extends sonarqube_1.SonarqubeProperties {
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "projen.sonarqube.SonarqubeRustProperties", version: "0.103.5" };
+    constructor(scope, options) {
+        super(scope, (0, util_1.deepMerge)([
+            {
+                language: "rust",
+                sources: "src",
+                tests: "tests",
+                sourceEncoding: "UTF-8",
+                profile: "Sonar Way",
+                scm: { provider: "git" },
+                exclusions: ["**/coverage/**", "**/tests/**", "**/target/**"],
+                coverage: {
+                    exclusions: ["**/tests/**", "**/target/**"],
+                },
+                cpd: { exclusions: ["**/tests/**/*.json"] },
+                rust: {
+                    lcov: { reportPaths: ["target/lcov.info"] },
+                    clippy: { enabled: false },
+                    clippyReport: { reportPaths: ["target/clippy.json"] },
+                },
+            },
+            options,
+        ]));
+    }
+}
+exports.SonarqubeRustProperties = SonarqubeRustProperties;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicnVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9zb25hcnF1YmUvcnVzdC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7O0FBQ0EsMkNBQWtEO0FBRWxELGtDQUFvQztBQVNwQzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7R0F1Qkc7QUFDSCxNQUFhLHVCQUF3QixTQUFRLCtCQUFtQjs7SUFDOUQsWUFBWSxLQUFpQixFQUFFLE9BQXVDO1FBQ3BFLEtBQUssQ0FDSCxLQUFLLEVBQ0wsSUFBQSxnQkFBUyxFQUFDO1lBQ1I7Z0JBQ0UsUUFBUSxFQUFFLE1BQU07Z0JBQ2hCLE9BQU8sRUFBRSxLQUFLO2dCQUNkLEtBQUssRUFBRSxPQUFPO2dCQUNkLGNBQWMsRUFBRSxPQUFPO2dCQUN2QixPQUFPLEVBQUUsV0FBVztnQkFDcEIsR0FBRyxFQUFFLEVBQUUsUUFBUSxFQUFFLEtBQUssRUFBRTtnQkFDeEIsVUFBVSxFQUFFLENBQUMsZ0JBQWdCLEVBQUUsYUFBYSxFQUFFLGNBQWMsQ0FBQztnQkFDN0QsUUFBUSxFQUFFO29CQUNSLFVBQVUsRUFBRSxDQUFDLGFBQWEsRUFBRSxjQUFjLENBQUM7aUJBQzVDO2dCQUNELEdBQUcsRUFBRSxFQUFFLFVBQVUsRUFBRSxDQUFDLG9CQUFvQixDQUFDLEVBQUU7Z0JBQzNDLElBQUksRUFBRTtvQkFDSixJQUFJLEVBQUUsRUFBRSxXQUFXLEVBQUUsQ0FBQyxrQkFBa0IsQ0FBQyxFQUFFO29CQUMzQyxNQUFNLEVBQUUsRUFBRSxPQUFPLEVBQUUsS0FBSyxFQUFFO29CQUMxQixZQUFZLEVBQUUsRUFBRSxXQUFXLEVBQUUsQ0FBQyxvQkFBb0IsQ0FBQyxFQUFFO2lCQUN0RDthQUNGO1lBQ0QsT0FBTztTQUNSLENBQW1DLENBQ3JDLENBQUM7SUFDSixDQUFDOztBQTFCSCwwREEyQkMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgdHlwZSB7IElDb25zdHJ1Y3QgfSBmcm9tIFwiY29uc3RydWN0c1wiO1xuaW1wb3J0IHsgU29uYXJxdWJlUHJvcGVydGllcyB9IGZyb20gXCIuL3NvbmFycXViZVwiO1xuaW1wb3J0IHR5cGUgeyBTb25hcnF1YmVQcm9wZXJ0aWVzT3B0aW9ucyB9IGZyb20gXCIuL3NvbmFycXViZVwiO1xuaW1wb3J0IHsgZGVlcE1lcmdlIH0gZnJvbSBcIi4uL3V0aWxcIjtcblxuLyoqXG4gKiBPcHRpb25zIGZvciBgU29uYXJxdWJlUnVzdFByb3BlcnRpZXNgLlxuICpcbiAqIEV4dGVuZHMgYmFzZSBvcHRpb25zIHdpdGggUnVzdC1zcGVjaWZpYyBkZWZhdWx0cy5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBTb25hcnF1YmVSdXN0UHJvcGVydGllc09wdGlvbnMgZXh0ZW5kcyBTb25hcnF1YmVQcm9wZXJ0aWVzT3B0aW9ucyB7fVxuXG4vKipcbiAqIEEgU29uYXJRdWJlIGNvbmZpZ3VyYXRpb24gcHJlc2V0IGZvciBSdXN0IHByb2plY3RzLlxuICpcbiAqIFByb3ZpZGVzIHNlbnNpYmxlIGRlZmF1bHRzIGZvciBSdXN0IGFuYWx5c2lzOlxuICogLSBgc29uYXIubGFuZ3VhZ2VgID0gYHJ1c3RgXG4gKiAtIGBzb25hci5zb3VyY2VzYCA9IGBzcmNgXG4gKiAtIGBzb25hci50ZXN0c2AgPSBgdGVzdHNgXG4gKiAtIGBzb25hci5zb3VyY2VFbmNvZGluZ2AgPSBgVVRGLThgXG4gKiAtIGBzb25hci5wcm9maWxlYCA9IGBTb25hciBXYXlgXG4gKiAtIGBzb25hci5zY20ucHJvdmlkZXJgID0gYGdpdGBcbiAqIC0gVHlwaWNhbCBleGNsdXNpb25zIGZvciBgY292ZXJhZ2VgLCB0ZXN0LCBhbmQgYHRhcmdldGAgZGlyc1xuICogLSBgc29uYXIucnVzdC5sY292LnJlcG9ydFBhdGhzYCA9IGB0YXJnZXQvbGNvdi5pbmZvYFxuICogLSBgc29uYXIucnVzdC5jbGlwcHkuZW5hYmxlZGAgPSBgZmFsc2VgXG4gKiAtIGBzb25hci5ydXN0LmNsaXBweVJlcG9ydC5yZXBvcnRQYXRoc2AgPSBgdGFyZ2V0L2NsaXBweS5qc29uYFxuICpcbiAqIEFsbCBkZWZhdWx0cyBjYW4gYmUgb3ZlcnJpZGRlbiB2aWEgb3B0aW9ucy4gTmVzdGVkIG9wdGlvbnMgKGUuZy4gYGNvdmVyYWdlYCxcbiAqIGBydXN0YCkgYXJlIGRlZXAtbWVyZ2VkIHdpdGggdGhlIGRlZmF1bHRzLCBzbyBvdmVycmlkaW5nIG9uZSBuZXN0ZWQgZmllbGRcbiAqIGRvZXMgbm90IGRyb3AgdGhlIG90aGVyIGRlZmF1bHRzIGluIHRoYXQgc3VidHJlZS5cbiAqXG4gKiBAZXhhbXBsZVxuICogbmV3IFNvbmFycXViZVJ1c3RQcm9wZXJ0aWVzKHByb2plY3QsIHtcbiAqICAgcHJvamVjdEtleTogJ215LW9yZ19teS1ydXN0LXByb2plY3QnLFxuICogfSk7XG4gKi9cbmV4cG9ydCBjbGFzcyBTb25hcnF1YmVSdXN0UHJvcGVydGllcyBleHRlbmRzIFNvbmFycXViZVByb3BlcnRpZXMge1xuICBjb25zdHJ1Y3RvcihzY29wZTogSUNvbnN0cnVjdCwgb3B0aW9uczogU29uYXJxdWJlUnVzdFByb3BlcnRpZXNPcHRpb25zKSB7XG4gICAgc3VwZXIoXG4gICAgICBzY29wZSxcbiAgICAgIGRlZXBNZXJnZShbXG4gICAgICAgIHtcbiAgICAgICAgICBsYW5ndWFnZTogXCJydXN0XCIsXG4gICAgICAgICAgc291cmNlczogXCJzcmNcIixcbiAgICAgICAgICB0ZXN0czogXCJ0ZXN0c1wiLFxuICAgICAgICAgIHNvdXJjZUVuY29kaW5nOiBcIlVURi04XCIsXG4gICAgICAgICAgcHJvZmlsZTogXCJTb25hciBXYXlcIixcbiAgICAgICAgICBzY206IHsgcHJvdmlkZXI6IFwiZ2l0XCIgfSxcbiAgICAgICAgICBleGNsdXNpb25zOiBbXCIqKi9jb3ZlcmFnZS8qKlwiLCBcIioqL3Rlc3RzLyoqXCIsIFwiKiovdGFyZ2V0LyoqXCJdLFxuICAgICAgICAgIGNvdmVyYWdlOiB7XG4gICAgICAgICAgICBleGNsdXNpb25zOiBbXCIqKi90ZXN0cy8qKlwiLCBcIioqL3RhcmdldC8qKlwiXSxcbiAgICAgICAgICB9LFxuICAgICAgICAgIGNwZDogeyBleGNsdXNpb25zOiBbXCIqKi90ZXN0cy8qKi8qLmpzb25cIl0gfSxcbiAgICAgICAgICBydXN0OiB7XG4gICAgICAgICAgICBsY292OiB7IHJlcG9ydFBhdGhzOiBbXCJ0YXJnZXQvbGNvdi5pbmZvXCJdIH0sXG4gICAgICAgICAgICBjbGlwcHk6IHsgZW5hYmxlZDogZmFsc2UgfSxcbiAgICAgICAgICAgIGNsaXBweVJlcG9ydDogeyByZXBvcnRQYXRoczogW1widGFyZ2V0L2NsaXBweS5qc29uXCJdIH0sXG4gICAgICAgICAgfSxcbiAgICAgICAgfSxcbiAgICAgICAgb3B0aW9ucyxcbiAgICAgIF0pIGFzIFNvbmFycXViZVJ1c3RQcm9wZXJ0aWVzT3B0aW9ucyxcbiAgICApO1xuICB9XG59XG4iXX0=

package/lib/sonarqube/sonarqube.d.ts

@@ -0,0 +1,439 @@
+import type { IConstruct } from "constructs";
+import { Component } from "../component";
+import { PropertiesFile } from "../properties-file";
+/**
+ * Log level for SonarQube analysis.
+ */
+export declare enum SonarqubeLogLevel {
+    /** Standard logging (default) */
+    INFO = "INFO",
+    /** Verbose logging */
+    DEBUG = "DEBUG",
+    /** Most verbose, includes plugin/library output */
+    TRACE = "TRACE"
+}
+/**
+ * SonarQube Cloud region.
+ */
+export declare enum SonarqubeRegion {
+    /** EU instance (default) */
+    EU = "eu",
+    /** US instance */
+    US = "us"
+}
+/**
+ * Options for `sonar.scm.*` properties.
+ */
+export interface SonarqubeScmOptions {
+    /**
+     * The SCM provider to use.
+     *
+     * Maps to `sonar.scm.provider`.
+     *
+     * @default - auto-detected
+     */
+    readonly provider?: string;
+    /**
+     * Options for `sonar.scm.exclusions.*`.
+     *
+     * @default - no exclusion overrides
+     */
+    readonly exclusions?: SonarqubeScmExclusionsOptions;
+}
+/**
+ * Options for `sonar.scm.exclusions.*` properties.
+ */
+export interface SonarqubeScmExclusionsOptions {
+    /**
+     * Whether to disable files ignored by the SCM (e.g., files in .gitignore)
+     * from being excluded from analysis.
+     *
+     * Maps to `sonar.scm.exclusions.disabled`.
+     *
+     * @default false
+     */
+    readonly disabled?: boolean;
+}
+/**
+ * Options for `sonar.coverage.*` properties.
+ */
+export interface SonarqubeCoverageOptions {
+    /**
+     * Comma-separated file path patterns to exclude from test coverage
+     * calculations.
+     *
+     * Maps to `sonar.coverage.exclusions`.
+     *
+     * @default - no coverage exclusions
+     */
+    readonly exclusions?: string[];
+}
+/**
+ * Options for `sonar.cpd.*` properties.
+ */
+export interface SonarqubeCpdOptions {
+    /**
+     * Comma-separated file path patterns to exclude from code
+     * duplication detection.
+     *
+     * Maps to `sonar.cpd.exclusions`.
+     *
+     * @default - no duplication exclusions
+     */
+    readonly exclusions?: string[];
+}
+/**
+ * Options for `sonar.javascript.*` properties.
+ */
+export interface SonarqubeJavascriptOptions {
+    /**
+     * Options for `sonar.javascript.lcov.*`.
+     *
+     * @default - no LCOV configuration
+     */
+    readonly lcov?: SonarqubeLcovOptions;
+}
+/**
+ * Options for `sonar.typescript.*` properties.
+ */
+export interface SonarqubeTypescriptOptions {
+    /**
+     * Path to the TypeScript configuration file.
+     *
+     * Maps to `sonar.typescript.tsconfigPath`.
+     *
+     * @default - not set
+     */
+    readonly tsconfigPath?: string;
+}
+/**
+ * Options for `sonar.rust.*` properties.
+ */
+export interface SonarqubeRustOptions {
+    /**
+     * Options for `sonar.rust.lcov.*`.
+     *
+     * @default - no Rust LCOV configuration
+     */
+    readonly lcov?: SonarqubeLcovOptions;
+    /**
+     * Options for `sonar.rust.clippy.*`.
+     *
+     * @default - no clippy configuration
+     */
+    readonly clippy?: SonarqubeRustClippyOptions;
+    /**
+     * Options for `sonar.rust.clippyReport.*`.
+     *
+     * @default - no clippy report configuration
+     */
+    readonly clippyReport?: SonarqubeRustClippyReportOptions;
+}
+/**
+ * Options for lcov report paths (shared between languages).
+ */
+export interface SonarqubeLcovOptions {
+    /**
+     * Comma-separated paths to LCOV coverage report files.
+     *
+     * Maps to `sonar.<language>.lcov.reportPaths`.
+     *
+     * @default - not set
+     */
+    readonly reportPaths?: string[];
+}
+/**
+ * Options for `sonar.rust.clippy.*` properties.
+ */
+export interface SonarqubeRustClippyOptions {
+    /**
+     * Whether Clippy analysis is enabled.
+     *
+     * Maps to `sonar.rust.clippy.enabled`.
+     *
+     * @default true
+     */
+    readonly enabled?: boolean;
+}
+/**
+ * Options for `sonar.rust.clippyReport.*` properties.
+ */
+export interface SonarqubeRustClippyReportOptions {
+    /**
+     * Paths to Clippy JSON report files.
+     *
+     * Maps to `sonar.rust.clippyReport.reportPaths`.
+     *
+     * @default - not set
+     */
+    readonly reportPaths?: string[];
+}
+/**
+ * Options for `sonar.log.*` properties.
+ */
+export interface SonarqubeLogOptions {
+    /**
+     * Controls the quantity/level of logs produced during analysis.
+     *
+     * Maps to `sonar.log.level`.
+     *
+     * @default SonarqubeLogLevel.INFO
+     */
+    readonly level?: SonarqubeLogLevel;
+}
+/**
+ * Options for `sonar.qualitygate.*` properties.
+ */
+export interface SonarqubeQualityGateOptions {
+    /**
+     * Forces the analysis step to poll the server and wait for the
+     * Quality Gate status. Will fail the pipeline if the quality gate fails.
+     *
+     * Maps to `sonar.qualitygate.wait`.
+     *
+     * @default false
+     */
+    readonly wait?: boolean;
+    /**
+     * The number of seconds that the scanner should wait for a report
+     * to be processed.
+     *
+     * Maps to `sonar.qualitygate.timeout`.
+     *
+     * @default 300
+     */
+    readonly timeout?: number;
+}
+/**
+ * Options for `SonarqubeProperties`.
+ *
+ * The interface structure mirrors the `sonar.*` dot-notation used in
+ * `sonar-project.properties`. Nested interfaces map to nested property
+ * namespaces. For example, `scm.provider` maps to `sonar.scm.provider`.
+ */
+export interface SonarqubePropertiesOptions {
+    /**
+     * The project's unique key.
+     *
+     * Can include up to 400 characters. Allowed characters:
+     * letters, digits, dash, underscore, periods, and colons.
+     *
+     * Maps to `sonar.projectKey`. This parameter is mandatory.
+     */
+    readonly projectKey: string;
+    /**
+     * The key of the organization to which the project belongs.
+     *
+     * Maps to `sonar.organization`. Mandatory for SonarQube Cloud.
+     *
+     * @default - no organization
+     */
+    readonly organization?: string;
+    /**
+     * Name of the project displayed on the web interface.
+     *
+     * Maps to `sonar.projectName`.
+     *
+     * @default - not set
+     */
+    readonly projectName?: string;
+    /**
+     * The project version.
+     *
+     * Maps to `sonar.projectVersion`.
+     *
+     * @default - not set
+     */
+    readonly projectVersion?: string;
+    /**
+     * Comma-separated paths to directories containing main source code
+     * (non-test code).
+     *
+     * Maps to `sonar.sources`.
+     *
+     * @default - the project base directory
+     */
+    readonly sources?: string;
+    /**
+     * Comma-separated paths to directories containing test code.
+     *
+     * Maps to `sonar.tests`.
+     *
+     * @default - no test code analyzed
+     */
+    readonly tests?: string;
+    /**
+     * The project's base directory when the analysis needs to take place
+     * in a directory other than the one from which it was started.
+     *
+     * Maps to `sonar.projectBaseDir`.
+     *
+     * @default - the directory from which the analysis was started
+     */
+    readonly projectBaseDir?: string;
+    /**
+     * Encoding of the source files.
+     *
+     * Maps to `sonar.sourceEncoding`.
+     *
+     * @default - system encoding
+     */
+    readonly sourceEncoding?: string;
+    /**
+     * Comma-separated file path patterns to exclude from the analysis scope.
+     *
+     * Maps to `sonar.exclusions`.
+     *
+     * @default - no exclusions
+     */
+    readonly exclusions?: string[];
+    /**
+     * The language for analysis.
+     *
+     * Maps to `sonar.language`.
+     *
+     * @default - auto-detected
+     */
+    readonly language?: string;
+    /**
+     * The quality profile name.
+     *
+     * Maps to `sonar.profile`.
+     *
+     * @default - uses the default profile configured on the server
+     */
+    readonly profile?: string;
+    /**
+     * The SonarQube Cloud instance's region.
+     *
+     * Maps to `sonar.region`.
+     *
+     * @default SonarqubeRegion.EU
+     */
+    readonly region?: SonarqubeRegion;
+    /**
+     * SCM-related options (`sonar.scm.*`).
+     *
+     * @default - no SCM configuration
+     */
+    readonly scm?: SonarqubeScmOptions;
+    /**
+     * Coverage-related options (`sonar.coverage.*`).
+     *
+     * @default - no coverage configuration
+     */
+    readonly coverage?: SonarqubeCoverageOptions;
+    /**
+     * Duplication detection options (`sonar.cpd.*`).
+     *
+     * @default - no CPD configuration
+     */
+    readonly cpd?: SonarqubeCpdOptions;
+    /**
+     * JavaScript-specific options (`sonar.javascript.*`).
+     *
+     * @default - no JavaScript configuration
+     */
+    readonly javascript?: SonarqubeJavascriptOptions;
+    /**
+     * TypeScript-specific options (`sonar.typescript.*`).
+     *
+     * @default - no TypeScript configuration
+     */
+    readonly typescript?: SonarqubeTypescriptOptions;
+    /**
+     * Rust-specific options (`sonar.rust.*`).
+     *
+     * @default - no Rust configuration
+     */
+    readonly rust?: SonarqubeRustOptions;
+    /**
+     * Logging options (`sonar.log.*`).
+     *
+     * @default - INFO level
+     */
+    readonly log?: SonarqubeLogOptions;
+    /**
+     * Quality gate options (`sonar.qualitygate.*`).
+     *
+     * @default - quality gate not awaited
+     */
+    readonly qualitygate?: SonarqubeQualityGateOptions;
+    /**
+     * Additional arbitrary properties to include in the configuration.
+     *
+     * Use this for properties not covered by the typed options.
+     * Keys use dot-notation (e.g., `sonar.java.binaries`).
+     *
+     * These are applied as overrides after the typed options above, so a key
+     * that is a prefix of a typed option (e.g. `"sonar.coverage"`) replaces
+     * that entire subtree rather than merging with it.
+     *
+     * @default - no additional properties
+     */
+    readonly extraProperties?: Record<string, string>;
+    /**
+     * Options for the generated properties file.
+     *
+     * @default - default file options
+     */
+    readonly fileOptions?: SonarqubeFileOptions;
+}
+/**
+ * File options for the generated `sonar-project.properties` file.
+ */
+export interface SonarqubeFileOptions {
+    /**
+     * Whether the generated file should be committed to git.
+     *
+     * @default true
+     */
+    readonly committed?: boolean;
+    /**
+     * Whether the generated file should be readonly.
+     *
+     * @default true
+     */
+    readonly readonly?: boolean;
+    /**
+     * Adds the projen marker to the file.
+     *
+     * @default - marker will be included as long as the project is not ejected
+     */
+    readonly marker?: boolean;
+    /**
+     * A comment to include at the top of the file.
+     *
+     * @default - no additional comment
+     */
+    readonly comment?: string[];
+}
+/**
+ * Manages the `sonar-project.properties` configuration file for SonarQube
+ * analysis.
+ *
+ * This component generates a `sonar-project.properties` file at the project
+ * root with the specified configuration parameters. It provides typed options
+ * whose structure mirrors the dot-notation property namespaces.
+ *
+ * @see https://docs.sonarsource.com/sonarqube-cloud/analyzing-source-code/analysis-parameters/parameters-not-settable-in-ui
+ *
+ * @example
+ * new SonarqubeProperties(project, {
+ *   projectKey: 'my-org_my-project',
+ *   organization: 'my-org',
+ *   sources: 'src',
+ *   tests: 'test',
+ *   exclusions: ['*{@literal *}/node_modules/**'],
+ *   coverage: { exclusions: ['*{@literal *}/test/**'] },
+ *   javascript: { lcov: { reportPaths: ['coverage/lcov.info'] } },
+ *   sourceEncoding: 'UTF-8',
+ * });
+ */
+export declare class SonarqubeProperties extends Component {
+    /**
+     * The underlying properties file.
+     */
+    readonly file: PropertiesFile;
+    constructor(scope: IConstruct, options: SonarqubePropertiesOptions);
+}