projen/lib/properties-file.d.ts

CDK for software projects

import type { IConstruct } from "constructs";
import type { IResolver } from "./file";
import type { ObjectFileOptions } from "./object-file";
import { ObjectFile } from "./object-file";
/**
 * Options for `PropertiesFile`.
 */
export interface PropertiesFileOptions extends ObjectFileOptions {
    /**
     * A comment to include at the top of the file (after the projen marker,
     * if enabled). Each string in the array becomes a separate comment line.
     *
     * @default - no additional comment
     */
    readonly comment?: string[];
}
/**
 * Represents a Java `.properties` file.
 *
 * Properties files consist of key=value pairs, one per line,
 * with `#` used for comments. This file format is commonly
 * used by tools like SonarQube, Gradle, and other JVM-based
 * ecosystem tools.
 *
 * The object passed as `obj` can be a nested structure. Nested keys are
 * flattened into dot-separated property keys on synthesis. For example,
 * `{ sonar: { sources: "src" } }` produces `sonar.sources=src`.
 *
 * This means `addOverride` uses dot notation as a path separator,
 * consistent with ObjectFile/JsonPatch semantics.
 *
 * @example
 * new PropertiesFile(project, 'sonar-project.properties', {
 *   obj: {
 *     sonar: {
 *       projectKey: 'my-project',
 *       sources: 'src',
 *     },
 *   },
 * });
 *
 * // Produces:
 * // sonar.projectKey=my-project
 * // sonar.sources=src
 */
export declare class PropertiesFile extends ObjectFile {
    private readonly comment?;
    constructor(scope: IConstruct, filePath: string, options: PropertiesFileOptions);
    protected synthesizeContent(resolver: IResolver): string | undefined;
}