projen 0.70.2 → 0.70.4

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

@@ -0,0 +1,374 @@
+import { Component } from "./component";
+import { Dependencies } from "./dependencies";
+import { FileBase } from "./file";
+import { GitAttributesFile } from "./gitattributes";
+import { IgnoreFile, IgnoreFileOptions } from "./ignore-file";
+import * as inventory from "./inventory";
+import { JsonFile } from "./json";
+import { Logger, LoggerOptions } from "./logger";
+import { ObjectFile } from "./object-file";
+import { InitProjectOptionHints } from "./option-hints";
+import { ProjectBuild as ProjectBuild } from "./project-build";
+import { ProjenrcJsonOptions } from "./projenrc-json";
+import { RenovatebotOptions } from "./renovatebot";
+import { Task, TaskOptions } from "./task";
+import { Tasks } from "./tasks";
+/**
+ * Options for `Project`.
+ */
+export interface ProjectOptions {
+    /**
+     * This is the name of your project.
+     *
+     * @default $BASEDIR
+     * @featured
+     */
+    readonly name: string;
+    /**
+     * The parent project, if this project is part of a bigger project.
+     */
+    readonly parent?: Project;
+    /**
+     * The root directory of the project.
+     *
+     * Relative to this directory, all files are synthesized.
+     *
+     * If this project has a parent, this directory is relative to the parent
+     * directory and it cannot be the same as the parent or any of it's other
+     * sub-projects.
+     *
+     * @default "."
+     */
+    readonly outdir?: string;
+    /**
+     * Configure logging options such as verbosity.
+     * @default {}
+     */
+    readonly logging?: LoggerOptions;
+    /**
+     * Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable
+     * .projenrc.json generation.
+     *
+     * @default false
+     */
+    readonly projenrcJson?: boolean;
+    /**
+     * Options for .projenrc.json
+     * @default - default options
+     */
+    readonly projenrcJsonOptions?: ProjenrcJsonOptions;
+    /**
+     * The shell command to use in order to run the projen CLI.
+     *
+     * Can be used to customize in special environments.
+     *
+     * @default "npx projen"
+     */
+    readonly projenCommand?: string;
+    /**
+     * Use renovatebot to handle dependency upgrades.
+     *
+     * @default false
+     */
+    readonly renovatebot?: boolean;
+    /**
+     * Options for renovatebot.
+     *
+     * @default - default options
+     */
+    readonly renovatebotOptions?: RenovatebotOptions;
+    /**
+     * Whether to commit the managed files by default.
+     *
+     * @default true
+     */
+    readonly commitGenerated?: boolean;
+    /**
+     * Configuration options for git
+     */
+    readonly gitOptions?: GitOptions;
+    /**
+     * Configuration options for .gitignore file
+     */
+    readonly gitIgnoreOptions?: IgnoreFileOptions;
+}
+/**
+ * Git configuration options
+ */
+export interface GitOptions {
+    /**
+     * File patterns to mark as stored in Git LFS
+     *
+     * @default - No files stored in LFS
+     */
+    readonly lfsPatterns?: string[];
+}
+/**
+ * Base project
+ */
+export declare class Project {
+    /**
+     * The name of the default task (the task executed when `projen` is run without arguments). Normally
+     * this task should synthesize the project files.
+     */
+    static readonly DEFAULT_TASK = "default";
+    /**
+     * Project name.
+     */
+    readonly name: string;
+    /**
+     * .gitignore
+     */
+    readonly gitignore: IgnoreFile;
+    /**
+     * The .gitattributes file for this repository.
+     */
+    readonly gitattributes: GitAttributesFile;
+    /**
+     * A parent project. If undefined, this is the root project.
+     */
+    readonly parent?: Project;
+    /**
+     * Absolute output directory of this project.
+     */
+    readonly outdir: string;
+    /**
+     * The root project.
+     **/
+    readonly root: Project;
+    /**
+     * Project tasks.
+     */
+    readonly tasks: Tasks;
+    /**
+     * Project dependencies.
+     */
+    readonly deps: Dependencies;
+    /**
+     * Logging utilities.
+     */
+    readonly logger: Logger;
+    /**
+     * The options used when this project is bootstrapped via `projen new`. It
+     * includes the original set of options passed to the CLI and also the JSII
+     * FQN of the project type.
+     */
+    readonly initProject?: InitProject;
+    /**
+     * The command to use in order to run the projen CLI.
+     */
+    readonly projenCommand: string;
+    /**
+     * This is the "default" task, the one that executes "projen". Undefined if
+     * the project is being ejected.
+     */
+    readonly defaultTask?: Task;
+    /**
+     * This task ejects the project from projen. This is undefined if the project
+     * it self is being ejected.
+     *
+     * See docs for more information.
+     */
+    private readonly ejectTask?;
+    /**
+     * Manages the build process of the project.
+     */
+    readonly projectBuild: ProjectBuild;
+    /**
+     * Whether to commit the managed files by default.
+     */
+    readonly commitGenerated: boolean;
+    private readonly _components;
+    private readonly subprojects;
+    private readonly tips;
+    private readonly excludeFromCleanup;
+    private readonly _ejected;
+    constructor(options: ProjectOptions);
+    /**
+     * Returns all the components within this project.
+     */
+    get components(): Component[];
+    /**
+     * All files in this project.
+     */
+    get files(): FileBase[];
+    /**
+     * Adds a new task to this project. This will fail if the project already has
+     * a task with this name.
+     *
+     * @param name The task name to add
+     * @param props Task properties
+     */
+    addTask(name: string, props?: TaskOptions): Task;
+    /**
+     * Removes a task from a project.
+     *
+     * @param name The name of the task to remove.
+     *
+     * @returns The `Task` that was removed, otherwise `undefined`.
+     */
+    removeTask(name: string): Task | undefined;
+    get buildTask(): Task;
+    get compileTask(): Task;
+    get testTask(): Task;
+    get preCompileTask(): Task;
+    get postCompileTask(): Task;
+    get packageTask(): Task;
+    /**
+     * Finds a file at the specified relative path within this project and all
+     * its subprojects.
+     *
+     * @param filePath The file path. If this path is relative, it will be resolved
+     * from the root of _this_ project.
+     * @returns a `FileBase` or undefined if there is no file in that path
+     */
+    tryFindFile(filePath: string): FileBase | undefined;
+    /**
+     * Finds a json file by name.
+     * @param filePath The file path.
+     * @deprecated use `tryFindObjectFile`
+     */
+    tryFindJsonFile(filePath: string): JsonFile | undefined;
+    /**
+     * Finds an object file (like JsonFile, YamlFile, etc.) by name.
+     * @param filePath The file path.
+     */
+    tryFindObjectFile(filePath: string): ObjectFile | undefined;
+    /**
+     * Finds a file at the specified relative path within this project and removes
+     * it.
+     *
+     * @param filePath The file path. If this path is relative, it will be
+     * resolved from the root of _this_ project.
+     * @returns a `FileBase` if the file was found and removed, or undefined if
+     * the file was not found.
+     */
+    tryRemoveFile(filePath: string): FileBase | undefined;
+    /**
+     * Prints a "tip" message during synthesis.
+     * @param message The message
+     * @deprecated - use `project.logger.info(message)` to show messages during synthesis
+     */
+    addTip(message: string): void;
+    /**
+     * Exclude the matching files from pre-synth cleanup. Can be used when, for example, some
+     * source files include the projen marker and we don't want them to be erased during synth.
+     *
+     * @param globs The glob patterns to match
+     */
+    addExcludeFromCleanup(...globs: string[]): void;
+    /**
+     * Returns the shell command to execute in order to run a task.
+     *
+     * By default, this is `npx projen@<version> <task>`
+     *
+     * @param task The task for which the command is required
+     */
+    runTaskCommand(task: Task): string;
+    /**
+     * Exclude these files from the bundled package. Implemented by project types based on the
+     * packaging mechanism. For example, `NodeProject` delegates this to `.npmignore`.
+     *
+     * @param _pattern The glob pattern to exclude
+     */
+    addPackageIgnore(_pattern: string): void;
+    /**
+     * Adds a .gitignore pattern.
+     * @param pattern The glob pattern to ignore.
+     */
+    addGitIgnore(pattern: string): void;
+    /**
+     * Consider a set of files as "generated". This method is implemented by
+     * derived classes and used for example, to add git attributes to tell GitHub
+     * that certain files are generated.
+     *
+     * @param _glob the glob pattern to match (could be a file path).
+     */
+    annotateGenerated(_glob: string): void;
+    /**
+     * Synthesize all project files into `outdir`.
+     *
+     * 1. Call "this.preSynthesize()"
+     * 2. Delete all generated files
+     * 3. Synthesize all sub-projects
+     * 4. Synthesize all components of this project
+     * 5. Call "postSynthesize()" for all components of this project
+     * 6. Call "this.postSynthesize()"
+     */
+    synth(): void;
+    /**
+     * Whether or not the project is being ejected.
+     */
+    get ejected(): boolean;
+    /**
+     * Called before all components are synthesized.
+     */
+    preSynthesize(): void;
+    /**
+     * Called after all components are synthesized. Order is *not* guaranteed.
+     */
+    postSynthesize(): void;
+    /**
+     * Adds a component to the project.
+     * @internal
+     */
+    _addComponent(component: Component): void;
+    /**
+     * Adds a sub-project to this project.
+     *
+     * This is automatically called when a new project is created with `parent`
+     * pointing to this project, so there is no real need to call this manually.
+     *
+     * @param sub-project The child project to add.
+     * @internal
+     */
+    _addSubProject(subproject: Project): void;
+    /**
+     * Resolves the project's output directory.
+     */
+    private determineOutdir;
+}
+/**
+ * Which type of project this is.
+ *
+ * @deprecated no longer supported at the base project level
+ */
+export declare enum ProjectType {
+    /**
+     * This module may be a either a library or an app.
+     */
+    UNKNOWN = "unknown",
+    /**
+     * This is a library, intended to be published to a package manager and
+     * consumed by other projects.
+     */
+    LIB = "lib",
+    /**
+     * This is an app (service, tool, website, etc). Its artifacts are intended to
+     * be deployed or published for end-user consumption.
+     */
+    APP = "app"
+}
+/**
+ * Information passed from `projen new` to the project object when the project
+ * is first created. It is used to generate projenrc files in various languages.
+ */
+export interface InitProject {
+    /**
+     * The JSII FQN of the project type.
+     */
+    readonly fqn: string;
+    /**
+     * Initial arguments passed to `projen new`.
+     */
+    readonly args: Record<string, any>;
+    /**
+     * Project metadata.
+     */
+    readonly type: inventory.ProjectType;
+    /**
+     * Include commented out options. Does not apply to projenrc.json files.
+     * @default InitProjectOptionHints.FEATURED
+     */
+    readonly comments: InitProjectOptionHints;
+}

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

