{ "author": { "email": "aws-cdk-dev@amazon.com", "name": "Amazon Web Services", "organization": true, "roles": [ "author" ] }, "bundled": { "yaml": "^2.8.3" }, "dependencies": { "constructs": "^10.0.0", "projen": ">=0.99.48 <1.0.0" }, "dependencyClosure": { "constructs": { "targets": { "dotnet": { "namespace": "Constructs", "packageId": "Constructs" }, "go": { "moduleName": "github.com/aws/constructs-go" }, "java": { "maven": { "artifactId": "constructs", "groupId": "software.constructs" }, "package": "software.constructs" }, "js": { "npm": "constructs" }, "python": { "distName": "constructs", "module": "constructs" } } }, "projen": { "submodules": { "projen.awscdk": {}, "projen.build": {}, "projen.cdk": {}, "projen.cdk8s": {}, "projen.cdktf": {}, "projen.circleci": {}, "projen.github": {}, "projen.github.workflows": {}, "projen.gitlab": {}, "projen.java": {}, "projen.javascript": {}, "projen.javascript.biome_config": {}, "projen.python": {}, "projen.python.uvConfig": {}, "projen.release": {}, "projen.typescript": {}, "projen.vscode": {}, "projen.web": {} }, "targets": { "go": { "moduleName": "github.com/projen/projen-go" }, "java": { "maven": { "artifactId": "projen", "groupId": "io.github.cdklabs" }, "package": "io.github.cdklabs.projen" }, "js": { "npm": "projen" }, "python": { "distName": "projen", "module": "projen" } } } }, "description": "cdklabs-projen-project-types", "docs": { "stability": "stable" }, "homepage": "https://github.com/cdklabs/cdklabs-projen-project-types.git", "jsiiVersion": "5.9.36 (build 27873df)", "license": "Apache-2.0", "metadata": { "jsii": { "pacmak": { "hasDefaultInterfaces": true } }, "tscRootDir": "src" }, "name": "cdklabs-projen-project-types", "readme": { "markdown": "# Cdklabs Projen Project Types\n\nThis repository stores custom project types extended from `projen` with cdklabs defaults\nbaked in. This is meant to serve as a hook for continuous management of all repos we own.\nWith cdklabs projen types, we can add new configuration as they come up and have it\npropagate to all repositories using the type.\n\n## CdklabsConstructLibrary\n\nThis type extends projen's `awscdk.AwsConstructLibrary` project type and should be used in place\nof that type.\n\n### Usage\n\nFrom the command line:\n\n```bash\nnpx projen new --from cdklabs-projen-project-types cdklabs-construct-lib\n```\n\nFrom inside `cdk-ops`:\n\n```ts\nthis.cdklabs.addPreApprovedRepo({\n repo: 'cdk-new-lib',\n owner: 'conroyka@amazon.com',\n createWith: {\n projectType: ProjectType.CDKLABS_MANAGED_CONSTRUCT_LIB,\n },\n});\n```\n\n### Features\n\n- `cdklabsPublishingDefaults`\n\nBy default, this is turned on. `cdklabsPublishingDefaults` provides publishing defaults based off\nof the project's name. Specifically, the defaults look like this:\n\n```ts\nreturn {\n publishToPypi: {\n distName: npmPackageName,\n module: changeDelimiter(npmPackageName, '_'),\n },\n publishToMaven: {\n javaPackage: `io.github.cdklabs.${changeDelimiter(npmPackageName, '.')}`,\n mavenGroupId: 'io.github.cdklabs',\n mavenArtifactId: npmPackageName,\n mavenEndpoint: 'https://s01.oss.sonatype.org',\n },\n publishToNuget: {\n dotNetNamespace: `Cdklabs${upperCaseName(npmPackageName)}`,\n packageId: `Cdklabs${upperCaseName(npmPackageName)}`,\n },\n publishToGo: {\n moduleName: `${npmPackageName}-go`,\n },\n};\n```\n\nAdditionally, we also require that we publish to all jsii language targets (including go) when\nwe specify a library as `stable`.\n\n- `private`\n\nBy default, a project is created as `private`. Turning this off simply means setting `private: false`.\nA project being `private` means it gets certain properties set as default that are true for private\nprojects. Today, that means setting `private: true` in `package.json`, removing `.mergify.yml` from\nthe project, and removing `.npmignore`.\n\n- `releasableCommits`\n\nBy default this project type releases `ReleasableCommits.featuresAndFixes`, to not release a new\nversion every day on a package that only sees devDependency updates. You may want to override this\nif you need something more specific.\n\n## CdklabsTypeScriptProject\n\nThis type extends projen's `typescript.TypeScriptProject` project type and should be used in place\nof that type.\n\n### Usage\n\n```bash\nnpx projen new --from cdklabs-projen-project-types cdklabs-ts-proj\n```\n\nFrom inside `cdk-ops`:\n\n```ts\nthis.cdklabs.addPreApprovedRepo({\n repo: 'cdk-new-lib',\n owner: 'conroyka@amazon.com',\n createWith: {\n projectType: ProjectType.CDKLABS_MANAGED_TS_PROJECT,\n },\n});\n```\n\n### Features\n\n- `private`\n\nBy default, a project is created as `private`. Turning this off simply means setting `private: false`.\nA project being `private` means it gets certain properties set as default that are true for private\nprojects. Today, that means setting `private: true` in `package.json`, removing `.mergify.yml` from\nthe project, and removing `.npmignore`.\n\n## CdklabsMonorepo\n\nA TypeScript monorepo using Yarn Workspaces.\nIndividual workspaces can be added with `yarn.TypeScriptWorkspace` which extends projen's `typescript.TypeScriptProject`.\n\n### Usage\n\n```bash\nnpx projen new --from cdklabs-projen-project-types cdklabs-yarn-monorepo\n```\n\n### Features\n\n```ts\nconst project = new yarn.CdkLabsMonorepo({\n defaultReleaseBranch: \"main\",\n devDeps: [\"cdklabs-projen-project-types\"],\n name: \"monorepo\",\n});\n```\n\n- Workspace commands: `projen build|compile|package|test|upgrade`\\\nWill run the specific command in all workspaces and the root if applicable.\n\n- Workspace run: `projen run `\\\nExecutes the given command in all workspaces\n\n- Automatic dependency installation\\\nThe monorepo will know if a dependency has been added for a workspace and run `yarn install` as part of `projen`\n\n- `projen` at any level\\\nThe default `projen` command can be run in any workspace and will execute the monorepo synth command.\n\n- Release\\\nThis feature is not supported at this time.\nAny release functionality must be implemented.\n\n- `vscodeWorkspace: boolean`\\\nYou can specify if a VSCode Workspace file should be created for the monorepo.\n\n#### Workspaces\n\n```ts\nnew yarn.TypeScriptWorkspace({\n parent: project,\n name: 'workspace'\n})\n```\n\n- `parent: yarn.Monorepo`\\\nWorkspaces (aka subprojects) must be added using the `parent` option.\n\n- `workspaceScope: string`\\\nThe location the workspace is placed at. Defaults to `./packages`\n\n- `excludeDepsFromUpgrade: Array`\\\nList any dependencies that should not be updated in the workspace.\n\n\n" }, "repository": { "type": "git", "url": "https://github.com/cdklabs/cdklabs-projen-project-types.git" }, "schema": "jsii/0.10.0", "submodules": { "cdklabs-projen-project-types.yarn": { "locationInModule": { "filename": "src/index.ts", "line": 10 }, "symbolId": "src/yarn/index:" } }, "targets": { "js": { "npm": "cdklabs-projen-project-types" } }, "types": { "cdklabs-projen-project-types.CdkCommonOptions": { "assembly": "cdklabs-projen-project-types", "datatype": true, "docs": { "stability": "stable", "summary": "CdkCommonOptions." }, "fqn": "cdklabs-projen-project-types.CdkCommonOptions", "kind": "interface", "locationInModule": { "filename": "src/cdk-common-options.ts", "line": 8 }, "name": "CdkCommonOptions", "properties": [ { "abstract": true, "docs": { "default": "- true for private projects, false otherwise", "remarks": "This will enable the auto merge workflow as well as the merge queue", "stability": "stable", "summary": "Whether to enable the auto merge workflow for PRs." }, "immutable": true, "locationInModule": { "filename": "src/cdk-common-options.ts", "line": 14 }, "name": "enablePRAutoMerge", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "remarks": "That is the workflow that turns on auto merge on all PRs.", "stability": "stable", "summary": "Options for the GitHub auto merge workflow." }, "immutable": true, "locationInModule": { "filename": "src/cdk-common-options.ts", "line": 20 }, "name": "ghAutoMergeOptions", "optional": true, "type": { "fqn": "projen.github.AutoQueueOptions" } }, { "abstract": true, "docs": { "default": "true", "remarks": "Setting this variable to true means that your project is created with sane defaults for private repositories.", "stability": "stable", "summary": "Whether or not this package is private." }, "immutable": true, "locationInModule": { "filename": "src/cdk-common-options.ts", "line": 26 }, "name": "private", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Set a minimal node version via the engines field Set this to `false` if a package did not enforce this previously and we don't want to change this for now." }, "immutable": true, "locationInModule": { "filename": "src/cdk-common-options.ts", "line": 32 }, "name": "setNodeEngineVersion", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- Auto detected from package name", "stability": "stable", "summary": "The organization this project is part of." }, "immutable": true, "locationInModule": { "filename": "src/cdk-common-options.ts", "line": 37 }, "name": "tenancy", "optional": true, "type": { "fqn": "cdklabs-projen-project-types.OrgTenancy" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Whether to enable the separate workflow to upgrade the cdklabs-projen-project-types dependencies." }, "immutable": true, "locationInModule": { "filename": "src/cdk-common-options.ts", "line": 42 }, "name": "upgradeCdklabsProjenProjectTypes", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Whether to have a separate workflow to upgrade runtime deps and mark this PR as fix." }, "immutable": true, "locationInModule": { "filename": "src/cdk-common-options.ts", "line": 47 }, "name": "upgradeRuntimeDepsAsFix", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/cdk-common-options:CdkCommonOptions" }, "cdklabs-projen-project-types.CdkConstructLibrary": { "assembly": "cdklabs-projen-project-types", "base": "projen.awscdk.AwsCdkConstructLibrary", "docs": { "custom": { "pjid": "cdk-construct-lib" }, "stability": "stable", "summary": "Create a Cdk Construct Library Project." }, "fqn": "cdklabs-projen-project-types.CdkConstructLibrary", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/cdk.ts", "line": 34 }, "parameters": [ { "name": "options", "type": { "fqn": "cdklabs-projen-project-types.CdkConstructLibraryOptions" } } ] }, "kind": "class", "locationInModule": { "filename": "src/cdk.ts", "line": 14 }, "name": "CdkConstructLibrary", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/cdk.ts", "line": 32 }, "name": "private", "type": { "primitive": "boolean" } } ], "symbolId": "src/cdk:CdkConstructLibrary" }, "cdklabs-projen-project-types.CdkConstructLibraryOptions": { "assembly": "cdklabs-projen-project-types", "datatype": true, "docs": { "stability": "stable", "summary": "CdkConstructLibraryOptions." }, "fqn": "cdklabs-projen-project-types.CdkConstructLibraryOptions", "kind": "interface", "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 8 }, "name": "CdkConstructLibraryOptions", "properties": [ { "abstract": true, "docs": { "default": "$GIT_USER_NAME", "stability": "stable", "summary": "The name of the library author." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 43 }, "name": "author", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "$GIT_USER_EMAIL", "stability": "stable", "summary": "Email or URL of the library author." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 48 }, "name": "authorAddress", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\"2.189.1\"", "stability": "stable", "summary": "Minimum version of the AWS CDK to depend on." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 226 }, "name": "cdkVersion", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\"main\"", "stability": "stable", "summary": "The name of the main release branch." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 302 }, "name": "defaultReleaseBranch", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "$BASEDIR", "stability": "stable", "summary": "This is the name of your project." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 625 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 13 }, "name": "addPackageManagerToDevEngines", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "true", "remarks": "This is normally only allowed for libraries. For apps, there's no meaning\nfor specifying these.", "stability": "stable", "summary": "Allow the project to include `peerDependencies` and `bundledDependencies`." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 20 }, "name": "allowLibraryDependencies", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "\"dist\"", "stability": "stable", "summary": "A directory which will contain build artifacts." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 25 }, "name": "artifactsDirectory", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "remarks": "When enabled, creates an \"audit\" task that checks for known security vulnerabilities\nin dependencies. By default, runs during every build and checks for \"high\" severity\nvulnerabilities or above in all dependencies (including dev dependencies).", "stability": "stable", "summary": "Run security audit on dependencies." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 33 }, "name": "auditDeps", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Security audit options." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 38 }, "name": "auditDepsOptions", "optional": true, "type": { "fqn": "projen.javascript.AuditOptions" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Author's e-mail." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 52 }, "name": "authorEmail", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Author's name." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 56 }, "name": "authorName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Is the author an organization." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 60 }, "name": "authorOrganization", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Author's URL / Website." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 64 }, "name": "authorUrl", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- auto approve is disabled", "stability": "stable", "summary": "Enable and configure the 'auto approve' workflow." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 69 }, "name": "autoApproveOptions", "optional": true, "type": { "fqn": "projen.github.AutoApproveOptions" } }, { "abstract": true, "docs": { "default": "- true", "remarks": "Throw if set to true but `autoApproveOptions` are not defined.", "stability": "stable", "summary": "Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured)." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 75 }, "name": "autoApproveUpgrades", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 80 }, "name": "autoDetectBin", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "true", "remarks": "Has no effect if `github.mergify`\nis set to false.", "stability": "stable", "summary": "Enable automatic merging on GitHub." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 87 }, "name": "autoMerge", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- see defaults in `AutoMergeOptions`", "remarks": "Has no effect if\n`github.mergify` or `autoMerge` is set to false.", "stability": "stable", "summary": "Configure options for automatic merging on GitHub." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 94 }, "name": "autoMergeOptions", "optional": true, "type": { "fqn": "projen.github.AutoMergeOptions" } }, { "abstract": true, "docs": { "remarks": "You can use this option to add/customize how binaries are represented in\nyour `package.json`, but unless `autoDetectBin` is `false`, every\nexecutable file under `bin` will automatically be added to this section.", "stability": "stable", "summary": "Binary programs vended with your module." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 101 }, "name": "bin", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Setup Biome." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 106 }, "name": "biome", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Biome options." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 111 }, "name": "biomeOptions", "optional": true, "type": { "fqn": "projen.javascript.BiomeOptions" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The email address to which issues should be reported." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 115 }, "name": "bugsEmail", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The url to your project's issue tracker." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 119 }, "name": "bugsUrl", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- true if not a subproject", "stability": "stable", "summary": "Define a GitHub workflow for building PRs." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 124 }, "name": "buildWorkflow", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Options for PR build workflow." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 128 }, "name": "buildWorkflowOptions", "optional": true, "type": { "fqn": "projen.javascript.BuildWorkflowOptions" } }, { "abstract": true, "docs": { "default": "\"{ pullRequest: {}, workflowDispatch: {} }\"", "deprecated": "- Use `buildWorkflowOptions.workflowTriggers`", "stability": "deprecated", "summary": "Build workflow triggers." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 134 }, "name": "buildWorkflowTriggers", "optional": true, "type": { "fqn": "projen.github.workflows.Triggers" } }, { "abstract": true, "docs": { "default": "- A recent version of \"commit-and-tag-version\"", "remarks": "This can be any compatible package version, including the deprecated `standard-version@9`.", "stability": "stable", "summary": "The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 140 }, "name": "bumpPackage", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "These modules will be\nadded both to the `dependencies` section and `bundledDependencies` section of\nyour `package.json`.\n\nThe recommendation is to only specify the module name here (e.g.\n`express`). This will behave similar to `pnpm add` or `npm install` in the\nsense that it will add the module as a dependency to your `package.json`\nfile with the latest version (`^`). You can specify semver requirements in\nthe same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and\nthis will be what your `package.json` will eventually include.", "stability": "stable", "summary": "List of dependencies to bundle into this module." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 154 }, "name": "bundledDeps", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Options for `Bundler`." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 158 }, "name": "bundlerOptions", "optional": true, "type": { "fqn": "projen.javascript.BundlerOptions" } }, { "abstract": true, "docs": { "default": "\"latest\"", "stability": "stable", "summary": "The version of Bun to use if using Bun as a package manager." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 163 }, "name": "bunVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- new version will be announced", "remarks": "https://awscdk.io/packages/[@SCOPE/]PACKAGE@VERSION\n\nThe catalog will also post a tweet to https://twitter.com/awscdkio with the\npackage name, description and the above link. You can disable these tweets\nthrough `{ announce: false }`.\n\nYou can also add a Twitter handle through `{ twitter: 'xx' }` which will be\nmentioned in the tweet.", "stability": "stable", "summary": "Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 176 }, "name": "catalog", "optional": true, "type": { "fqn": "projen.cdk.Catalog" } }, { "abstract": true, "docs": { "default": "- will be included by default for AWS CDK >= 1.0.0 < 2.0.0", "deprecated": "The", "remarks": "Install the", "stability": "deprecated", "summary": "Warning: NodeJS only." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 183 }, "name": "cdkAssert", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- will be included by default for AWS CDK >= 1.111.0 < 2.0.0", "remarks": "Only needed for CDK 1.x. If using CDK 2.x then\nassertions is already included in 'aws-cdk-lib'", "stability": "stable", "summary": "Install the assertions library?" }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 190 }, "name": "cdkAssertions", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "\"^2\"", "remarks": "Can be either a specific version, or an NPM version range.\n\nBy default, the latest 2.x version will be installed; you can use this\noption to restrict it to a specific version or version range.", "stability": "stable", "summary": "Version range of the AWS CDK CLI to depend on." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 199 }, "name": "cdkCliVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "deprecated": "For CDK 2.x use \"deps\" instead. (or \"peerDeps\" if you're building a library)", "stability": "deprecated", "summary": "Which AWS CDKv1 modules this project requires." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 204 }, "name": "cdkDependencies", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "true", "deprecated": "Not supported in CDK v2.", "remarks": "This is to ensure that downstream consumers actually have your CDK dependencies installed\nwhen using npm < 7 or yarn, where peer dependencies are not automatically installed.\nIf this is disabled, `cdkDependencies` will be added to `devDependencies` to ensure\nthey are present during development.\n\nNote: this setting only applies to construct library projects", "stability": "deprecated", "summary": "If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`)." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 216 }, "name": "cdkDependenciesAsDeps", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "deprecated": "For CDK 2.x use 'devDeps' (in node.js projects) or 'testDeps' (in java projects) instead", "stability": "deprecated", "summary": "AWS CDK modules required for testing." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 221 }, "name": "cdkTestDependencies", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "remarks": "You can use this to prevent mixed versions for your CDK dependencies and to prevent auto-updates.\nIf you use experimental features this will let you define the moment you include breaking changes.", "stability": "stable", "summary": "Use pinned version instead of caret version for CDK." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 232 }, "name": "cdkVersionPinning", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- no license checks are run during the build and all licenses will be accepted", "remarks": "This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered.", "stability": "stable", "summary": "Configure which licenses should be deemed acceptable for use by dependencies." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 238 }, "name": "checkLicenses", "optional": true, "type": { "fqn": "projen.javascript.LicenseCheckerOptions" } }, { "abstract": true, "docs": { "default": "- true, but false for subprojects", "stability": "stable", "summary": "Add a `clobber` task which resets the repo to origin." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 243 }, "name": "clobber", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- undefined", "remarks": "This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact", "stability": "stable", "summary": "Options for npm packages using AWS CodeArtifact." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 249 }, "name": "codeArtifactOptions", "optional": true, "type": { "fqn": "projen.javascript.CodeArtifactOptions" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 254 }, "name": "codeCov", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- OIDC auth is used", "stability": "stable", "summary": "Define the secret name for a specified https://codecov.io/ token." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 259 }, "name": "codeCovTokenSecret", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Whether to commit the managed files by default." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 264 }, "name": "commitGenerated", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "- You can manually run compatibility tests using `yarn compat` if this feature is disabled.\n- You can ignore compatibility failures by adding lines to a \".compatignore\" file.", "stability": "stable", "summary": "Automatically run API compatibility test against the latest version published to npm after compilation." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 271 }, "name": "compat", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "\".compatignore\"", "stability": "stable", "summary": "Name of the ignore file for API compatibility tests." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 276 }, "name": "compatIgnore", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Emit a compressed version of the assembly." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 281 }, "name": "compressAssembly", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- for CDK 1.x the default is \"3.2.27\", for CDK 2.x the default is\n\"10.5.1\".", "stability": "stable", "summary": "Minimum version of the `constructs` library to depend on." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 287 }, "name": "constructsVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- defaults to the value of authorName or \"\" if `authorName` is undefined.", "stability": "stable", "summary": "License copyright owner." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 292 }, "name": "copyrightOwner", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- current year", "stability": "stable", "summary": "The copyright years to put in the LICENSE file." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 297 }, "name": "copyrightPeriod", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "remarks": "Only triggered when the lockfile for the configured package\nmanager already exists.\n\nThis is useful when migrating between package managers to avoid conflicts.", "stability": "stable", "summary": "Automatically delete lockfiles from package managers that are not the active one." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 311 }, "name": "deleteOrphanedLockFiles", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "Cannot be used in conjunction with `depsUpgrade`.", "stability": "stable", "summary": "Use dependabot to handle dependency upgrades." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 317 }, "name": "dependabot", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Options for dependabot." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 322 }, "name": "dependabotOptions", "optional": true, "type": { "fqn": "projen.github.DependabotOptions" } }, { "abstract": true, "docs": { "default": "[]", "remarks": "The recommendation is to only specify the module name here (e.g.\n`express`). This will behave similar to `pnpm add` or `npm install` in the\nsense that it will add the module as a dependency to your `package.json`\nfile with the latest version (`^`). You can specify semver requirements in\nthe same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and\nthis will be what your `package.json` will eventually include.", "stability": "stable", "summary": "Runtime dependencies of this module." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 333 }, "name": "deps", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- `true` for root projects, `false` for subprojects", "remarks": "Cannot be used in conjunction with `dependabot`.", "stability": "stable", "summary": "Use tasks and github workflows to handle dependency upgrades." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 339 }, "name": "depsUpgrade", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Options for `UpgradeDependencies`." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 344 }, "name": "depsUpgradeOptions", "optional": true, "type": { "fqn": "projen.javascript.UpgradeDependenciesOptions" } }, { "abstract": true, "docs": { "remarks": "It can be used when searching for packages in a package manager as well.\nSee https://classic.yarnpkg.com/en/docs/package-json/#toc-description", "stability": "stable", "summary": "The description is just a string that helps people understand the purpose of the package." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 350 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Add a VSCode development environment (used for GitHub Codespaces)." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 355 }, "name": "devContainer", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "[]", "remarks": "These dependencies will only be\navailable in your build environment but will not be fetched when this\nmodule is consumed.\n\nThe recommendation is to only specify the module name here (e.g.\n`express`). This will behave similar to `pnpm add` or `npm install` in the\nsense that it will add the module as a dependency to your `package.json`\nfile with the latest version (`^`). You can specify semver requirements in\nthe same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and\nthis will be what your `package.json` will eventually include.", "stability": "stable", "summary": "Build dependencies for this module." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 370 }, "name": "devDeps", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 377 }, "name": "devEngines", "optional": true, "type": { "fqn": "projen.javascript.DevEngines" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler)." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 382 }, "name": "disableTsconfig", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Do not generate a `tsconfig.dev.json` file." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 387 }, "name": "disableTsconfigDev", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Docgen by Typedoc." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 392 }, "name": "docgen", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "\"API.md\"", "stability": "stable", "summary": "File path for generated docs." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 397 }, "name": "docgenFilePath", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\"docs\"", "stability": "stable", "summary": "Docs directory." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 402 }, "name": "docsDirectory", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "deprecated": "use `publishToNuget`", "stability": "deprecated" }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 406 }, "name": "dotnet", "optional": true, "type": { "fqn": "projen.cdk.JsiiDotNetTarget" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Automatically adds an `cloudfront.experimental.EdgeFunction` for each `.edge-lambda.ts` handler in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 411 }, "name": "edgeLambdaAutoDiscover", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- true for private projects, false otherwise", "remarks": "This will enable the auto merge workflow as well as the merge queue", "stability": "stable", "summary": "Whether to enable the auto merge workflow for PRs." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 417 }, "name": "enablePRAutoMerge", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "\"lib/index.js\"", "stability": "stable", "summary": "Module entrypoint (`main` in `package.json`). Set to an empty string to not include `main` in your package.json." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 423 }, "name": "entrypoint", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)", "stability": "stable", "summary": "The .d.ts file that includes the type declarations for this module." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 428 }, "name": "entrypointTypes", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- true, unless biome is enabled", "stability": "stable", "summary": "Setup eslint." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 433 }, "name": "eslint", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- opinionated default options", "stability": "stable", "summary": "Eslint options." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 438 }, "name": "eslintOptions", "optional": true, "type": { "fqn": "projen.javascript.EslintOptions" } }, { "abstract": true, "docs": { "remarks": "By default, jsii will include all *.ts files (except .d.ts files) in the TypeScript compiler input.\nThis can be problematic for example when the package's build or test procedure generates .ts files\nthat cannot be compiled with jsii's compiler settings.", "stability": "stable", "summary": "Accepts a list of glob patterns. Files matching any of those patterns will be excluded from the TypeScript compiler input." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 447 }, "name": "excludeTypescript", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Enable experimental support for the AWS CDK integ-runner." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 452 }, "name": "experimentalIntegRunner", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "remarks": "That is the workflow that turns on auto merge on all PRs.", "stability": "stable", "summary": "Options for the GitHub auto merge workflow." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 458 }, "name": "ghAutoMergeOptions", "optional": true, "type": { "fqn": "projen.github.AutoQueueOptions" } }, { "abstract": true, "docs": { "default": "true", "remarks": "Enabled by default for root projects. Disabled for non-root projects.", "stability": "stable", "summary": "Enable GitHub integration." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 464 }, "name": "github", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- see GitHubOptions", "stability": "stable", "summary": "Options for GitHub integration." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 469 }, "name": "githubOptions", "optional": true, "type": { "fqn": "projen.github.GitHubOptions" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Additional entries to .gitignore." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 473 }, "name": "gitignore", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Configuration options for .gitignore file." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 477 }, "name": "gitIgnoreOptions", "optional": true, "type": { "fqn": "projen.IgnoreFileOptions" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Configuration options for git." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 481 }, "name": "gitOptions", "optional": true, "type": { "fqn": "projen.GitOptions" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Add a Gitpod development environment." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 486 }, "name": "gitpod", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Package's Homepage / Website." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 490 }, "name": "homepage", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Automatically discovers and creates integration tests for each `.integ.ts` file under your test directory." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 495 }, "name": "integrationTestAutoDiscover", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Setup jest unit tests." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 500 }, "name": "jest", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Jest options." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 505 }, "name": "jestOptions", "optional": true, "type": { "fqn": "projen.javascript.JestOptions" } }, { "abstract": true, "docs": { "default": "\"latest\"", "stability": "stable", "summary": "Version requirement of `publib` which is used to publish modules to npm." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 510 }, "name": "jsiiReleaseVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\"~5.9.0\"", "remarks": "Set to \"*\" if you want to manually manage the version of jsii in your\nproject by managing updates to `package.json` on your own.\n\nNOTE: The jsii compiler releases since 5.0.0 are not semantically versioned\nand should remain on the same minor, so we recommend using a `~` dependency\n(e.g. `~5.0.0`).", "stability": "stable", "summary": "Version of the jsii compiler to use." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 521 }, "name": "jsiiVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Keywords to include in `package.json`." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 525 }, "name": "keywords", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Automatically adds an `aws_lambda.Function` for each `.lambda.ts` handler in your source tree. If this is disabled, you either need to explicitly call `aws_lambda.Function.autoDiscover()` or define a `new aws_lambda.Function()` for each handler." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 530 }, "name": "lambdaAutoDiscover", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Automatically adds an `awscdk.LambdaExtension` for each `.lambda-extension.ts` entrypoint in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 535 }, "name": "lambdaExtensionAutoDiscover", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Common options for all AWS Lambda functions." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 540 }, "name": "lambdaOptions", "optional": true, "type": { "fqn": "projen.awscdk.LambdaFunctionCommonOptions" } }, { "abstract": true, "docs": { "default": "\"lib\"", "stability": "stable", "summary": "Typescript artifacts output directory." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 545 }, "name": "libdir", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\"Apache-2.0\"", "remarks": "See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses.\nUse the `licensed` option if you want to no license to be specified.", "stability": "stable", "summary": "License's SPDX identifier." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 552 }, "name": "license", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Indicates if a license should be added." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 557 }, "name": "licensed", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "{}", "stability": "stable", "summary": "Configure logging options such as verbosity." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 562 }, "name": "logging", "optional": true, "type": { "fqn": "projen.LoggerOptions" } }, { "abstract": true, "docs": { "default": "- Major version is not enforced.", "remarks": "If this is specified, we bump the latest version of this major version line.\nIf not specified, we bump the global latest version.", "stability": "stable", "summary": "Major version to release from the default branch." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 569 }, "name": "majorVersion", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- no maximum version is enforced", "remarks": "Most projects should not use this option.\nThe value indicates that the package is incompatible with any newer versions of node.\nThis requirement is enforced via the engines field.\n\nYou will normally not need to set this option.\nConsider this option only if your package is known to not function with newer versions of node.", "stability": "stable", "summary": "The maximum node version supported by this package." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 579 }, "name": "maxNodeVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "deprecated": "use `githubOptions.mergify` instead", "stability": "deprecated", "summary": "Whether mergify should be enabled on this repository or not." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 585 }, "name": "mergify", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "deprecated": "use `githubOptions.mergifyOptions` instead", "stability": "deprecated", "summary": "Options for mergify." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 591 }, "name": "mergifyOptions", "optional": true, "type": { "fqn": "projen.github.MergifyOptions" } }, { "abstract": true, "docs": { "default": "- No minimum version is being enforced", "remarks": "This can be useful to set to 1, as breaking changes before the 1.x major\nrelease are not incrementing the major version number.\n\nCan not be set together with `majorVersion`.", "stability": "stable", "summary": "Minimal Major version to release." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 600 }, "name": "minMajorVersion", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- no \"engines\" specified", "remarks": "Only set this if your package will not work properly on specific (older?)\nNode versions.", "stability": "stable", "summary": "Minimum Node.js version to require via package.json `engines` (inclusive)." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 609 }, "name": "minNodeVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "deprecated": "- Use `buildWorkflowOptions.mutableBuild`", "remarks": "This means\nthat any files synthesized by projen or e.g. test snapshots will always be up-to-date\nbefore a PR is merged.\n\nImplies that PR builds do not have anti-tamper checks.", "stability": "deprecated", "summary": "Automatically update files modified during builds to pull-request branches." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 620 }, "name": "mutableBuild", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- The next version will be determined based on the commit history and project settings.", "remarks": "If present, this shell command will be run before the bump is executed, and\nit determines what version to release. It will be executed in the following\nenvironment:\n\n- Working directory: the project directory.\n- `$VERSION`: the current version. Looks like `1.2.3`.\n- `$LATEST_TAG`: the most recent tag. Looks like `prefix-v1.2.3`, or may be unset.\n- `$SUGGESTED_BUMP`: the suggested bump action based on commits. One of `major|minor|patch|none`.\n\nThe command should print one of the following to `stdout`:\n\n- Nothing: the next version number will be determined based on commit history.\n- `x.y.z`: the next version number will be `x.y.z`.\n- `major|minor|patch`: the next version number will be the current version number\n with the indicated component bumped.\n\nThis setting cannot be specified together with `minMajorVersion`; the invoked\nscript can be used to achieve the effects of `minMajorVersion`.", "stability": "stable", "summary": "A shell command to control the next version to release." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 648 }, "name": "nextVersionCommand", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- for scoped packages (e.g. `foo@bar`), the default is\n`NpmAccess.RESTRICTED`, for non-scoped packages, the default is\n`NpmAccess.PUBLIC`.", "stability": "stable", "summary": "Access level of the npm package." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 655 }, "name": "npmAccess", "optional": true, "type": { "fqn": "projen.javascript.NpmAccess" } }, { "abstract": true, "docs": { "default": "\"latest\"", "remarks": "To set the npm dist-tag for release branches, set the `npmDistTag` property\nfor each branch.", "stability": "stable", "summary": "The npmDistTag to use when publishing from the default branch." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 662 }, "name": "npmDistTag", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "deprecated": "- use `project.addPackageIgnore`", "stability": "deprecated", "summary": "Additional entries to .npmignore." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 667 }, "name": "npmignore", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 672 }, "name": "npmignoreEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Configuration options for .npmignore file." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 676 }, "name": "npmIgnoreOptions", "optional": true, "type": { "fqn": "projen.IgnoreFileOptions" } }, { "abstract": true, "docs": { "default": "- true for public packages, false otherwise", "remarks": "A supported package manager is required to publish a package with npm provenance statements and\nyou will need to use a supported CI/CD provider.\n\nNote that the projen `Release` and `Publisher` components are using `publib` to publish packages,\nwhich is using npm internally and supports provenance statements independently of the package manager used.", "stability": "stable", "summary": "Should provenance statements be generated when the package is published." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 686 }, "name": "npmProvenance", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "deprecated": "use `npmRegistryUrl` instead", "remarks": "Cannot be set together with `npmRegistryUrl`.", "stability": "deprecated", "summary": "The host name of the npm registry to publish to." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 692 }, "name": "npmRegistry", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\"https://registry.npmjs.org\"", "remarks": "Must be a URL (e.g. start with \"https://\" or \"http://\")", "stability": "stable", "summary": "The base URL of the npm package registry." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 698 }, "name": "npmRegistryUrl", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\"NPM_TOKEN\"", "stability": "stable", "summary": "GitHub secret which contains the NPM token to use when publishing packages." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 703 }, "name": "npmTokenSecret", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- false", "stability": "stable", "summary": "Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 708 }, "name": "npmTrustedPublishing", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "\".\"", "remarks": "If this project has a parent, this directory is relative to the parent\ndirectory and it cannot be the same as the parent or any of it's other\nsubprojects.", "stability": "stable", "summary": "The root directory of the project. Relative to this directory, all files are synthesized." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 718 }, "name": "outdir", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`)." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 723 }, "name": "package", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- Detected from the calling process or `YARN_CLASSIC` if detection fails.", "stability": "stable", "summary": "The Node Package Manager used to execute scripts." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 728 }, "name": "packageManager", "optional": true, "type": { "fqn": "projen.javascript.NodePackageManager" } }, { "abstract": true, "docs": { "default": "- defaults to project name", "stability": "stable", "summary": "The \"name\" in package.json." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 733 }, "name": "packageName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The parent project, if this project is part of a bigger project." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 737 }, "name": "parent", "optional": true, "type": { "fqn": "projen.Project" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Options for `peerDeps`." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 741 }, "name": "peerDependencyOptions", "optional": true, "type": { "fqn": "projen.javascript.PeerDependencyOptions" } }, { "abstract": true, "docs": { "default": "[]", "remarks": "Dependencies listed here are required to\nbe installed (and satisfied) by the _consumer_ of this library. Using peer\ndependencies allows you to ensure that only a single module of a certain\nlibrary exists in the `node_modules` tree of your consumers.\n\nNote that prior to npm@7, peer dependencies are _not_ automatically\ninstalled, which means that adding peer dependencies to a library will be a\nbreaking change for your customers.\n\nUnless `peerDependencyOptions.pinnedDevDependency` is disabled (it is\nenabled by default), projen will automatically add a dev dependency with a\npinned version for each peer dependency. This will ensure that you build &\ntest your module against the lowest peer version required.", "stability": "stable", "summary": "Peer dependencies for this module." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 759 }, "name": "peerDeps", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "\"10.33.0\"", "stability": "stable", "summary": "The version of PNPM to use if using PNPM as a package manager." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 764 }, "name": "pnpmVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "[]", "stability": "stable", "summary": "Steps to execute after build as part of the release workflow." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 769 }, "name": "postBuildSteps", "optional": true, "type": { "collection": { "elementtype": { "fqn": "projen.github.workflows.JobStep" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- normal semantic versions", "stability": "stable", "summary": "Bump versions from the default branch as pre-releases (e.g. \"beta\", \"alpha\", \"pre\")." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 774 }, "name": "prerelease", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Setup prettier." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 779 }, "name": "prettier", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Prettier options." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 784 }, "name": "prettierOptions", "optional": true, "type": { "fqn": "projen.javascript.PrettierOptions" } }, { "abstract": true, "docs": { "default": "true", "remarks": "Setting this variable to true means that your project is created with sane defaults for private repositories.", "stability": "stable", "summary": "Whether or not this package is private." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 790 }, "name": "private", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 795 }, "name": "projectTree", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "ProjectType.UNKNOWN", "deprecated": "no longer supported at the base project level", "stability": "deprecated", "summary": "Which type of project this is (library/app)." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 801 }, "name": "projectType", "optional": true, "type": { "fqn": "projen.ProjectType" } }, { "abstract": true, "docs": { "default": "\"npx projen\"", "remarks": "Can be used to customize in special environments.", "stability": "stable", "summary": "The shell command to use in order to run the projen CLI." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 807 }, "name": "projenCommand", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- use a personal access token named PROJEN_GITHUB_TOKEN", "stability": "stable", "summary": "Choose a method of providing GitHub API access for projen workflows." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 812 }, "name": "projenCredentials", "optional": true, "type": { "fqn": "projen.github.GithubCredentials" } }, { "abstract": true, "docs": { "default": "- true if not a subproject", "stability": "stable", "summary": "Indicates of \"projen\" should be installed as a devDependency." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 817 }, "name": "projenDevDependency", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- true if projenrcJson is false", "stability": "stable", "summary": "Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 822 }, "name": "projenrcJs", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 827 }, "name": "projenrcJson", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Options for .projenrc.json." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 832 }, "name": "projenrcJsonOptions", "optional": true, "type": { "fqn": "projen.ProjenrcJsonOptions" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Options for .projenrc.js." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 837 }, "name": "projenrcJsOptions", "optional": true, "type": { "fqn": "projen.javascript.ProjenrcOptions" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Use TypeScript for your projenrc file (`.projenrc.ts`)." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 842 }, "name": "projenrcTs", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Options for .projenrc.ts." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 846 }, "name": "projenrcTsOptions", "optional": true, "type": { "fqn": "projen.typescript.ProjenrcOptions" } }, { "abstract": true, "docs": { "default": "\"PROJEN_GITHUB_TOKEN\"", "deprecated": "use `projenCredentials`", "remarks": "This token needs to have the `repo`, `workflows`\nand `packages` scope.", "stability": "deprecated", "summary": "The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 854 }, "name": "projenTokenSecret", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- Defaults to the latest version.", "stability": "stable", "summary": "Version of projen to install." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 859 }, "name": "projenVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Instead of actually publishing to package managers, just print the publishing command." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 864 }, "name": "publishDryRun", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "Normally, publishing only happens within automated workflows. Enable this\nin order to create a publishing task for each publishing activity.", "stability": "stable", "summary": "Define publishing tasks that can be executed manually as well as workflows." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 871 }, "name": "publishTasks", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- no publishing", "stability": "stable", "summary": "Publish Go bindings to a git repository." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 876 }, "name": "publishToGo", "optional": true, "type": { "fqn": "projen.cdk.JsiiGoTarget" } }, { "abstract": true, "docs": { "default": "- no publishing", "stability": "stable", "summary": "Publish to maven." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 881 }, "name": "publishToMaven", "optional": true, "type": { "fqn": "projen.cdk.JsiiJavaTarget" } }, { "abstract": true, "docs": { "default": "- no publishing", "stability": "stable", "summary": "Publish to NuGet." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 886 }, "name": "publishToNuget", "optional": true, "type": { "fqn": "projen.cdk.JsiiDotNetTarget" } }, { "abstract": true, "docs": { "default": "- no publishing", "stability": "stable", "summary": "Publish to pypi." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 891 }, "name": "publishToPypi", "optional": true, "type": { "fqn": "projen.cdk.JsiiPythonTarget" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Include a GitHub pull request template." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 896 }, "name": "pullRequestTemplate", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default content", "stability": "stable", "summary": "The contents of the pull request template." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 901 }, "name": "pullRequestTemplateContents", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "deprecated": "use `publishToPyPi`", "stability": "deprecated" }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 905 }, "name": "python", "optional": true, "type": { "fqn": "projen.cdk.JsiiPythonTarget" } }, { "abstract": true, "docs": { "default": "- { filename: 'README.md', contents: '# replace this' }", "stability": "stable", "summary": "The README setup." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 910 }, "name": "readme", "optional": true, "type": { "fqn": "projen.SampleReadmeProps" } }, { "abstract": true, "docs": { "default": "ReleasableCommits.everyCommit()", "stability": "stable", "summary": "Find commits that should be considered releasable Used to decide if a release is required." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 915 }, "name": "releasableCommits", "optional": true, "type": { "fqn": "projen.ReleasableCommits" } }, { "abstract": true, "docs": { "default": "- true (false for subprojects)", "stability": "stable", "summary": "Add release management to this project." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 920 }, "name": "release", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- no additional branches are used for release. you can use\n`addBranch()` to add additional branches.", "remarks": "A workflow will be created for each\nrelease branch which will publish releases from commits in this branch.\nEach release branch _must_ be assigned a major version number which is used\nto enforce that versions published from that branch always use that major\nversion. If multiple branches are used, the `majorVersion` field must also\nbe provided for the default branch.", "stability": "stable", "summary": "Defines additional release branches." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 932 }, "name": "releaseBranches", "optional": true, "type": { "collection": { "elementtype": { "fqn": "projen.release.BranchOptions" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- no environment used, unless set at the artifact level", "remarks": "This can be used to add an explicit approval step to the release\nor limit who can initiate a release through environment protection rules.\n\nWhen multiple artifacts are released, the environment can be overwritten\non a per artifact basis.", "stability": "stable", "summary": "The GitHub Actions environment used for the release." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 942 }, "name": "releaseEnvironment", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "deprecated": "Use `releaseTrigger: ReleaseTrigger.continuous()` instead", "stability": "deprecated", "summary": "Automatically release new versions every commit to one of branches in `releaseBranches`." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 948 }, "name": "releaseEveryCommit", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Create a github issue on every failed publishing task." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 953 }, "name": "releaseFailureIssue", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "\"failed-release\"", "remarks": "Only applies if `releaseFailureIssue` is true.", "stability": "stable", "summary": "The label to apply to issues indicating publish failures." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 959 }, "name": "releaseFailureIssueLabel", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no scheduled releases", "deprecated": "Use `releaseTrigger: ReleaseTrigger.scheduled()` instead", "stability": "deprecated", "summary": "CRON schedule to trigger new releases." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 965 }, "name": "releaseSchedule", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\"v\"", "remarks": "Useful if you are releasing on multiple branches with overlapping version numbers.\nNote: this prefix is used to detect the latest tagged version\nwhen bumping, so if you change this on a project with an existing version\nhistory, you may need to manually tag your latest release\nwith the new prefix.", "stability": "stable", "summary": "Automatically add the given prefix to release tags." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 974 }, "name": "releaseTagPrefix", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Automatically release to npm when new versions are introduced." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 979 }, "name": "releaseToNpm", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- Continuous releases (`ReleaseTrigger.continuous()`)", "stability": "stable", "summary": "The release trigger to use." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 984 }, "name": "releaseTrigger", "optional": true, "type": { "fqn": "projen.release.ReleaseTrigger" } }, { "abstract": true, "docs": { "default": "- true if not a subproject", "deprecated": "see `release`.", "stability": "deprecated", "summary": "DEPRECATED: renamed to `release`." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 990 }, "name": "releaseWorkflow", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "{}", "stability": "stable", "summary": "Build environment variables for release workflows." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 995 }, "name": "releaseWorkflowEnv", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "\"release\"", "stability": "stable", "summary": "The name of the default release workflow." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1000 }, "name": "releaseWorkflowName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "A set of workflow steps to execute in order to setup the workflow container." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1004 }, "name": "releaseWorkflowSetupSteps", "optional": true, "type": { "collection": { "elementtype": { "fqn": "projen.github.workflows.JobStep" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Use renovatebot to handle dependency upgrades." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1009 }, "name": "renovatebot", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Options for renovatebot." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1014 }, "name": "renovatebotOptions", "optional": true, "type": { "fqn": "projen.RenovatebotOptions" } }, { "abstract": true, "docs": { "default": "- generated from org tenancy and package name", "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1018 }, "name": "repository", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1022 }, "name": "repositoryDirectory", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- generated from org tenancy and package name", "deprecated": "use `repository`", "stability": "deprecated" }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1027 }, "name": "repositoryUrl", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\".\"", "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1031 }, "name": "rootdir", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Options for rosetta:extract task." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1035 }, "name": "rosettaOptions", "optional": true, "type": { "fqn": "cdklabs-projen-project-types.RosettaOptions" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Generate one-time sample in `src/` and `test/` if there are no files there." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1040 }, "name": "sampleCode", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- fetch all scoped packages from the public npm registry", "stability": "stable", "summary": "Options for privately hosted scoped packages." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1045 }, "name": "scopedPackagesOptions", "optional": true, "type": { "collection": { "elementtype": { "fqn": "projen.javascript.ScopedPackagesOptions" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "{}", "deprecated": "use `project.addTask()` or `package.setScript()`", "remarks": "If a script has the same name as a standard script,\nthe standard script will be overwritten.\nAlso adds the script as a task.", "stability": "deprecated", "summary": "npm scripts to include." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1054 }, "name": "scripts", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Set a minimal node version via the engines field Set this to `false` if a package did not enforce this previously and we don't want to change this for now." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1060 }, "name": "setNodeEngineVersion", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Automatically adds an `awscdk.SingletonFunction` for each `.singleton-lambda.ts` handler in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1065 }, "name": "singletonLambdaAutoDiscover", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "\"src\"", "stability": "stable", "summary": "Typescript sources directory." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1070 }, "name": "srcdir", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Package's Stability." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1074 }, "name": "stability", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "remarks": "See `staleOptions` for options.", "stability": "stable", "summary": "Auto-close of stale issues and pull request." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1080 }, "name": "stale", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- see defaults in `StaleOptions`", "remarks": "To disable set `stale` to `false`.", "stability": "stable", "summary": "Auto-close stale issues and pull requests." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1086 }, "name": "staleOptions", "optional": true, "type": { "fqn": "projen.github.StaleOptions" } }, { "abstract": true, "docs": { "default": "- Auto detected from package name", "stability": "stable", "summary": "The organization this project is part of." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1091 }, "name": "tenancy", "optional": true, "type": { "fqn": "cdklabs-projen-project-types.OrgTenancy" } }, { "abstract": true, "docs": { "default": "\"test\"", "remarks": "Tests files should be named `xxx.test.ts`.\nIf this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`),\nthen tests are going to be compiled into `lib/` and executed as javascript.\nIf the test directory is outside of `src`, then we configure jest to\ncompile the code in-memory.", "stability": "stable", "summary": "Jest tests directory." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1100 }, "name": "testdir", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Custom TSConfig." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1105 }, "name": "tsconfig", "optional": true, "type": { "fqn": "projen.javascript.TypescriptConfigOptions" } }, { "abstract": true, "docs": { "default": "- use the production tsconfig options", "stability": "stable", "summary": "Custom tsconfig options for the development tsconfig.json file (used for testing)." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1110 }, "name": "tsconfigDev", "optional": true, "type": { "fqn": "projen.javascript.TypescriptConfigOptions" } }, { "abstract": true, "docs": { "default": "\"tsconfig.dev.json\"", "stability": "stable", "summary": "The name of the development tsconfig.json file." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1115 }, "name": "tsconfigDevFile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Options for ts-jest." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1119 }, "name": "tsJestOptions", "optional": true, "type": { "fqn": "projen.typescript.TsJestOptions" } }, { "abstract": true, "docs": { "default": "\"latest\"", "remarks": "NOTE: Typescript is not semantically versioned and should remain on the\nsame minor, so we recommend using a `~` dependency (e.g. `~1.2.3`).", "stability": "stable", "summary": "TypeScript version to use." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1126 }, "name": "typescriptVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Whether to enable the separate workflow to upgrade the cdklabs-projen-project-types dependencies." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1131 }, "name": "upgradeCdklabsProjenProjectTypes", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Whether to have a separate workflow to upgrade runtime deps and mark this PR as fix." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1136 }, "name": "upgradeRuntimeDepsAsFix", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- standard configuration applicable for GitHub repositories", "remarks": "Given values either append to default configuration or overwrite values in it.", "stability": "stable", "summary": "Custom configuration used when creating changelog with commit-and-tag-version package." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1142 }, "name": "versionrcOptions", "optional": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "true", "remarks": "Enabled by default for root projects. Disabled for non-root projects.", "stability": "stable", "summary": "Enable VSCode integration." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1148 }, "name": "vscode", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "\"yarn install --frozen-lockfile && yarn projen\"", "stability": "stable", "summary": "Workflow steps to use in order to bootstrap this repo." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1153 }, "name": "workflowBootstrapSteps", "optional": true, "type": { "collection": { "elementtype": { "fqn": "projen.github.workflows.JobStep" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- default image", "stability": "stable", "summary": "Container image to use for GitHub workflows." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1158 }, "name": "workflowContainerImage", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- default GitHub Actions user", "stability": "stable", "summary": "The git identity to use in workflows." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1163 }, "name": "workflowGitIdentity", "optional": true, "type": { "fqn": "projen.github.GitIdentity" } }, { "abstract": true, "docs": { "default": "'lts/*'", "stability": "stable", "summary": "The node version to use in GitHub workflows." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1168 }, "name": "workflowNodeVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Enable Node.js package cache in GitHub workflows." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1173 }, "name": "workflowPackageCache", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "[\"ubuntu-latest\"]", "stability": "stable", "summary": "Github Runner selection labels." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1178 }, "name": "workflowRunsOn", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Github Runner Group selection options." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1182 }, "name": "workflowRunsOnGroup", "optional": true, "type": { "fqn": "projen.GroupRunnerOptions" } }, { "abstract": true, "docs": { "default": "- Yarn Berry v4 with all default options", "stability": "stable", "summary": "Options for Yarn Berry." }, "immutable": true, "locationInModule": { "filename": "src/cdk-construct-library-options.ts", "line": 1187 }, "name": "yarnBerryOptions", "optional": true, "type": { "fqn": "projen.javascript.YarnBerryOptions" } } ], "symbolId": "src/cdk-construct-library-options:CdkConstructLibraryOptions" }, "cdklabs-projen-project-types.CdkJsiiProject": { "assembly": "cdklabs-projen-project-types", "base": "projen.cdk.JsiiProject", "docs": { "custom": { "pjid": "cdk-jsii-proj" }, "stability": "stable", "summary": "Create a Cdk Jsii Jsii project." }, "fqn": "cdklabs-projen-project-types.CdkJsiiProject", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/jsii.ts", "line": 13 }, "parameters": [ { "name": "options", "type": { "fqn": "cdklabs-projen-project-types.CdkJsiiProjectOptions" } } ] }, "kind": "class", "locationInModule": { "filename": "src/jsii.ts", "line": 10 }, "name": "CdkJsiiProject", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/jsii.ts", "line": 11 }, "name": "private", "type": { "primitive": "boolean" } } ], "symbolId": "src/jsii:CdkJsiiProject" }, "cdklabs-projen-project-types.CdkJsiiProjectOptions": { "assembly": "cdklabs-projen-project-types", "datatype": true, "docs": { "stability": "stable", "summary": "CdkJsiiProjectOptions." }, "fqn": "cdklabs-projen-project-types.CdkJsiiProjectOptions", "kind": "interface", "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 8 }, "name": "CdkJsiiProjectOptions", "properties": [ { "abstract": true, "docs": { "default": "$GIT_USER_NAME", "stability": "stable", "summary": "The name of the library author." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 43 }, "name": "author", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "$GIT_USER_EMAIL", "stability": "stable", "summary": "Email or URL of the library author." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 48 }, "name": "authorAddress", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\"main\"", "stability": "stable", "summary": "The name of the main release branch." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 227 }, "name": "defaultReleaseBranch", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "$BASEDIR", "stability": "stable", "summary": "This is the name of your project." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 525 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 13 }, "name": "addPackageManagerToDevEngines", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "true", "remarks": "This is normally only allowed for libraries. For apps, there's no meaning\nfor specifying these.", "stability": "stable", "summary": "Allow the project to include `peerDependencies` and `bundledDependencies`." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 20 }, "name": "allowLibraryDependencies", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "\"dist\"", "stability": "stable", "summary": "A directory which will contain build artifacts." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 25 }, "name": "artifactsDirectory", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "remarks": "When enabled, creates an \"audit\" task that checks for known security vulnerabilities\nin dependencies. By default, runs during every build and checks for \"high\" severity\nvulnerabilities or above in all dependencies (including dev dependencies).", "stability": "stable", "summary": "Run security audit on dependencies." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 33 }, "name": "auditDeps", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Security audit options." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 38 }, "name": "auditDepsOptions", "optional": true, "type": { "fqn": "projen.javascript.AuditOptions" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Author's e-mail." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 52 }, "name": "authorEmail", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Author's name." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 56 }, "name": "authorName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Is the author an organization." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 60 }, "name": "authorOrganization", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Author's URL / Website." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 64 }, "name": "authorUrl", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- auto approve is disabled", "stability": "stable", "summary": "Enable and configure the 'auto approve' workflow." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 69 }, "name": "autoApproveOptions", "optional": true, "type": { "fqn": "projen.github.AutoApproveOptions" } }, { "abstract": true, "docs": { "default": "- true", "remarks": "Throw if set to true but `autoApproveOptions` are not defined.", "stability": "stable", "summary": "Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured)." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 75 }, "name": "autoApproveUpgrades", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 80 }, "name": "autoDetectBin", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "true", "remarks": "Has no effect if `github.mergify`\nis set to false.", "stability": "stable", "summary": "Enable automatic merging on GitHub." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 87 }, "name": "autoMerge", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- see defaults in `AutoMergeOptions`", "remarks": "Has no effect if\n`github.mergify` or `autoMerge` is set to false.", "stability": "stable", "summary": "Configure options for automatic merging on GitHub." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 94 }, "name": "autoMergeOptions", "optional": true, "type": { "fqn": "projen.github.AutoMergeOptions" } }, { "abstract": true, "docs": { "remarks": "You can use this option to add/customize how binaries are represented in\nyour `package.json`, but unless `autoDetectBin` is `false`, every\nexecutable file under `bin` will automatically be added to this section.", "stability": "stable", "summary": "Binary programs vended with your module." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 101 }, "name": "bin", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Setup Biome." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 106 }, "name": "biome", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Biome options." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 111 }, "name": "biomeOptions", "optional": true, "type": { "fqn": "projen.javascript.BiomeOptions" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The email address to which issues should be reported." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 115 }, "name": "bugsEmail", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The url to your project's issue tracker." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 119 }, "name": "bugsUrl", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- true if not a subproject", "stability": "stable", "summary": "Define a GitHub workflow for building PRs." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 124 }, "name": "buildWorkflow", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Options for PR build workflow." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 128 }, "name": "buildWorkflowOptions", "optional": true, "type": { "fqn": "projen.javascript.BuildWorkflowOptions" } }, { "abstract": true, "docs": { "default": "\"{ pullRequest: {}, workflowDispatch: {} }\"", "deprecated": "- Use `buildWorkflowOptions.workflowTriggers`", "stability": "deprecated", "summary": "Build workflow triggers." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 134 }, "name": "buildWorkflowTriggers", "optional": true, "type": { "fqn": "projen.github.workflows.Triggers" } }, { "abstract": true, "docs": { "default": "- A recent version of \"commit-and-tag-version\"", "remarks": "This can be any compatible package version, including the deprecated `standard-version@9`.", "stability": "stable", "summary": "The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 140 }, "name": "bumpPackage", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "These modules will be\nadded both to the `dependencies` section and `bundledDependencies` section of\nyour `package.json`.\n\nThe recommendation is to only specify the module name here (e.g.\n`express`). This will behave similar to `pnpm add` or `npm install` in the\nsense that it will add the module as a dependency to your `package.json`\nfile with the latest version (`^`). You can specify semver requirements in\nthe same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and\nthis will be what your `package.json` will eventually include.", "stability": "stable", "summary": "List of dependencies to bundle into this module." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 154 }, "name": "bundledDeps", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Options for `Bundler`." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 158 }, "name": "bundlerOptions", "optional": true, "type": { "fqn": "projen.javascript.BundlerOptions" } }, { "abstract": true, "docs": { "default": "\"latest\"", "stability": "stable", "summary": "The version of Bun to use if using Bun as a package manager." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 163 }, "name": "bunVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no license checks are run during the build and all licenses will be accepted", "remarks": "This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered.", "stability": "stable", "summary": "Configure which licenses should be deemed acceptable for use by dependencies." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 169 }, "name": "checkLicenses", "optional": true, "type": { "fqn": "projen.javascript.LicenseCheckerOptions" } }, { "abstract": true, "docs": { "default": "- true, but false for subprojects", "stability": "stable", "summary": "Add a `clobber` task which resets the repo to origin." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 174 }, "name": "clobber", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- undefined", "remarks": "This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact", "stability": "stable", "summary": "Options for npm packages using AWS CodeArtifact." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 180 }, "name": "codeArtifactOptions", "optional": true, "type": { "fqn": "projen.javascript.CodeArtifactOptions" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 185 }, "name": "codeCov", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- OIDC auth is used", "stability": "stable", "summary": "Define the secret name for a specified https://codecov.io/ token." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 190 }, "name": "codeCovTokenSecret", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Whether to commit the managed files by default." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 195 }, "name": "commitGenerated", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "- You can manually run compatibility tests using `yarn compat` if this feature is disabled.\n- You can ignore compatibility failures by adding lines to a \".compatignore\" file.", "stability": "stable", "summary": "Automatically run API compatibility test against the latest version published to npm after compilation." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 202 }, "name": "compat", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "\".compatignore\"", "stability": "stable", "summary": "Name of the ignore file for API compatibility tests." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 207 }, "name": "compatIgnore", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Emit a compressed version of the assembly." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 212 }, "name": "compressAssembly", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- defaults to the value of authorName or \"\" if `authorName` is undefined.", "stability": "stable", "summary": "License copyright owner." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 217 }, "name": "copyrightOwner", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- current year", "stability": "stable", "summary": "The copyright years to put in the LICENSE file." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 222 }, "name": "copyrightPeriod", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "remarks": "Only triggered when the lockfile for the configured package\nmanager already exists.\n\nThis is useful when migrating between package managers to avoid conflicts.", "stability": "stable", "summary": "Automatically delete lockfiles from package managers that are not the active one." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 236 }, "name": "deleteOrphanedLockFiles", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "Cannot be used in conjunction with `depsUpgrade`.", "stability": "stable", "summary": "Use dependabot to handle dependency upgrades." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 242 }, "name": "dependabot", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Options for dependabot." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 247 }, "name": "dependabotOptions", "optional": true, "type": { "fqn": "projen.github.DependabotOptions" } }, { "abstract": true, "docs": { "default": "[]", "remarks": "The recommendation is to only specify the module name here (e.g.\n`express`). This will behave similar to `pnpm add` or `npm install` in the\nsense that it will add the module as a dependency to your `package.json`\nfile with the latest version (`^`). You can specify semver requirements in\nthe same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and\nthis will be what your `package.json` will eventually include.", "stability": "stable", "summary": "Runtime dependencies of this module." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 258 }, "name": "deps", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- `true` for root projects, `false` for subprojects", "remarks": "Cannot be used in conjunction with `dependabot`.", "stability": "stable", "summary": "Use tasks and github workflows to handle dependency upgrades." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 264 }, "name": "depsUpgrade", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Options for `UpgradeDependencies`." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 269 }, "name": "depsUpgradeOptions", "optional": true, "type": { "fqn": "projen.javascript.UpgradeDependenciesOptions" } }, { "abstract": true, "docs": { "remarks": "It can be used when searching for packages in a package manager as well.\nSee https://classic.yarnpkg.com/en/docs/package-json/#toc-description", "stability": "stable", "summary": "The description is just a string that helps people understand the purpose of the package." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 275 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Add a VSCode development environment (used for GitHub Codespaces)." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 280 }, "name": "devContainer", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "[]", "remarks": "These dependencies will only be\navailable in your build environment but will not be fetched when this\nmodule is consumed.\n\nThe recommendation is to only specify the module name here (e.g.\n`express`). This will behave similar to `pnpm add` or `npm install` in the\nsense that it will add the module as a dependency to your `package.json`\nfile with the latest version (`^`). You can specify semver requirements in\nthe same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and\nthis will be what your `package.json` will eventually include.", "stability": "stable", "summary": "Build dependencies for this module." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 295 }, "name": "devDeps", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 302 }, "name": "devEngines", "optional": true, "type": { "fqn": "projen.javascript.DevEngines" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler)." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 307 }, "name": "disableTsconfig", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Do not generate a `tsconfig.dev.json` file." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 312 }, "name": "disableTsconfigDev", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Docgen by Typedoc." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 317 }, "name": "docgen", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "\"API.md\"", "stability": "stable", "summary": "File path for generated docs." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 322 }, "name": "docgenFilePath", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\"docs\"", "stability": "stable", "summary": "Docs directory." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 327 }, "name": "docsDirectory", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "deprecated": "use `publishToNuget`", "stability": "deprecated" }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 331 }, "name": "dotnet", "optional": true, "type": { "fqn": "projen.cdk.JsiiDotNetTarget" } }, { "abstract": true, "docs": { "default": "- true for private projects, false otherwise", "remarks": "This will enable the auto merge workflow as well as the merge queue", "stability": "stable", "summary": "Whether to enable the auto merge workflow for PRs." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 337 }, "name": "enablePRAutoMerge", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "\"lib/index.js\"", "stability": "stable", "summary": "Module entrypoint (`main` in `package.json`). Set to an empty string to not include `main` in your package.json." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 343 }, "name": "entrypoint", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)", "stability": "stable", "summary": "The .d.ts file that includes the type declarations for this module." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 348 }, "name": "entrypointTypes", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- true, unless biome is enabled", "stability": "stable", "summary": "Setup eslint." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 353 }, "name": "eslint", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- opinionated default options", "stability": "stable", "summary": "Eslint options." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 358 }, "name": "eslintOptions", "optional": true, "type": { "fqn": "projen.javascript.EslintOptions" } }, { "abstract": true, "docs": { "remarks": "By default, jsii will include all *.ts files (except .d.ts files) in the TypeScript compiler input.\nThis can be problematic for example when the package's build or test procedure generates .ts files\nthat cannot be compiled with jsii's compiler settings.", "stability": "stable", "summary": "Accepts a list of glob patterns. Files matching any of those patterns will be excluded from the TypeScript compiler input." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 367 }, "name": "excludeTypescript", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- default options", "remarks": "That is the workflow that turns on auto merge on all PRs.", "stability": "stable", "summary": "Options for the GitHub auto merge workflow." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 373 }, "name": "ghAutoMergeOptions", "optional": true, "type": { "fqn": "projen.github.AutoQueueOptions" } }, { "abstract": true, "docs": { "default": "true", "remarks": "Enabled by default for root projects. Disabled for non-root projects.", "stability": "stable", "summary": "Enable GitHub integration." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 379 }, "name": "github", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- see GitHubOptions", "stability": "stable", "summary": "Options for GitHub integration." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 384 }, "name": "githubOptions", "optional": true, "type": { "fqn": "projen.github.GitHubOptions" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Additional entries to .gitignore." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 388 }, "name": "gitignore", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Configuration options for .gitignore file." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 392 }, "name": "gitIgnoreOptions", "optional": true, "type": { "fqn": "projen.IgnoreFileOptions" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Configuration options for git." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 396 }, "name": "gitOptions", "optional": true, "type": { "fqn": "projen.GitOptions" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Add a Gitpod development environment." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 401 }, "name": "gitpod", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Package's Homepage / Website." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 405 }, "name": "homepage", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Setup jest unit tests." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 410 }, "name": "jest", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Jest options." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 415 }, "name": "jestOptions", "optional": true, "type": { "fqn": "projen.javascript.JestOptions" } }, { "abstract": true, "docs": { "default": "\"latest\"", "stability": "stable", "summary": "Version requirement of `publib` which is used to publish modules to npm." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 420 }, "name": "jsiiReleaseVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\"~5.9.0\"", "remarks": "Set to \"*\" if you want to manually manage the version of jsii in your\nproject by managing updates to `package.json` on your own.\n\nNOTE: The jsii compiler releases since 5.0.0 are not semantically versioned\nand should remain on the same minor, so we recommend using a `~` dependency\n(e.g. `~5.0.0`).", "stability": "stable", "summary": "Version of the jsii compiler to use." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 431 }, "name": "jsiiVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Keywords to include in `package.json`." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 435 }, "name": "keywords", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "\"lib\"", "stability": "stable", "summary": "Typescript artifacts output directory." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 440 }, "name": "libdir", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\"Apache-2.0\"", "remarks": "See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses.\nUse the `licensed` option if you want to no license to be specified.", "stability": "stable", "summary": "License's SPDX identifier." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 447 }, "name": "license", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Indicates if a license should be added." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 452 }, "name": "licensed", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "{}", "stability": "stable", "summary": "Configure logging options such as verbosity." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 457 }, "name": "logging", "optional": true, "type": { "fqn": "projen.LoggerOptions" } }, { "abstract": true, "docs": { "default": "- Major version is not enforced.", "remarks": "If this is specified, we bump the latest version of this major version line.\nIf not specified, we bump the global latest version.", "stability": "stable", "summary": "Major version to release from the default branch." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 464 }, "name": "majorVersion", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- no maximum version is enforced", "remarks": "Most projects should not use this option.\nThe value indicates that the package is incompatible with any newer versions of node.\nThis requirement is enforced via the engines field.\n\nYou will normally not need to set this option.\nConsider this option only if your package is known to not function with newer versions of node.", "stability": "stable", "summary": "The maximum node version supported by this package." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 474 }, "name": "maxNodeVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "deprecated": "use `githubOptions.mergify` instead", "stability": "deprecated", "summary": "Whether mergify should be enabled on this repository or not." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 480 }, "name": "mergify", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "deprecated": "use `githubOptions.mergifyOptions` instead", "stability": "deprecated", "summary": "Options for mergify." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 486 }, "name": "mergifyOptions", "optional": true, "type": { "fqn": "projen.github.MergifyOptions" } }, { "abstract": true, "docs": { "default": "- No minimum version is being enforced", "remarks": "This can be useful to set to 1, as breaking changes before the 1.x major\nrelease are not incrementing the major version number.\n\nCan not be set together with `majorVersion`.", "stability": "stable", "summary": "Minimal Major version to release." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 495 }, "name": "minMajorVersion", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- no minimum version is enforced", "remarks": "Most projects should not use this option.\nThe value indicates that the package is incompatible with any older versions of node.\nThis requirement is enforced via the engines field.\n\nYou will normally not need to set this option, even if your package is incompatible with EOL versions of node.\nConsider this option only if your package depends on a specific feature, that is not available in other LTS versions.\nSetting this option has very high impact on the consumers of your package,\nas package managers will actively prevent usage with node versions you have marked as incompatible.\n\nTo change the node version of your CI/CD workflows, use `workflowNodeVersion`.", "stability": "stable", "summary": "The minimum node version required by this package to function." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 509 }, "name": "minNodeVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "deprecated": "- Use `buildWorkflowOptions.mutableBuild`", "remarks": "This means\nthat any files synthesized by projen or e.g. test snapshots will always be up-to-date\nbefore a PR is merged.\n\nImplies that PR builds do not have anti-tamper checks.", "stability": "deprecated", "summary": "Automatically update files modified during builds to pull-request branches." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 520 }, "name": "mutableBuild", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- The next version will be determined based on the commit history and project settings.", "remarks": "If present, this shell command will be run before the bump is executed, and\nit determines what version to release. It will be executed in the following\nenvironment:\n\n- Working directory: the project directory.\n- `$VERSION`: the current version. Looks like `1.2.3`.\n- `$LATEST_TAG`: the most recent tag. Looks like `prefix-v1.2.3`, or may be unset.\n- `$SUGGESTED_BUMP`: the suggested bump action based on commits. One of `major|minor|patch|none`.\n\nThe command should print one of the following to `stdout`:\n\n- Nothing: the next version number will be determined based on commit history.\n- `x.y.z`: the next version number will be `x.y.z`.\n- `major|minor|patch`: the next version number will be the current version number\n with the indicated component bumped.\n\nThis setting cannot be specified together with `minMajorVersion`; the invoked\nscript can be used to achieve the effects of `minMajorVersion`.", "stability": "stable", "summary": "A shell command to control the next version to release." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 548 }, "name": "nextVersionCommand", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- for scoped packages (e.g. `foo@bar`), the default is\n`NpmAccess.RESTRICTED`, for non-scoped packages, the default is\n`NpmAccess.PUBLIC`.", "stability": "stable", "summary": "Access level of the npm package." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 555 }, "name": "npmAccess", "optional": true, "type": { "fqn": "projen.javascript.NpmAccess" } }, { "abstract": true, "docs": { "default": "\"latest\"", "remarks": "To set the npm dist-tag for release branches, set the `npmDistTag` property\nfor each branch.", "stability": "stable", "summary": "The npmDistTag to use when publishing from the default branch." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 562 }, "name": "npmDistTag", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "deprecated": "- use `project.addPackageIgnore`", "stability": "deprecated", "summary": "Additional entries to .npmignore." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 567 }, "name": "npmignore", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 572 }, "name": "npmignoreEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Configuration options for .npmignore file." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 576 }, "name": "npmIgnoreOptions", "optional": true, "type": { "fqn": "projen.IgnoreFileOptions" } }, { "abstract": true, "docs": { "default": "- true for public packages, false otherwise", "remarks": "A supported package manager is required to publish a package with npm provenance statements and\nyou will need to use a supported CI/CD provider.\n\nNote that the projen `Release` and `Publisher` components are using `publib` to publish packages,\nwhich is using npm internally and supports provenance statements independently of the package manager used.", "stability": "stable", "summary": "Should provenance statements be generated when the package is published." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 586 }, "name": "npmProvenance", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "deprecated": "use `npmRegistryUrl` instead", "remarks": "Cannot be set together with `npmRegistryUrl`.", "stability": "deprecated", "summary": "The host name of the npm registry to publish to." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 592 }, "name": "npmRegistry", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\"https://registry.npmjs.org\"", "remarks": "Must be a URL (e.g. start with \"https://\" or \"http://\")", "stability": "stable", "summary": "The base URL of the npm package registry." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 598 }, "name": "npmRegistryUrl", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\"NPM_TOKEN\"", "stability": "stable", "summary": "GitHub secret which contains the NPM token to use when publishing packages." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 603 }, "name": "npmTokenSecret", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- false", "stability": "stable", "summary": "Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 608 }, "name": "npmTrustedPublishing", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "\".\"", "remarks": "If this project has a parent, this directory is relative to the parent\ndirectory and it cannot be the same as the parent or any of it's other\nsubprojects.", "stability": "stable", "summary": "The root directory of the project. Relative to this directory, all files are synthesized." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 618 }, "name": "outdir", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`)." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 623 }, "name": "package", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- Detected from the calling process or `YARN_CLASSIC` if detection fails.", "stability": "stable", "summary": "The Node Package Manager used to execute scripts." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 628 }, "name": "packageManager", "optional": true, "type": { "fqn": "projen.javascript.NodePackageManager" } }, { "abstract": true, "docs": { "default": "- defaults to project name", "stability": "stable", "summary": "The \"name\" in package.json." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 633 }, "name": "packageName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The parent project, if this project is part of a bigger project." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 637 }, "name": "parent", "optional": true, "type": { "fqn": "projen.Project" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Options for `peerDeps`." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 641 }, "name": "peerDependencyOptions", "optional": true, "type": { "fqn": "projen.javascript.PeerDependencyOptions" } }, { "abstract": true, "docs": { "default": "[]", "remarks": "Dependencies listed here are required to\nbe installed (and satisfied) by the _consumer_ of this library. Using peer\ndependencies allows you to ensure that only a single module of a certain\nlibrary exists in the `node_modules` tree of your consumers.\n\nNote that prior to npm@7, peer dependencies are _not_ automatically\ninstalled, which means that adding peer dependencies to a library will be a\nbreaking change for your customers.\n\nUnless `peerDependencyOptions.pinnedDevDependency` is disabled (it is\nenabled by default), projen will automatically add a dev dependency with a\npinned version for each peer dependency. This will ensure that you build &\ntest your module against the lowest peer version required.", "stability": "stable", "summary": "Peer dependencies for this module." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 659 }, "name": "peerDeps", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "\"10.33.0\"", "stability": "stable", "summary": "The version of PNPM to use if using PNPM as a package manager." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 664 }, "name": "pnpmVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "[]", "stability": "stable", "summary": "Steps to execute after build as part of the release workflow." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 669 }, "name": "postBuildSteps", "optional": true, "type": { "collection": { "elementtype": { "fqn": "projen.github.workflows.JobStep" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- normal semantic versions", "stability": "stable", "summary": "Bump versions from the default branch as pre-releases (e.g. \"beta\", \"alpha\", \"pre\")." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 674 }, "name": "prerelease", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Setup prettier." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 679 }, "name": "prettier", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Prettier options." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 684 }, "name": "prettierOptions", "optional": true, "type": { "fqn": "projen.javascript.PrettierOptions" } }, { "abstract": true, "docs": { "default": "true", "remarks": "Setting this variable to true means that your project is created with sane defaults for private repositories.", "stability": "stable", "summary": "Whether or not this package is private." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 690 }, "name": "private", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 695 }, "name": "projectTree", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "ProjectType.UNKNOWN", "deprecated": "no longer supported at the base project level", "stability": "deprecated", "summary": "Which type of project this is (library/app)." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 701 }, "name": "projectType", "optional": true, "type": { "fqn": "projen.ProjectType" } }, { "abstract": true, "docs": { "default": "\"npx projen\"", "remarks": "Can be used to customize in special environments.", "stability": "stable", "summary": "The shell command to use in order to run the projen CLI." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 707 }, "name": "projenCommand", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- use a personal access token named PROJEN_GITHUB_TOKEN", "stability": "stable", "summary": "Choose a method of providing GitHub API access for projen workflows." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 712 }, "name": "projenCredentials", "optional": true, "type": { "fqn": "projen.github.GithubCredentials" } }, { "abstract": true, "docs": { "default": "- true if not a subproject", "stability": "stable", "summary": "Indicates of \"projen\" should be installed as a devDependency." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 717 }, "name": "projenDevDependency", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- true if projenrcJson is false", "stability": "stable", "summary": "Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 722 }, "name": "projenrcJs", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 727 }, "name": "projenrcJson", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Options for .projenrc.json." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 732 }, "name": "projenrcJsonOptions", "optional": true, "type": { "fqn": "projen.ProjenrcJsonOptions" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Options for .projenrc.js." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 737 }, "name": "projenrcJsOptions", "optional": true, "type": { "fqn": "projen.javascript.ProjenrcOptions" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Use TypeScript for your projenrc file (`.projenrc.ts`)." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 742 }, "name": "projenrcTs", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Options for .projenrc.ts." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 746 }, "name": "projenrcTsOptions", "optional": true, "type": { "fqn": "projen.typescript.ProjenrcOptions" } }, { "abstract": true, "docs": { "default": "\"PROJEN_GITHUB_TOKEN\"", "deprecated": "use `projenCredentials`", "remarks": "This token needs to have the `repo`, `workflows`\nand `packages` scope.", "stability": "deprecated", "summary": "The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 754 }, "name": "projenTokenSecret", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- Defaults to the latest version.", "stability": "stable", "summary": "Version of projen to install." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 759 }, "name": "projenVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Instead of actually publishing to package managers, just print the publishing command." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 764 }, "name": "publishDryRun", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "Normally, publishing only happens within automated workflows. Enable this\nin order to create a publishing task for each publishing activity.", "stability": "stable", "summary": "Define publishing tasks that can be executed manually as well as workflows." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 771 }, "name": "publishTasks", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- no publishing", "stability": "stable", "summary": "Publish Go bindings to a git repository." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 776 }, "name": "publishToGo", "optional": true, "type": { "fqn": "projen.cdk.JsiiGoTarget" } }, { "abstract": true, "docs": { "default": "- no publishing", "stability": "stable", "summary": "Publish to maven." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 781 }, "name": "publishToMaven", "optional": true, "type": { "fqn": "projen.cdk.JsiiJavaTarget" } }, { "abstract": true, "docs": { "default": "- no publishing", "stability": "stable", "summary": "Publish to NuGet." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 786 }, "name": "publishToNuget", "optional": true, "type": { "fqn": "projen.cdk.JsiiDotNetTarget" } }, { "abstract": true, "docs": { "default": "- no publishing", "stability": "stable", "summary": "Publish to pypi." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 791 }, "name": "publishToPypi", "optional": true, "type": { "fqn": "projen.cdk.JsiiPythonTarget" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Include a GitHub pull request template." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 796 }, "name": "pullRequestTemplate", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default content", "stability": "stable", "summary": "The contents of the pull request template." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 801 }, "name": "pullRequestTemplateContents", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "deprecated": "use `publishToPyPi`", "stability": "deprecated" }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 805 }, "name": "python", "optional": true, "type": { "fqn": "projen.cdk.JsiiPythonTarget" } }, { "abstract": true, "docs": { "default": "- { filename: 'README.md', contents: '# replace this' }", "stability": "stable", "summary": "The README setup." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 810 }, "name": "readme", "optional": true, "type": { "fqn": "projen.SampleReadmeProps" } }, { "abstract": true, "docs": { "default": "ReleasableCommits.everyCommit()", "stability": "stable", "summary": "Find commits that should be considered releasable Used to decide if a release is required." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 815 }, "name": "releasableCommits", "optional": true, "type": { "fqn": "projen.ReleasableCommits" } }, { "abstract": true, "docs": { "default": "- true (false for subprojects)", "stability": "stable", "summary": "Add release management to this project." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 820 }, "name": "release", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- no additional branches are used for release. you can use\n`addBranch()` to add additional branches.", "remarks": "A workflow will be created for each\nrelease branch which will publish releases from commits in this branch.\nEach release branch _must_ be assigned a major version number which is used\nto enforce that versions published from that branch always use that major\nversion. If multiple branches are used, the `majorVersion` field must also\nbe provided for the default branch.", "stability": "stable", "summary": "Defines additional release branches." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 832 }, "name": "releaseBranches", "optional": true, "type": { "collection": { "elementtype": { "fqn": "projen.release.BranchOptions" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- no environment used, unless set at the artifact level", "remarks": "This can be used to add an explicit approval step to the release\nor limit who can initiate a release through environment protection rules.\n\nWhen multiple artifacts are released, the environment can be overwritten\non a per artifact basis.", "stability": "stable", "summary": "The GitHub Actions environment used for the release." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 842 }, "name": "releaseEnvironment", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "deprecated": "Use `releaseTrigger: ReleaseTrigger.continuous()` instead", "stability": "deprecated", "summary": "Automatically release new versions every commit to one of branches in `releaseBranches`." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 848 }, "name": "releaseEveryCommit", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Create a github issue on every failed publishing task." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 853 }, "name": "releaseFailureIssue", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "\"failed-release\"", "remarks": "Only applies if `releaseFailureIssue` is true.", "stability": "stable", "summary": "The label to apply to issues indicating publish failures." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 859 }, "name": "releaseFailureIssueLabel", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no scheduled releases", "deprecated": "Use `releaseTrigger: ReleaseTrigger.scheduled()` instead", "stability": "deprecated", "summary": "CRON schedule to trigger new releases." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 865 }, "name": "releaseSchedule", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\"v\"", "remarks": "Useful if you are releasing on multiple branches with overlapping version numbers.\nNote: this prefix is used to detect the latest tagged version\nwhen bumping, so if you change this on a project with an existing version\nhistory, you may need to manually tag your latest release\nwith the new prefix.", "stability": "stable", "summary": "Automatically add the given prefix to release tags." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 874 }, "name": "releaseTagPrefix", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Automatically release to npm when new versions are introduced." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 879 }, "name": "releaseToNpm", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- Continuous releases (`ReleaseTrigger.continuous()`)", "stability": "stable", "summary": "The release trigger to use." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 884 }, "name": "releaseTrigger", "optional": true, "type": { "fqn": "projen.release.ReleaseTrigger" } }, { "abstract": true, "docs": { "default": "- true if not a subproject", "deprecated": "see `release`.", "stability": "deprecated", "summary": "DEPRECATED: renamed to `release`." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 890 }, "name": "releaseWorkflow", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "{}", "stability": "stable", "summary": "Build environment variables for release workflows." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 895 }, "name": "releaseWorkflowEnv", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "\"release\"", "stability": "stable", "summary": "The name of the default release workflow." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 900 }, "name": "releaseWorkflowName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "A set of workflow steps to execute in order to setup the workflow container." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 904 }, "name": "releaseWorkflowSetupSteps", "optional": true, "type": { "collection": { "elementtype": { "fqn": "projen.github.workflows.JobStep" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Use renovatebot to handle dependency upgrades." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 909 }, "name": "renovatebot", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Options for renovatebot." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 914 }, "name": "renovatebotOptions", "optional": true, "type": { "fqn": "projen.RenovatebotOptions" } }, { "abstract": true, "docs": { "default": "- generated from org tenancy and package name", "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 918 }, "name": "repository", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 922 }, "name": "repositoryDirectory", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- generated from org tenancy and package name", "deprecated": "use `repository`", "stability": "deprecated" }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 927 }, "name": "repositoryUrl", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\".\"", "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 931 }, "name": "rootdir", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Generate one-time sample in `src/` and `test/` if there are no files there." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 936 }, "name": "sampleCode", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- fetch all scoped packages from the public npm registry", "stability": "stable", "summary": "Options for privately hosted scoped packages." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 941 }, "name": "scopedPackagesOptions", "optional": true, "type": { "collection": { "elementtype": { "fqn": "projen.javascript.ScopedPackagesOptions" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "{}", "deprecated": "use `project.addTask()` or `package.setScript()`", "remarks": "If a script has the same name as a standard script,\nthe standard script will be overwritten.\nAlso adds the script as a task.", "stability": "deprecated", "summary": "npm scripts to include." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 950 }, "name": "scripts", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Set a minimal node version via the engines field Set this to `false` if a package did not enforce this previously and we don't want to change this for now." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 956 }, "name": "setNodeEngineVersion", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "\"src\"", "stability": "stable", "summary": "Typescript sources directory." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 961 }, "name": "srcdir", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Package's Stability." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 965 }, "name": "stability", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "remarks": "See `staleOptions` for options.", "stability": "stable", "summary": "Auto-close of stale issues and pull request." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 971 }, "name": "stale", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- see defaults in `StaleOptions`", "remarks": "To disable set `stale` to `false`.", "stability": "stable", "summary": "Auto-close stale issues and pull requests." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 977 }, "name": "staleOptions", "optional": true, "type": { "fqn": "projen.github.StaleOptions" } }, { "abstract": true, "docs": { "default": "- Auto detected from package name", "stability": "stable", "summary": "The organization this project is part of." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 982 }, "name": "tenancy", "optional": true, "type": { "fqn": "cdklabs-projen-project-types.OrgTenancy" } }, { "abstract": true, "docs": { "default": "\"test\"", "remarks": "Tests files should be named `xxx.test.ts`.\nIf this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`),\nthen tests are going to be compiled into `lib/` and executed as javascript.\nIf the test directory is outside of `src`, then we configure jest to\ncompile the code in-memory.", "stability": "stable", "summary": "Jest tests directory." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 991 }, "name": "testdir", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Custom TSConfig." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 996 }, "name": "tsconfig", "optional": true, "type": { "fqn": "projen.javascript.TypescriptConfigOptions" } }, { "abstract": true, "docs": { "default": "- use the production tsconfig options", "stability": "stable", "summary": "Custom tsconfig options for the development tsconfig.json file (used for testing)." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 1001 }, "name": "tsconfigDev", "optional": true, "type": { "fqn": "projen.javascript.TypescriptConfigOptions" } }, { "abstract": true, "docs": { "default": "\"tsconfig.dev.json\"", "stability": "stable", "summary": "The name of the development tsconfig.json file." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 1006 }, "name": "tsconfigDevFile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Options for ts-jest." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 1010 }, "name": "tsJestOptions", "optional": true, "type": { "fqn": "projen.typescript.TsJestOptions" } }, { "abstract": true, "docs": { "default": "\"latest\"", "remarks": "NOTE: Typescript is not semantically versioned and should remain on the\nsame minor, so we recommend using a `~` dependency (e.g. `~1.2.3`).", "stability": "stable", "summary": "TypeScript version to use." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 1017 }, "name": "typescriptVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Whether to enable the separate workflow to upgrade the cdklabs-projen-project-types dependencies." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 1022 }, "name": "upgradeCdklabsProjenProjectTypes", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Whether to have a separate workflow to upgrade runtime deps and mark this PR as fix." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 1027 }, "name": "upgradeRuntimeDepsAsFix", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- standard configuration applicable for GitHub repositories", "remarks": "Given values either append to default configuration or overwrite values in it.", "stability": "stable", "summary": "Custom configuration used when creating changelog with commit-and-tag-version package." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 1033 }, "name": "versionrcOptions", "optional": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "true", "remarks": "Enabled by default for root projects. Disabled for non-root projects.", "stability": "stable", "summary": "Enable VSCode integration." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 1039 }, "name": "vscode", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "\"yarn install --frozen-lockfile && yarn projen\"", "stability": "stable", "summary": "Workflow steps to use in order to bootstrap this repo." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 1044 }, "name": "workflowBootstrapSteps", "optional": true, "type": { "collection": { "elementtype": { "fqn": "projen.github.workflows.JobStep" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- default image", "stability": "stable", "summary": "Container image to use for GitHub workflows." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 1049 }, "name": "workflowContainerImage", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- default GitHub Actions user", "stability": "stable", "summary": "The git identity to use in workflows." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 1054 }, "name": "workflowGitIdentity", "optional": true, "type": { "fqn": "projen.github.GitIdentity" } }, { "abstract": true, "docs": { "default": "- `minNodeVersion` if set, otherwise `lts/*`.", "remarks": "Always use this option if your GitHub Actions workflows require a specific to run.", "stability": "stable", "summary": "The node version used in GitHub Actions workflows." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 1060 }, "name": "workflowNodeVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Enable Node.js package cache in GitHub workflows." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 1065 }, "name": "workflowPackageCache", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "[\"ubuntu-latest\"]", "stability": "stable", "summary": "Github Runner selection labels." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 1070 }, "name": "workflowRunsOn", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Github Runner Group selection options." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 1074 }, "name": "workflowRunsOnGroup", "optional": true, "type": { "fqn": "projen.GroupRunnerOptions" } }, { "abstract": true, "docs": { "default": "- Yarn Berry v4 with all default options", "stability": "stable", "summary": "Options for Yarn Berry." }, "immutable": true, "locationInModule": { "filename": "src/cdk-jsii-options.ts", "line": 1079 }, "name": "yarnBerryOptions", "optional": true, "type": { "fqn": "projen.javascript.YarnBerryOptions" } } ], "symbolId": "src/cdk-jsii-options:CdkJsiiProjectOptions" }, "cdklabs-projen-project-types.CdkTypeScriptProject": { "assembly": "cdklabs-projen-project-types", "base": "projen.typescript.TypeScriptProject", "docs": { "custom": { "pjid": "cdk-ts-proj" }, "stability": "stable", "summary": "Create a Cdk TypeScript Project." }, "fqn": "cdklabs-projen-project-types.CdkTypeScriptProject", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/cdk.ts", "line": 73 }, "parameters": [ { "name": "options", "type": { "fqn": "cdklabs-projen-project-types.CdkTypeScriptProjectOptions" } } ] }, "kind": "class", "locationInModule": { "filename": "src/cdk.ts", "line": 70 }, "name": "CdkTypeScriptProject", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/cdk.ts", "line": 71 }, "name": "private", "type": { "primitive": "boolean" } } ], "symbolId": "src/cdk:CdkTypeScriptProject" }, "cdklabs-projen-project-types.CdkTypeScriptProjectOptions": { "assembly": "cdklabs-projen-project-types", "datatype": true, "docs": { "stability": "stable" }, "fqn": "cdklabs-projen-project-types.CdkTypeScriptProjectOptions", "interfaces": [ "projen.typescript.TypeScriptProjectOptions", "cdklabs-projen-project-types.CdkCommonOptions" ], "kind": "interface", "locationInModule": { "filename": "src/cdk.ts", "line": 63 }, "name": "CdkTypeScriptProjectOptions", "symbolId": "src/cdk:CdkTypeScriptProjectOptions" }, "cdklabs-projen-project-types.CdklabsConstructLibrary": { "assembly": "cdklabs-projen-project-types", "base": "cdklabs-projen-project-types.CdkConstructLibrary", "docs": { "custom": { "pjid": "cdklabs-construct-lib" }, "stability": "stable", "summary": "Create a Cdklabs Construct Library Project." }, "fqn": "cdklabs-projen-project-types.CdklabsConstructLibrary", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/cdklabs.ts", "line": 150 }, "parameters": [ { "name": "options", "type": { "fqn": "cdklabs-projen-project-types.CdklabsConstructLibraryOptions" } } ] }, "kind": "class", "locationInModule": { "filename": "src/cdklabs.ts", "line": 149 }, "name": "CdklabsConstructLibrary", "symbolId": "src/cdklabs:CdklabsConstructLibrary" }, "cdklabs-projen-project-types.CdklabsConstructLibraryOptions": { "assembly": "cdklabs-projen-project-types", "datatype": true, "docs": { "stability": "stable" }, "fqn": "cdklabs-projen-project-types.CdklabsConstructLibraryOptions", "interfaces": [ "cdklabs-projen-project-types.CdkConstructLibraryOptions", "cdklabs-projen-project-types.CdklabsPublishingProjectOptions" ], "kind": "interface", "locationInModule": { "filename": "src/cdklabs.ts", "line": 142 }, "name": "CdklabsConstructLibraryOptions", "symbolId": "src/cdklabs:CdklabsConstructLibraryOptions" }, "cdklabs-projen-project-types.CdklabsJsiiProject": { "assembly": "cdklabs-projen-project-types", "base": "cdklabs-projen-project-types.CdkJsiiProject", "docs": { "custom": { "pjid": "cdklabs-jsii-proj" }, "stability": "stable", "summary": "Create a Cdklabs Jsii Project." }, "fqn": "cdklabs-projen-project-types.CdklabsJsiiProject", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/cdklabs.ts", "line": 197 }, "parameters": [ { "name": "options", "type": { "fqn": "cdklabs-projen-project-types.CdklabsJsiiProjectOptions" } } ] }, "kind": "class", "locationInModule": { "filename": "src/cdklabs.ts", "line": 196 }, "name": "CdklabsJsiiProject", "symbolId": "src/cdklabs:CdklabsJsiiProject" }, "cdklabs-projen-project-types.CdklabsJsiiProjectOptions": { "assembly": "cdklabs-projen-project-types", "datatype": true, "docs": { "stability": "stable" }, "fqn": "cdklabs-projen-project-types.CdklabsJsiiProjectOptions", "interfaces": [ "cdklabs-projen-project-types.CdkJsiiProjectOptions", "cdklabs-projen-project-types.CdklabsPublishingProjectOptions" ], "kind": "interface", "locationInModule": { "filename": "src/cdklabs.ts", "line": 189 }, "name": "CdklabsJsiiProjectOptions", "symbolId": "src/cdklabs:CdklabsJsiiProjectOptions" }, "cdklabs-projen-project-types.CdklabsPublishingProjectOptions": { "assembly": "cdklabs-projen-project-types", "datatype": true, "docs": { "stability": "stable" }, "fqn": "cdklabs-projen-project-types.CdklabsPublishingProjectOptions", "kind": "interface", "locationInModule": { "filename": "src/cdklabs.ts", "line": 117 }, "name": "CdklabsPublishingProjectOptions", "properties": [ { "abstract": true, "docs": { "default": "true", "remarks": "Setting this property guarantees\nthat your project will have reasonable publishing names. You can choose\nto modify them however you wish with the traditional `publishToPypi`,\n`publishToMaven`, `publishToNuget`, and `publishToGo` properties, and\nyour configuration will be respected.\n\nThis should be set to false only if you do not plan on releasing the package.", "stability": "stable", "summary": "Set default publishing properties." }, "immutable": true, "locationInModule": { "filename": "src/cdklabs.ts", "line": 129 }, "name": "cdklabsPublishingDefaults", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- all jsii target languages", "remarks": "This can be used when the library\nis experimental only, because stable libraries must publish to all jsii languages.\nThis should be used in conjunction with `cdklabsPublishingDefaults: true`; otherwise\nit is a no-op.", "stability": "stable", "summary": "Specify specific languages to publish to." }, "immutable": true, "locationInModule": { "filename": "src/cdklabs.ts", "line": 139 }, "name": "jsiiTargetLanguages", "optional": true, "type": { "collection": { "elementtype": { "fqn": "cdklabs-projen-project-types.JsiiLanguage" }, "kind": "array" } } } ], "symbolId": "src/cdklabs:CdklabsPublishingProjectOptions" }, "cdklabs-projen-project-types.CdklabsTypeScriptProject": { "assembly": "cdklabs-projen-project-types", "base": "cdklabs-projen-project-types.CdkTypeScriptProject", "docs": { "custom": { "pjid": "cdklabs-ts-proj" }, "stability": "stable", "summary": "Create a Cdklabs TypeScript Project." }, "fqn": "cdklabs-projen-project-types.CdklabsTypeScriptProject", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/cdklabs.ts", "line": 175 }, "parameters": [ { "name": "options", "type": { "fqn": "cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions" } } ] }, "kind": "class", "locationInModule": { "filename": "src/cdklabs.ts", "line": 174 }, "name": "CdklabsTypeScriptProject", "symbolId": "src/cdklabs:CdklabsTypeScriptProject" }, "cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions": { "assembly": "cdklabs-projen-project-types", "datatype": true, "docs": { "stability": "stable" }, "fqn": "cdklabs-projen-project-types.CdklabsTypeScriptProjectOptions", "interfaces": [ "cdklabs-projen-project-types.CdkTypeScriptProjectOptions" ], "kind": "interface", "locationInModule": { "filename": "src/cdklabs.ts", "line": 167 }, "name": "CdklabsTypeScriptProjectOptions", "symbolId": "src/cdklabs:CdklabsTypeScriptProjectOptions" }, "cdklabs-projen-project-types.JsiiLanguage": { "assembly": "cdklabs-projen-project-types", "docs": { "stability": "stable" }, "fqn": "cdklabs-projen-project-types.JsiiLanguage", "kind": "enum", "locationInModule": { "filename": "src/cdklabs.ts", "line": 5 }, "members": [ { "docs": { "stability": "stable" }, "name": "PYTHON" }, { "docs": { "stability": "stable" }, "name": "JAVA" }, { "docs": { "stability": "stable" }, "name": "DOTNET" }, { "docs": { "stability": "stable" }, "name": "GO" } ], "name": "JsiiLanguage", "symbolId": "src/cdklabs:JsiiLanguage" }, "cdklabs-projen-project-types.OrgTenancy": { "assembly": "cdklabs-projen-project-types", "docs": { "stability": "stable" }, "fqn": "cdklabs-projen-project-types.OrgTenancy", "kind": "enum", "locationInModule": { "filename": "src/common-options.ts", "line": 8 }, "members": [ { "docs": { "stability": "stable" }, "name": "CDKLABS" }, { "docs": { "stability": "stable" }, "name": "AWS" } ], "name": "OrgTenancy", "symbolId": "src/common-options:OrgTenancy" }, "cdklabs-projen-project-types.Rosetta": { "assembly": "cdklabs-projen-project-types", "base": "projen.Component", "docs": { "remarks": "Since ConstructHub will run\nrosetta for real, this just adds a check to the build to\nensure that rosetta will run successfully", "stability": "stable", "summary": "The Rosetta component adds builtin rosetta support for a construct library." }, "fqn": "cdklabs-projen-project-types.Rosetta", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/rosetta.ts", "line": 26 }, "parameters": [ { "name": "project", "type": { "fqn": "projen.cdk.JsiiProject" } }, { "name": "options", "optional": true, "type": { "fqn": "cdklabs-projen-project-types.RosettaOptions" } } ] }, "kind": "class", "locationInModule": { "filename": "src/rosetta.ts", "line": 25 }, "name": "Rosetta", "symbolId": "src/rosetta:Rosetta" }, "cdklabs-projen-project-types.RosettaOptions": { "assembly": "cdklabs-projen-project-types", "datatype": true, "docs": { "stability": "stable" }, "fqn": "cdklabs-projen-project-types.RosettaOptions", "kind": "interface", "locationInModule": { "filename": "src/rosetta.ts", "line": 3 }, "name": "RosettaOptions", "properties": [ { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Enable or disable strict mode." }, "immutable": true, "locationInModule": { "filename": "src/rosetta.ts", "line": 9 }, "name": "strict", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- no version is set, use automatic detection", "stability": "stable", "summary": "Set an explicit version of rosetta." }, "immutable": true, "locationInModule": { "filename": "src/rosetta.ts", "line": 16 }, "name": "version", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/rosetta:RosettaOptions" }, "cdklabs-projen-project-types.yarn.CdkLabsMonorepo": { "assembly": "cdklabs-projen-project-types", "base": "cdklabs-projen-project-types.yarn.Monorepo", "docs": { "custom": { "pjid": "cdklabs-yarn-monorepo" }, "stability": "stable", "summary": "Opinionated implementation of yarn.Monorepo." }, "fqn": "cdklabs-projen-project-types.yarn.CdkLabsMonorepo", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/yarn/monorepo.ts", "line": 324 }, "parameters": [ { "name": "options", "type": { "fqn": "cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions" } } ] }, "kind": "class", "locationInModule": { "filename": "src/yarn/monorepo.ts", "line": 323 }, "name": "CdkLabsMonorepo", "namespace": "yarn", "symbolId": "src/yarn/monorepo:CdkLabsMonorepo" }, "cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions": { "assembly": "cdklabs-projen-project-types", "datatype": true, "docs": { "stability": "stable", "summary": "Options for CdkLabsMonorepo." }, "fqn": "cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions", "interfaces": [ "cdklabs-projen-project-types.yarn.MonorepoOptions" ], "kind": "interface", "locationInModule": { "filename": "src/yarn/monorepo.ts", "line": 317 }, "name": "CdkLabsMonorepoOptions", "namespace": "yarn", "symbolId": "src/yarn/monorepo:CdkLabsMonorepoOptions" }, "cdklabs-projen-project-types.yarn.Constraints": { "assembly": "cdklabs-projen-project-types", "base": "projen.Component", "docs": { "stability": "stable" }, "fqn": "cdklabs-projen-project-types.yarn.Constraints", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/yarn/constraints.ts", "line": 20 }, "parameters": [ { "name": "project", "type": { "fqn": "cdklabs-projen-project-types.yarn.Monorepo" } }, { "name": "options", "type": { "fqn": "cdklabs-projen-project-types.yarn.ConstraintsOptions" } } ] }, "kind": "class", "locationInModule": { "filename": "src/yarn/constraints.ts", "line": 15 }, "methods": [ { "docs": { "stability": "stable", "summary": "Called before synthesis." }, "locationInModule": { "filename": "src/yarn/constraints.ts", "line": 33 }, "name": "preSynthesize", "overrides": "projen.Component" } ], "name": "Constraints", "namespace": "yarn", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/yarn/constraints.ts", "line": 16 }, "name": "project", "overrides": "projen.Component", "type": { "fqn": "cdklabs-projen-project-types.yarn.Monorepo" } } ], "symbolId": "src/yarn/constraints:Constraints" }, "cdklabs-projen-project-types.yarn.ConstraintsOptions": { "assembly": "cdklabs-projen-project-types", "datatype": true, "docs": { "stability": "stable" }, "fqn": "cdklabs-projen-project-types.yarn.ConstraintsOptions", "kind": "interface", "locationInModule": { "filename": "src/yarn/constraints.ts", "line": 6 }, "name": "ConstraintsOptions", "namespace": "yarn", "properties": [ { "abstract": true, "docs": { "remarks": "Each package must already be declared as a dev dependency on the monorepo root.\nThe version is enforced across all workspaces using Yarn Berry constraints.", "stability": "stable", "summary": "Package names that must use a consistent version across all workspaces." }, "immutable": true, "locationInModule": { "filename": "src/yarn/constraints.ts", "line": 12 }, "name": "consistentVersions", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "src/yarn/constraints:ConstraintsOptions" }, "cdklabs-projen-project-types.yarn.IDependencyResolver": { "assembly": "cdklabs-projen-project-types", "docs": { "stability": "stable" }, "fqn": "cdklabs-projen-project-types.yarn.IDependencyResolver", "kind": "interface", "locationInModule": { "filename": "src/yarn/monorepo.ts", "line": 306 }, "methods": [ { "abstract": true, "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/yarn/monorepo.ts", "line": 307 }, "name": "resolveDepsAndWritePackageJson", "returns": { "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } } ], "name": "IDependencyResolver", "namespace": "yarn", "symbolId": "src/yarn/monorepo:IDependencyResolver" }, "cdklabs-projen-project-types.yarn.IWorkspaceReference": { "assembly": "cdklabs-projen-project-types", "docs": { "remarks": "This can be used to reference packages in the same monorepo when declaring\n`deps` and `devDeps`.\n\nBy default, all `TypeScriptWorkspace`s implement this interface, representing themselves\nwith a `^` dependency and a restriction that public packages must have public dependencies.\n\nThe method `.customizeReference({ ... })` can be used to create a workspace reference with\ndifferent behavior.", "stability": "stable", "summary": "A reference to a workspace in the same monorepo." }, "fqn": "cdklabs-projen-project-types.yarn.IWorkspaceReference", "kind": "interface", "locationInModule": { "filename": "src/yarn/typescript-workspace.ts", "line": 32 }, "name": "IWorkspaceReference", "namespace": "yarn", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Whether the referenced workspace package is private." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace.ts", "line": 36 }, "name": "isPrivatePackage", "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The dependency name of the package." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace.ts", "line": 41 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The directory that holds this package in the monorepo." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace.ts", "line": 51 }, "name": "outdir", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The semver range that should be used to reference this package when it is released." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace.ts", "line": 46 }, "name": "versionType", "type": { "primitive": "string" } } ], "symbolId": "src/yarn/typescript-workspace:IWorkspaceReference" }, "cdklabs-projen-project-types.yarn.Monorepo": { "assembly": "cdklabs-projen-project-types", "base": "projen.typescript.TypeScriptProject", "docs": { "stability": "stable", "summary": "A monorepo using yarn workspaces." }, "fqn": "cdklabs-projen-project-types.yarn.Monorepo", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/yarn/monorepo.ts", "line": 31 }, "parameters": [ { "name": "options", "type": { "fqn": "cdklabs-projen-project-types.yarn.MonorepoOptions" } } ] }, "kind": "class", "locationInModule": { "filename": "src/yarn/monorepo.ts", "line": 14 }, "methods": [ { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/yarn/monorepo.ts", "line": 15 }, "name": "isMonorepo", "parameters": [ { "name": "x", "type": { "fqn": "projen.Project" } } ], "returns": { "type": { "primitive": "boolean" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Hooks into the install dependencies cycle." }, "locationInModule": { "filename": "src/yarn/monorepo.ts", "line": 291 }, "name": "postSynthesize", "overrides": "projen.Project" }, { "docs": { "remarks": "This is used to resolve dependency versions from `*` to a concrete version constraint.", "stability": "stable", "summary": "Allows a sub project to request installation of dependency at the Monorepo root They must provide a function that is executed after dependencies have been installed If this function returns true, the install command is run for a second time after all sub project requests have run." }, "locationInModule": { "filename": "src/yarn/monorepo.ts", "line": 231 }, "name": "requestInstallDependencies", "parameters": [ { "name": "resolver", "type": { "fqn": "cdklabs-projen-project-types.yarn.IDependencyResolver" } } ] }, { "docs": { "remarks": "1. Call \"this.preSynthesize()\"\n2. Delete all generated files\n3. Synthesize all subprojects\n4. Synthesize all components of this project\n5. Call \"postSynthesize()\" for all components of this project\n6. Call \"this.postSynthesize()\"", "stability": "stable", "summary": "Synthesize all project files into `outdir`." }, "locationInModule": { "filename": "src/yarn/monorepo.ts", "line": 220 }, "name": "synth", "overrides": "projen.Project" } ], "name": "Monorepo", "namespace": "yarn", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo.ts", "line": 31 }, "name": "options", "type": { "fqn": "cdklabs-projen-project-types.yarn.MonorepoOptions" } }, { "docs": { "stability": "stable", "summary": "Returns all the subprojects within this project." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo.ts", "line": 216 }, "name": "subprojects", "overrides": "projen.Project", "type": { "collection": { "elementtype": { "fqn": "cdklabs-projen-project-types.yarn.TypeScriptWorkspace" }, "kind": "array" } } }, { "docs": { "stability": "stable", "summary": "The Monorepo Release component." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo.ts", "line": 22 }, "name": "monorepoRelease", "optional": true, "type": { "fqn": "cdklabs-projen-project-types.yarn.MonorepoRelease" } }, { "docs": { "stability": "stable", "summary": "The URL where the actual code for the package lives." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo.ts", "line": 27 }, "name": "repositoryUrl", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/yarn/monorepo:Monorepo" }, "cdklabs-projen-project-types.yarn.MonorepoOptions": { "assembly": "cdklabs-projen-project-types", "datatype": true, "docs": { "stability": "stable", "summary": "MonorepoOptions." }, "fqn": "cdklabs-projen-project-types.yarn.MonorepoOptions", "kind": "interface", "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 8 }, "name": "MonorepoOptions", "namespace": "yarn", "properties": [ { "abstract": true, "docs": { "default": "\"main\"", "stability": "stable", "summary": "The name of the main release branch." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 221 }, "name": "defaultReleaseBranch", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "$BASEDIR", "stability": "stable", "summary": "This is the name of your project." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 458 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 13 }, "name": "addPackageManagerToDevEngines", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "true", "remarks": "This is normally only allowed for libraries. For apps, there's no meaning\nfor specifying these.", "stability": "stable", "summary": "Allow the project to include `peerDependencies` and `bundledDependencies`." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 20 }, "name": "allowLibraryDependencies", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "\"dist\"", "stability": "stable", "summary": "A directory which will contain build artifacts." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 25 }, "name": "artifactsDirectory", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "remarks": "When enabled, creates an \"audit\" task that checks for known security vulnerabilities\nin dependencies. By default, runs during every build and checks for \"high\" severity\nvulnerabilities or above in all dependencies (including dev dependencies).", "stability": "stable", "summary": "Run security audit on dependencies." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 33 }, "name": "auditDeps", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Security audit options." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 38 }, "name": "auditDepsOptions", "optional": true, "type": { "fqn": "projen.javascript.AuditOptions" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Author's e-mail." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 42 }, "name": "authorEmail", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Author's name." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 46 }, "name": "authorName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Is the author an organization." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 50 }, "name": "authorOrganization", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Author's URL / Website." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 54 }, "name": "authorUrl", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- auto approve is disabled", "stability": "stable", "summary": "Enable and configure the 'auto approve' workflow." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 59 }, "name": "autoApproveOptions", "optional": true, "type": { "fqn": "projen.github.AutoApproveOptions" } }, { "abstract": true, "docs": { "default": "- true", "remarks": "Throw if set to true but `autoApproveOptions` are not defined.", "stability": "stable", "summary": "Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured)." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 65 }, "name": "autoApproveUpgrades", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 70 }, "name": "autoDetectBin", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "true", "remarks": "Has no effect if `github.mergify`\nis set to false.", "stability": "stable", "summary": "Enable automatic merging on GitHub." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 77 }, "name": "autoMerge", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- see defaults in `AutoMergeOptions`", "remarks": "Has no effect if\n`github.mergify` or `autoMerge` is set to false.", "stability": "stable", "summary": "Configure options for automatic merging on GitHub." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 84 }, "name": "autoMergeOptions", "optional": true, "type": { "fqn": "projen.github.AutoMergeOptions" } }, { "abstract": true, "docs": { "remarks": "You can use this option to add/customize how binaries are represented in\nyour `package.json`, but unless `autoDetectBin` is `false`, every\nexecutable file under `bin` will automatically be added to this section.", "stability": "stable", "summary": "Binary programs vended with your module." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 91 }, "name": "bin", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Setup Biome." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 96 }, "name": "biome", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Biome options." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 101 }, "name": "biomeOptions", "optional": true, "type": { "fqn": "projen.javascript.BiomeOptions" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The email address to which issues should be reported." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 105 }, "name": "bugsEmail", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The url to your project's issue tracker." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 109 }, "name": "bugsUrl", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "Yarn Berry disables build scripts by default (`enableScripts: false`).\nThis option sets `dependenciesMeta..built: true` in the root `package.json`\nfor each listed package, allowing them to run their install scripts.\nOnly has an effect when the monorepo uses Yarn Berry.", "stability": "stable", "summary": "Packages that should have their build scripts enabled during install." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 117 }, "name": "buildablePackages", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "When Nx is enabled, always build the monorepo using Nx Will build projects in parallel and can improve build performance." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 123 }, "name": "buildWithNx", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- true if not a subproject", "stability": "stable", "summary": "Define a GitHub workflow for building PRs." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 128 }, "name": "buildWorkflow", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Options for PR build workflow." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 132 }, "name": "buildWorkflowOptions", "optional": true, "type": { "fqn": "projen.javascript.BuildWorkflowOptions" } }, { "abstract": true, "docs": { "default": "\"{ pullRequest: {}, workflowDispatch: {} }\"", "deprecated": "- Use `buildWorkflowOptions.workflowTriggers`", "stability": "deprecated", "summary": "Build workflow triggers." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 138 }, "name": "buildWorkflowTriggers", "optional": true, "type": { "fqn": "projen.github.workflows.Triggers" } }, { "abstract": true, "docs": { "default": "- A recent version of \"commit-and-tag-version\"", "remarks": "This can be any compatible package version, including the deprecated `standard-version@9`.", "stability": "stable", "summary": "The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 144 }, "name": "bumpPackage", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "These modules will be\nadded both to the `dependencies` section and `bundledDependencies` section of\nyour `package.json`.\n\nThe recommendation is to only specify the module name here (e.g.\n`express`). This will behave similar to `pnpm add` or `npm install` in the\nsense that it will add the module as a dependency to your `package.json`\nfile with the latest version (`^`). You can specify semver requirements in\nthe same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and\nthis will be what your `package.json` will eventually include.", "stability": "stable", "summary": "List of dependencies to bundle into this module." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 158 }, "name": "bundledDeps", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Options for `Bundler`." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 162 }, "name": "bundlerOptions", "optional": true, "type": { "fqn": "projen.javascript.BundlerOptions" } }, { "abstract": true, "docs": { "default": "\"latest\"", "stability": "stable", "summary": "The version of Bun to use if using Bun as a package manager." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 167 }, "name": "bunVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no license checks are run during the build and all licenses will be accepted", "remarks": "This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered.", "stability": "stable", "summary": "Configure which licenses should be deemed acceptable for use by dependencies." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 173 }, "name": "checkLicenses", "optional": true, "type": { "fqn": "projen.javascript.LicenseCheckerOptions" } }, { "abstract": true, "docs": { "default": "- true, but false for subprojects", "stability": "stable", "summary": "Add a `clobber` task which resets the repo to origin." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 178 }, "name": "clobber", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- undefined", "remarks": "This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact", "stability": "stable", "summary": "Options for npm packages using AWS CodeArtifact." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 184 }, "name": "codeArtifactOptions", "optional": true, "type": { "fqn": "projen.javascript.CodeArtifactOptions" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 189 }, "name": "codeCov", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- OIDC auth is used", "stability": "stable", "summary": "Define the secret name for a specified https://codecov.io/ token." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 194 }, "name": "codeCovTokenSecret", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Whether to commit the managed files by default." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 199 }, "name": "commitGenerated", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "remarks": "Uses Yarn Berry constraints to enforce that all workspaces use the same version\nof the listed packages. The version is read from the root `devDependencies`.\nOnly has an effect when the monorepo uses Yarn Berry.", "stability": "stable", "summary": "Package names that must use a consistent version across all workspaces." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 206 }, "name": "consistentVersions", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- defaults to the value of authorName or \"\" if `authorName` is undefined.", "stability": "stable", "summary": "License copyright owner." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 211 }, "name": "copyrightOwner", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- current year", "stability": "stable", "summary": "The copyright years to put in the LICENSE file." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 216 }, "name": "copyrightPeriod", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "remarks": "Only triggered when the lockfile for the configured package\nmanager already exists.\n\nThis is useful when migrating between package managers to avoid conflicts.", "stability": "stable", "summary": "Automatically delete lockfiles from package managers that are not the active one." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 230 }, "name": "deleteOrphanedLockFiles", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "Cannot be used in conjunction with `depsUpgrade`.", "stability": "stable", "summary": "Use dependabot to handle dependency upgrades." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 236 }, "name": "dependabot", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Options for dependabot." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 241 }, "name": "dependabotOptions", "optional": true, "type": { "fqn": "projen.github.DependabotOptions" } }, { "abstract": true, "docs": { "default": "[]", "remarks": "The recommendation is to only specify the module name here (e.g.\n`express`). This will behave similar to `pnpm add` or `npm install` in the\nsense that it will add the module as a dependency to your `package.json`\nfile with the latest version (`^`). You can specify semver requirements in\nthe same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and\nthis will be what your `package.json` will eventually include.", "stability": "stable", "summary": "Runtime dependencies of this module." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 252 }, "name": "deps", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- `true` for root projects, `false` for subprojects", "remarks": "Cannot be used in conjunction with `dependabot`.", "stability": "stable", "summary": "Use tasks and github workflows to handle dependency upgrades." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 258 }, "name": "depsUpgrade", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Options for `UpgradeDependencies`." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 263 }, "name": "depsUpgradeOptions", "optional": true, "type": { "fqn": "projen.javascript.UpgradeDependenciesOptions" } }, { "abstract": true, "docs": { "remarks": "It can be used when searching for packages in a package manager as well.\nSee https://classic.yarnpkg.com/en/docs/package-json/#toc-description", "stability": "stable", "summary": "The description is just a string that helps people understand the purpose of the package." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 269 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Add a VSCode development environment (used for GitHub Codespaces)." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 274 }, "name": "devContainer", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "[]", "remarks": "These dependencies will only be\navailable in your build environment but will not be fetched when this\nmodule is consumed.\n\nThe recommendation is to only specify the module name here (e.g.\n`express`). This will behave similar to `pnpm add` or `npm install` in the\nsense that it will add the module as a dependency to your `package.json`\nfile with the latest version (`^`). You can specify semver requirements in\nthe same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and\nthis will be what your `package.json` will eventually include.", "stability": "stable", "summary": "Build dependencies for this module." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 289 }, "name": "devDeps", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 296 }, "name": "devEngines", "optional": true, "type": { "fqn": "projen.javascript.DevEngines" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler)." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 301 }, "name": "disableTsconfig", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Do not generate a `tsconfig.dev.json` file." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 306 }, "name": "disableTsconfigDev", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Docgen by Typedoc." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 311 }, "name": "docgen", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "\"docs\"", "stability": "stable", "summary": "Docs directory." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 316 }, "name": "docsDirectory", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\"lib/index.js\"", "stability": "stable", "summary": "Module entrypoint (`main` in `package.json`). Set to an empty string to not include `main` in your package.json." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 322 }, "name": "entrypoint", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)", "stability": "stable", "summary": "The .d.ts file that includes the type declarations for this module." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 327 }, "name": "entrypointTypes", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- opinionated default options", "stability": "stable", "summary": "Eslint options." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 332 }, "name": "eslintOptions", "optional": true, "type": { "fqn": "projen.javascript.EslintOptions" } }, { "abstract": true, "docs": { "default": "true", "remarks": "Enabled by default for root projects. Disabled for non-root projects.", "stability": "stable", "summary": "Enable GitHub integration." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 338 }, "name": "github", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- see GitHubOptions", "stability": "stable", "summary": "Options for GitHub integration." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 343 }, "name": "githubOptions", "optional": true, "type": { "fqn": "projen.github.GitHubOptions" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Additional entries to .gitignore." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 347 }, "name": "gitignore", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Configuration options for .gitignore file." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 351 }, "name": "gitIgnoreOptions", "optional": true, "type": { "fqn": "projen.IgnoreFileOptions" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Configuration options for git." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 355 }, "name": "gitOptions", "optional": true, "type": { "fqn": "projen.GitOptions" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Add a Gitpod development environment." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 360 }, "name": "gitpod", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Package's Homepage / Website." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 364 }, "name": "homepage", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\"latest\"", "stability": "stable", "summary": "Version requirement of `publib` which is used to publish modules to npm." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 369 }, "name": "jsiiReleaseVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Keywords to include in `package.json`." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 373 }, "name": "keywords", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "\"lib\"", "stability": "stable", "summary": "Typescript artifacts output directory." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 378 }, "name": "libdir", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\"Apache-2.0\"", "remarks": "See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses.\nUse the `licensed` option if you want to no license to be specified.", "stability": "stable", "summary": "License's SPDX identifier." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 385 }, "name": "license", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Indicates if a license should be added." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 390 }, "name": "licensed", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "{}", "stability": "stable", "summary": "Configure logging options such as verbosity." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 395 }, "name": "logging", "optional": true, "type": { "fqn": "projen.LoggerOptions" } }, { "abstract": true, "docs": { "default": "- Major version is not enforced.", "remarks": "If this is specified, we bump the latest version of this major version line.\nIf not specified, we bump the global latest version.", "stability": "stable", "summary": "Major version to release from the default branch." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 402 }, "name": "majorVersion", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- no maximum version is enforced", "remarks": "Most projects should not use this option.\nThe value indicates that the package is incompatible with any newer versions of node.\nThis requirement is enforced via the engines field.\n\nYou will normally not need to set this option.\nConsider this option only if your package is known to not function with newer versions of node.", "stability": "stable", "summary": "The maximum node version supported by this package." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 412 }, "name": "maxNodeVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "deprecated": "use `githubOptions.mergify` instead", "stability": "deprecated", "summary": "Whether mergify should be enabled on this repository or not." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 418 }, "name": "mergify", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "deprecated": "use `githubOptions.mergifyOptions` instead", "stability": "deprecated", "summary": "Options for mergify." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 424 }, "name": "mergifyOptions", "optional": true, "type": { "fqn": "projen.github.MergifyOptions" } }, { "abstract": true, "docs": { "default": "- No minimum version is being enforced", "remarks": "This can be useful to set to 1, as breaking changes before the 1.x major\nrelease are not incrementing the major version number.\n\nCan not be set together with `majorVersion`.", "stability": "stable", "summary": "Minimal Major version to release." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 433 }, "name": "minMajorVersion", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- no \"engines\" specified", "remarks": "Only set this if your package will not work properly on specific (older?)\nNode versions.", "stability": "stable", "summary": "Minimum Node.js version to require via package.json `engines` (inclusive)." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 442 }, "name": "minNodeVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "deprecated": "- Use `buildWorkflowOptions.mutableBuild`", "remarks": "This means\nthat any files synthesized by projen or e.g. test snapshots will always be up-to-date\nbefore a PR is merged.\n\nImplies that PR builds do not have anti-tamper checks.", "stability": "deprecated", "summary": "Automatically update files modified during builds to pull-request branches." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 453 }, "name": "mutableBuild", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- The next version will be determined based on the commit history and project settings.", "remarks": "If present, this shell command will be run before the bump is executed, and\nit determines what version to release. It will be executed in the following\nenvironment:\n\n- Working directory: the project directory.\n- `$VERSION`: the current version. Looks like `1.2.3`.\n- `$LATEST_TAG`: the most recent tag. Looks like `prefix-v1.2.3`, or may be unset.\n- `$SUGGESTED_BUMP`: the suggested bump action based on commits. One of `major|minor|patch|none`.\n\nThe command should print one of the following to `stdout`:\n\n- Nothing: the next version number will be determined based on commit history.\n- `x.y.z`: the next version number will be `x.y.z`.\n- `major|minor|patch`: the next version number will be the current version number\n with the indicated component bumped.\n\nThis setting cannot be specified together with `minMajorVersion`; the invoked\nscript can be used to achieve the effects of `minMajorVersion`.", "stability": "stable", "summary": "A shell command to control the next version to release." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 481 }, "name": "nextVersionCommand", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- for scoped packages (e.g. `foo@bar`), the default is\n`NpmAccess.RESTRICTED`, for non-scoped packages, the default is\n`NpmAccess.PUBLIC`.", "stability": "stable", "summary": "Access level of the npm package." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 488 }, "name": "npmAccess", "optional": true, "type": { "fqn": "projen.javascript.NpmAccess" } }, { "abstract": true, "docs": { "default": "\"latest\"", "remarks": "To set the npm dist-tag for release branches, set the `npmDistTag` property\nfor each branch.", "stability": "stable", "summary": "The npmDistTag to use when publishing from the default branch." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 495 }, "name": "npmDistTag", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "deprecated": "- use `project.addPackageIgnore`", "stability": "deprecated", "summary": "Additional entries to .npmignore." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 500 }, "name": "npmignore", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 505 }, "name": "npmignoreEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Configuration options for .npmignore file." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 509 }, "name": "npmIgnoreOptions", "optional": true, "type": { "fqn": "projen.IgnoreFileOptions" } }, { "abstract": true, "docs": { "default": "- true for public packages, false otherwise", "remarks": "A supported package manager is required to publish a package with npm provenance statements and\nyou will need to use a supported CI/CD provider.\n\nNote that the projen `Release` and `Publisher` components are using `publib` to publish packages,\nwhich is using npm internally and supports provenance statements independently of the package manager used.", "stability": "stable", "summary": "Should provenance statements be generated when the package is published." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 519 }, "name": "npmProvenance", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "deprecated": "use `npmRegistryUrl` instead", "remarks": "Cannot be set together with `npmRegistryUrl`.", "stability": "deprecated", "summary": "The host name of the npm registry to publish to." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 525 }, "name": "npmRegistry", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\"https://registry.npmjs.org\"", "remarks": "Must be a URL (e.g. start with \"https://\" or \"http://\")", "stability": "stable", "summary": "The base URL of the npm package registry." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 531 }, "name": "npmRegistryUrl", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\"NPM_TOKEN\"", "stability": "stable", "summary": "GitHub secret which contains the NPM token to use when publishing packages." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 536 }, "name": "npmTokenSecret", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- false", "stability": "stable", "summary": "Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 541 }, "name": "npmTrustedPublishing", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Enable the integration with Nx in the monorepo." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 546 }, "name": "nx", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "\".\"", "remarks": "If this project has a parent, this directory is relative to the parent\ndirectory and it cannot be the same as the parent or any of it's other\nsubprojects.", "stability": "stable", "summary": "The root directory of the project. Relative to this directory, all files are synthesized." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 556 }, "name": "outdir", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`)." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 561 }, "name": "package", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- defaults to project name", "stability": "stable", "summary": "The \"name\" in package.json." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 566 }, "name": "packageName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The parent project, if this project is part of a bigger project." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 570 }, "name": "parent", "optional": true, "type": { "fqn": "projen.Project" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Options for `peerDeps`." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 574 }, "name": "peerDependencyOptions", "optional": true, "type": { "fqn": "projen.javascript.PeerDependencyOptions" } }, { "abstract": true, "docs": { "default": "[]", "remarks": "Dependencies listed here are required to\nbe installed (and satisfied) by the _consumer_ of this library. Using peer\ndependencies allows you to ensure that only a single module of a certain\nlibrary exists in the `node_modules` tree of your consumers.\n\nNote that prior to npm@7, peer dependencies are _not_ automatically\ninstalled, which means that adding peer dependencies to a library will be a\nbreaking change for your customers.\n\nUnless `peerDependencyOptions.pinnedDevDependency` is disabled (it is\nenabled by default), projen will automatically add a dev dependency with a\npinned version for each peer dependency. This will ensure that you build &\ntest your module against the lowest peer version required.", "stability": "stable", "summary": "Peer dependencies for this module." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 592 }, "name": "peerDeps", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "\"10.33.0\"", "stability": "stable", "summary": "The version of PNPM to use if using PNPM as a package manager." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 597 }, "name": "pnpmVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "[]", "stability": "stable", "summary": "Steps to execute after build as part of the release workflow." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 602 }, "name": "postBuildSteps", "optional": true, "type": { "collection": { "elementtype": { "fqn": "projen.github.workflows.JobStep" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- normal semantic versions", "stability": "stable", "summary": "Bump versions from the default branch as pre-releases (e.g. \"beta\", \"alpha\", \"pre\")." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 607 }, "name": "prerelease", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Setup prettier." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 612 }, "name": "prettier", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Prettier options." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 617 }, "name": "prettierOptions", "optional": true, "type": { "fqn": "projen.javascript.PrettierOptions" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 622 }, "name": "projectTree", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "ProjectType.UNKNOWN", "deprecated": "no longer supported at the base project level", "stability": "deprecated", "summary": "Which type of project this is (library/app)." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 628 }, "name": "projectType", "optional": true, "type": { "fqn": "projen.ProjectType" } }, { "abstract": true, "docs": { "default": "\"npx projen\"", "remarks": "Can be used to customize in special environments.", "stability": "stable", "summary": "The shell command to use in order to run the projen CLI." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 634 }, "name": "projenCommand", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- use a personal access token named PROJEN_GITHUB_TOKEN", "stability": "stable", "summary": "Choose a method of providing GitHub API access for projen workflows." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 639 }, "name": "projenCredentials", "optional": true, "type": { "fqn": "projen.github.GithubCredentials" } }, { "abstract": true, "docs": { "default": "- true if not a subproject", "stability": "stable", "summary": "Indicates of \"projen\" should be installed as a devDependency." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 644 }, "name": "projenDevDependency", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- true if projenrcJson is false", "stability": "stable", "summary": "Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 649 }, "name": "projenrcJs", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 654 }, "name": "projenrcJson", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Options for .projenrc.json." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 659 }, "name": "projenrcJsonOptions", "optional": true, "type": { "fqn": "projen.ProjenrcJsonOptions" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Options for .projenrc.js." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 664 }, "name": "projenrcJsOptions", "optional": true, "type": { "fqn": "projen.javascript.ProjenrcOptions" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Use TypeScript for your projenrc file (`.projenrc.ts`)." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 669 }, "name": "projenrcTs", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Options for .projenrc.ts." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 673 }, "name": "projenrcTsOptions", "optional": true, "type": { "fqn": "projen.typescript.ProjenrcOptions" } }, { "abstract": true, "docs": { "default": "\"PROJEN_GITHUB_TOKEN\"", "deprecated": "use `projenCredentials`", "remarks": "This token needs to have the `repo`, `workflows`\nand `packages` scope.", "stability": "deprecated", "summary": "The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 681 }, "name": "projenTokenSecret", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- Defaults to the latest version.", "stability": "stable", "summary": "Version of projen to install." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 686 }, "name": "projenVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Instead of actually publishing to package managers, just print the publishing command." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 691 }, "name": "publishDryRun", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "Normally, publishing only happens within automated workflows. Enable this\nin order to create a publishing task for each publishing activity.", "stability": "stable", "summary": "Define publishing tasks that can be executed manually as well as workflows." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 698 }, "name": "publishTasks", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Include a GitHub pull request template." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 703 }, "name": "pullRequestTemplate", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default content", "stability": "stable", "summary": "The contents of the pull request template." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 708 }, "name": "pullRequestTemplateContents", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- { filename: 'README.md', contents: '# replace this' }", "stability": "stable", "summary": "The README setup." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 713 }, "name": "readme", "optional": true, "type": { "fqn": "projen.SampleReadmeProps" } }, { "abstract": true, "docs": { "default": "ReleasableCommits.everyCommit()", "stability": "stable", "summary": "Find commits that should be considered releasable Used to decide if a release is required." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 718 }, "name": "releasableCommits", "optional": true, "type": { "fqn": "projen.ReleasableCommits" } }, { "abstract": true, "docs": { "default": "- No release", "stability": "stable", "summary": "Whether or not to add release workflows for this repository." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 723 }, "name": "release", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- no additional branches are used for release. you can use\n`addBranch()` to add additional branches.", "remarks": "A workflow will be created for each\nrelease branch which will publish releases from commits in this branch.\nEach release branch _must_ be assigned a major version number which is used\nto enforce that versions published from that branch always use that major\nversion. If multiple branches are used, the `majorVersion` field must also\nbe provided for the default branch.", "stability": "stable", "summary": "Defines additional release branches." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 735 }, "name": "releaseBranches", "optional": true, "type": { "collection": { "elementtype": { "fqn": "projen.release.BranchOptions" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- no environment used, unless set at the artifact level", "remarks": "This can be used to add an explicit approval step to the release\nor limit who can initiate a release through environment protection rules.\n\nWhen multiple artifacts are released, the environment can be overwritten\non a per artifact basis.", "stability": "stable", "summary": "The GitHub Actions environment used for the release." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 745 }, "name": "releaseEnvironment", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "deprecated": "Use `releaseTrigger: ReleaseTrigger.continuous()` instead", "stability": "deprecated", "summary": "Automatically release new versions every commit to one of branches in `releaseBranches`." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 751 }, "name": "releaseEveryCommit", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Create a github issue on every failed publishing task." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 756 }, "name": "releaseFailureIssue", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "\"failed-release\"", "remarks": "Only applies if `releaseFailureIssue` is true.", "stability": "stable", "summary": "The label to apply to issues indicating publish failures." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 762 }, "name": "releaseFailureIssueLabel", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Options for the release workflows." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 766 }, "name": "releaseOptions", "optional": true, "type": { "fqn": "cdklabs-projen-project-types.yarn.MonorepoReleaseOptions" } }, { "abstract": true, "docs": { "default": "- no scheduled releases", "deprecated": "Use `releaseTrigger: ReleaseTrigger.scheduled()` instead", "stability": "deprecated", "summary": "CRON schedule to trigger new releases." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 772 }, "name": "releaseSchedule", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\"v\"", "remarks": "Useful if you are releasing on multiple branches with overlapping version numbers.\nNote: this prefix is used to detect the latest tagged version\nwhen bumping, so if you change this on a project with an existing version\nhistory, you may need to manually tag your latest release\nwith the new prefix.", "stability": "stable", "summary": "Automatically add the given prefix to release tags." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 781 }, "name": "releaseTagPrefix", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Automatically release to npm when new versions are introduced." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 786 }, "name": "releaseToNpm", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- Continuous releases (`ReleaseTrigger.continuous()`)", "stability": "stable", "summary": "The release trigger to use." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 791 }, "name": "releaseTrigger", "optional": true, "type": { "fqn": "projen.release.ReleaseTrigger" } }, { "abstract": true, "docs": { "default": "- true if not a subproject", "deprecated": "see `release`.", "stability": "deprecated", "summary": "DEPRECATED: renamed to `release`." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 797 }, "name": "releaseWorkflow", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "{}", "stability": "stable", "summary": "Build environment variables for release workflows." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 802 }, "name": "releaseWorkflowEnv", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "\"release\"", "stability": "stable", "summary": "The name of the default release workflow." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 807 }, "name": "releaseWorkflowName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "A set of workflow steps to execute in order to setup the workflow container." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 811 }, "name": "releaseWorkflowSetupSteps", "optional": true, "type": { "collection": { "elementtype": { "fqn": "projen.github.workflows.JobStep" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Use renovatebot to handle dependency upgrades." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 816 }, "name": "renovatebot", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Options for renovatebot." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 821 }, "name": "renovatebotOptions", "optional": true, "type": { "fqn": "projen.RenovatebotOptions" } }, { "abstract": true, "docs": { "remarks": "See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository", "stability": "stable", "summary": "The repository is the location where the actual code for your package lives." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 826 }, "name": "repository", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 830 }, "name": "repositoryDirectory", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- fetch all scoped packages from the public npm registry", "stability": "stable", "summary": "Options for privately hosted scoped packages." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 835 }, "name": "scopedPackagesOptions", "optional": true, "type": { "collection": { "elementtype": { "fqn": "projen.javascript.ScopedPackagesOptions" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "{}", "deprecated": "use `project.addTask()` or `package.setScript()`", "remarks": "If a script has the same name as a standard script,\nthe standard script will be overwritten.\nAlso adds the script as a task.", "stability": "deprecated", "summary": "npm scripts to include." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 844 }, "name": "scripts", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "\"src\"", "stability": "stable", "summary": "Typescript sources directory." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 849 }, "name": "srcdir", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Package's Stability." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 853 }, "name": "stability", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "remarks": "See `staleOptions` for options.", "stability": "stable", "summary": "Auto-close of stale issues and pull request." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 859 }, "name": "stale", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- see defaults in `StaleOptions`", "remarks": "To disable set `stale` to `false`.", "stability": "stable", "summary": "Auto-close stale issues and pull requests." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 865 }, "name": "staleOptions", "optional": true, "type": { "fqn": "projen.github.StaleOptions" } }, { "abstract": true, "docs": { "default": "\"test\"", "remarks": "Tests files should be named `xxx.test.ts`.\nIf this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`),\nthen tests are going to be compiled into `lib/` and executed as javascript.\nIf the test directory is outside of `src`, then we configure jest to\ncompile the code in-memory.", "stability": "stable", "summary": "Jest tests directory." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 874 }, "name": "testdir", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Custom TSConfig." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 879 }, "name": "tsconfig", "optional": true, "type": { "fqn": "projen.javascript.TypescriptConfigOptions" } }, { "abstract": true, "docs": { "default": "- use the production tsconfig options", "stability": "stable", "summary": "Custom tsconfig options for the development tsconfig.json file (used for testing)." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 884 }, "name": "tsconfigDev", "optional": true, "type": { "fqn": "projen.javascript.TypescriptConfigOptions" } }, { "abstract": true, "docs": { "default": "\"tsconfig.dev.json\"", "stability": "stable", "summary": "The name of the development tsconfig.json file." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 889 }, "name": "tsconfigDevFile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Options for ts-jest." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 893 }, "name": "tsJestOptions", "optional": true, "type": { "fqn": "projen.typescript.TsJestOptions" } }, { "abstract": true, "docs": { "default": "\"latest\"", "remarks": "NOTE: Typescript is not semantically versioned and should remain on the\nsame minor, so we recommend using a `~` dependency (e.g. `~1.2.3`).", "stability": "stable", "summary": "TypeScript version to use." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 900 }, "name": "typescriptVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- standard configuration applicable for GitHub repositories", "remarks": "Given values either append to default configuration or overwrite values in it.", "stability": "stable", "summary": "Custom configuration used when creating changelog with commit-and-tag-version package." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 906 }, "name": "versionrcOptions", "optional": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "true", "remarks": "Enabled by default for root projects. Disabled for non-root projects.", "stability": "stable", "summary": "Enable VSCode integration." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 912 }, "name": "vscode", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Create a VSCode multi-root workspace file for all monorepo workspaces." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 917 }, "name": "vscodeWorkspace", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default configuration", "stability": "stable", "summary": "Configuration options for the VSCode multi-root workspace file." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 922 }, "name": "vscodeWorkspaceOptions", "optional": true, "type": { "fqn": "cdklabs-projen-project-types.yarn.VsCodeWorkspaceOptions" } }, { "abstract": true, "docs": { "default": "\"yarn install --frozen-lockfile && yarn projen\"", "stability": "stable", "summary": "Workflow steps to use in order to bootstrap this repo." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 927 }, "name": "workflowBootstrapSteps", "optional": true, "type": { "collection": { "elementtype": { "fqn": "projen.github.workflows.JobStep" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- default image", "stability": "stable", "summary": "Container image to use for GitHub workflows." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 932 }, "name": "workflowContainerImage", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- default GitHub Actions user", "stability": "stable", "summary": "The git identity to use in workflows." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 937 }, "name": "workflowGitIdentity", "optional": true, "type": { "fqn": "projen.github.GitIdentity" } }, { "abstract": true, "docs": { "default": "'lts/*'", "stability": "stable", "summary": "The node version to use in GitHub workflows." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 942 }, "name": "workflowNodeVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Enable Node.js package cache in GitHub workflows." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 947 }, "name": "workflowPackageCache", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "[\"ubuntu-latest\"]", "stability": "stable", "summary": "Github Runner selection labels." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 952 }, "name": "workflowRunsOn", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Github Runner Group selection options." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 956 }, "name": "workflowRunsOnGroup", "optional": true, "type": { "fqn": "projen.GroupRunnerOptions" } }, { "abstract": true, "docs": { "default": "false", "remarks": "When enabled, the monorepo will use `YARN_BERRY` instead of `YARN_CLASSIC`.\n`yarnBerryOptions` can be used to further configure Yarn Berry.\nThe `nodeLinker` defaults to `node-modules`.", "stability": "stable", "summary": "Use Yarn Berry as the package manager." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 964 }, "name": "yarnBerry", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- Yarn Berry v4 with all default options", "stability": "stable", "summary": "Options for Yarn Berry." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-options.ts", "line": 969 }, "name": "yarnBerryOptions", "optional": true, "type": { "fqn": "projen.javascript.YarnBerryOptions" } } ], "symbolId": "src/yarn/monorepo-options:MonorepoOptions" }, "cdklabs-projen-project-types.yarn.MonorepoRelease": { "assembly": "cdklabs-projen-project-types", "base": "projen.Component", "docs": { "stability": "stable" }, "fqn": "cdklabs-projen-project-types.yarn.MonorepoRelease", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/yarn/monorepo-release.ts", "line": 42 }, "parameters": [ { "name": "project", "type": { "fqn": "projen.Project" } }, { "name": "options", "optional": true, "type": { "fqn": "cdklabs-projen-project-types.yarn.MonorepoReleaseOptions" } } ] }, "kind": "class", "locationInModule": { "filename": "src/yarn/monorepo-release.ts", "line": 14 }, "methods": [ { "docs": { "stability": "stable", "summary": "Returns the `MonorepoReleaseWorkflow` component of a project or `undefined` if the project does not have a MonorepoReleaseWorkflow component." }, "locationInModule": { "filename": "src/yarn/monorepo-release.ts", "line": 19 }, "name": "of", "parameters": [ { "name": "project", "type": { "fqn": "projen.Project" } } ], "returns": { "optional": true, "type": { "fqn": "cdklabs-projen-project-types.yarn.MonorepoRelease" } }, "static": true }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/yarn/monorepo-release.ts", "line": 64 }, "name": "addWorkspace", "parameters": [ { "name": "project", "type": { "fqn": "cdklabs-projen-project-types.yarn.TypeScriptWorkspace" } }, { "name": "options", "type": { "fqn": "cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions" } } ] }, { "docs": { "stability": "stable", "summary": "Called before synthesis." }, "locationInModule": { "filename": "src/yarn/monorepo-release.ts", "line": 98 }, "name": "preSynthesize", "overrides": "projen.Component" }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/yarn/monorepo-release.ts", "line": 56 }, "name": "workspaceRelease", "parameters": [ { "name": "project", "type": { "fqn": "cdklabs-projen-project-types.yarn.TypeScriptWorkspace" } } ], "returns": { "type": { "fqn": "cdklabs-projen-project-types.yarn.WorkspaceRelease" } } } ], "name": "MonorepoRelease", "namespace": "yarn", "symbolId": "src/yarn/monorepo-release:MonorepoRelease" }, "cdklabs-projen-project-types.yarn.MonorepoReleaseOptions": { "assembly": "cdklabs-projen-project-types", "datatype": true, "docs": { "stability": "stable", "summary": "MonorepoReleaseOptions." }, "fqn": "cdklabs-projen-project-types.yarn.MonorepoReleaseOptions", "kind": "interface", "locationInModule": { "filename": "src/yarn/monorepo-release-options.ts", "line": 7 }, "name": "MonorepoReleaseOptions", "namespace": "yarn", "properties": [ { "abstract": true, "docs": { "default": "\"main\"", "stability": "stable", "summary": "Branch name to release from." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-release-options.ts", "line": 12 }, "name": "branchName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "remarks": "Will build projects in parallel and can improve build performance", "stability": "stable", "summary": "Build the monorepo using Nx during the release." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-release-options.ts", "line": 18 }, "name": "buildWithNx", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- A recent version of \"commit-and-tag-version\"", "remarks": "This can be any compatible package version, including the deprecated `standard-version@9`.", "stability": "stable", "summary": "The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-release-options.ts", "line": 24 }, "name": "bumpPackage", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\"latest\"", "stability": "stable", "summary": "Version requirement of `publib` which is used to publish modules to npm." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-release-options.ts", "line": 29 }, "name": "jsiiReleaseVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- Major version is not enforced.", "remarks": "If this is specified, we bump the latest version of this major version line.\nIf not specified, we bump the global latest version.", "stability": "stable", "summary": "Major version to release from the default branch." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-release-options.ts", "line": 36 }, "name": "majorVersion", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- No minimum version is being enforced", "remarks": "This can be useful to set to 1, as breaking changes before the 1.x major\nrelease are not incrementing the major version number.\n\nCan not be set together with `majorVersion`.", "stability": "stable", "summary": "Minimal Major version to release." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-release-options.ts", "line": 45 }, "name": "minMajorVersion", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- The next version will be determined based on the commit history and project settings.", "remarks": "If present, this shell command will be run before the bump is executed, and\nit determines what version to release. It will be executed in the following\nenvironment:\n\n- Working directory: the project directory.\n- `$VERSION`: the current version. Looks like `1.2.3`.\n- `$LATEST_TAG`: the most recent tag. Looks like `prefix-v1.2.3`, or may be unset.\n- `$SUGGESTED_BUMP`: the suggested bump action based on commits. One of `major|minor|patch|none`.\n\nThe command should print one of the following to `stdout`:\n\n- Nothing: the next version number will be determined based on commit history.\n- `x.y.z`: the next version number will be `x.y.z`.\n- `major|minor|patch`: the next version number will be the current version number\n with the indicated component bumped.\n\nThis setting cannot be specified together with `minMajorVersion`; the invoked\nscript can be used to achieve the effects of `minMajorVersion`.", "stability": "stable", "summary": "A shell command to control the next version to release." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-release-options.ts", "line": 68 }, "name": "nextVersionCommand", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\"lts/*\"", "stability": "stable", "summary": "Node version to use in the release workflow." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-release-options.ts", "line": 73 }, "name": "nodeVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\"latest\"", "remarks": "To set the npm dist-tag for release branches, set the `npmDistTag` property\nfor each branch.", "stability": "stable", "summary": "The npmDistTag to use when publishing from the default branch." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-release-options.ts", "line": 80 }, "name": "npmDistTag", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "[]", "stability": "stable", "summary": "Steps to execute after build as part of the release workflow." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-release-options.ts", "line": 85 }, "name": "postBuildSteps", "optional": true, "type": { "collection": { "elementtype": { "fqn": "projen.github.workflows.JobStep" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- normal semantic versions", "stability": "stable", "summary": "Bump versions from the default branch as pre-releases (e.g. \"beta\", \"alpha\", \"pre\")." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-release-options.ts", "line": 90 }, "name": "prerelease", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Instead of actually publishing to package managers, just print the publishing command." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-release-options.ts", "line": 95 }, "name": "publishDryRun", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Publish packages to npm." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-release-options.ts", "line": 100 }, "name": "publishToNpm", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "ReleasableCommits.everyCommit()", "stability": "stable", "summary": "Find commits that should be considered releasable Used to decide if a release is required." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-release-options.ts", "line": 105 }, "name": "releasableCommits", "optional": true, "type": { "fqn": "projen.ReleasableCommits" } }, { "abstract": true, "docs": { "default": "- no environment used, unless set at the artifact level", "remarks": "This can be used to add an explicit approval step to the release\nor limit who can initiate a release through environment protection rules.\n\nWhen multiple artifacts are released, the environment can be overwritten\non a per artifact basis.", "stability": "stable", "summary": "The GitHub Actions environment used for the release." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-release-options.ts", "line": 115 }, "name": "releaseEnvironment", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- Continuous releases (`ReleaseTrigger.continuous()`)", "stability": "stable", "summary": "The release trigger to use." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-release-options.ts", "line": 120 }, "name": "releaseTrigger", "optional": true, "type": { "fqn": "projen.release.ReleaseTrigger" } }, { "abstract": true, "docs": { "default": "{}", "stability": "stable", "summary": "Build environment variables for release workflows." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-release-options.ts", "line": 125 }, "name": "releaseWorkflowEnv", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "\"release\"", "stability": "stable", "summary": "The name of the default release workflow." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-release-options.ts", "line": 130 }, "name": "releaseWorkflowName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "A set of workflow steps to execute in order to setup the workflow container." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-release-options.ts", "line": 134 }, "name": "releaseWorkflowSetupSteps", "optional": true, "type": { "collection": { "elementtype": { "fqn": "projen.github.workflows.JobStep" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- default image", "stability": "stable", "summary": "Container image to use for GitHub workflows." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-release-options.ts", "line": 139 }, "name": "workflowContainerImage", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "[\"ubuntu-latest\"]", "stability": "stable", "summary": "Github Runner selection labels." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-release-options.ts", "line": 144 }, "name": "workflowRunsOn", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Github Runner Group selection options." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-release-options.ts", "line": 148 }, "name": "workflowRunsOnGroup", "optional": true, "type": { "fqn": "projen.GroupRunnerOptions" } }, { "abstract": true, "docs": { "default": "false", "remarks": "When enabled, release tasks use Yarn Berry compatible commands.", "stability": "stable", "summary": "Whether the monorepo uses Yarn Berry." }, "immutable": true, "locationInModule": { "filename": "src/yarn/monorepo-release-options.ts", "line": 154 }, "name": "yarnBerry", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "src/yarn/monorepo-release-options:MonorepoReleaseOptions" }, "cdklabs-projen-project-types.yarn.ReferenceOptions": { "assembly": "cdklabs-projen-project-types", "datatype": true, "docs": { "stability": "stable", "summary": "Options for the `workspace.customizeReference()` method." }, "fqn": "cdklabs-projen-project-types.yarn.ReferenceOptions", "kind": "interface", "locationInModule": { "filename": "src/yarn/typescript-workspace.ts", "line": 356 }, "name": "ReferenceOptions", "namespace": "yarn", "properties": [ { "abstract": true, "docs": { "default": "'future-minor'", "remarks": "By default, dependencies will be referenced with a `^`, which means that\ncome install time a newer version may be installed.\n\nChoose a different range type to take, for example, an `exact` dependency.", "stability": "stable", "summary": "What type of dependency to take on this package." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace.ts", "line": 367 }, "name": "versionType", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/yarn/typescript-workspace:ReferenceOptions" }, "cdklabs-projen-project-types.yarn.TypeScriptWorkspace": { "assembly": "cdklabs-projen-project-types", "base": "projen.typescript.TypeScriptProject", "docs": { "stability": "stable", "summary": "A TypeScript workspace in a `yarn.Monorepo`." }, "fqn": "cdklabs-projen-project-types.yarn.TypeScriptWorkspace", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/yarn/typescript-workspace.ts", "line": 65 }, "parameters": [ { "name": "options", "type": { "fqn": "cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions" } } ] }, "interfaces": [ "cdklabs-projen-project-types.yarn.IWorkspaceReference" ], "kind": "class", "locationInModule": { "filename": "src/yarn/typescript-workspace.ts", "line": 57 }, "methods": [ { "docs": { "remarks": ".eslintrc.js will take precedence over the JSON file, it will load the\nJSON file and patch it with a dynamic directory name that cannot be represented in\nplain JSON (see https://github.com/projen/projen/issues/2405).\n\nSince eslint config is loaded with different cwd's depending on whether it's\nfrom the VSCode plugin or from the command line, use absolute paths everywhere.", "stability": "stable", "summary": "Need to hack ESLint config." }, "locationInModule": { "filename": "src/yarn/typescript-workspace.ts", "line": 316 }, "name": "addEslintRcFix", "protected": true }, { "docs": { "stability": "stable", "summary": "I don't know why `tsconfig.dev.json` doesn't have an outdir, or where it's used, but it's causing in-place `.js` files to appear." }, "locationInModule": { "filename": "src/yarn/typescript-workspace.ts", "line": 302 }, "name": "addTsconfigDevFix", "protected": true }, { "docs": { "stability": "stable", "summary": "Return a specialized reference to this workspace." }, "locationInModule": { "filename": "src/yarn/typescript-workspace.ts", "line": 343 }, "name": "customizeReference", "parameters": [ { "name": "refOpts", "optional": true, "type": { "fqn": "cdklabs-projen-project-types.yarn.ReferenceOptions" } } ], "returns": { "type": { "fqn": "cdklabs-projen-project-types.yarn.IWorkspaceReference" } } }, { "docs": { "remarks": "Optionally filter by dependency type.", "stability": "stable", "summary": "Return all Projects in the workspace that are also dependencies." }, "locationInModule": { "filename": "src/yarn/typescript-workspace.ts", "line": 334 }, "name": "workspaceDependencies", "parameters": [ { "name": "types", "optional": true, "type": { "collection": { "elementtype": { "fqn": "projen.DependencyType" }, "kind": "array" } } } ], "returns": { "type": { "collection": { "elementtype": { "fqn": "projen.Project" }, "kind": "array" } } } } ], "name": "TypeScriptWorkspace", "namespace": "yarn", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace.ts", "line": 59 }, "name": "bundledDeps", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "stability": "stable", "summary": "Whether the referenced workspace package is private." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace.ts", "line": 60 }, "name": "isPrivatePackage", "overrides": "cdklabs-projen-project-types.yarn.IWorkspaceReference", "type": { "primitive": "boolean" } }, { "docs": { "stability": "stable", "summary": "The semver range that should be used to reference this package when it is released." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace.ts", "line": 61 }, "name": "versionType", "overrides": "cdklabs-projen-project-types.yarn.IWorkspaceReference", "type": { "primitive": "string" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace.ts", "line": 58 }, "name": "workspaceDirectory", "type": { "primitive": "string" } } ], "symbolId": "src/yarn/typescript-workspace:TypeScriptWorkspace" }, "cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions": { "assembly": "cdklabs-projen-project-types", "datatype": true, "docs": { "stability": "stable", "summary": "TypeScriptWorkspaceOptions." }, "fqn": "cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions", "kind": "interface", "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 8 }, "name": "TypeScriptWorkspaceOptions", "namespace": "yarn", "properties": [ { "abstract": true, "docs": { "default": "$BASEDIR", "stability": "stable", "summary": "This is the name of your project." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 457 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The parent `yarn.Monorepo` project." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 559 }, "name": "parent", "type": { "fqn": "cdklabs-projen-project-types.yarn.Monorepo" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 13 }, "name": "addPackageManagerToDevEngines", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "true", "remarks": "This is normally only allowed for libraries. For apps, there's no meaning\nfor specifying these.", "stability": "stable", "summary": "Allow the project to include `peerDependencies` and `bundledDependencies`." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 20 }, "name": "allowLibraryDependencies", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "By default, private dependencies are not allowed as users will not be able to install\nyour package. It makes sense to relax this check *only* if you are bundling your package.", "stability": "stable", "summary": "Allow private workspace dependencies in the 'deps' parameter." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 28 }, "name": "allowPrivateDeps", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "\"dist\"", "stability": "stable", "summary": "A directory which will contain build artifacts." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 33 }, "name": "artifactsDirectory", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "remarks": "When enabled, creates an \"audit\" task that checks for known security vulnerabilities\nin dependencies. By default, runs during every build and checks for \"high\" severity\nvulnerabilities or above in all dependencies (including dev dependencies).", "stability": "stable", "summary": "Run security audit on dependencies." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 41 }, "name": "auditDeps", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Security audit options." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 46 }, "name": "auditDepsOptions", "optional": true, "type": { "fqn": "projen.javascript.AuditOptions" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Author's e-mail." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 50 }, "name": "authorEmail", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Author's name." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 54 }, "name": "authorName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Is the author an organization." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 58 }, "name": "authorOrganization", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Author's URL / Website." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 62 }, "name": "authorUrl", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- auto approve is disabled", "stability": "stable", "summary": "Enable and configure the 'auto approve' workflow." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 67 }, "name": "autoApproveOptions", "optional": true, "type": { "fqn": "projen.github.AutoApproveOptions" } }, { "abstract": true, "docs": { "default": "- true", "remarks": "Throw if set to true but `autoApproveOptions` are not defined.", "stability": "stable", "summary": "Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured)." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 73 }, "name": "autoApproveUpgrades", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "true", "remarks": "Has no effect if `github.mergify`\nis set to false.", "stability": "stable", "summary": "Enable automatic merging on GitHub." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 80 }, "name": "autoMerge", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- see defaults in `AutoMergeOptions`", "remarks": "Has no effect if\n`github.mergify` or `autoMerge` is set to false.", "stability": "stable", "summary": "Configure options for automatic merging on GitHub." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 87 }, "name": "autoMergeOptions", "optional": true, "type": { "fqn": "projen.github.AutoMergeOptions" } }, { "abstract": true, "docs": { "remarks": "You can use this option to add/customize how binaries are represented in\nyour `package.json`, but unless `autoDetectBin` is `false`, every\nexecutable file under `bin` will automatically be added to this section.", "stability": "stable", "summary": "Binary programs vended with your module." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 94 }, "name": "bin", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Setup Biome." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 99 }, "name": "biome", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Biome options." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 104 }, "name": "biomeOptions", "optional": true, "type": { "fqn": "projen.javascript.BiomeOptions" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The email address to which issues should be reported." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 108 }, "name": "bugsEmail", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The url to your project's issue tracker." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 112 }, "name": "bugsUrl", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- true if not a subproject", "stability": "stable", "summary": "Define a GitHub workflow for building PRs." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 117 }, "name": "buildWorkflow", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Options for PR build workflow." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 121 }, "name": "buildWorkflowOptions", "optional": true, "type": { "fqn": "projen.javascript.BuildWorkflowOptions" } }, { "abstract": true, "docs": { "default": "\"{ pullRequest: {}, workflowDispatch: {} }\"", "deprecated": "- Use `buildWorkflowOptions.workflowTriggers`", "stability": "deprecated", "summary": "Build workflow triggers." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 127 }, "name": "buildWorkflowTriggers", "optional": true, "type": { "fqn": "projen.github.workflows.Triggers" } }, { "abstract": true, "docs": { "default": "- A recent version of \"commit-and-tag-version\"", "remarks": "This can be any compatible package version, including the deprecated `standard-version@9`.", "stability": "stable", "summary": "The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 133 }, "name": "bumpPackage", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "These modules will be\nadded both to the `dependencies` section and `bundledDependencies` section of\nyour `package.json`.\n\nThe recommendation is to only specify the module name here (e.g.\n`express`). This will behave similar to `pnpm add` or `npm install` in the\nsense that it will add the module as a dependency to your `package.json`\nfile with the latest version (`^`). You can specify semver requirements in\nthe same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and\nthis will be what your `package.json` will eventually include.", "stability": "stable", "summary": "List of dependencies to bundle into this module." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 147 }, "name": "bundledDeps", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Options for `Bundler`." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 151 }, "name": "bundlerOptions", "optional": true, "type": { "fqn": "projen.javascript.BundlerOptions" } }, { "abstract": true, "docs": { "default": "\"latest\"", "stability": "stable", "summary": "The version of Bun to use if using Bun as a package manager." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 156 }, "name": "bunVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no license checks are run during the build and all licenses will be accepted", "remarks": "This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered.", "stability": "stable", "summary": "Configure which licenses should be deemed acceptable for use by dependencies." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 162 }, "name": "checkLicenses", "optional": true, "type": { "fqn": "projen.javascript.LicenseCheckerOptions" } }, { "abstract": true, "docs": { "default": "- true, but false for subprojects", "stability": "stable", "summary": "Add a `clobber` task which resets the repo to origin." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 167 }, "name": "clobber", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- undefined", "remarks": "This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact", "stability": "stable", "summary": "Options for npm packages using AWS CodeArtifact." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 173 }, "name": "codeArtifactOptions", "optional": true, "type": { "fqn": "projen.javascript.CodeArtifactOptions" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 178 }, "name": "codeCov", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- OIDC auth is used", "stability": "stable", "summary": "Define the secret name for a specified https://codecov.io/ token." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 183 }, "name": "codeCovTokenSecret", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Whether to commit the managed files by default." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 188 }, "name": "commitGenerated", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- defaults to the value of authorName or \"\" if `authorName` is undefined.", "stability": "stable", "summary": "License copyright owner." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 193 }, "name": "copyrightOwner", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- current year", "stability": "stable", "summary": "The copyright years to put in the LICENSE file." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 198 }, "name": "copyrightPeriod", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "remarks": "Only triggered when the lockfile for the configured package\nmanager already exists.\n\nThis is useful when migrating between package managers to avoid conflicts.", "stability": "stable", "summary": "Automatically delete lockfiles from package managers that are not the active one." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 207 }, "name": "deleteOrphanedLockFiles", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "Cannot be used in conjunction with `depsUpgrade`.", "stability": "stable", "summary": "Use dependabot to handle dependency upgrades." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 213 }, "name": "dependabot", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Options for dependabot." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 218 }, "name": "dependabotOptions", "optional": true, "type": { "fqn": "projen.github.DependabotOptions" } }, { "abstract": true, "docs": { "default": "[]", "remarks": "The recommendation is to only specify the module name here (e.g.\n`express`). This will behave similar to `pnpm add` or `npm install` in the\nsense that it will add the module as a dependency to your `package.json`\nfile with the latest version (`^`). You can specify semver requirements in\nthe same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and\nthis will be what your `package.json` will eventually include.", "stability": "stable", "summary": "Runtime dependencies of this module." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 229 }, "name": "deps", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "primitive": "string" }, { "fqn": "cdklabs-projen-project-types.yarn.IWorkspaceReference" } ] } }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- `true` for root projects, `false` for subprojects", "remarks": "Cannot be used in conjunction with `dependabot`.", "stability": "stable", "summary": "Use tasks and github workflows to handle dependency upgrades." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 235 }, "name": "depsUpgrade", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "remarks": "It can be used when searching for packages in a package manager as well.\nSee https://classic.yarnpkg.com/en/docs/package-json/#toc-description", "stability": "stable", "summary": "The description is just a string that helps people understand the purpose of the package." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 241 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Add a VSCode development environment (used for GitHub Codespaces)." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 246 }, "name": "devContainer", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "[]", "remarks": "These dependencies will only be\navailable in your build environment but will not be fetched when this\nmodule is consumed.\n\nThe recommendation is to only specify the module name here (e.g.\n`express`). This will behave similar to `pnpm add` or `npm install` in the\nsense that it will add the module as a dependency to your `package.json`\nfile with the latest version (`^`). You can specify semver requirements in\nthe same syntax passed to `pnpm add` or `npm i` (e.g. `express@^2`) and\nthis will be what your `package.json` will eventually include.", "stability": "stable", "summary": "Build dependencies for this module." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 261 }, "name": "devDeps", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "primitive": "string" }, { "fqn": "cdklabs-projen-project-types.yarn.IWorkspaceReference" } ] } }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 268 }, "name": "devEngines", "optional": true, "type": { "fqn": "projen.javascript.DevEngines" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler)." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 273 }, "name": "disableTsconfig", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Do not generate a `tsconfig.dev.json` file." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 278 }, "name": "disableTsconfigDev", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Docgen by Typedoc." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 283 }, "name": "docgen", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "\"docs\"", "stability": "stable", "summary": "Docs directory." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 288 }, "name": "docsDirectory", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\"lib/index.js\"", "stability": "stable", "summary": "Module entrypoint (`main` in `package.json`). Set to an empty string to not include `main` in your package.json." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 294 }, "name": "entrypoint", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)", "stability": "stable", "summary": "The .d.ts file that includes the type declarations for this module." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 299 }, "name": "entrypointTypes", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- true, unless biome is enabled", "stability": "stable", "summary": "Setup eslint." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 304 }, "name": "eslint", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- opinionated default options", "stability": "stable", "summary": "Eslint options." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 309 }, "name": "eslintOptions", "optional": true, "type": { "fqn": "projen.javascript.EslintOptions" } }, { "abstract": true, "docs": { "default": "[]", "stability": "stable", "summary": "Dependencies that should be excluded from upgrades." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 314 }, "name": "excludeDepsFromUpgrade", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "true", "remarks": "Enabled by default for root projects. Disabled for non-root projects.", "stability": "stable", "summary": "Enable GitHub integration." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 320 }, "name": "github", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- see GitHubOptions", "stability": "stable", "summary": "Options for GitHub integration." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 325 }, "name": "githubOptions", "optional": true, "type": { "fqn": "projen.github.GitHubOptions" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Additional entries to .gitignore." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 329 }, "name": "gitignore", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Configuration options for .gitignore file." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 333 }, "name": "gitIgnoreOptions", "optional": true, "type": { "fqn": "projen.IgnoreFileOptions" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Configuration options for git." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 337 }, "name": "gitOptions", "optional": true, "type": { "fqn": "projen.GitOptions" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Add a Gitpod development environment." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 342 }, "name": "gitpod", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Configure Yarn Berry's `installConfig.hoistingLimits` for this workspace. Sets the `installConfig.hoistingLimits` field in the workspace `package.json`. Accepted values are `workspaces`, `dependencies`, or `none`. Only has an effect when the parent monorepo uses Yarn Berry." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 349 }, "name": "hoistingLimits", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Package's Homepage / Website." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 353 }, "name": "homepage", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Setup jest unit tests." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 358 }, "name": "jest", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Jest options." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 363 }, "name": "jestOptions", "optional": true, "type": { "fqn": "projen.javascript.JestOptions" } }, { "abstract": true, "docs": { "default": "\"latest\"", "stability": "stable", "summary": "Version requirement of `publib` which is used to publish modules to npm." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 368 }, "name": "jsiiReleaseVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Keywords to include in `package.json`." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 372 }, "name": "keywords", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "\"lib\"", "stability": "stable", "summary": "Typescript artifacts output directory." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 377 }, "name": "libdir", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\"Apache-2.0\"", "remarks": "See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses.\nUse the `licensed` option if you want to no license to be specified.", "stability": "stable", "summary": "License's SPDX identifier." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 384 }, "name": "license", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Indicates if a license should be added." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 389 }, "name": "licensed", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "{}", "stability": "stable", "summary": "Configure logging options such as verbosity." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 394 }, "name": "logging", "optional": true, "type": { "fqn": "projen.LoggerOptions" } }, { "abstract": true, "docs": { "default": "- Major version is not enforced.", "remarks": "If this is specified, we bump the latest version of this major version line.\nIf not specified, we bump the global latest version.", "stability": "stable", "summary": "Major version to release from the default branch." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 401 }, "name": "majorVersion", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- no maximum version is enforced", "remarks": "Most projects should not use this option.\nThe value indicates that the package is incompatible with any newer versions of node.\nThis requirement is enforced via the engines field.\n\nYou will normally not need to set this option.\nConsider this option only if your package is known to not function with newer versions of node.", "stability": "stable", "summary": "The maximum node version supported by this package." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 411 }, "name": "maxNodeVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "deprecated": "use `githubOptions.mergify` instead", "stability": "deprecated", "summary": "Whether mergify should be enabled on this repository or not." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 417 }, "name": "mergify", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "deprecated": "use `githubOptions.mergifyOptions` instead", "stability": "deprecated", "summary": "Options for mergify." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 423 }, "name": "mergifyOptions", "optional": true, "type": { "fqn": "projen.github.MergifyOptions" } }, { "abstract": true, "docs": { "default": "- No minimum version is being enforced", "remarks": "This can be useful to set to 1, as breaking changes before the 1.x major\nrelease are not incrementing the major version number.\n\nCan not be set together with `majorVersion`.", "stability": "stable", "summary": "Minimal Major version to release." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 432 }, "name": "minMajorVersion", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- no \"engines\" specified", "remarks": "Only set this if your package will not work properly on specific (older?)\nNode versions.", "stability": "stable", "summary": "Minimum Node.js version to require via package.json `engines` (inclusive)." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 441 }, "name": "minNodeVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "deprecated": "- Use `buildWorkflowOptions.mutableBuild`", "remarks": "This means\nthat any files synthesized by projen or e.g. test snapshots will always be up-to-date\nbefore a PR is merged.\n\nImplies that PR builds do not have anti-tamper checks.", "stability": "deprecated", "summary": "Automatically update files modified during builds to pull-request branches." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 452 }, "name": "mutableBuild", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- The next version will be determined based on the commit history and project settings.", "remarks": "If present, this shell command will be run before the bump is executed, and\nit determines what version to release. It will be executed in the following\nenvironment:\n\n- Working directory: the project directory.\n- `$VERSION`: the current version. Looks like `1.2.3`.\n- `$LATEST_TAG`: the most recent tag. Looks like `prefix-v1.2.3`, or may be unset.\n- `$SUGGESTED_BUMP`: the suggested bump action based on commits. One of `major|minor|patch|none`.\n\nThe command should print one of the following to `stdout`:\n\n- Nothing: the next version number will be determined based on commit history.\n- `x.y.z`: the next version number will be `x.y.z`.\n- `major|minor|patch`: the next version number will be the current version number\n with the indicated component bumped.\n\nThis setting cannot be specified together with `minMajorVersion`; the invoked\nscript can be used to achieve the effects of `minMajorVersion`.", "stability": "stable", "summary": "A shell command to control the next version to release." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 480 }, "name": "nextVersionCommand", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- for scoped packages (e.g. `foo@bar`), the default is\n`NpmAccess.RESTRICTED`, for non-scoped packages, the default is\n`NpmAccess.PUBLIC`.", "stability": "stable", "summary": "Access level of the npm package." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 487 }, "name": "npmAccess", "optional": true, "type": { "fqn": "projen.javascript.NpmAccess" } }, { "abstract": true, "docs": { "default": "\"latest\"", "remarks": "To set the npm dist-tag for release branches, set the `npmDistTag` property\nfor each branch.", "stability": "stable", "summary": "The npmDistTag to use when publishing from the default branch." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 494 }, "name": "npmDistTag", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "deprecated": "- use `project.addPackageIgnore`", "stability": "deprecated", "summary": "Additional entries to .npmignore." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 499 }, "name": "npmignore", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 504 }, "name": "npmignoreEnabled", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Configuration options for .npmignore file." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 508 }, "name": "npmIgnoreOptions", "optional": true, "type": { "fqn": "projen.IgnoreFileOptions" } }, { "abstract": true, "docs": { "default": "- true for public packages, false otherwise", "remarks": "A supported package manager is required to publish a package with npm provenance statements and\nyou will need to use a supported CI/CD provider.\n\nNote that the projen `Release` and `Publisher` components are using `publib` to publish packages,\nwhich is using npm internally and supports provenance statements independently of the package manager used.", "stability": "stable", "summary": "Should provenance statements be generated when the package is published." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 518 }, "name": "npmProvenance", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "deprecated": "use `npmRegistryUrl` instead", "remarks": "Cannot be set together with `npmRegistryUrl`.", "stability": "deprecated", "summary": "The host name of the npm registry to publish to." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 524 }, "name": "npmRegistry", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\"https://registry.npmjs.org\"", "remarks": "Must be a URL (e.g. start with \"https://\" or \"http://\")", "stability": "stable", "summary": "The base URL of the npm package registry." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 530 }, "name": "npmRegistryUrl", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\"NPM_TOKEN\"", "stability": "stable", "summary": "GitHub secret which contains the NPM token to use when publishing packages." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 535 }, "name": "npmTokenSecret", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- false", "stability": "stable", "summary": "Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 540 }, "name": "npmTrustedPublishing", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`)." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 545 }, "name": "package", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- Detected from the calling process or `YARN_CLASSIC` if detection fails.", "stability": "stable", "summary": "The Node Package Manager used to execute scripts." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 550 }, "name": "packageManager", "optional": true, "type": { "fqn": "projen.javascript.NodePackageManager" } }, { "abstract": true, "docs": { "default": "- defaults to project name", "stability": "stable", "summary": "The \"name\" in package.json." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 555 }, "name": "packageName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Options for `peerDeps`." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 563 }, "name": "peerDependencyOptions", "optional": true, "type": { "fqn": "projen.javascript.PeerDependencyOptions" } }, { "abstract": true, "docs": { "default": "[]", "remarks": "Dependencies listed here are required to\nbe installed (and satisfied) by the _consumer_ of this library. Using peer\ndependencies allows you to ensure that only a single module of a certain\nlibrary exists in the `node_modules` tree of your consumers.\n\nNote that prior to npm@7, peer dependencies are _not_ automatically\ninstalled, which means that adding peer dependencies to a library will be a\nbreaking change for your customers.\n\nUnless `peerDependencyOptions.pinnedDevDependency` is disabled (it is\nenabled by default), projen will automatically add a dev dependency with a\npinned version for each peer dependency. This will ensure that you build &\ntest your module against the lowest peer version required.", "stability": "stable", "summary": "Peer dependencies for this module." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 581 }, "name": "peerDeps", "optional": true, "type": { "collection": { "elementtype": { "union": { "types": [ { "primitive": "string" }, { "fqn": "cdklabs-projen-project-types.yarn.IWorkspaceReference" } ] } }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "\"10.33.0\"", "stability": "stable", "summary": "The version of PNPM to use if using PNPM as a package manager." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 586 }, "name": "pnpmVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "[]", "stability": "stable", "summary": "Steps to execute after build as part of the release workflow." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 591 }, "name": "postBuildSteps", "optional": true, "type": { "collection": { "elementtype": { "fqn": "projen.github.workflows.JobStep" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- normal semantic versions", "stability": "stable", "summary": "Bump versions from the default branch as pre-releases (e.g. \"beta\", \"alpha\", \"pre\")." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 596 }, "name": "prerelease", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Setup prettier." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 601 }, "name": "prettier", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Prettier options." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 606 }, "name": "prettierOptions", "optional": true, "type": { "fqn": "projen.javascript.PrettierOptions" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Make this a private package." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 611 }, "name": "private", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 616 }, "name": "projectTree", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "ProjectType.UNKNOWN", "deprecated": "no longer supported at the base project level", "stability": "deprecated", "summary": "Which type of project this is (library/app)." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 622 }, "name": "projectType", "optional": true, "type": { "fqn": "projen.ProjectType" } }, { "abstract": true, "docs": { "default": "\"npx projen\"", "remarks": "Can be used to customize in special environments.", "stability": "stable", "summary": "The shell command to use in order to run the projen CLI." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 628 }, "name": "projenCommand", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- use a personal access token named PROJEN_GITHUB_TOKEN", "stability": "stable", "summary": "Choose a method of providing GitHub API access for projen workflows." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 633 }, "name": "projenCredentials", "optional": true, "type": { "fqn": "projen.github.GithubCredentials" } }, { "abstract": true, "docs": { "default": "- true if not a subproject", "stability": "stable", "summary": "Indicates of \"projen\" should be installed as a devDependency." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 638 }, "name": "projenDevDependency", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- true if projenrcJson is false", "stability": "stable", "summary": "Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 643 }, "name": "projenrcJs", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 648 }, "name": "projenrcJson", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Options for .projenrc.json." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 653 }, "name": "projenrcJsonOptions", "optional": true, "type": { "fqn": "projen.ProjenrcJsonOptions" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Options for .projenrc.js." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 658 }, "name": "projenrcJsOptions", "optional": true, "type": { "fqn": "projen.javascript.ProjenrcOptions" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Use TypeScript for your projenrc file (`.projenrc.ts`)." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 663 }, "name": "projenrcTs", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Options for .projenrc.ts." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 667 }, "name": "projenrcTsOptions", "optional": true, "type": { "fqn": "projen.typescript.ProjenrcOptions" } }, { "abstract": true, "docs": { "default": "\"PROJEN_GITHUB_TOKEN\"", "deprecated": "use `projenCredentials`", "remarks": "This token needs to have the `repo`, `workflows`\nand `packages` scope.", "stability": "deprecated", "summary": "The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 675 }, "name": "projenTokenSecret", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- Defaults to the latest version.", "stability": "stable", "summary": "Version of projen to install." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 680 }, "name": "projenVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Instead of actually publishing to package managers, just print the publishing command." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 685 }, "name": "publishDryRun", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "remarks": "Normally, publishing only happens within automated workflows. Enable this\nin order to create a publishing task for each publishing activity.", "stability": "stable", "summary": "Define publishing tasks that can be executed manually as well as workflows." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 692 }, "name": "publishTasks", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Include a GitHub pull request template." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 697 }, "name": "pullRequestTemplate", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default content", "stability": "stable", "summary": "The contents of the pull request template." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 702 }, "name": "pullRequestTemplateContents", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- { filename: 'README.md', contents: '# replace this' }", "stability": "stable", "summary": "The README setup." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 707 }, "name": "readme", "optional": true, "type": { "fqn": "projen.SampleReadmeProps" } }, { "abstract": true, "docs": { "default": "ReleasableCommits.everyCommit()", "stability": "stable", "summary": "Find commits that should be considered releasable Used to decide if a release is required." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 712 }, "name": "releasableCommits", "optional": true, "type": { "fqn": "projen.ReleasableCommits" } }, { "abstract": true, "docs": { "default": "- no additional branches are used for release. you can use\n`addBranch()` to add additional branches.", "remarks": "A workflow will be created for each\nrelease branch which will publish releases from commits in this branch.\nEach release branch _must_ be assigned a major version number which is used\nto enforce that versions published from that branch always use that major\nversion. If multiple branches are used, the `majorVersion` field must also\nbe provided for the default branch.", "stability": "stable", "summary": "Defines additional release branches." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 724 }, "name": "releaseBranches", "optional": true, "type": { "collection": { "elementtype": { "fqn": "projen.release.BranchOptions" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- no environment used, unless set at the artifact level", "remarks": "This can be used to add an explicit approval step to the release\nor limit who can initiate a release through environment protection rules.\n\nWhen multiple artifacts are released, the environment can be overwritten\non a per artifact basis.", "stability": "stable", "summary": "The GitHub Actions environment used for the release." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 734 }, "name": "releaseEnvironment", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "deprecated": "Use `releaseTrigger: ReleaseTrigger.continuous()` instead", "stability": "deprecated", "summary": "Automatically release new versions every commit to one of branches in `releaseBranches`." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 740 }, "name": "releaseEveryCommit", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Create a github issue on every failed publishing task." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 745 }, "name": "releaseFailureIssue", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "\"failed-release\"", "remarks": "Only applies if `releaseFailureIssue` is true.", "stability": "stable", "summary": "The label to apply to issues indicating publish failures." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 751 }, "name": "releaseFailureIssueLabel", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no scheduled releases", "deprecated": "Use `releaseTrigger: ReleaseTrigger.scheduled()` instead", "stability": "deprecated", "summary": "CRON schedule to trigger new releases." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 757 }, "name": "releaseSchedule", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "\"v\"", "remarks": "Useful if you are releasing on multiple branches with overlapping version numbers.\nNote: this prefix is used to detect the latest tagged version\nwhen bumping, so if you change this on a project with an existing version\nhistory, you may need to manually tag your latest release\nwith the new prefix.", "stability": "stable", "summary": "Automatically add the given prefix to release tags." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 766 }, "name": "releaseTagPrefix", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Automatically release to npm when new versions are introduced." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 771 }, "name": "releaseToNpm", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- Continuous releases (`ReleaseTrigger.continuous()`)", "stability": "stable", "summary": "The release trigger to use." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 776 }, "name": "releaseTrigger", "optional": true, "type": { "fqn": "projen.release.ReleaseTrigger" } }, { "abstract": true, "docs": { "default": "- true if not a subproject", "deprecated": "see `release`.", "stability": "deprecated", "summary": "DEPRECATED: renamed to `release`." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 782 }, "name": "releaseWorkflow", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "{}", "stability": "stable", "summary": "Build environment variables for release workflows." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 787 }, "name": "releaseWorkflowEnv", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "\"release\"", "stability": "stable", "summary": "The name of the default release workflow." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 792 }, "name": "releaseWorkflowName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "A set of workflow steps to execute in order to setup the workflow container." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 796 }, "name": "releaseWorkflowSetupSteps", "optional": true, "type": { "collection": { "elementtype": { "fqn": "projen.github.workflows.JobStep" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Use renovatebot to handle dependency upgrades." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 801 }, "name": "renovatebot", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Options for renovatebot." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 806 }, "name": "renovatebotOptions", "optional": true, "type": { "fqn": "projen.RenovatebotOptions" } }, { "abstract": true, "docs": { "remarks": "See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository", "stability": "stable", "summary": "The repository is the location where the actual code for your package lives." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 811 }, "name": "repository", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Generate one-time sample in `src/` and `test/` if there are no files there." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 816 }, "name": "sampleCode", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- fetch all scoped packages from the public npm registry", "stability": "stable", "summary": "Options for privately hosted scoped packages." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 821 }, "name": "scopedPackagesOptions", "optional": true, "type": { "collection": { "elementtype": { "fqn": "projen.javascript.ScopedPackagesOptions" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "{}", "deprecated": "use `project.addTask()` or `package.setScript()`", "remarks": "If a script has the same name as a standard script,\nthe standard script will be overwritten.\nAlso adds the script as a task.", "stability": "deprecated", "summary": "npm scripts to include." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 830 }, "name": "scripts", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "\"src\"", "stability": "stable", "summary": "Typescript sources directory." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 835 }, "name": "srcdir", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Package's Stability." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 839 }, "name": "stability", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "remarks": "See `staleOptions` for options.", "stability": "stable", "summary": "Auto-close of stale issues and pull request." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 845 }, "name": "stale", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- see defaults in `StaleOptions`", "remarks": "To disable set `stale` to `false`.", "stability": "stable", "summary": "Auto-close stale issues and pull requests." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 851 }, "name": "staleOptions", "optional": true, "type": { "fqn": "projen.github.StaleOptions" } }, { "abstract": true, "docs": { "default": "\"test\"", "remarks": "Tests files should be named `xxx.test.ts`.\nIf this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`),\nthen tests are going to be compiled into `lib/` and executed as javascript.\nIf the test directory is outside of `src`, then we configure jest to\ncompile the code in-memory.", "stability": "stable", "summary": "Jest tests directory." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 860 }, "name": "testdir", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- default options", "stability": "stable", "summary": "Custom TSConfig." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 865 }, "name": "tsconfig", "optional": true, "type": { "fqn": "projen.javascript.TypescriptConfigOptions" } }, { "abstract": true, "docs": { "default": "- use the production tsconfig options", "stability": "stable", "summary": "Custom tsconfig options for the development tsconfig.json file (used for testing)." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 870 }, "name": "tsconfigDev", "optional": true, "type": { "fqn": "projen.javascript.TypescriptConfigOptions" } }, { "abstract": true, "docs": { "default": "\"tsconfig.dev.json\"", "stability": "stable", "summary": "The name of the development tsconfig.json file." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 875 }, "name": "tsconfigDevFile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Options for ts-jest." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 879 }, "name": "tsJestOptions", "optional": true, "type": { "fqn": "projen.typescript.TsJestOptions" } }, { "abstract": true, "docs": { "default": "\"latest\"", "remarks": "NOTE: Typescript is not semantically versioned and should remain on the\nsame minor, so we recommend using a `~` dependency (e.g. `~1.2.3`).", "stability": "stable", "summary": "TypeScript version to use." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 886 }, "name": "typescriptVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- standard configuration applicable for GitHub repositories", "remarks": "Given values either append to default configuration or overwrite values in it.", "stability": "stable", "summary": "Custom configuration used when creating changelog with commit-and-tag-version package." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 892 }, "name": "versionrcOptions", "optional": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "true", "remarks": "Enabled by default for root projects. Disabled for non-root projects.", "stability": "stable", "summary": "Enable VSCode integration." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 898 }, "name": "vscode", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "\"yarn install --frozen-lockfile && yarn projen\"", "stability": "stable", "summary": "Workflow steps to use in order to bootstrap this repo." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 903 }, "name": "workflowBootstrapSteps", "optional": true, "type": { "collection": { "elementtype": { "fqn": "projen.github.workflows.JobStep" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- default image", "stability": "stable", "summary": "Container image to use for GitHub workflows." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 908 }, "name": "workflowContainerImage", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- default GitHub Actions user", "stability": "stable", "summary": "The git identity to use in workflows." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 913 }, "name": "workflowGitIdentity", "optional": true, "type": { "fqn": "projen.github.GitIdentity" } }, { "abstract": true, "docs": { "default": "'lts/*'", "stability": "stable", "summary": "The node version to use in GitHub workflows." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 918 }, "name": "workflowNodeVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Enable Node.js package cache in GitHub workflows." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 923 }, "name": "workflowPackageCache", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "[\"ubuntu-latest\"]", "stability": "stable", "summary": "Github Runner selection labels." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 928 }, "name": "workflowRunsOn", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Github Runner Group selection options." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 932 }, "name": "workflowRunsOnGroup", "optional": true, "type": { "fqn": "projen.GroupRunnerOptions" } }, { "abstract": true, "docs": { "default": "\"packages\"", "stability": "stable", "summary": "The workspace scope the package is located in." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 937 }, "name": "workspaceScope", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- Yarn Berry v4 with all default options", "stability": "stable", "summary": "Options for Yarn Berry." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-options.ts", "line": 942 }, "name": "yarnBerryOptions", "optional": true, "type": { "fqn": "projen.javascript.YarnBerryOptions" } } ], "symbolId": "src/yarn/typescript-workspace-options:TypeScriptWorkspaceOptions" }, "cdklabs-projen-project-types.yarn.VsCodeWorkspaceOptions": { "assembly": "cdklabs-projen-project-types", "datatype": true, "docs": { "stability": "stable", "summary": "VsCodeWorkspaceOptions." }, "fqn": "cdklabs-projen-project-types.yarn.VsCodeWorkspaceOptions", "kind": "interface", "locationInModule": { "filename": "src/yarn/vscode-workspace-options.ts", "line": 6 }, "name": "VsCodeWorkspaceOptions", "namespace": "yarn", "properties": [ { "abstract": true, "docs": { "default": "false", "remarks": "This can be useful to manage the repository configuration.", "stability": "stable", "summary": "Adds a workspace for the repository root." }, "immutable": true, "locationInModule": { "filename": "src/yarn/vscode-workspace-options.ts", "line": 11 }, "name": "includeRootWorkspace", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "", "stability": "stable", "summary": "The name of the root workspace if included." }, "immutable": true, "locationInModule": { "filename": "src/yarn/vscode-workspace-options.ts", "line": 16 }, "name": "rootWorkspaceName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/yarn/vscode-workspace-options:VsCodeWorkspaceOptions" }, "cdklabs-projen-project-types.yarn.WorkspaceRelease": { "assembly": "cdklabs-projen-project-types", "base": "projen.Component", "docs": { "stability": "stable" }, "fqn": "cdklabs-projen-project-types.yarn.WorkspaceRelease", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "src/yarn/typescript-workspace-release.ts", "line": 30 }, "parameters": [ { "name": "project", "type": { "fqn": "cdklabs-projen-project-types.yarn.TypeScriptWorkspace" } }, { "name": "options", "type": { "fqn": "cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions" } } ] }, "kind": "class", "locationInModule": { "filename": "src/yarn/typescript-workspace-release.ts", "line": 25 }, "name": "WorkspaceRelease", "namespace": "yarn", "properties": [ { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-release.ts", "line": 28 }, "name": "workspace", "type": { "fqn": "cdklabs-projen-project-types.yarn.TypeScriptWorkspace" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-release.ts", "line": 26 }, "name": "publisher", "optional": true, "type": { "fqn": "projen.release.Publisher" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-release.ts", "line": 27 }, "name": "version", "optional": true, "type": { "fqn": "projen.Version" } } ], "symbolId": "src/yarn/typescript-workspace-release:WorkspaceRelease" }, "cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions": { "assembly": "cdklabs-projen-project-types", "datatype": true, "docs": { "stability": "stable" }, "fqn": "cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions", "kind": "interface", "locationInModule": { "filename": "src/yarn/typescript-workspace-release.ts", "line": 6 }, "name": "WorkspaceReleaseOptions", "namespace": "yarn", "properties": [ { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-release.ts", "line": 7 }, "name": "private", "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-release.ts", "line": 17 }, "name": "versionBranchOptions", "type": { "fqn": "projen.VersionBranchOptions" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-release.ts", "line": 16 }, "name": "environment", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-release.ts", "line": 14 }, "name": "nextVersionCommand", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-release.ts", "line": 12 }, "name": "npmDistTag", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-release.ts", "line": 15 }, "name": "npmTrustedPublishing", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-release.ts", "line": 11 }, "name": "publishToNpm", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-release.ts", "line": 13 }, "name": "releasableCommits", "optional": true, "type": { "fqn": "projen.ReleasableCommits" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "For runtime and peer dependencies, the type of dependency we take on each package." }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-release.ts", "line": 22 }, "name": "repoRuntimeDependencies", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "'lts/*'", "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "src/yarn/typescript-workspace-release.ts", "line": 10 }, "name": "workflowNodeVersion", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "src/yarn/typescript-workspace-release:WorkspaceReleaseOptions" } }, "usedFeatures": [ "class-covariant-overrides" ], "version": "0.3.28", "fingerprint": "GaeSTVss5IrQk4HCdidI65gnfNpaVRD08N3SirCLOzI=" }