(deprecated) Auto approve set up for this project.
(experimental) Automatic PR merges.
(experimental) The task responsible for a full release build.
It spawns: compile + test + release + package
(experimental) The PR build GitHub workflow.
undefined if buildWorkflow is disabled.
(experimental) Compiles the code.
By default for node.js projects this task is empty.
(experimental) Project dependencies.
(deprecated) Access for .devcontainer.json (used for GitHub Codespaces).
This will be undefined if devContainer boolean is false
(experimental) The .gitattributes file for this repository.
(deprecated) Access all github components.
This will be undefined for subprojects.
(experimental) .gitignore.
(deprecated) Access for Gitpod.
This will be undefined if gitpod boolean is false
(experimental) The Jest configuration (if enabled).
(experimental) Logging utilities.
(experimental) Project name.
(experimental) 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) The .npmignore file.
(experimental) Absolute output directory of this project.
(experimental) API for managing the node package.
(experimental) A parent project.
If undefined, this is the root project.
(deprecated) Package publisher.
This will be undefined if the project does not have a
release workflow.
(experimental) Release management.
(experimental) The root project.
(experimental) The command to use to run scripts (e.g. yarn run or npm run depends on the package manager).
(experimental) Project tasks.
(experimental) Compiles the test code.
(experimental) Tests the code.
(deprecated) Access all VSCode components.
This will be undefined for subprojects.
(experimental) The name of the default task (the task executed when projen is run without arguments).
Normally this task should synthesize the project files.
(experimental) Returns all the components within this project.
(experimental) All files in this project.
(experimental) Maximum node version required by this pacakge.
(experimental) Minimum node.js version required by this package.
(deprecated) The package manager to use.
(experimental) The command to use in order to run the projen CLI.
(deprecated) DEPRECATED.
(experimental) Defines bundled dependencies.
Bundled dependencies will be added as normal dependencies as well as to the
bundledDependencies section of your package.json.
Names modules to install.
(deprecated) DEPRECATED.
(experimental) Defines normal dependencies.
Names modules to install.
(experimental) Defines development/test dependencies.
Names modules to install.
(experimental) 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.
The glob patterns to match.
(experimental) Directly set fields in package.json.
The fields to set.
(experimental) Adds a .gitignore pattern.
The glob pattern to ignore.
(experimental) Adds keywords to package.json (deduplicated).
The keywords to add.
(experimental) Exclude these files from the bundled package.
Implemented by project types based on the
packaging mechanism. For example, NodeProject delegates this to .npmignore.
(experimental) Defines peer dependencies.
When adding peer dependencies, a devDependency will also be added on the pinned version of the declared peer. This will ensure that you are testing your code against the minimum version required from your consumers.
Names modules to install.
(experimental) Adds a new task to this project.
This will fail if the project already has a task with this name.
The task name to add.
Task properties.
(deprecated) DEPRECATED.
(deprecated) Prints a "tip" message during synthesis.
The message.
(deprecated) Marks the provided file(s) as being generated.
This is achieved using the github-linguist attributes. Generated files do not count against the repository statistics and language breakdown.
the glob pattern to match (could be a file path).
(experimental) Indicates if a script by the name name is defined.
The name of the script.
(experimental) Called after all components are synthesized.
Order is not guaranteed.
(experimental) Removes the npm script (always successful).
The name of the script.
(experimental) Removes a task from a project.
The name of the task to remove.
The Task that was removed, otherwise undefined.
(experimental) Returns the shell command to execute in order to run a task.
This will
typically be npx projen TASK.
The task for which the command is required.
(experimental) Replaces the contents of an npm package.json script.
The script name.
The command to execute.
(experimental) Synthesize all project files into outdir.
(experimental) Finds a file at the specified relative path within this project and all its subprojects.
The file path.
a FileBase or undefined if there is no file in that path
(deprecated) Finds a json file by name.
The file path.
(experimental) Finds an object file (like JsonFile, YamlFile, etc.) by name.
The file path.
Generated using TypeDoc
(experimental) Indicates if workflows have anti-tamper checks.