@@ -0,0 +1,63 @@
+import { InitProjectOptionHints } from "./option-hints";
+export interface CreateProjectOptions {
+    /**
+     * Directory that the project will be generated in.
+     */
+    readonly dir: string;
+    /**
+     * Fully-qualified name of the project type (usually formatted
+     * as `projen.module.ProjectType`).
+     * @example `projen.typescript.TypescriptProject`
+     */
+    readonly projectFqn: string;
+    /**
+     * Project options. Only JSON-like values can be passed in (strings,
+     * booleans, numbers, enums, arrays, and objects that are not
+     * derived from classes).
+     *
+     * Consult the API reference of the project type you are generating for
+     * information about what fields and types are available.
+     */
+    readonly projectOptions: Record<string, any>;
+    /**
+     * Should we render commented-out default options in the projenrc file?
+     * Does not apply to projenrc.json files.
+     *
+     * @default InitProjectOptionHints.FEATURED
+     */
+    readonly optionHints?: InitProjectOptionHints;
+    /**
+     * Should we call `project.synth()` or instantiate the project (could still
+     * have side-effects) and render the .projenrc file.
+     *
+     * @default true
+     */
+    readonly synth?: boolean;
+    /**
+     * Should we execute post synthesis hooks? (usually package manager install).
+     *
+     * @default true
+     */
+    readonly post?: boolean;
+}
+/**
+ * Programmatic API for projen.
+ */
+export declare class Projects {
+    /**
+     * Creates a new project with defaults.
+     *
+     * This function creates the project type in-process (with in VM) and calls
+     * `.synth()` on it (if `options.synth` is not `false`).
+     *
+     * At the moment, it also generates a `.projenrc.js` file with the same code
+     * that was just executed. In the future, this will also be done by the project
+     * type, so we can easily support multiple languages of projenrc.
+     *
+     * An environment variable (PROJEN_CREATE_PROJECT=true) is set within the VM
+     * so that custom project types can detect whether the current synthesis is the
+     * result of a new project creation (and take additional steps accordingly)
+     */
+    static createProject(options: CreateProjectOptions): void;
+    private constructor();
+}

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

