projen 0.70.2 → 0.70.4

package/lib/.types-compat/ts3.9/lib/json.d.ts

@@ -0,0 +1,27 @@
+import { IResolver } from "./file";
+import { ObjectFile, ObjectFileOptions } from "./object-file";
+import { Project } from "./project";
+/**
+ * Options for `JsonFile`.
+ */
+export interface JsonFileOptions extends ObjectFileOptions {
+    /**
+     * Adds a newline at the end of the file.
+     * @default true
+     */
+    readonly newline?: boolean;
+    /**
+     * Allow the use of comments in this file.
+     * @default - false for .json files, true for .json5 and .jsonc files
+     */
+    readonly allowComments?: boolean;
+}
+/**
+ * Represents a JSON file.
+ */
+export declare class JsonFile extends ObjectFile {
+    private readonly newline;
+    readonly supportsComments: boolean;
+    constructor(project: Project, filePath: string, options: JsonFileOptions);
+    protected synthesizeContent(resolver: IResolver): string | undefined;
+}

package/lib/.types-compat/ts3.9/lib/license.d.ts

@@ -0,0 +1,31 @@
+import { FileBase, IResolver } from "./file";
+import { Project } from "./project";
+export interface LicenseOptions {
+    /**
+     * License type (SPDX).
+     *
+     * @see https://github.com/projen/projen/tree/main/license-text for list of supported licenses
+     */
+    readonly spdx: string;
+    /**
+     * Copyright owner.
+     *
+     * If the license text has $copyright_owner, this option must be specified.
+     *
+     * @default -
+     */
+    readonly copyrightOwner?: string;
+    /**
+     * Period of license (e.g. "1998-2023")
+     *
+     * The string `$copyright_period` will be substituted with this string.
+     *
+     * @default - current year (e.g. "2020")
+     */
+    readonly copyrightPeriod?: string;
+}
+export declare class License extends FileBase {
+    private readonly text;
+    constructor(project: Project, options: LicenseOptions);
+    protected synthesizeContent(_: IResolver): string | undefined;
+}

package/lib/.types-compat/ts3.9/lib/logger.d.ts

@@ -0,0 +1,73 @@
+import { Component } from "./component";
+import { Project } from "./project";
+/**
+ * Options for logging utilities.
+ */
+export interface LoggerOptions {
+    /**
+     * The logging verbosity. The levels available (in increasing verbosity) are
+     * OFF, ERROR, WARN, INFO, DEBUG, and VERBOSE.
+     *
+     * @default LogLevel.INFO
+     */
+    readonly level?: LogLevel;
+    /**
+     * Include a prefix for all logging messages with the project name.
+     *
+     * @default false
+     */
+    readonly usePrefix?: boolean;
+}
+/**
+ * Project-level logging utilities.
+ */
+export declare class Logger extends Component {
+    private readonly level;
+    private readonly usePrefix;
+    constructor(project: Project, options?: LoggerOptions);
+    /**
+     * Log a message to stderr with a given logging level. The message will be
+     * printed as long as `logger.level` is set to the message's severity or higher.
+     *
+     * @param level Logging verbosity
+     * @param text strings or objects to print
+     */
+    log(level: LogLevel, ...text: any[]): void;
+    /**
+     * Log a message to stderr with VERBOSE severity
+     * @param text strings or objects to print
+     */
+    verbose(...text: any[]): void;
+    /**
+     * Log a message to stderr with DEBUG severity
+     * @param text strings or objects to print
+     */
+    debug(...text: any[]): void;
+    /**
+     * Log a message to stderr with INFO severity
+     * @param text strings or objects to print
+     */
+    info(...text: any[]): void;
+    /**
+     * Log a message to stderr with WARN severity
+     * @param text strings or objects to print
+     */
+    warn(...text: any[]): void;
+    /**
+     * Log a message to stderr with ERROR severity
+     * @param text strings or objects to print
+     */
+    error(...text: any[]): void;
+    private colorForLogLevel;
+}
+/**
+ * Logging verbosity.
+ */
+export declare enum LogLevel {
+    OFF = "00.off",
+    ERROR = "10.error",
+    WARN = "20.warn",
+    INFO = "30.info",
+    DEBUG = "40.debug",
+    VERBOSE = "50.verbose"
+}

package/lib/.types-compat/ts3.9/lib/logging.d.ts

@@ -0,0 +1,8 @@
+export declare const ICON = "\uD83D\uDC7E";
+export declare function debug(...text: any[]): void;
+export declare function verbose(...text: any[]): void;
+export declare function info(...text: any[]): void;
+export declare function error(...text: any[]): void;
+export declare function warn(...text: any[]): void;
+export declare function disable(): void;
+export declare function isEnabled(): boolean;

