projen 0.52.21 → 0.52.25

package/lib/project.d.ts

@@ -13,27 +13,22 @@ import { ProjenrcOptions } from "./projenrc-json";
 import { Task, TaskOptions } from "./task";
 import { Tasks } from "./tasks";
 /**
- * (experimental) Options for `Project`.
- *
- * @experimental
+ * Options for `Project`.
  */
 export interface ProjectOptions {
     /**
-     * (experimental) This is the name of your project.
+     * This is the name of your project.
      *
      * @default $BASEDIR
-     * @experimental
-     * @featured true
+     * @featured
      */
     readonly name: string;
     /**
-     * (experimental) The parent project, if this project is part of a bigger project.
-     *
-     * @experimental
+     * The parent project, if this project is part of a bigger project.
      */
     readonly parent?: Project;
     /**
-     * (experimental) The root directory of the project.
+     * The root directory of the project.
      *
      * Relative to this directory, all files are synthesized.
      *
@@ -42,134 +37,92 @@ export interface ProjectOptions {
      * sub-projects.
      *
      * @default "."
-     * @experimental
      */
     readonly outdir?: string;
     /**
-     * (experimental) Configure logging options such as verbosity.
-     *
+     * Configure logging options such as verbosity.
      * @default {}
-     * @experimental
      */
     readonly logging?: LoggerOptions;
     /**
-     * (experimental) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
+     * Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable
+     * .projenrc.json generation.
      *
      * @default false
-     * @experimental
      */
     readonly projenrcJson?: boolean;
     /**
-     * (experimental) Options for .projenrc.json.
-     *
+     * Options for .projenrc.json
      * @default - default options
-     * @experimental
      */
     readonly projenrcJsonOptions?: ProjenrcOptions;
     /**
-     * (experimental) The shell command to use in order to run the projen CLI.
+     * The shell command to use in order to run the projen CLI.
      *
      * Can be used to customize in special environments.
      *
      * @default "npx projen"
-     * @experimental
      */
     readonly projenCommand?: string;
 }
 /**
- * (experimental) Base project.
- *
- * @experimental
+ * Base project
  */
 export declare class Project {
     /**
-     * (experimental) The name of the default task (the task executed when `projen` is run without arguments).
-     *
-     * Normally
+     * The name of the default task (the task executed when `projen` is run without arguments). Normally
      * this task should synthesize the project files.
-     *
-     * @experimental
      */
     static readonly DEFAULT_TASK = "default";
     /**
-     * (experimental) Project name.
-     *
-     * @experimental
+     * Project name.
      */
     readonly name: string;
     /**
-     * (experimental) .gitignore.
-     *
-     * @experimental
+     * .gitignore
      */
     readonly gitignore: IgnoreFile;
     /**
-     * (experimental) The .gitattributes file for this repository.
-     *
-     * @experimental
+     * The .gitattributes file for this repository.
      */
     readonly gitattributes: GitAttributesFile;
     /**
-     * (experimental) A parent project.
-     *
-     * If undefined, this is the root project.
-     *
-     * @experimental
+     * A parent project. If undefined, this is the root project.
      */
     readonly parent?: Project;
     /**
-     * (experimental) Absolute output directory of this project.
-     *
-     * @experimental
+     * Absolute output directory of this project.
      */
     readonly outdir: string;
     /**
-     * (experimental) The root project.
-     *
-     * @experimental
-     */
+     * The root project.
+     **/
     readonly root: Project;
     /**
-     * (experimental) Project tasks.
-     *
-     * @experimental
+     * Project tasks.
      */
     readonly tasks: Tasks;
     /**
-     * (experimental) Project dependencies.
-     *
-     * @experimental
+     * Project dependencies.
      */
     readonly deps: Dependencies;
     /**
-     * (experimental) Logging utilities.
-     *
-     * @experimental
+     * Logging utilities.
      */
     readonly logger: Logger;
     /**
-     * (experimental) The options used when this project is bootstrapped via `projen new`.
-     *
-     * It
+     * 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.
-     *
-     * @experimental
      */
     readonly initProject?: InitProject;
     /**
-     * (experimental) The command to use in order to run the projen CLI.
-     *
-     * @experimental
+     * The command to use in order to run the projen CLI.
      */
     readonly projenCommand: string;
     /**
-     * (experimental) This is the "default" task, the one that executes "projen".
-     *
-     * Undefined if
+     * This is the "default" task, the one that executes "projen". Undefined if
      * the project is being ejected.
-     *
-     * @experimental
      */
     readonly defaultTask?: Task;
     /**
@@ -180,9 +133,7 @@ export declare class Project {
      */
     private readonly ejectTask?;
     /**
-     * (experimental) Manages the build process of the project.
-     *
-     * @experimental
+     * Manages the build process of the project.
      */
     readonly projectBuild: ProjectBuild;
     private readonly _components;
@@ -190,143 +141,100 @@ export declare class Project {
     private readonly tips;
     private readonly excludeFromCleanup;
     private readonly _ejected;
-    /**
-     * @experimental
-     */
     constructor(options: ProjectOptions);
     /**
-     * (experimental) Returns all the components within this project.
-     *
-     * @experimental
+     * Returns all the components within this project.
      */
     get components(): Component[];
     /**
-     * (experimental) All files in this project.
-     *
-     * @experimental
+     * All files in this project.
      */
     get files(): FileBase[];
     /**
-     * (experimental) Adds a new task to this project.
-     *
-     * This will fail if the project already has
+     * 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.
-     * @experimental
+     * @param name The task name to add
+     * @param props Task properties
      */
     addTask(name: string, props?: TaskOptions): Task;
     /**
-     * (experimental) Removes a task from a project.
+     * Removes a task from a project.
      *
      * @param name The name of the task to remove.
+     *
      * @returns The `Task` that was removed, otherwise `undefined`.
-     * @experimental
      */
     removeTask(name: string): Task | undefined;
-    /**
-     * @experimental
-     */
     get buildTask(): Task;
-    /**
-     * @experimental
-     */
     get compileTask(): Task;
-    /**
-     * @experimental
-     */
     get testTask(): Task;
-    /**
-     * @experimental
-     */
     get preCompileTask(): Task;
-    /**
-     * @experimental
-     */
     get postCompileTask(): Task;
-    /**
-     * @experimental
-     */
     get packageTask(): Task;
     /**
-     * (experimental) Finds a file at the specified relative path within this project and all its subprojects.
+     * Finds a file at the specified relative path within this project and all
+     * its subprojects.
      *
-     * @param filePath The file path.
+     * @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
-     * @experimental
      */
     tryFindFile(filePath: string): FileBase | undefined;
     /**
-     * (deprecated) Finds a json file by name.
-     *
+     * Finds a json file by name.
      * @param filePath The file path.
      * @deprecated use `tryFindObjectFile`
      */
     tryFindJsonFile(filePath: string): JsonFile | undefined;
     /**
-     * (experimental) Finds an object file (like JsonFile, YamlFile, etc.) by name.
-     *
+     * Finds an object file (like JsonFile, YamlFile, etc.) by name.
      * @param filePath The file path.
-     * @experimental
      */
     tryFindObjectFile(filePath: string): ObjectFile | undefined;
     /**
-     * (deprecated) Prints a "tip" message during synthesis.
-     *
-     * @param message The message.
+     * 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;
     /**
-     * (experimental) Exclude the matching files from pre-synth cleanup.
-     *
-     * Can be used when, for example, some
+     * 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.
-     * @experimental
+     * @param globs The glob patterns to match
      */
     addExcludeFromCleanup(...globs: string[]): void;
     /**
-     * (experimental) Returns the shell command to execute in order to run a task.
+     * 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.
-     * @experimental
+     * @param task The task for which the command is required
      */
     runTaskCommand(task: Task): string;
     /**
-     * (experimental) Exclude these files from the bundled package.
-     *
-     * Implemented by project types based on the
+     * 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.
-     * @experimental
+     * @param _pattern The glob pattern to exclude
      */
     addPackageIgnore(_pattern: string): void;
     /**
-     * (experimental) Adds a .gitignore pattern.
-     *
+     * Adds a .gitignore pattern.
      * @param pattern The glob pattern to ignore.
-     * @experimental
      */
     addGitIgnore(pattern: string): void;
     /**
-     * (experimental) Consider a set of files as "generated".
-     *
-     * This method is implemented by
+     * 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).
-     * @experimental
      */
     annotateGenerated(_glob: string): void;
     /**
-     * (experimental) Synthesize all project files into `outdir`.
+     * Synthesize all project files into `outdir`.
      *
      * 1. Call "this.preSynthesize()"
      * 2. Delete all generated files
@@ -334,28 +242,18 @@ export declare class Project {
      * 4. Synthesize all components of this project
      * 5. Call "postSynthesize()" for all components of this project
      * 6. Call "this.postSynthesize()"
-     *
-     * @experimental
      */
     synth(): void;
     /**
-     * (experimental) Whether or not the project is being ejected.
-     *
-     * @experimental
+     * Whether or not the project is being ejected.
      */
     get ejected(): boolean;
     /**
-     * (experimental) Called before all components are synthesized.
-     *
-     * @experimental
+     * Called before all components are synthesized.
      */
     preSynthesize(): void;
     /**
-     * (experimental) Called after all components are synthesized.
-     *
-     * Order is *not* guaranteed.
-     *
-     * @experimental
+     * Called after all components are synthesized. Order is *not* guaranteed.
      */
     postSynthesize(): void;
     /**
@@ -379,66 +277,46 @@ export declare class Project {
     private determineOutdir;
 }
 /**
- * (deprecated) Which type of project this is.
+ * Which type of project this is.
  *
  * @deprecated no longer supported at the base project level
  */
 export declare enum ProjectType {
     /**
-     * (deprecated) This module may be a either a library or an app.
-     *
-     * @deprecated
+     * This module may be a either a library or an app.
      */
     UNKNOWN = "unknown",
     /**
-     * (deprecated) This is a library, intended to be published to a package manager and consumed by other projects.
-     *
-     * @deprecated
+     * This is a library, intended to be published to a package manager and
+     * consumed by other projects.
      */
     LIB = "lib",
     /**
-     * (deprecated) This is an app (service, tool, website, etc).
-     *
-     * Its artifacts are intended to
+     * This is an app (service, tool, website, etc). Its artifacts are intended to
      * be deployed or published for end-user consumption.
-     *
-     * @deprecated
      */
     APP = "app"
 }
 /**
- * (experimental) 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.
- *
- * @experimental
+ * 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 {
     /**
-     * (experimental) The JSII FQN of the project type.
-     *
-     * @experimental
+     * The JSII FQN of the project type.
      */
     readonly fqn: string;
     /**
-     * (experimental) Initial arguments passed to `projen new`.
-     *
-     * @experimental
+     * Initial arguments passed to `projen new`.
      */
     readonly args: Record<string, any>;
     /**
-     * (experimental) Project metadata.
-     *
-     * @experimental
+     * Project metadata.
      */
     readonly type: inventory.ProjectType;
     /**
-     * (experimental) Include commented out options.
-     *
-     * Does not apply to projenrc.json files.
-     *
+     * Include commented out options. Does not apply to projenrc.json files.
      * @default InitProjectOptionHints.FEATURED
-     * @experimental
      */
     readonly comments: InitProjectOptionHints;
 }