@@ -0,0 +1,27 @@
+import { Project } from "./project";
+import { ProjenrcFile } from "./projenrc";
+export interface ProjenrcJsonOptions {
+    /**
+     * The name of the projenrc file.
+     * @default ".projenrc.json"
+     */
+    readonly filename?: string;
+}
+/**
+ * Sets up a project to use JSON for projenrc.
+ */
+export declare class ProjenrcJson extends ProjenrcFile {
+    readonly filePath: string;
+    constructor(project: Project, options?: ProjenrcJsonOptions);
+    private generateProjenrc;
+}
+/**
+ * @deprecated use `ProjenrcJsonOptions`
+ */
+export interface ProjenrcOptions extends ProjenrcJsonOptions {
+}
+/**
+ * @deprecated use `ProjenrcJson`
+ */
+export declare class Projenrc extends ProjenrcJson {
+}

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

@@ -0,0 +1,18 @@
+import { Component } from "./component";
+import { Project } from "./project";
+/**
+ * A component representing the projen runtime configuration
+ */
+export declare abstract class ProjenrcFile extends Component {
+    /**
+     * Returns the `Projenrc` instance associated with a project or `undefined` if
+     * there is no Projenrc.
+     * @param project The project
+     * @returns A Projenrc
+     */
+    static of(project: Project): ProjenrcFile | undefined;
+    /**
+     * The path of the projenrc file.
+     */
+    abstract readonly filePath: string;
+}