package/lib/.types-compat/ts3.9/lib/makefile.d.ts

@@ -0,0 +1,77 @@
+import { FileBase, FileBaseOptions, IResolver } from "./file";
+import { Project } from "./project";
+/**
+ * A Make rule.
+ */
+export interface Rule {
+    /**
+     * Files to be created or updated by this rule.
+     *
+     * If the rule is phony then instead this represents the command's name(s).
+     */
+    readonly targets: string[];
+    /**
+     * Files that are used as inputs to create a target.
+     *
+     * @default []
+     */
+    readonly prerequisites?: string[];
+    /**
+     * Commands that are run (using prerequisites as inputs) to create a target.
+     *
+     * @default []
+     */
+    readonly recipe?: string[];
+    /**
+     * Marks whether the target is phony.
+     *
+     * @default false
+     */
+    readonly phony?: boolean;
+}
+/**
+ * Options for Makefiles.
+ */
+export interface MakefileOptions extends FileBaseOptions {
+    /**
+     * List of targets to build when Make is invoked without specifying any targets.
+     *
+     * @default []
+     */
+    readonly all?: string[];
+    /**
+     * Rules to include in the Makefile.
+     *
+     * @default []
+     */
+    readonly rules?: Rule[];
+}
+/**
+ * Minimal Makefile.
+ */
+export declare class Makefile extends FileBase {
+    /**
+     * List of rule definitions.
+     */
+    readonly rules: Rule[];
+    private readonly all;
+    constructor(project: Project, filePath: string, options?: MakefileOptions);
+    /**
+     * Add a target to all
+     */
+    addAll(target: string): Makefile;
+    /**
+     * Add multiple targets to all
+     */
+    addAlls(...targets: string[]): Makefile;
+    /**
+     * Add a rule to the Makefile.
+     */
+    addRule(rule: Rule): Makefile;
+    /**
+     * Add multiple rules to the Makefile.
+     */
+    addRules(...rules: Rule[]): Makefile;
+    private validateRule;
+    protected synthesizeContent(resolver: IResolver): string | undefined;
+}

package/lib/.types-compat/ts3.9/lib/object-file.d.ts