package/lib/.types-compat/ts3.9/lib/python/index.d.ts

@@ -0,0 +1,14 @@
+export * from "./pip";
+export * from "./poetry";
+export * from "./projenrc";
+export * from "./pytest";
+export * from "./pytest-sample";
+export * from "./python-env";
+export * from "./python-deps";
+export * from "./python-packaging";
+export * from "./python-project";
+export * from "./python-sample";
+export * from "./requirements-file";
+export * from "./setuppy";
+export * from "./setuptools";
+export * from "./venv";

package/lib/.types-compat/ts3.9/lib/python/pip.d.ts

@@ -0,0 +1,32 @@
+import { IPythonDeps } from "./python-deps";
+import { Component } from "../component";
+import { Project } from "../project";
+import { Task } from "../task";
+/**
+ * Options for pip
+ */
+export interface PipOptions {
+}
+/**
+ * Manages dependencies using a requirements.txt file and the pip CLI tool.
+ */
+export declare class Pip extends Component implements IPythonDeps {
+    readonly installTask: Task;
+    constructor(project: Project, _options?: PipOptions);
+    /**
+     * Adds a runtime dependency.
+     *
+     * @param spec Format `<module>@<semver>`
+     */
+    addDependency(spec: string): void;
+    /**
+     * Adds a dev dependency.
+     *
+     * @param spec Format `<module>@<semver>`
+     */
+    addDevDependency(spec: string): void;
+    /**
+     * Installs dependencies (called during post-synthesis).
+     */
+    installDependencies(): void;
+}

package/lib/.types-compat/ts3.9/lib/python/poetry.d.ts

@@ -0,0 +1,177 @@
+import { IPythonDeps } from "./python-deps";
+import { IPythonEnv } from "./python-env";
+import { IPythonPackaging, PythonPackagingOptions } from "./python-packaging";
+import { Component } from "../component";
+import { Project } from "../project";
+import { Task } from "../task";
+import { TomlFile } from "../toml";
+/**
+ * Manage project dependencies, virtual environments, and packaging through the
+ * poetry CLI tool.
+ */
+export declare class Poetry extends Component implements IPythonDeps, IPythonEnv, IPythonPackaging {
+    readonly installTask: Task;
+    readonly publishTask: Task;
+    /**
+     * A task that uploads the package to the Test PyPI repository.
+     */
+    readonly publishTestTask: Task;
+    constructor(project: Project, options: PythonPackagingOptions);
+    private synthDependencies;
+    private synthDevDependencies;
+    /**
+     * Adds a runtime dependency.
+     *
+     * @param spec Format `<module>@<semver>`
+     */
+    addDependency(spec: string): void;
+    /**
+     * Adds a dev dependency.
+     *
+     * @param spec Format `<module>@<semver>`
+     */
+    addDevDependency(spec: string): void;
+    /**
+     * Initializes the virtual environment if it doesn't exist (called during post-synthesis).
+     */
+    setupEnvironment(): void;
+    /**
+     * Installs dependencies (called during post-synthesis).
+     */
+    installDependencies(): void;
+}
+/**
+ * Poetry-specific options.
+ * @see https://python-poetry.org/docs/pyproject/
+ */
+export interface PoetryPyprojectOptionsWithoutDeps {
+    /**
+     * Name of the package (required).
+     */
+    readonly name?: string;
+    /**
+     * Version of the package (required).
+     */
+    readonly version?: string;
+    /**
+     * A short description of the package (required).
+     */
+    readonly description?: string;
+    /**
+     * License of this package as an SPDX identifier.
+     *
+     * If the project is proprietary and does not use a specific license, you
+     * can set this value as "Proprietary".
+     */
+    readonly license?: string;
+    /**
+     * The authors of the package. Must be in the form "name <email>"
+     */
+    readonly authors?: string[];
+    /**
+     * the maintainers of the package. Must be in the form "name <email>"
+     */
+    readonly maintainers?: string[];
+    /**
+     * The name of the readme file of the package.
+     */
+    readonly readme?: string;
+    /**
+     * A URL to the website of the project.
+     */
+    readonly homepage?: string;
+    /**
+     * A URL to the repository of the project.
+     */
+    readonly repository?: string;
+    /**
+     * A URL to the documentation of the project.
+     */
+    readonly documentation?: string;
+    /**
+     * A list of keywords (max: 5) that the package is related to.
+     */
+    readonly keywords?: string[];
+    /**
+     * A list of PyPI trove classifiers that describe the project.
+     *
+     * @see https://pypi.org/classifiers/
+     */
+    readonly classifiers?: string[];
+    /**
+     * A list of packages and modules to include in the final distribution.
+     */
+    readonly packages?: any[];
+    /**
+     * A list of patterns that will be included in the final package.
+     */
+    readonly include?: string[];
+    /**
+     * A list of patterns that will be excluded in the final package.
+     *
+     * If a VCS is being used for a package, the exclude field will be seeded with
+     * the VCS’ ignore settings (.gitignore for git for example).
+     */
+    readonly exclude?: string[];
+    /**
+     * The scripts or executables that will be installed when installing the package.
+     */
+    readonly scripts?: {
+        [key: string]: any;
+    };
+    /**
+     * Source registries from which packages are retrieved.
+     */
+    readonly source?: any[];
+    /**
+     * Package extras
+     */
+    readonly extras?: {
+        [key: string]: string[];
+    };
+    /**
+     * Plugins. Must be specified as a table.
+     * @see https://toml.io/en/v1.0.0#table
+     */
+    readonly plugins?: any;
+    /**
+     * Project custom URLs, in addition to homepage, repository and documentation.
+     * E.g. "Bug Tracker"
+     */
+    readonly urls?: {
+        [key: string]: string;
+    };
+}
+/**
+ * Poetry-specific options.
+ * @see https://python-poetry.org/docs/pyproject/
+ */
+export interface PoetryPyprojectOptions extends PoetryPyprojectOptionsWithoutDeps {
+    /**
+     * A list of dependencies for the project.
+     *
+     * The python version for which your package is compatible is also required.
+     *
+     * @example { requests: "^2.13.0" }
+     */
+    readonly dependencies?: {
+        [key: string]: any;
+    };
+    /**
+     * A list of development dependencies for the project.
+     *
+     * @example { requests: "^2.13.0" }
+     */
+    readonly devDependencies?: {
+        [key: string]: any;
+    };
+}
+/**
+ * Represents configuration of a pyproject.toml file for a Poetry project.
+ *
+ * @see https://python-poetry.org/docs/pyproject/
+ */
+export declare class PoetryPyproject extends Component {
+    readonly file: TomlFile;
+    constructor(project: Project, options: PoetryPyprojectOptions);
+}