@@ -0,0 +1,155 @@
+import { FileBase, FileBaseOptions, IResolver } from "./file";
+import { JsonPatch } from "./json-patch";
+import { Project } from "./project";
+/**
+ * Options for `ObjectFile`.
+ */
+export interface ObjectFileOptions extends FileBaseOptions {
+    /**
+     * The object that will be serialized. You can modify the object's contents
+     * before synthesis.
+     *
+     * @default {} an empty object (use `file.obj` to mutate).
+     */
+    readonly obj?: any;
+    /**
+     * Omits empty objects and arrays.
+     * @default false
+     */
+    readonly omitEmpty?: boolean;
+}
+/**
+ * Represents an Object file.
+ */
+export declare abstract class ObjectFile extends FileBase {
+    /**
+     * The output object. This object can be mutated until the project is
+     * synthesized.
+     */
+    private readonly obj;
+    /**
+     * An object to be merged on top of `obj` after the resolver is called
+     */
+    private readonly rawOverrides;
+    /**
+     * Indicates if empty objects and arrays are omitted from the output object.
+     */
+    readonly omitEmpty: boolean;
+    /**
+     * patches to be applied to `obj` after the resolver is called
+     */
+    private readonly patchOperations;
+    constructor(project: Project, filePath: string, options: ObjectFileOptions);
+    /**
+     * Adds an override to the synthesized object file.
+     *
+     * If the override is nested, separate each nested level using a dot (.) in the path parameter.
+     * If there is an array as part of the nesting, specify the index in the path.
+     *
+     * To include a literal `.` in the property name, prefix with a `\`. In most
+     * programming languages you will need to write this as `"\\."` because the
+     * `\` itself will need to be escaped.
+     *
+     * For example,
+     * ```typescript
+     * project.tsconfig.file.addOverride('compilerOptions.alwaysStrict', true);
+     * project.tsconfig.file.addOverride('compilerOptions.lib', ['dom', 'dom.iterable', 'esnext']);
+     * ```
+     * would add the overrides
+     * ```json
+     * "compilerOptions": {
+     *   "alwaysStrict": true,
+     *   "lib": [
+     *     "dom",
+     *     "dom.iterable",
+     *     "esnext"
+     *   ]
+     *   ...
+     * }
+     * ...
+     * ```
+     *
+     * @param path - The path of the property, you can use dot notation to
+     *        override values in complex types. Any intermediate keys
+     *        will be created as needed.
+     * @param value - The value. Could be primitive or complex.
+     */
+    addOverride(path: string, value: any): void;
+    /**
+     * Adds to an array in the synthesized object file.
+     *
+     * If the array is nested, separate each nested level using a dot (.) in the path parameter.
+     * If there is an array as part of the nesting, specify the index in the path.
+     *
+     * To include a literal `.` in the property name, prefix with a `\`. In most
+     * programming languages you will need to write this as `"\\."` because the
+     * `\` itself will need to be escaped.
+     *
+     * For example, with the following object file
+     * ```json
+     * "compilerOptions": {
+     *   "exclude": ["node_modules"],
+     *   "lib": ["es2019"]
+     *   ...
+     * }
+     * ...
+     * ```
+     *
+     * ```typescript
+     * project.tsconfig.file.addToArray('compilerOptions.exclude', 'coverage');
+     * project.tsconfig.file.addToArray('compilerOptions.lib', 'dom', 'dom.iterable', 'esnext');
+     * ```
+     * would result in the following object file
+     * ```json
+     * "compilerOptions": {
+     *   "exclude": ["node_modules", "coverage"],
+     *   "lib": ["es2019", "dom", "dom.iterable", "esnext"]
+     *   ...
+     * }
+     * ...
+     * ```
+     *
+     * @param path - The path of the property, you can use dot notation to
+     *        att to arrays in complex types. Any intermediate keys
+     *        will be created as needed.
+     * @param values - The values to add. Could be primitive or complex.
+     */
+    addToArray(path: string, ...values: any): void;
+    /**
+     * Applies an RFC 6902 JSON-patch to the synthesized object file.
+     * See https://datatracker.ietf.org/doc/html/rfc6902 for more information.
+     *
+     * For example, with the following object file
+     * ```json
+     * "compilerOptions": {
+     *   "exclude": ["node_modules"],
+     *   "lib": ["es2019"]
+     *   ...
+     * }
+     * ...
+     * ```
+     *
+     * ```typescript
+     * project.tsconfig.file.patch(JsonPatch.add("/compilerOptions/exclude/-", "coverage"));
+     * project.tsconfig.file.patch(JsonPatch.replace("/compilerOptions/lib", ["dom", "dom.iterable", "esnext"]));
+     * ```
+     * would result in the following object file
+     * ```json
+     * "compilerOptions": {
+     *   "exclude": ["node_modules", "coverage"],
+     *   "lib": ["dom", "dom.iterable", "esnext"]
+     *   ...
+     * }
+     * ...
+     * ```
+     *
+     * @param patches - The patch operations to apply
+     */
+    patch(...patches: JsonPatch[]): void;
+    /**
+     * Syntactic sugar for `addOverride(path, undefined)`.
+     * @param path The path of the value to delete
+     */
+    addDeletionOverride(path: string): void;
+    protected synthesizeContent(resolver: IResolver): string | undefined;
+}

package/lib/.types-compat/ts3.9/lib/option-hints.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Choices for how to display commented out options in projenrc files.
+ * Does not apply to projenrc.json files.
+ */
+export declare enum InitProjectOptionHints {
+    /**
+     * Display all possible options (grouped by which interface they belong to).
+     */
+    ALL = "all",
+    /**
+     * Display only featured options, in alphabetical order.
+     */
+    FEATURED = "featured",
+    /**
+     * Display no extra options.
+     */
+    NONE = "none"
+}

package/lib/.types-compat/ts3.9/lib/project-build.d.ts

@@ -0,0 +1,41 @@
+import { Component } from "./component";
+import { Project } from "./project";
+import { Task } from "./task";
+/**
+ * Manages a standard build process for all projects.
+ *
+ * Build spawns these tasks in order:
+ * 1. default
+ * 2. pre-compile
+ * 3. compile
+ * 4. post-compile
+ * 5. test
+ * 6. package
+ */
+export declare class ProjectBuild extends Component {
+    /**
+     * The task responsible for a full release build.
+     */
+    readonly buildTask: Task;
+    /**
+     * Pre-compile task.
+     */
+    readonly preCompileTask: Task;
+    /**
+     * Compiles the code. By default for node.js projects this task is empty.
+     */
+    readonly compileTask: Task;
+    /**
+     * Post-compile task.
+     */
+    readonly postCompileTask: Task;
+    /**
+     * Tests the code.
+     */
+    readonly testTask: Task;
+    /**
+     * The "package" task.
+     */
+    readonly packageTask: Task;
+    constructor(project: Project);
+}