# API Reference ## Constructs ### TypeSafeRestApi A construct for creating an api gateway rest api based on the definition in the OpenAPI spec. #### Initializers ```java import software.aws.awsprototypingsdk.typesafeapi.TypeSafeRestApi; TypeSafeRestApi.Builder.create(Construct scope, java.lang.String id) // .cloudWatchRole(java.lang.Boolean) // .deploy(java.lang.Boolean) // .deployOptions(StageOptions) // .description(java.lang.String) // .disableExecuteApiEndpoint(java.lang.Boolean) // .domainName(DomainNameOptions) // .endpointExportName(java.lang.String) // .endpointTypes(java.util.List) // .failOnWarnings(java.lang.Boolean) // .parameters(java.util.Map) // .policy(PolicyDocument) // .restApiName(java.lang.String) // .retainDeployments(java.lang.Boolean) .integrations(java.util.Map) .operationLookup(java.util.Map) // .apiKeyOptions(ApiKeyOptions) // .corsOptions(CorsOptions) // .defaultAuthorizer(Authorizer) .specPath(java.lang.String) // .minCompressionSize(Size) // .webAclOptions(TypeSafeApiWebAclOptions) .build(); ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | software.constructs.Construct | *No description.* | | id | java.lang.String | *No description.* | | cloudWatchRole | java.lang.Boolean | Automatically configure an AWS CloudWatch role for API Gateway. | | deploy | java.lang.Boolean | Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes. | | deployOptions | software.amazon.awscdk.services.apigateway.StageOptions | Options for the API Gateway stage that will always point to the latest deployment when `deploy` is enabled. | | description | java.lang.String | A description of the RestApi construct. | | disableExecuteApiEndpoint | java.lang.Boolean | Specifies whether clients can invoke the API using the default execute-api endpoint. | | domainName | software.amazon.awscdk.services.apigateway.DomainNameOptions | Configure a custom domain name and map it to this API. | | endpointExportName | java.lang.String | Export name for the CfnOutput containing the API endpoint. | | endpointTypes | java.util.List | A list of the endpoint types of the API. | | failOnWarnings | java.lang.Boolean | Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource. | | parameters | java.util.Map | Custom header parameters for the request. | | policy | software.amazon.awscdk.services.iam.PolicyDocument | A policy document that contains the permissions for this RestApi. | | restApiName | java.lang.String | A name for the API Gateway RestApi resource. | | retainDeployments | java.lang.Boolean | Retains old deployment resources when the API changes. | | integrations | java.util.MapTypeSafeApiIntegration> | A mapping of API operation to its integration. | | operationLookup | java.util.MapOperationDetails> | Details about each operation. | | apiKeyOptions | ApiKeyOptions | Options for API keys. | | corsOptions | software.amazon.awscdk.services.apigateway.CorsOptions | Cross Origin Resource Sharing options for the API. | | defaultAuthorizer | Authorizer | The default authorizer to use for your api. | | specPath | java.lang.String | Path to the JSON open api spec. | | minCompressionSize | software.amazon.awscdk.Size | A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API. | | webAclOptions | TypeSafeApiWebAclOptions | Options for the AWS WAF v2 WebACL associated with the api. | --- ##### `scope`^Required - *Type:* software.constructs.Construct --- ##### `id`^Required - *Type:* java.lang.String --- ##### `cloudWatchRole`^Optional - *Type:* java.lang.Boolean - *Default:* false if `@aws-cdk/aws-apigateway:disableCloudWatchRole` is enabled, true otherwise Automatically configure an AWS CloudWatch role for API Gateway. --- ##### `deploy`^Optional - *Type:* java.lang.Boolean - *Default:* true Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes. Since API Gateway deployments are immutable, When this option is enabled (by default), an AWS::ApiGateway::Deployment resource will automatically created with a logical ID that hashes the API model (methods, resources and options). This means that when the model changes, the logical ID of this CloudFormation resource will change, and a new deployment will be created. If this is set, `latestDeployment` will refer to the `Deployment` object and `deploymentStage` will refer to a `Stage` that points to this deployment. To customize the stage options, use the `deployOptions` property. A CloudFormation Output will also be defined with the root URL endpoint of this REST API. --- ##### `deployOptions`^Optional - *Type:* software.amazon.awscdk.services.apigateway.StageOptions - *Default:* Based on defaults of `StageOptions`. Options for the API Gateway stage that will always point to the latest deployment when `deploy` is enabled. If `deploy` is disabled, this value cannot be set. --- ##### `description`^Optional - *Type:* java.lang.String - *Default:* 'Automatically created by the RestApi construct' A description of the RestApi construct. --- ##### `disableExecuteApiEndpoint`^Optional - *Type:* java.lang.Boolean - *Default:* false Specifies whether clients can invoke the API using the default execute-api endpoint. To require that clients use a custom domain name to invoke the API, disable the default endpoint. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) --- ##### `domainName`^Optional - *Type:* software.amazon.awscdk.services.apigateway.DomainNameOptions - *Default:* no domain name is defined, use `addDomainName` or directly define a `DomainName`. Configure a custom domain name and map it to this API. --- ##### `endpointExportName`^Optional - *Type:* java.lang.String - *Default:* when no export name is given, output will be created without export Export name for the CfnOutput containing the API endpoint. --- ##### `endpointTypes`^Optional - *Type:* java.util.List - *Default:* EndpointType.EDGE A list of the endpoint types of the API. Use this property when creating an API. --- ##### `failOnWarnings`^Optional - *Type:* java.lang.Boolean - *Default:* false Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource. --- ##### `parameters`^Optional - *Type:* java.util.Map - *Default:* No parameters. Custom header parameters for the request. > [https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-rest-api.html](https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-rest-api.html) --- ##### `policy`^Optional - *Type:* software.amazon.awscdk.services.iam.PolicyDocument - *Default:* No policy. A policy document that contains the permissions for this RestApi. --- ##### `restApiName`^Optional - *Type:* java.lang.String - *Default:* ID of the RestApi construct. A name for the API Gateway RestApi resource. --- ##### `retainDeployments`^Optional - *Type:* java.lang.Boolean - *Default:* false Retains old deployment resources when the API changes. This allows manually reverting stages to point to old deployments via the AWS Console. --- ##### `integrations`^Required - *Type:* java.util.MapTypeSafeApiIntegration> A mapping of API operation to its integration. --- ##### `operationLookup`^Required - *Type:* java.util.MapOperationDetails> Details about each operation. --- ##### `apiKeyOptions`^Optional - *Type:* ApiKeyOptions Options for API keys. --- ##### `corsOptions`^Optional - *Type:* software.amazon.awscdk.services.apigateway.CorsOptions Cross Origin Resource Sharing options for the API. --- ##### `defaultAuthorizer`^Optional - *Type:* Authorizer The default authorizer to use for your api. When omitted, no default authorizer is used. Authorizers specified at the integration level will override this for that operation. --- ##### `specPath`^Required - *Type:* java.lang.String Path to the JSON open api spec. --- ##### `minCompressionSize`^Optional - *Type:* software.amazon.awscdk.Size - *Default:* Compression is disabled. A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size. --- ##### `webAclOptions`^Optional - *Type:* TypeSafeApiWebAclOptions Options for the AWS WAF v2 WebACL associated with the api. By default, a Web ACL with the AWS default managed rule set will be associated with the API. These options may disable or override the defaults. --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | --- ##### `toString` ```java public java.lang.String toString() ``` Returns a string representation of this construct. #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | --- ##### `isConstruct` ```java import software.aws.awsprototypingsdk.typesafeapi.TypeSafeRestApi; TypeSafeRestApi.isConstruct(java.lang.Object x) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* java.lang.Object Any object. --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | software.constructs.Node | The tree node. | | api | software.amazon.awscdk.services.apigateway.SpecRestApi | Underlying API Gateway API construct. | | extendedApiSpecification | java.lang.Object | The OpenAPI specification with applied API gateway extensions. | | ipSet | software.amazon.awscdk.services.wafv2.CfnIPSet | Reference to the IP set if created. | | webAcl | software.amazon.awscdk.services.wafv2.CfnWebACL | Reference to the webacl, if created. | | webAclAssociation | software.amazon.awscdk.services.wafv2.CfnWebACLAssociation | Reference to the web acl association if created. | --- ##### `node`^Required ```java public Node getNode(); ``` - *Type:* software.constructs.Node The tree node. --- ##### `api`^Required ```java public SpecRestApi getApi(); ``` - *Type:* software.amazon.awscdk.services.apigateway.SpecRestApi Underlying API Gateway API construct. --- ##### `extendedApiSpecification`^Required ```java public java.lang.Object getExtendedApiSpecification(); ``` - *Type:* java.lang.Object The OpenAPI specification with applied API gateway extensions. --- ##### `ipSet`^Optional ```java public CfnIPSet getIpSet(); ``` - *Type:* software.amazon.awscdk.services.wafv2.CfnIPSet Reference to the IP set if created. --- ##### `webAcl`^Optional ```java public CfnWebACL getWebAcl(); ``` - *Type:* software.amazon.awscdk.services.wafv2.CfnWebACL Reference to the webacl, if created. --- ##### `webAclAssociation`^Optional ```java public CfnWebACLAssociation getWebAclAssociation(); ``` - *Type:* software.amazon.awscdk.services.wafv2.CfnWebACLAssociation Reference to the web acl association if created. --- ## Structs ### ApiGatewayIntegration Represents an api gateway integration. > [https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration.html](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration.html) #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.ApiGatewayIntegration; ApiGatewayIntegration.builder() // .cacheKeyParameters(java.util.List) // .cacheNamespace(java.lang.String) // .connectionId(java.lang.String) // .connectionType(java.lang.String) // .contentHandling(java.lang.String) // .credentials(java.lang.String) // .httpMethod(java.lang.String) // .passthroughBehavior(java.lang.String) // .requestParameters(java.util.Map) // .requestTemplates(java.util.Map) // .responses(java.util.Map) // .timeoutInMillis(java.lang.Number) // .tlsConfig(ApiGatewayIntegrationTlsConfig) // .type(java.lang.String) // .uri(java.lang.String) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cacheKeyParameters | java.util.List | A list of request parameters whose values are to be cached. | | cacheNamespace | java.lang.String | An API-specific tag group of related cached parameters. | | connectionId | java.lang.String | The ID of a VpcLink for the private integration. | | connectionType | java.lang.String | The integration connection type. | | contentHandling | java.lang.String | Request payload encoding conversion types. | | credentials | java.lang.String | For AWS IAM role-based credentials, specify the ARN of an appropriate IAM role. | | httpMethod | java.lang.String | The HTTP method used in the integration request. | | passthroughBehavior | java.lang.String | Specifies how a request payload of unmapped content type is passed through the integration request without modification. | | requestParameters | java.util.Map | Specifies mappings from method request parameters to integration request parameters. | | requestTemplates | java.util.Map | Mapping templates for a request payload of specified MIME types. | | responses | java.util.MapApiGatewayIntegrationResponse> | Defines the method's responses and specifies desired parameter mappings or payload mappings from integration responses to method responses. | | timeoutInMillis | java.lang.Number | Custom timeout between 50 and 29,000 milliseconds. | | tlsConfig | ApiGatewayIntegrationTlsConfig | Specifies the TLS configuration for an integration. | | type | java.lang.String | The type of integration with the specified backend. | | uri | java.lang.String | The endpoint URI of the backend. | --- ##### `cacheKeyParameters`^Optional ```java public java.util.List getCacheKeyParameters(); ``` - *Type:* java.util.List A list of request parameters whose values are to be cached. --- ##### `cacheNamespace`^Optional ```java public java.lang.String getCacheNamespace(); ``` - *Type:* java.lang.String An API-specific tag group of related cached parameters. --- ##### `connectionId`^Optional ```java public java.lang.String getConnectionId(); ``` - *Type:* java.lang.String The ID of a VpcLink for the private integration. > [https://docs.aws.amazon.com/apigateway/latest/api/API_VpcLink.html](https://docs.aws.amazon.com/apigateway/latest/api/API_VpcLink.html) --- ##### `connectionType`^Optional ```java public java.lang.String getConnectionType(); ``` - *Type:* java.lang.String The integration connection type. The valid value is "VPC_LINK" for private integration or "INTERNET", otherwise. --- ##### `contentHandling`^Optional ```java public java.lang.String getContentHandling(); ``` - *Type:* java.lang.String Request payload encoding conversion types. Valid values are 1) CONVERT_TO_TEXT, for converting a binary payload into a base64-encoded string or converting a text payload into a utf-8-encoded string or passing through the text payload natively without modification, and 2) CONVERT_TO_BINARY, for converting a text payload into a base64-decoded blob or passing through a binary payload natively without modification. --- ##### `credentials`^Optional ```java public java.lang.String getCredentials(); ``` - *Type:* java.lang.String For AWS IAM role-based credentials, specify the ARN of an appropriate IAM role. If unspecified, credentials default to resource-based permissions that must be added manually to allow the API to access the resource. For more information, see Granting Permissions Using a Resource Policy. Note: When using IAM credentials, make sure that AWS STS Regional endpoints are enabled for the Region where this API is deployed for best performance. --- ##### `httpMethod`^Optional ```java public java.lang.String getHttpMethod(); ``` - *Type:* java.lang.String The HTTP method used in the integration request. For Lambda function invocations, the value must be POST. --- ##### `passthroughBehavior`^Optional ```java public java.lang.String getPassthroughBehavior(); ``` - *Type:* java.lang.String Specifies how a request payload of unmapped content type is passed through the integration request without modification. Supported values are when_no_templates, when_no_match, and never. > [https://docs.aws.amazon.com/apigateway/latest/api/API_Integration.html#passthroughBehavior](https://docs.aws.amazon.com/apigateway/latest/api/API_Integration.html#passthroughBehavior) --- ##### `requestParameters`^Optional ```java public java.util.Map getRequestParameters(); ``` - *Type:* java.util.Map Specifies mappings from method request parameters to integration request parameters. Supported request parameters are querystring, path, header, and body. > [https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-requestParameters.html](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-requestParameters.html) --- ##### `requestTemplates`^Optional ```java public java.util.Map getRequestTemplates(); ``` - *Type:* java.util.Map Mapping templates for a request payload of specified MIME types. > [https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-requestTemplates.html](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-requestTemplates.html) --- ##### `responses`^Optional ```java public java.util.Map getResponses(); ``` - *Type:* java.util.MapApiGatewayIntegrationResponse> Defines the method's responses and specifies desired parameter mappings or payload mappings from integration responses to method responses. > [https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-responses.html](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-responses.html) --- ##### `timeoutInMillis`^Optional ```java public java.lang.Number getTimeoutInMillis(); ``` - *Type:* java.lang.Number Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds. --- ##### `tlsConfig`^Optional ```java public ApiGatewayIntegrationTlsConfig getTlsConfig(); ``` - *Type:* ApiGatewayIntegrationTlsConfig Specifies the TLS configuration for an integration. > [https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-extensions-integration-tls-config.html](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-extensions-integration-tls-config.html) --- ##### `type`^Optional ```java public java.lang.String getType(); ``` - *Type:* java.lang.String The type of integration with the specified backend. > [https://docs.aws.amazon.com/apigateway/latest/api/API_Integration.html#type](https://docs.aws.amazon.com/apigateway/latest/api/API_Integration.html#type) --- ##### `uri`^Optional ```java public java.lang.String getUri(); ``` - *Type:* java.lang.String The endpoint URI of the backend. For integrations of the aws type, this is an ARN value. For the HTTP integration, this is the URL of the HTTP endpoint including the https or http scheme. --- ### ApiGatewayIntegrationResponse API Gateway integration response. > [https://docs.aws.amazon.com/apigateway/latest/api/API_Integration.html](https://docs.aws.amazon.com/apigateway/latest/api/API_Integration.html) #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.ApiGatewayIntegrationResponse; ApiGatewayIntegrationResponse.builder() .responseParameters(java.util.Map) .responseTemplates(java.util.Map) .statusCode(java.lang.String) // .contentHandling(java.lang.String) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | responseParameters | java.util.Map | Specifies parameter mappings for the response. | | responseTemplates | java.util.Map | Specifies MIME type-specific mapping templates for the response’s payload. | | statusCode | java.lang.String | HTTP status code for the method response. | | contentHandling | java.lang.String | Response payload encoding conversion types. | --- ##### `responseParameters`^Required ```java public java.util.Map getResponseParameters(); ``` - *Type:* java.util.Map Specifies parameter mappings for the response. --- ##### `responseTemplates`^Required ```java public java.util.Map getResponseTemplates(); ``` - *Type:* java.util.Map Specifies MIME type-specific mapping templates for the response’s payload. --- ##### `statusCode`^Required ```java public java.lang.String getStatusCode(); ``` - *Type:* java.lang.String HTTP status code for the method response. --- ##### `contentHandling`^Optional ```java public java.lang.String getContentHandling(); ``` - *Type:* java.lang.String Response payload encoding conversion types. Valid values are 1) CONVERT_TO_TEXT, for converting a binary payload into a base64-encoded string or converting a text payload into a utf-8-encoded string or passing through the text payload natively without modification, and 2) CONVERT_TO_BINARY, for converting a text payload into a base64-decoded blob or passing through a binary payload natively without modification. --- ### ApiGatewayIntegrationTlsConfig Specifies the TLS configuration for an integration. > [https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-extensions-integration-tls-config.html](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-extensions-integration-tls-config.html) #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.ApiGatewayIntegrationTlsConfig; ApiGatewayIntegrationTlsConfig.builder() // .insecureSkipVerification(java.lang.Boolean) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | insecureSkipVerification | java.lang.Boolean | Specifies whether or not API Gateway skips verification that the certificate for an integration endpoint is issued by a supported certificate authority. | --- ##### `insecureSkipVerification`^Optional ```java public java.lang.Boolean getInsecureSkipVerification(); ``` - *Type:* java.lang.Boolean Specifies whether or not API Gateway skips verification that the certificate for an integration endpoint is issued by a supported certificate authority. This isn’t recommended, but it enables you to use certificates that are signed by private certificate authorities, or certificates that are self-signed. If enabled, API Gateway still performs basic certificate validation, which includes checking the certificate's expiration date, hostname, and presence of a root certificate authority. Supported only for HTTP and HTTP_PROXY integrations. --- ### ApiKeyOptions Options for API keys. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.ApiKeyOptions; ApiKeyOptions.builder() .source(ApiKeySourceType) // .requiredByDefault(java.lang.Boolean) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | source | software.amazon.awscdk.services.apigateway.ApiKeySourceType | Source type for an API key. | | requiredByDefault | java.lang.Boolean | Set to true to require an API key on all operations by default. | --- ##### `source`^Required ```java public ApiKeySourceType getSource(); ``` - *Type:* software.amazon.awscdk.services.apigateway.ApiKeySourceType Source type for an API key. --- ##### `requiredByDefault`^Optional ```java public java.lang.Boolean getRequiredByDefault(); ``` - *Type:* java.lang.Boolean Set to true to require an API key on all operations by default. Only applicable when the source is HEADER. --- ### AuthorizerProps Properties for an authorizer. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.AuthorizerProps; AuthorizerProps.builder() .authorizationType(AuthorizationType) .authorizerId(java.lang.String) // .authorizationScopes(java.util.List) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | authorizationType | software.amazon.awscdk.services.apigateway.AuthorizationType | The type of the authorizer. | | authorizerId | java.lang.String | The unique identifier for the authorizer. | | authorizationScopes | java.util.List | Scopes for the authorizer, if any. | --- ##### `authorizationType`^Required ```java public AuthorizationType getAuthorizationType(); ``` - *Type:* software.amazon.awscdk.services.apigateway.AuthorizationType The type of the authorizer. --- ##### `authorizerId`^Required ```java public java.lang.String getAuthorizerId(); ``` - *Type:* java.lang.String The unique identifier for the authorizer. --- ##### `authorizationScopes`^Optional ```java public java.util.List getAuthorizationScopes(); ``` - *Type:* java.util.List Scopes for the authorizer, if any. --- ### CidrAllowList Representation of a CIDR range. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.CidrAllowList; CidrAllowList.builder() .cidrRanges(java.util.List) .cidrType(java.lang.String) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cidrRanges | java.util.List | Specify an IPv4 address by using CIDR notation. | | cidrType | java.lang.String | Type of CIDR range. | --- ##### `cidrRanges`^Required ```java public java.util.List getCidrRanges(); ``` - *Type:* java.util.List Specify an IPv4 address by using CIDR notation. For example: To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32 . To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24 . For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing . Specify an IPv6 address by using CIDR notation. For example: To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128 . To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64 . --- ##### `cidrType`^Required ```java public java.lang.String getCidrType(); ``` - *Type:* java.lang.String Type of CIDR range. --- ### CodeGenerationSourceOptions Options for the source files used for code generation. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.CodeGenerationSourceOptions; CodeGenerationSourceOptions.builder() .specPath(java.lang.String) // .smithyJsonModelPath(java.lang.String) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | specPath | java.lang.String | Path to the OpenAPI specification. | | smithyJsonModelPath | java.lang.String | Path to the Smithy json model if applicable. | --- ##### `specPath`^Required ```java public java.lang.String getSpecPath(); ``` - *Type:* java.lang.String Path to the OpenAPI specification. --- ##### `smithyJsonModelPath`^Optional ```java public java.lang.String getSmithyJsonModelPath(); ``` - *Type:* java.lang.String Path to the Smithy json model if applicable. --- ### CognitoAuthorizerProps Properties used to configure a cognito authorizer. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.CognitoAuthorizerProps; CognitoAuthorizerProps.builder() .authorizerId(java.lang.String) .userPools(java.util.List) // .authorizationScopes(java.util.List) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | authorizerId | java.lang.String | Unique identifier for this authorizer. | | userPools | java.util.List | The Cognito user pools associated with this authorizer. | | authorizationScopes | java.util.List | A list of authorization scopes configured on the method. | --- ##### `authorizerId`^Required ```java public java.lang.String getAuthorizerId(); ``` - *Type:* java.lang.String Unique identifier for this authorizer. --- ##### `userPools`^Required ```java public java.util.List getUserPools(); ``` - *Type:* java.util.List The Cognito user pools associated with this authorizer. --- ##### `authorizationScopes`^Optional ```java public java.util.List getAuthorizationScopes(); ``` - *Type:* java.util.List - *Default:* [] A list of authorization scopes configured on the method. When used as the default authorizer, these scopes will be applied to all methods without an authorizer at the integration level. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes) --- ### CustomAuthorizerProps Properties used to configure a custom authorizer. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.CustomAuthorizerProps; CustomAuthorizerProps.builder() .authorizerId(java.lang.String) .function(IFunction) // .authorizerResultTtlInSeconds(java.lang.Number) // .identitySource(java.lang.String) // .type(CustomAuthorizerType) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | authorizerId | java.lang.String | Unique identifier for this authorizer. | | function | software.amazon.awscdk.services.lambda.IFunction | The lambda function used to authorize requests. | | authorizerResultTtlInSeconds | java.lang.Number | The number of seconds during which the authorizer result is cached. | | identitySource | java.lang.String | The source of the identity in an incoming request. | | type | CustomAuthorizerType | The type of custom authorizer. | --- ##### `authorizerId`^Required ```java public java.lang.String getAuthorizerId(); ``` - *Type:* java.lang.String Unique identifier for this authorizer. --- ##### `function`^Required ```java public IFunction getFunction(); ``` - *Type:* software.amazon.awscdk.services.lambda.IFunction The lambda function used to authorize requests. --- ##### `authorizerResultTtlInSeconds`^Optional ```java public java.lang.Number getAuthorizerResultTtlInSeconds(); ``` - *Type:* java.lang.Number - *Default:* 300 The number of seconds during which the authorizer result is cached. --- ##### `identitySource`^Optional ```java public java.lang.String getIdentitySource(); ``` - *Type:* java.lang.String - *Default:* "method.request.header.Authorization" The source of the identity in an incoming request. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identitysource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identitysource) --- ##### `type`^Optional ```java public CustomAuthorizerType getType(); ``` - *Type:* CustomAuthorizerType - *Default:* CustomAuthorizerType.TOKEN The type of custom authorizer. > [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type) --- ### DocumentationConfiguration Configuration for generated documentation. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.DocumentationConfiguration; DocumentationConfiguration.builder() .formats(java.util.List) // .options(GeneratedDocumentationOptions) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | formats | java.util.List<DocumentationFormat> | Formats for generated documentation. | | options | GeneratedDocumentationOptions | Options for the generated documentation projects. | --- ##### `formats`^Required ```java public java.util.List getFormats(); ``` - *Type:* java.util.List<DocumentationFormat> Formats for generated documentation. --- ##### `options`^Optional ```java public GeneratedDocumentationOptions getOptions(); ``` - *Type:* GeneratedDocumentationOptions Options for the generated documentation projects. Note that only those provided for the specified formats will apply --- ### GeneratedCodeProjects Generated code projects. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.GeneratedCodeProjects; GeneratedCodeProjects.builder() // .java(JavaProject) // .python(PythonProject) // .typescript(TypeScriptProject) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | java | io.github.cdklabs.projen.java.JavaProject | Generated java project. | | python | io.github.cdklabs.projen.python.PythonProject | Generated python project. | | typescript | io.github.cdklabs.projen.typescript.TypeScriptProject | Generated typescript project. | --- ##### `java`^Optional ```java public JavaProject getJava(); ``` - *Type:* io.github.cdklabs.projen.java.JavaProject Generated java project. --- ##### `python`^Optional ```java public PythonProject getPython(); ``` - *Type:* io.github.cdklabs.projen.python.PythonProject Generated python project. --- ##### `typescript`^Optional ```java public TypeScriptProject getTypescript(); ``` - *Type:* io.github.cdklabs.projen.typescript.TypeScriptProject Generated typescript project. --- ### GeneratedDocumentationOptions Options for generated documentation projects. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.GeneratedDocumentationOptions; GeneratedDocumentationOptions.builder() // .html2(GeneratedHtml2DocumentationOptions) // .htmlRedoc(GeneratedHtmlRedocDocumentationOptions) // .markdown(GeneratedMarkdownDocumentationOptions) // .plantuml(GeneratedPlantumlDocumentationOptions) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | html2 | GeneratedHtml2DocumentationOptions | Generated html2 documentation project options. | | htmlRedoc | GeneratedHtmlRedocDocumentationOptions | Generated html redoc documentation project options. | | markdown | GeneratedMarkdownDocumentationOptions | Generated markdown documentation project options. | | plantuml | GeneratedPlantumlDocumentationOptions | Generated plantuml documentation project options. | --- ##### `html2`^Optional ```java public GeneratedHtml2DocumentationOptions getHtml2(); ``` - *Type:* GeneratedHtml2DocumentationOptions Generated html2 documentation project options. --- ##### `htmlRedoc`^Optional ```java public GeneratedHtmlRedocDocumentationOptions getHtmlRedoc(); ``` - *Type:* GeneratedHtmlRedocDocumentationOptions Generated html redoc documentation project options. --- ##### `markdown`^Optional ```java public GeneratedMarkdownDocumentationOptions getMarkdown(); ``` - *Type:* GeneratedMarkdownDocumentationOptions Generated markdown documentation project options. --- ##### `plantuml`^Optional ```java public GeneratedPlantumlDocumentationOptions getPlantuml(); ``` - *Type:* GeneratedPlantumlDocumentationOptions Generated plantuml documentation project options. --- ### GeneratedDocumentationProjects Generated documentation project references. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.GeneratedDocumentationProjects; GeneratedDocumentationProjects.builder() // .html2(Project) // .htmlRedoc(Project) // .markdown(Project) // .plantuml(Project) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | html2 | io.github.cdklabs.projen.Project | Generated html2 documentation project. | | htmlRedoc | io.github.cdklabs.projen.Project | Generated html redoc documentation project. | | markdown | io.github.cdklabs.projen.Project | Generated markdown documentation project. | | plantuml | io.github.cdklabs.projen.Project | Generated plantuml documentation project. | --- ##### `html2`^Optional ```java public Project getHtml2(); ``` - *Type:* io.github.cdklabs.projen.Project Generated html2 documentation project. --- ##### `htmlRedoc`^Optional ```java public Project getHtmlRedoc(); ``` - *Type:* io.github.cdklabs.projen.Project Generated html redoc documentation project. --- ##### `markdown`^Optional ```java public Project getMarkdown(); ``` - *Type:* io.github.cdklabs.projen.Project Generated markdown documentation project. --- ##### `plantuml`^Optional ```java public Project getPlantuml(); ``` - *Type:* io.github.cdklabs.projen.Project Generated plantuml documentation project. --- ### GeneratedHandlersCodeOptions Options for lambda handler projects for implementing API operations. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.GeneratedHandlersCodeOptions; GeneratedHandlersCodeOptions.builder() // .java(GeneratedJavaHandlersOptions) // .python(GeneratedPythonHandlersOptions) // .typescript(GeneratedTypeScriptHandlersOptions) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | java | GeneratedJavaHandlersOptions | Options for the java handlers project. | | python | GeneratedPythonHandlersOptions | Options for the python handlers project. | | typescript | GeneratedTypeScriptHandlersOptions | Options for the typescript handlers project. | --- ##### `java`^Optional ```java public GeneratedJavaHandlersOptions getJava(); ``` - *Type:* GeneratedJavaHandlersOptions Options for the java handlers project. These override the default inferred options. --- ##### `python`^Optional ```java public GeneratedPythonHandlersOptions getPython(); ``` - *Type:* GeneratedPythonHandlersOptions Options for the python handlers project. These override the default inferred options. --- ##### `typescript`^Optional ```java public GeneratedTypeScriptHandlersOptions getTypescript(); ``` - *Type:* GeneratedTypeScriptHandlersOptions Options for the typescript handlers project. These override the default inferred options. --- ### GeneratedHtml2DocumentationOptions Options for the html2 documentation project. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.GeneratedHtml2DocumentationOptions; GeneratedHtml2DocumentationOptions.builder() // .openApiGeneratorCliConfig(OpenApiGeneratorCliConfig) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | openApiGeneratorCliConfig | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. | --- ##### `openApiGeneratorCliConfig`^Optional ```java public OpenApiGeneratorCliConfig getOpenApiGeneratorCliConfig(); ``` - *Type:* OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. Overrides default values if specified. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) --- ### GeneratedHtmlRedocDocumentationOptions Options for the html redoc documentation project. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.GeneratedHtmlRedocDocumentationOptions; GeneratedHtmlRedocDocumentationOptions.builder() // .openApiGeneratorCliConfig(OpenApiGeneratorCliConfig) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | openApiGeneratorCliConfig | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. | --- ##### `openApiGeneratorCliConfig`^Optional ```java public OpenApiGeneratorCliConfig getOpenApiGeneratorCliConfig(); ``` - *Type:* OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. Overrides default values if specified. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) --- ### GeneratedInfrastructureCodeOptions Options for generated infrastructure. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.GeneratedInfrastructureCodeOptions; GeneratedInfrastructureCodeOptions.builder() // .java(GeneratedJavaInfrastructureOptions) // .python(GeneratedPythonInfrastructureOptions) // .typescript(GeneratedTypeScriptInfrastructureOptions) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | java | GeneratedJavaInfrastructureOptions | Options for the generated java infrastructure project. | | python | GeneratedPythonInfrastructureOptions | Options for the generated python infrastructure project. | | typescript | GeneratedTypeScriptInfrastructureOptions | Options for the generated typescript infrastructure project. | --- ##### `java`^Optional ```java public GeneratedJavaInfrastructureOptions getJava(); ``` - *Type:* GeneratedJavaInfrastructureOptions Options for the generated java infrastructure project. These override the default inferred options. --- ##### `python`^Optional ```java public GeneratedPythonInfrastructureOptions getPython(); ``` - *Type:* GeneratedPythonInfrastructureOptions Options for the generated python infrastructure project. These override the default inferred options. --- ##### `typescript`^Optional ```java public GeneratedTypeScriptInfrastructureOptions getTypescript(); ``` - *Type:* GeneratedTypeScriptInfrastructureOptions Options for the generated typescript infrastructure project. These override the default inferred options. --- ### GeneratedJavaHandlersOptions Options for configuring a generated java handlers project. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.GeneratedJavaHandlersOptions; GeneratedJavaHandlersOptions.builder() .name(java.lang.String) // .commitGenerated(java.lang.Boolean) // .gitIgnoreOptions(IgnoreFileOptions) // .gitOptions(GitOptions) // .logging(LoggerOptions) // .outdir(java.lang.String) // .parent(Project) // .projenCommand(java.lang.String) // .projenrcJson(java.lang.Boolean) // .projenrcJsonOptions(ProjenrcJsonOptions) // .renovatebot(java.lang.Boolean) // .renovatebotOptions(RenovatebotOptions) // .autoApproveOptions(AutoApproveOptions) // .autoMerge(java.lang.Boolean) // .autoMergeOptions(AutoMergeOptions) // .clobber(java.lang.Boolean) // .devContainer(java.lang.Boolean) // .github(java.lang.Boolean) // .githubOptions(GitHubOptions) // .gitpod(java.lang.Boolean) // .mergify(java.lang.Boolean) // .mergifyOptions(MergifyOptions) // .projectType(ProjectType) // .projenCredentials(GithubCredentials) // .projenTokenSecret(java.lang.String) // .readme(SampleReadmeProps) // .stale(java.lang.Boolean) // .staleOptions(StaleOptions) // .vscode(java.lang.Boolean) .artifactId(java.lang.String) .groupId(java.lang.String) .version(java.lang.String) // .description(java.lang.String) // .packaging(java.lang.String) // .url(java.lang.String) // .compileOptions(MavenCompileOptions) // .deps(java.util.List) // .distdir(java.lang.String) // .junit(java.lang.Boolean) // .junitOptions(JunitOptions) // .packagingOptions(MavenPackagingOptions) // .projenrcJava(java.lang.Boolean) // .projenrcJavaOptions(ProjenrcOptions) // .testDeps(java.util.List) // .sample(java.lang.Boolean) // .sampleJavaPackage(java.lang.String) // .openApiGeneratorCliConfig(OpenApiGeneratorCliConfig) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | java.lang.String | This is the name of your project. | | commitGenerated | java.lang.Boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | io.github.cdklabs.projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | io.github.cdklabs.projen.GitOptions | Configuration options for git. | | logging | io.github.cdklabs.projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | java.lang.String | The root directory of the project. | | parent | io.github.cdklabs.projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | java.lang.String | The shell command to use in order to run the projen CLI. | | projenrcJson | java.lang.Boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | io.github.cdklabs.projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | java.lang.Boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | io.github.cdklabs.projen.RenovatebotOptions | Options for renovatebot. | | autoApproveOptions | io.github.cdklabs.projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoMerge | java.lang.Boolean | Enable automatic merging on GitHub. | | autoMergeOptions | io.github.cdklabs.projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | java.lang.Boolean | Add a `clobber` task which resets the repo to origin. | | devContainer | java.lang.Boolean | Add a VSCode development environment (used for GitHub Codespaces). | | github | java.lang.Boolean | Enable GitHub integration. | | githubOptions | io.github.cdklabs.projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | java.lang.Boolean | Add a Gitpod development environment. | | mergify | java.lang.Boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | io.github.cdklabs.projen.github.MergifyOptions | Options for mergify. | | projectType | io.github.cdklabs.projen.ProjectType | Which type of project this is (library/app). | | projenCredentials | io.github.cdklabs.projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projenTokenSecret | java.lang.String | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | io.github.cdklabs.projen.SampleReadmeProps | The README setup. | | stale | java.lang.Boolean | Auto-close of stale issues and pull request. | | staleOptions | io.github.cdklabs.projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | java.lang.Boolean | Enable VSCode integration. | | artifactId | java.lang.String | The artifactId is generally the name that the project is known by. | | groupId | java.lang.String | This is generally unique amongst an organization or a project. | | version | java.lang.String | This is the last piece of the naming puzzle. | | description | java.lang.String | Description of a project is always good. | | packaging | java.lang.String | Project packaging format. | | url | java.lang.String | The URL, like the name, is not required. | | compileOptions | io.github.cdklabs.projen.java.MavenCompileOptions | Compile options. | | deps | java.util.List | List of runtime dependencies for this project. | | distdir | java.lang.String | Final artifact output directory. | | junit | java.lang.Boolean | Include junit tests. | | junitOptions | io.github.cdklabs.projen.java.JunitOptions | junit options. | | packagingOptions | io.github.cdklabs.projen.java.MavenPackagingOptions | Packaging options. | | projenrcJava | java.lang.Boolean | Use projenrc in java. | | projenrcJavaOptions | io.github.cdklabs.projen.java.ProjenrcOptions | Options related to projenrc in java. | | testDeps | java.util.List | List of test dependencies for this project. | | sample | java.lang.Boolean | Include sample code and test if the relevant directories don't exist. | | sampleJavaPackage | java.lang.String | The java package to use for the code sample. | | openApiGeneratorCliConfig | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. | --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional ```java public java.lang.Boolean getCommitGenerated(); ``` - *Type:* java.lang.Boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional ```java public IgnoreFileOptions getGitIgnoreOptions(); ``` - *Type:* io.github.cdklabs.projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```java public GitOptions getGitOptions(); ``` - *Type:* io.github.cdklabs.projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```java public LoggerOptions getLogging(); ``` - *Type:* io.github.cdklabs.projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```java public java.lang.String getOutdir(); ``` - *Type:* java.lang.String - *Default:* "." The root directory of the project. Relative to this directory, all files are synthesized. If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects. --- ##### `parent`^Optional ```java public Project getParent(); ``` - *Type:* io.github.cdklabs.projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional ```java public java.lang.String getProjenCommand(); ``` - *Type:* java.lang.String - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrcJson`^Optional ```java public java.lang.Boolean getProjenrcJson(); ``` - *Type:* java.lang.Boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional ```java public ProjenrcJsonOptions getProjenrcJsonOptions(); ``` - *Type:* io.github.cdklabs.projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```java public java.lang.Boolean getRenovatebot(); ``` - *Type:* java.lang.Boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```java public RenovatebotOptions getRenovatebotOptions(); ``` - *Type:* io.github.cdklabs.projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional ```java public AutoApproveOptions getAutoApproveOptions(); ``` - *Type:* io.github.cdklabs.projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional ```java public java.lang.Boolean getAutoMerge(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `autoMergeOptions`^Optional ```java public AutoMergeOptions getAutoMergeOptions(); ``` - *Type:* io.github.cdklabs.projen.github.AutoMergeOptions - *Default:* see defaults in `AutoMergeOptions` Configure options for automatic merging on GitHub. Has no effect if `github.mergify` or `autoMerge` is set to false. --- ##### `clobber`^Optional ```java public java.lang.Boolean getClobber(); ``` - *Type:* java.lang.Boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional ```java public java.lang.Boolean getDevContainer(); ``` - *Type:* java.lang.Boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```java public java.lang.Boolean getGithub(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```java public GitHubOptions getGithubOptions(); ``` - *Type:* io.github.cdklabs.projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```java public java.lang.Boolean getGitpod(); ``` - *Type:* java.lang.Boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```java public java.lang.Boolean getMergify(); ``` - *Type:* java.lang.Boolean - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergifyOptions`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead ```java public MergifyOptions getMergifyOptions(); ``` - *Type:* io.github.cdklabs.projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```java public ProjectType getProjectType(); ``` - *Type:* io.github.cdklabs.projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional ```java public GithubCredentials getProjenCredentials(); ``` - *Type:* io.github.cdklabs.projen.github.GithubCredentials - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN Choose a method of providing GitHub API access for projen workflows. --- ##### ~~`projenTokenSecret`~~^Optional - *Deprecated:* use `projenCredentials` ```java public java.lang.String getProjenTokenSecret(); ``` - *Type:* java.lang.String - *Default:* "PROJEN_GITHUB_TOKEN" The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This token needs to have the `repo`, `workflows` and `packages` scope. --- ##### `readme`^Optional ```java public SampleReadmeProps getReadme(); ``` - *Type:* io.github.cdklabs.projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```java "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```java public java.lang.Boolean getStale(); ``` - *Type:* java.lang.Boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```java public StaleOptions getStaleOptions(); ``` - *Type:* io.github.cdklabs.projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional ```java public java.lang.Boolean getVscode(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `artifactId`^Required ```java public java.lang.String getArtifactId(); ``` - *Type:* java.lang.String - *Default:* "my-app" The artifactId is generally the name that the project is known by. Although the groupId is important, people within the group will rarely mention the groupId in discussion (they are often all be the same ID, such as the MojoHaus project groupId: org.codehaus.mojo). It, along with the groupId, creates a key that separates this project from every other project in the world (at least, it should :) ). Along with the groupId, the artifactId fully defines the artifact's living quarters within the repository. In the case of the above project, my-project lives in $M2_REPO/org/codehaus/mojo/my-project. --- ##### `groupId`^Required ```java public java.lang.String getGroupId(); ``` - *Type:* java.lang.String - *Default:* "org.acme" This is generally unique amongst an organization or a project. For example, all core Maven artifacts do (well, should) live under the groupId org.apache.maven. Group ID's do not necessarily use the dot notation, for example, the junit project. Note that the dot-notated groupId does not have to correspond to the package structure that the project contains. It is, however, a good practice to follow. When stored within a repository, the group acts much like the Java packaging structure does in an operating system. The dots are replaced by OS specific directory separators (such as '/' in Unix) which becomes a relative directory structure from the base repository. In the example given, the org.codehaus.mojo group lives within the directory $M2_REPO/org/codehaus/mojo. --- ##### `version`^Required ```java public java.lang.String getVersion(); ``` - *Type:* java.lang.String - *Default:* "0.1.0" This is the last piece of the naming puzzle. groupId:artifactId denotes a single project but they cannot delineate which incarnation of that project we are talking about. Do we want the junit:junit of 2018 (version 4.12), or of 2007 (version 3.8.2)? In short: code changes, those changes should be versioned, and this element keeps those versions in line. It is also used within an artifact's repository to separate versions from each other. my-project version 1.0 files live in the directory structure $M2_REPO/org/codehaus/mojo/my-project/1.0. --- ##### `description`^Optional ```java public java.lang.String getDescription(); ``` - *Type:* java.lang.String - *Default:* undefined Description of a project is always good. Although this should not replace formal documentation, a quick comment to any readers of the POM is always helpful. --- ##### `packaging`^Optional ```java public java.lang.String getPackaging(); ``` - *Type:* java.lang.String - *Default:* "jar" Project packaging format. --- ##### `url`^Optional ```java public java.lang.String getUrl(); ``` - *Type:* java.lang.String - *Default:* undefined The URL, like the name, is not required. This is a nice gesture for projects users, however, so that they know where the project lives. --- ##### `compileOptions`^Optional ```java public MavenCompileOptions getCompileOptions(); ``` - *Type:* io.github.cdklabs.projen.java.MavenCompileOptions - *Default:* defaults Compile options. --- ##### `deps`^Optional ```java public java.util.List getDeps(); ``` - *Type:* java.util.List - *Default:* [] List of runtime dependencies for this project. Dependencies use the format: `/@` Additional dependencies can be added via `project.addDependency()`. --- ##### `distdir`^Optional ```java public java.lang.String getDistdir(); ``` - *Type:* java.lang.String - *Default:* "dist/java" Final artifact output directory. --- ##### `junit`^Optional ```java public java.lang.Boolean getJunit(); ``` - *Type:* java.lang.Boolean - *Default:* true Include junit tests. --- ##### `junitOptions`^Optional ```java public JunitOptions getJunitOptions(); ``` - *Type:* io.github.cdklabs.projen.java.JunitOptions - *Default:* defaults junit options. --- ##### `packagingOptions`^Optional ```java public MavenPackagingOptions getPackagingOptions(); ``` - *Type:* io.github.cdklabs.projen.java.MavenPackagingOptions - *Default:* defaults Packaging options. --- ##### `projenrcJava`^Optional ```java public java.lang.Boolean getProjenrcJava(); ``` - *Type:* java.lang.Boolean - *Default:* true Use projenrc in java. This will install `projen` as a java dependency and will add a `synth` task which will compile & execute `main()` from `src/main/java/projenrc.java`. --- ##### `projenrcJavaOptions`^Optional ```java public ProjenrcOptions getProjenrcJavaOptions(); ``` - *Type:* io.github.cdklabs.projen.java.ProjenrcOptions - *Default:* default options Options related to projenrc in java. --- ##### `testDeps`^Optional ```java public java.util.List getTestDeps(); ``` - *Type:* java.util.List - *Default:* [] List of test dependencies for this project. Dependencies use the format: `/@` Additional dependencies can be added via `project.addTestDependency()`. --- ##### `sample`^Optional ```java public java.lang.Boolean getSample(); ``` - *Type:* java.lang.Boolean - *Default:* true Include sample code and test if the relevant directories don't exist. --- ##### `sampleJavaPackage`^Optional ```java public java.lang.String getSampleJavaPackage(); ``` - *Type:* java.lang.String - *Default:* "org.acme" The java package to use for the code sample. --- ##### `openApiGeneratorCliConfig`^Optional ```java public OpenApiGeneratorCliConfig getOpenApiGeneratorCliConfig(); ``` - *Type:* OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. Overrides default values if specified. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) --- ### GeneratedJavaInfrastructureOptions Options for configuring a generated java infrastructure project. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.GeneratedJavaInfrastructureOptions; GeneratedJavaInfrastructureOptions.builder() .name(java.lang.String) // .commitGenerated(java.lang.Boolean) // .gitIgnoreOptions(IgnoreFileOptions) // .gitOptions(GitOptions) // .logging(LoggerOptions) // .outdir(java.lang.String) // .parent(Project) // .projenCommand(java.lang.String) // .projenrcJson(java.lang.Boolean) // .projenrcJsonOptions(ProjenrcJsonOptions) // .renovatebot(java.lang.Boolean) // .renovatebotOptions(RenovatebotOptions) // .autoApproveOptions(AutoApproveOptions) // .autoMerge(java.lang.Boolean) // .autoMergeOptions(AutoMergeOptions) // .clobber(java.lang.Boolean) // .devContainer(java.lang.Boolean) // .github(java.lang.Boolean) // .githubOptions(GitHubOptions) // .gitpod(java.lang.Boolean) // .mergify(java.lang.Boolean) // .mergifyOptions(MergifyOptions) // .projectType(ProjectType) // .projenCredentials(GithubCredentials) // .projenTokenSecret(java.lang.String) // .readme(SampleReadmeProps) // .stale(java.lang.Boolean) // .staleOptions(StaleOptions) // .vscode(java.lang.Boolean) .artifactId(java.lang.String) .groupId(java.lang.String) .version(java.lang.String) // .description(java.lang.String) // .packaging(java.lang.String) // .url(java.lang.String) // .compileOptions(MavenCompileOptions) // .deps(java.util.List) // .distdir(java.lang.String) // .junit(java.lang.Boolean) // .junitOptions(JunitOptions) // .packagingOptions(MavenPackagingOptions) // .projenrcJava(java.lang.Boolean) // .projenrcJavaOptions(ProjenrcOptions) // .testDeps(java.util.List) // .sample(java.lang.Boolean) // .sampleJavaPackage(java.lang.String) // .openApiGeneratorCliConfig(OpenApiGeneratorCliConfig) // .mockDataOptions(MockResponseDataGenerationOptions) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | java.lang.String | This is the name of your project. | | commitGenerated | java.lang.Boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | io.github.cdklabs.projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | io.github.cdklabs.projen.GitOptions | Configuration options for git. | | logging | io.github.cdklabs.projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | java.lang.String | The root directory of the project. | | parent | io.github.cdklabs.projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | java.lang.String | The shell command to use in order to run the projen CLI. | | projenrcJson | java.lang.Boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | io.github.cdklabs.projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | java.lang.Boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | io.github.cdklabs.projen.RenovatebotOptions | Options for renovatebot. | | autoApproveOptions | io.github.cdklabs.projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoMerge | java.lang.Boolean | Enable automatic merging on GitHub. | | autoMergeOptions | io.github.cdklabs.projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | java.lang.Boolean | Add a `clobber` task which resets the repo to origin. | | devContainer | java.lang.Boolean | Add a VSCode development environment (used for GitHub Codespaces). | | github | java.lang.Boolean | Enable GitHub integration. | | githubOptions | io.github.cdklabs.projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | java.lang.Boolean | Add a Gitpod development environment. | | mergify | java.lang.Boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | io.github.cdklabs.projen.github.MergifyOptions | Options for mergify. | | projectType | io.github.cdklabs.projen.ProjectType | Which type of project this is (library/app). | | projenCredentials | io.github.cdklabs.projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projenTokenSecret | java.lang.String | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | io.github.cdklabs.projen.SampleReadmeProps | The README setup. | | stale | java.lang.Boolean | Auto-close of stale issues and pull request. | | staleOptions | io.github.cdklabs.projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | java.lang.Boolean | Enable VSCode integration. | | artifactId | java.lang.String | The artifactId is generally the name that the project is known by. | | groupId | java.lang.String | This is generally unique amongst an organization or a project. | | version | java.lang.String | This is the last piece of the naming puzzle. | | description | java.lang.String | Description of a project is always good. | | packaging | java.lang.String | Project packaging format. | | url | java.lang.String | The URL, like the name, is not required. | | compileOptions | io.github.cdklabs.projen.java.MavenCompileOptions | Compile options. | | deps | java.util.List | List of runtime dependencies for this project. | | distdir | java.lang.String | Final artifact output directory. | | junit | java.lang.Boolean | Include junit tests. | | junitOptions | io.github.cdklabs.projen.java.JunitOptions | junit options. | | packagingOptions | io.github.cdklabs.projen.java.MavenPackagingOptions | Packaging options. | | projenrcJava | java.lang.Boolean | Use projenrc in java. | | projenrcJavaOptions | io.github.cdklabs.projen.java.ProjenrcOptions | Options related to projenrc in java. | | testDeps | java.util.List | List of test dependencies for this project. | | sample | java.lang.Boolean | Include sample code and test if the relevant directories don't exist. | | sampleJavaPackage | java.lang.String | The java package to use for the code sample. | | openApiGeneratorCliConfig | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. | | mockDataOptions | MockResponseDataGenerationOptions | Options for the generated mock response data. | --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional ```java public java.lang.Boolean getCommitGenerated(); ``` - *Type:* java.lang.Boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional ```java public IgnoreFileOptions getGitIgnoreOptions(); ``` - *Type:* io.github.cdklabs.projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```java public GitOptions getGitOptions(); ``` - *Type:* io.github.cdklabs.projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```java public LoggerOptions getLogging(); ``` - *Type:* io.github.cdklabs.projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```java public java.lang.String getOutdir(); ``` - *Type:* java.lang.String - *Default:* "." The root directory of the project. Relative to this directory, all files are synthesized. If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects. --- ##### `parent`^Optional ```java public Project getParent(); ``` - *Type:* io.github.cdklabs.projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional ```java public java.lang.String getProjenCommand(); ``` - *Type:* java.lang.String - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrcJson`^Optional ```java public java.lang.Boolean getProjenrcJson(); ``` - *Type:* java.lang.Boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional ```java public ProjenrcJsonOptions getProjenrcJsonOptions(); ``` - *Type:* io.github.cdklabs.projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```java public java.lang.Boolean getRenovatebot(); ``` - *Type:* java.lang.Boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```java public RenovatebotOptions getRenovatebotOptions(); ``` - *Type:* io.github.cdklabs.projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional ```java public AutoApproveOptions getAutoApproveOptions(); ``` - *Type:* io.github.cdklabs.projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional ```java public java.lang.Boolean getAutoMerge(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `autoMergeOptions`^Optional ```java public AutoMergeOptions getAutoMergeOptions(); ``` - *Type:* io.github.cdklabs.projen.github.AutoMergeOptions - *Default:* see defaults in `AutoMergeOptions` Configure options for automatic merging on GitHub. Has no effect if `github.mergify` or `autoMerge` is set to false. --- ##### `clobber`^Optional ```java public java.lang.Boolean getClobber(); ``` - *Type:* java.lang.Boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional ```java public java.lang.Boolean getDevContainer(); ``` - *Type:* java.lang.Boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```java public java.lang.Boolean getGithub(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```java public GitHubOptions getGithubOptions(); ``` - *Type:* io.github.cdklabs.projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```java public java.lang.Boolean getGitpod(); ``` - *Type:* java.lang.Boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```java public java.lang.Boolean getMergify(); ``` - *Type:* java.lang.Boolean - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergifyOptions`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead ```java public MergifyOptions getMergifyOptions(); ``` - *Type:* io.github.cdklabs.projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```java public ProjectType getProjectType(); ``` - *Type:* io.github.cdklabs.projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional ```java public GithubCredentials getProjenCredentials(); ``` - *Type:* io.github.cdklabs.projen.github.GithubCredentials - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN Choose a method of providing GitHub API access for projen workflows. --- ##### ~~`projenTokenSecret`~~^Optional - *Deprecated:* use `projenCredentials` ```java public java.lang.String getProjenTokenSecret(); ``` - *Type:* java.lang.String - *Default:* "PROJEN_GITHUB_TOKEN" The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This token needs to have the `repo`, `workflows` and `packages` scope. --- ##### `readme`^Optional ```java public SampleReadmeProps getReadme(); ``` - *Type:* io.github.cdklabs.projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```java "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```java public java.lang.Boolean getStale(); ``` - *Type:* java.lang.Boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```java public StaleOptions getStaleOptions(); ``` - *Type:* io.github.cdklabs.projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional ```java public java.lang.Boolean getVscode(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `artifactId`^Required ```java public java.lang.String getArtifactId(); ``` - *Type:* java.lang.String - *Default:* "my-app" The artifactId is generally the name that the project is known by. Although the groupId is important, people within the group will rarely mention the groupId in discussion (they are often all be the same ID, such as the MojoHaus project groupId: org.codehaus.mojo). It, along with the groupId, creates a key that separates this project from every other project in the world (at least, it should :) ). Along with the groupId, the artifactId fully defines the artifact's living quarters within the repository. In the case of the above project, my-project lives in $M2_REPO/org/codehaus/mojo/my-project. --- ##### `groupId`^Required ```java public java.lang.String getGroupId(); ``` - *Type:* java.lang.String - *Default:* "org.acme" This is generally unique amongst an organization or a project. For example, all core Maven artifacts do (well, should) live under the groupId org.apache.maven. Group ID's do not necessarily use the dot notation, for example, the junit project. Note that the dot-notated groupId does not have to correspond to the package structure that the project contains. It is, however, a good practice to follow. When stored within a repository, the group acts much like the Java packaging structure does in an operating system. The dots are replaced by OS specific directory separators (such as '/' in Unix) which becomes a relative directory structure from the base repository. In the example given, the org.codehaus.mojo group lives within the directory $M2_REPO/org/codehaus/mojo. --- ##### `version`^Required ```java public java.lang.String getVersion(); ``` - *Type:* java.lang.String - *Default:* "0.1.0" This is the last piece of the naming puzzle. groupId:artifactId denotes a single project but they cannot delineate which incarnation of that project we are talking about. Do we want the junit:junit of 2018 (version 4.12), or of 2007 (version 3.8.2)? In short: code changes, those changes should be versioned, and this element keeps those versions in line. It is also used within an artifact's repository to separate versions from each other. my-project version 1.0 files live in the directory structure $M2_REPO/org/codehaus/mojo/my-project/1.0. --- ##### `description`^Optional ```java public java.lang.String getDescription(); ``` - *Type:* java.lang.String - *Default:* undefined Description of a project is always good. Although this should not replace formal documentation, a quick comment to any readers of the POM is always helpful. --- ##### `packaging`^Optional ```java public java.lang.String getPackaging(); ``` - *Type:* java.lang.String - *Default:* "jar" Project packaging format. --- ##### `url`^Optional ```java public java.lang.String getUrl(); ``` - *Type:* java.lang.String - *Default:* undefined The URL, like the name, is not required. This is a nice gesture for projects users, however, so that they know where the project lives. --- ##### `compileOptions`^Optional ```java public MavenCompileOptions getCompileOptions(); ``` - *Type:* io.github.cdklabs.projen.java.MavenCompileOptions - *Default:* defaults Compile options. --- ##### `deps`^Optional ```java public java.util.List getDeps(); ``` - *Type:* java.util.List - *Default:* [] List of runtime dependencies for this project. Dependencies use the format: `/@` Additional dependencies can be added via `project.addDependency()`. --- ##### `distdir`^Optional ```java public java.lang.String getDistdir(); ``` - *Type:* java.lang.String - *Default:* "dist/java" Final artifact output directory. --- ##### `junit`^Optional ```java public java.lang.Boolean getJunit(); ``` - *Type:* java.lang.Boolean - *Default:* true Include junit tests. --- ##### `junitOptions`^Optional ```java public JunitOptions getJunitOptions(); ``` - *Type:* io.github.cdklabs.projen.java.JunitOptions - *Default:* defaults junit options. --- ##### `packagingOptions`^Optional ```java public MavenPackagingOptions getPackagingOptions(); ``` - *Type:* io.github.cdklabs.projen.java.MavenPackagingOptions - *Default:* defaults Packaging options. --- ##### `projenrcJava`^Optional ```java public java.lang.Boolean getProjenrcJava(); ``` - *Type:* java.lang.Boolean - *Default:* true Use projenrc in java. This will install `projen` as a java dependency and will add a `synth` task which will compile & execute `main()` from `src/main/java/projenrc.java`. --- ##### `projenrcJavaOptions`^Optional ```java public ProjenrcOptions getProjenrcJavaOptions(); ``` - *Type:* io.github.cdklabs.projen.java.ProjenrcOptions - *Default:* default options Options related to projenrc in java. --- ##### `testDeps`^Optional ```java public java.util.List getTestDeps(); ``` - *Type:* java.util.List - *Default:* [] List of test dependencies for this project. Dependencies use the format: `/@` Additional dependencies can be added via `project.addTestDependency()`. --- ##### `sample`^Optional ```java public java.lang.Boolean getSample(); ``` - *Type:* java.lang.Boolean - *Default:* true Include sample code and test if the relevant directories don't exist. --- ##### `sampleJavaPackage`^Optional ```java public java.lang.String getSampleJavaPackage(); ``` - *Type:* java.lang.String - *Default:* "org.acme" The java package to use for the code sample. --- ##### `openApiGeneratorCliConfig`^Optional ```java public OpenApiGeneratorCliConfig getOpenApiGeneratorCliConfig(); ``` - *Type:* OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. Overrides default values if specified. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) --- ##### `mockDataOptions`^Optional ```java public MockResponseDataGenerationOptions getMockDataOptions(); ``` - *Type:* MockResponseDataGenerationOptions Options for the generated mock response data. --- ### GeneratedJavaRuntimeOptions Options for configuring a generated java runtime project. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.GeneratedJavaRuntimeOptions; GeneratedJavaRuntimeOptions.builder() .name(java.lang.String) // .commitGenerated(java.lang.Boolean) // .gitIgnoreOptions(IgnoreFileOptions) // .gitOptions(GitOptions) // .logging(LoggerOptions) // .outdir(java.lang.String) // .parent(Project) // .projenCommand(java.lang.String) // .projenrcJson(java.lang.Boolean) // .projenrcJsonOptions(ProjenrcJsonOptions) // .renovatebot(java.lang.Boolean) // .renovatebotOptions(RenovatebotOptions) // .autoApproveOptions(AutoApproveOptions) // .autoMerge(java.lang.Boolean) // .autoMergeOptions(AutoMergeOptions) // .clobber(java.lang.Boolean) // .devContainer(java.lang.Boolean) // .github(java.lang.Boolean) // .githubOptions(GitHubOptions) // .gitpod(java.lang.Boolean) // .mergify(java.lang.Boolean) // .mergifyOptions(MergifyOptions) // .projectType(ProjectType) // .projenCredentials(GithubCredentials) // .projenTokenSecret(java.lang.String) // .readme(SampleReadmeProps) // .stale(java.lang.Boolean) // .staleOptions(StaleOptions) // .vscode(java.lang.Boolean) .artifactId(java.lang.String) .groupId(java.lang.String) .version(java.lang.String) // .description(java.lang.String) // .packaging(java.lang.String) // .url(java.lang.String) // .compileOptions(MavenCompileOptions) // .deps(java.util.List) // .distdir(java.lang.String) // .junit(java.lang.Boolean) // .junitOptions(JunitOptions) // .packagingOptions(MavenPackagingOptions) // .projenrcJava(java.lang.Boolean) // .projenrcJavaOptions(ProjenrcOptions) // .testDeps(java.util.List) // .sample(java.lang.Boolean) // .sampleJavaPackage(java.lang.String) // .openApiGeneratorCliConfig(OpenApiGeneratorCliConfig) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | java.lang.String | This is the name of your project. | | commitGenerated | java.lang.Boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | io.github.cdklabs.projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | io.github.cdklabs.projen.GitOptions | Configuration options for git. | | logging | io.github.cdklabs.projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | java.lang.String | The root directory of the project. | | parent | io.github.cdklabs.projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | java.lang.String | The shell command to use in order to run the projen CLI. | | projenrcJson | java.lang.Boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | io.github.cdklabs.projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | java.lang.Boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | io.github.cdklabs.projen.RenovatebotOptions | Options for renovatebot. | | autoApproveOptions | io.github.cdklabs.projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoMerge | java.lang.Boolean | Enable automatic merging on GitHub. | | autoMergeOptions | io.github.cdklabs.projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | java.lang.Boolean | Add a `clobber` task which resets the repo to origin. | | devContainer | java.lang.Boolean | Add a VSCode development environment (used for GitHub Codespaces). | | github | java.lang.Boolean | Enable GitHub integration. | | githubOptions | io.github.cdklabs.projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | java.lang.Boolean | Add a Gitpod development environment. | | mergify | java.lang.Boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | io.github.cdklabs.projen.github.MergifyOptions | Options for mergify. | | projectType | io.github.cdklabs.projen.ProjectType | Which type of project this is (library/app). | | projenCredentials | io.github.cdklabs.projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projenTokenSecret | java.lang.String | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | io.github.cdklabs.projen.SampleReadmeProps | The README setup. | | stale | java.lang.Boolean | Auto-close of stale issues and pull request. | | staleOptions | io.github.cdklabs.projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | java.lang.Boolean | Enable VSCode integration. | | artifactId | java.lang.String | The artifactId is generally the name that the project is known by. | | groupId | java.lang.String | This is generally unique amongst an organization or a project. | | version | java.lang.String | This is the last piece of the naming puzzle. | | description | java.lang.String | Description of a project is always good. | | packaging | java.lang.String | Project packaging format. | | url | java.lang.String | The URL, like the name, is not required. | | compileOptions | io.github.cdklabs.projen.java.MavenCompileOptions | Compile options. | | deps | java.util.List | List of runtime dependencies for this project. | | distdir | java.lang.String | Final artifact output directory. | | junit | java.lang.Boolean | Include junit tests. | | junitOptions | io.github.cdklabs.projen.java.JunitOptions | junit options. | | packagingOptions | io.github.cdklabs.projen.java.MavenPackagingOptions | Packaging options. | | projenrcJava | java.lang.Boolean | Use projenrc in java. | | projenrcJavaOptions | io.github.cdklabs.projen.java.ProjenrcOptions | Options related to projenrc in java. | | testDeps | java.util.List | List of test dependencies for this project. | | sample | java.lang.Boolean | Include sample code and test if the relevant directories don't exist. | | sampleJavaPackage | java.lang.String | The java package to use for the code sample. | | openApiGeneratorCliConfig | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. | --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional ```java public java.lang.Boolean getCommitGenerated(); ``` - *Type:* java.lang.Boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional ```java public IgnoreFileOptions getGitIgnoreOptions(); ``` - *Type:* io.github.cdklabs.projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```java public GitOptions getGitOptions(); ``` - *Type:* io.github.cdklabs.projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```java public LoggerOptions getLogging(); ``` - *Type:* io.github.cdklabs.projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```java public java.lang.String getOutdir(); ``` - *Type:* java.lang.String - *Default:* "." The root directory of the project. Relative to this directory, all files are synthesized. If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects. --- ##### `parent`^Optional ```java public Project getParent(); ``` - *Type:* io.github.cdklabs.projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional ```java public java.lang.String getProjenCommand(); ``` - *Type:* java.lang.String - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrcJson`^Optional ```java public java.lang.Boolean getProjenrcJson(); ``` - *Type:* java.lang.Boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional ```java public ProjenrcJsonOptions getProjenrcJsonOptions(); ``` - *Type:* io.github.cdklabs.projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```java public java.lang.Boolean getRenovatebot(); ``` - *Type:* java.lang.Boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```java public RenovatebotOptions getRenovatebotOptions(); ``` - *Type:* io.github.cdklabs.projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional ```java public AutoApproveOptions getAutoApproveOptions(); ``` - *Type:* io.github.cdklabs.projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional ```java public java.lang.Boolean getAutoMerge(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `autoMergeOptions`^Optional ```java public AutoMergeOptions getAutoMergeOptions(); ``` - *Type:* io.github.cdklabs.projen.github.AutoMergeOptions - *Default:* see defaults in `AutoMergeOptions` Configure options for automatic merging on GitHub. Has no effect if `github.mergify` or `autoMerge` is set to false. --- ##### `clobber`^Optional ```java public java.lang.Boolean getClobber(); ``` - *Type:* java.lang.Boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional ```java public java.lang.Boolean getDevContainer(); ``` - *Type:* java.lang.Boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```java public java.lang.Boolean getGithub(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```java public GitHubOptions getGithubOptions(); ``` - *Type:* io.github.cdklabs.projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```java public java.lang.Boolean getGitpod(); ``` - *Type:* java.lang.Boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```java public java.lang.Boolean getMergify(); ``` - *Type:* java.lang.Boolean - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergifyOptions`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead ```java public MergifyOptions getMergifyOptions(); ``` - *Type:* io.github.cdklabs.projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```java public ProjectType getProjectType(); ``` - *Type:* io.github.cdklabs.projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional ```java public GithubCredentials getProjenCredentials(); ``` - *Type:* io.github.cdklabs.projen.github.GithubCredentials - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN Choose a method of providing GitHub API access for projen workflows. --- ##### ~~`projenTokenSecret`~~^Optional - *Deprecated:* use `projenCredentials` ```java public java.lang.String getProjenTokenSecret(); ``` - *Type:* java.lang.String - *Default:* "PROJEN_GITHUB_TOKEN" The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This token needs to have the `repo`, `workflows` and `packages` scope. --- ##### `readme`^Optional ```java public SampleReadmeProps getReadme(); ``` - *Type:* io.github.cdklabs.projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```java "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```java public java.lang.Boolean getStale(); ``` - *Type:* java.lang.Boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```java public StaleOptions getStaleOptions(); ``` - *Type:* io.github.cdklabs.projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional ```java public java.lang.Boolean getVscode(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `artifactId`^Required ```java public java.lang.String getArtifactId(); ``` - *Type:* java.lang.String - *Default:* "my-app" The artifactId is generally the name that the project is known by. Although the groupId is important, people within the group will rarely mention the groupId in discussion (they are often all be the same ID, such as the MojoHaus project groupId: org.codehaus.mojo). It, along with the groupId, creates a key that separates this project from every other project in the world (at least, it should :) ). Along with the groupId, the artifactId fully defines the artifact's living quarters within the repository. In the case of the above project, my-project lives in $M2_REPO/org/codehaus/mojo/my-project. --- ##### `groupId`^Required ```java public java.lang.String getGroupId(); ``` - *Type:* java.lang.String - *Default:* "org.acme" This is generally unique amongst an organization or a project. For example, all core Maven artifacts do (well, should) live under the groupId org.apache.maven. Group ID's do not necessarily use the dot notation, for example, the junit project. Note that the dot-notated groupId does not have to correspond to the package structure that the project contains. It is, however, a good practice to follow. When stored within a repository, the group acts much like the Java packaging structure does in an operating system. The dots are replaced by OS specific directory separators (such as '/' in Unix) which becomes a relative directory structure from the base repository. In the example given, the org.codehaus.mojo group lives within the directory $M2_REPO/org/codehaus/mojo. --- ##### `version`^Required ```java public java.lang.String getVersion(); ``` - *Type:* java.lang.String - *Default:* "0.1.0" This is the last piece of the naming puzzle. groupId:artifactId denotes a single project but they cannot delineate which incarnation of that project we are talking about. Do we want the junit:junit of 2018 (version 4.12), or of 2007 (version 3.8.2)? In short: code changes, those changes should be versioned, and this element keeps those versions in line. It is also used within an artifact's repository to separate versions from each other. my-project version 1.0 files live in the directory structure $M2_REPO/org/codehaus/mojo/my-project/1.0. --- ##### `description`^Optional ```java public java.lang.String getDescription(); ``` - *Type:* java.lang.String - *Default:* undefined Description of a project is always good. Although this should not replace formal documentation, a quick comment to any readers of the POM is always helpful. --- ##### `packaging`^Optional ```java public java.lang.String getPackaging(); ``` - *Type:* java.lang.String - *Default:* "jar" Project packaging format. --- ##### `url`^Optional ```java public java.lang.String getUrl(); ``` - *Type:* java.lang.String - *Default:* undefined The URL, like the name, is not required. This is a nice gesture for projects users, however, so that they know where the project lives. --- ##### `compileOptions`^Optional ```java public MavenCompileOptions getCompileOptions(); ``` - *Type:* io.github.cdklabs.projen.java.MavenCompileOptions - *Default:* defaults Compile options. --- ##### `deps`^Optional ```java public java.util.List getDeps(); ``` - *Type:* java.util.List - *Default:* [] List of runtime dependencies for this project. Dependencies use the format: `/@` Additional dependencies can be added via `project.addDependency()`. --- ##### `distdir`^Optional ```java public java.lang.String getDistdir(); ``` - *Type:* java.lang.String - *Default:* "dist/java" Final artifact output directory. --- ##### `junit`^Optional ```java public java.lang.Boolean getJunit(); ``` - *Type:* java.lang.Boolean - *Default:* true Include junit tests. --- ##### `junitOptions`^Optional ```java public JunitOptions getJunitOptions(); ``` - *Type:* io.github.cdklabs.projen.java.JunitOptions - *Default:* defaults junit options. --- ##### `packagingOptions`^Optional ```java public MavenPackagingOptions getPackagingOptions(); ``` - *Type:* io.github.cdklabs.projen.java.MavenPackagingOptions - *Default:* defaults Packaging options. --- ##### `projenrcJava`^Optional ```java public java.lang.Boolean getProjenrcJava(); ``` - *Type:* java.lang.Boolean - *Default:* true Use projenrc in java. This will install `projen` as a java dependency and will add a `synth` task which will compile & execute `main()` from `src/main/java/projenrc.java`. --- ##### `projenrcJavaOptions`^Optional ```java public ProjenrcOptions getProjenrcJavaOptions(); ``` - *Type:* io.github.cdklabs.projen.java.ProjenrcOptions - *Default:* default options Options related to projenrc in java. --- ##### `testDeps`^Optional ```java public java.util.List getTestDeps(); ``` - *Type:* java.util.List - *Default:* [] List of test dependencies for this project. Dependencies use the format: `/@` Additional dependencies can be added via `project.addTestDependency()`. --- ##### `sample`^Optional ```java public java.lang.Boolean getSample(); ``` - *Type:* java.lang.Boolean - *Default:* true Include sample code and test if the relevant directories don't exist. --- ##### `sampleJavaPackage`^Optional ```java public java.lang.String getSampleJavaPackage(); ``` - *Type:* java.lang.String - *Default:* "org.acme" The java package to use for the code sample. --- ##### `openApiGeneratorCliConfig`^Optional ```java public OpenApiGeneratorCliConfig getOpenApiGeneratorCliConfig(); ``` - *Type:* OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. Overrides default values if specified. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) --- ### GeneratedLibraryOptions Options for generated libraries. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.GeneratedLibraryOptions; GeneratedLibraryOptions.builder() // .typescriptReactQueryHooks(GeneratedTypeScriptReactQueryHooksOptions) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | typescriptReactQueryHooks | GeneratedTypeScriptReactQueryHooksOptions | Options for the generated typescript react-query hooks library. | --- ##### `typescriptReactQueryHooks`^Optional ```java public GeneratedTypeScriptReactQueryHooksOptions getTypescriptReactQueryHooks(); ``` - *Type:* GeneratedTypeScriptReactQueryHooksOptions Options for the generated typescript react-query hooks library. These override the default inferred options. --- ### GeneratedLibraryProjects Generated library projects. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.GeneratedLibraryProjects; GeneratedLibraryProjects.builder() // .typescriptReactQueryHooks(TypeScriptProject) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | typescriptReactQueryHooks | io.github.cdklabs.projen.typescript.TypeScriptProject | Generated typescript react-query hooks project. | --- ##### `typescriptReactQueryHooks`^Optional ```java public TypeScriptProject getTypescriptReactQueryHooks(); ``` - *Type:* io.github.cdklabs.projen.typescript.TypeScriptProject Generated typescript react-query hooks project. --- ### GeneratedMarkdownDocumentationOptions Options for the markdown documentation project. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.GeneratedMarkdownDocumentationOptions; GeneratedMarkdownDocumentationOptions.builder() // .openApiGeneratorCliConfig(OpenApiGeneratorCliConfig) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | openApiGeneratorCliConfig | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. | --- ##### `openApiGeneratorCliConfig`^Optional ```java public OpenApiGeneratorCliConfig getOpenApiGeneratorCliConfig(); ``` - *Type:* OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. Overrides default values if specified. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) --- ### GeneratedPlantumlDocumentationOptions Options for the plantuml documentation project. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.GeneratedPlantumlDocumentationOptions; GeneratedPlantumlDocumentationOptions.builder() // .openApiGeneratorCliConfig(OpenApiGeneratorCliConfig) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | openApiGeneratorCliConfig | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. | --- ##### `openApiGeneratorCliConfig`^Optional ```java public OpenApiGeneratorCliConfig getOpenApiGeneratorCliConfig(); ``` - *Type:* OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. Overrides default values if specified. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) --- ### GeneratedPythonHandlersOptions Options for configuring a generated python handlers project. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.GeneratedPythonHandlersOptions; GeneratedPythonHandlersOptions.builder() .name(java.lang.String) // .commitGenerated(java.lang.Boolean) // .gitIgnoreOptions(IgnoreFileOptions) // .gitOptions(GitOptions) // .logging(LoggerOptions) // .outdir(java.lang.String) // .parent(Project) // .projenCommand(java.lang.String) // .projenrcJson(java.lang.Boolean) // .projenrcJsonOptions(ProjenrcJsonOptions) // .renovatebot(java.lang.Boolean) // .renovatebotOptions(RenovatebotOptions) // .autoApproveOptions(AutoApproveOptions) // .autoMerge(java.lang.Boolean) // .autoMergeOptions(AutoMergeOptions) // .clobber(java.lang.Boolean) // .devContainer(java.lang.Boolean) // .github(java.lang.Boolean) // .githubOptions(GitHubOptions) // .gitpod(java.lang.Boolean) // .mergify(java.lang.Boolean) // .mergifyOptions(MergifyOptions) // .projectType(ProjectType) // .projenCredentials(GithubCredentials) // .projenTokenSecret(java.lang.String) // .readme(SampleReadmeProps) // .stale(java.lang.Boolean) // .staleOptions(StaleOptions) // .vscode(java.lang.Boolean) .authorEmail(java.lang.String) .authorName(java.lang.String) .version(java.lang.String) // .classifiers(java.util.List) // .description(java.lang.String) // .homepage(java.lang.String) // .license(java.lang.String) // .packageName(java.lang.String) // .poetryOptions(PoetryPyprojectOptionsWithoutDeps) // .setupConfig(java.util.Map) .moduleName(java.lang.String) // .deps(java.util.List) // .devDeps(java.util.List) // .pip(java.lang.Boolean) // .poetry(java.lang.Boolean) // .projenrcJs(java.lang.Boolean) // .projenrcJsOptions(ProjenrcOptions) // .projenrcPython(java.lang.Boolean) // .projenrcPythonOptions(ProjenrcOptions) // .projenrcTs(java.lang.Boolean) // .projenrcTsOptions(ProjenrcTsOptions) // .pytest(java.lang.Boolean) // .pytestOptions(PytestOptions) // .pythonExec(java.lang.String) // .sample(java.lang.Boolean) // .setuptools(java.lang.Boolean) // .venv(java.lang.Boolean) // .venvOptions(VenvOptions) // .openApiGeneratorCliConfig(OpenApiGeneratorCliConfig) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | java.lang.String | This is the name of your project. | | commitGenerated | java.lang.Boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | io.github.cdklabs.projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | io.github.cdklabs.projen.GitOptions | Configuration options for git. | | logging | io.github.cdklabs.projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | java.lang.String | The root directory of the project. | | parent | io.github.cdklabs.projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | java.lang.String | The shell command to use in order to run the projen CLI. | | projenrcJson | java.lang.Boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | io.github.cdklabs.projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | java.lang.Boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | io.github.cdklabs.projen.RenovatebotOptions | Options for renovatebot. | | autoApproveOptions | io.github.cdklabs.projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoMerge | java.lang.Boolean | Enable automatic merging on GitHub. | | autoMergeOptions | io.github.cdklabs.projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | java.lang.Boolean | Add a `clobber` task which resets the repo to origin. | | devContainer | java.lang.Boolean | Add a VSCode development environment (used for GitHub Codespaces). | | github | java.lang.Boolean | Enable GitHub integration. | | githubOptions | io.github.cdklabs.projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | java.lang.Boolean | Add a Gitpod development environment. | | mergify | java.lang.Boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | io.github.cdklabs.projen.github.MergifyOptions | Options for mergify. | | projectType | io.github.cdklabs.projen.ProjectType | Which type of project this is (library/app). | | projenCredentials | io.github.cdklabs.projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projenTokenSecret | java.lang.String | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | io.github.cdklabs.projen.SampleReadmeProps | The README setup. | | stale | java.lang.Boolean | Auto-close of stale issues and pull request. | | staleOptions | io.github.cdklabs.projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | java.lang.Boolean | Enable VSCode integration. | | authorEmail | java.lang.String | Author's e-mail. | | authorName | java.lang.String | Author's name. | | version | java.lang.String | Version of the package. | | classifiers | java.util.List | A list of PyPI trove classifiers that describe the project. | | description | java.lang.String | A short description of the package. | | homepage | java.lang.String | A URL to the website of the project. | | license | java.lang.String | License of this package as an SPDX identifier. | | packageName | java.lang.String | Package name. | | poetryOptions | io.github.cdklabs.projen.python.PoetryPyprojectOptionsWithoutDeps | Additional options to set for poetry if using poetry. | | setupConfig | java.util.Map | Additional fields to pass in the setup() function if using setuptools. | | moduleName | java.lang.String | Name of the python package as used in imports and filenames. | | deps | java.util.List | List of runtime dependencies for this project. | | devDeps | java.util.List | List of dev dependencies for this project. | | pip | java.lang.Boolean | Use pip with a requirements.txt file to track project dependencies. | | poetry | java.lang.Boolean | Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing. | | projenrcJs | java.lang.Boolean | Use projenrc in javascript. | | projenrcJsOptions | io.github.cdklabs.projen.javascript.ProjenrcOptions | Options related to projenrc in JavaScript. | | projenrcPython | java.lang.Boolean | Use projenrc in Python. | | projenrcPythonOptions | io.github.cdklabs.projen.python.ProjenrcOptions | Options related to projenrc in python. | | projenrcTs | java.lang.Boolean | Use projenrc in TypeScript. | | projenrcTsOptions | io.github.cdklabs.projen.typescript.ProjenrcTsOptions | Options related to projenrc in TypeScript. | | pytest | java.lang.Boolean | Include pytest tests. | | pytestOptions | io.github.cdklabs.projen.python.PytestOptions | pytest options. | | pythonExec | java.lang.String | Path to the python executable to use. | | sample | java.lang.Boolean | Include sample code and test if the relevant directories don't exist. | | setuptools | java.lang.Boolean | Use setuptools with a setup.py script for packaging and publishing. | | venv | java.lang.Boolean | Use venv to manage a virtual environment for installing dependencies inside. | | venvOptions | io.github.cdklabs.projen.python.VenvOptions | Venv options. | | openApiGeneratorCliConfig | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. | --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional ```java public java.lang.Boolean getCommitGenerated(); ``` - *Type:* java.lang.Boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional ```java public IgnoreFileOptions getGitIgnoreOptions(); ``` - *Type:* io.github.cdklabs.projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```java public GitOptions getGitOptions(); ``` - *Type:* io.github.cdklabs.projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```java public LoggerOptions getLogging(); ``` - *Type:* io.github.cdklabs.projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```java public java.lang.String getOutdir(); ``` - *Type:* java.lang.String - *Default:* "." The root directory of the project. Relative to this directory, all files are synthesized. If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects. --- ##### `parent`^Optional ```java public Project getParent(); ``` - *Type:* io.github.cdklabs.projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional ```java public java.lang.String getProjenCommand(); ``` - *Type:* java.lang.String - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrcJson`^Optional ```java public java.lang.Boolean getProjenrcJson(); ``` - *Type:* java.lang.Boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional ```java public ProjenrcJsonOptions getProjenrcJsonOptions(); ``` - *Type:* io.github.cdklabs.projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```java public java.lang.Boolean getRenovatebot(); ``` - *Type:* java.lang.Boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```java public RenovatebotOptions getRenovatebotOptions(); ``` - *Type:* io.github.cdklabs.projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional ```java public AutoApproveOptions getAutoApproveOptions(); ``` - *Type:* io.github.cdklabs.projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional ```java public java.lang.Boolean getAutoMerge(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `autoMergeOptions`^Optional ```java public AutoMergeOptions getAutoMergeOptions(); ``` - *Type:* io.github.cdklabs.projen.github.AutoMergeOptions - *Default:* see defaults in `AutoMergeOptions` Configure options for automatic merging on GitHub. Has no effect if `github.mergify` or `autoMerge` is set to false. --- ##### `clobber`^Optional ```java public java.lang.Boolean getClobber(); ``` - *Type:* java.lang.Boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional ```java public java.lang.Boolean getDevContainer(); ``` - *Type:* java.lang.Boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```java public java.lang.Boolean getGithub(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```java public GitHubOptions getGithubOptions(); ``` - *Type:* io.github.cdklabs.projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```java public java.lang.Boolean getGitpod(); ``` - *Type:* java.lang.Boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```java public java.lang.Boolean getMergify(); ``` - *Type:* java.lang.Boolean - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergifyOptions`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead ```java public MergifyOptions getMergifyOptions(); ``` - *Type:* io.github.cdklabs.projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```java public ProjectType getProjectType(); ``` - *Type:* io.github.cdklabs.projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional ```java public GithubCredentials getProjenCredentials(); ``` - *Type:* io.github.cdklabs.projen.github.GithubCredentials - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN Choose a method of providing GitHub API access for projen workflows. --- ##### ~~`projenTokenSecret`~~^Optional - *Deprecated:* use `projenCredentials` ```java public java.lang.String getProjenTokenSecret(); ``` - *Type:* java.lang.String - *Default:* "PROJEN_GITHUB_TOKEN" The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This token needs to have the `repo`, `workflows` and `packages` scope. --- ##### `readme`^Optional ```java public SampleReadmeProps getReadme(); ``` - *Type:* io.github.cdklabs.projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```java "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```java public java.lang.Boolean getStale(); ``` - *Type:* java.lang.Boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```java public StaleOptions getStaleOptions(); ``` - *Type:* io.github.cdklabs.projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional ```java public java.lang.Boolean getVscode(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `authorEmail`^Required ```java public java.lang.String getAuthorEmail(); ``` - *Type:* java.lang.String - *Default:* $GIT_USER_EMAIL Author's e-mail. --- ##### `authorName`^Required ```java public java.lang.String getAuthorName(); ``` - *Type:* java.lang.String - *Default:* $GIT_USER_NAME Author's name. --- ##### `version`^Required ```java public java.lang.String getVersion(); ``` - *Type:* java.lang.String - *Default:* "0.1.0" Version of the package. --- ##### `classifiers`^Optional ```java public java.util.List getClassifiers(); ``` - *Type:* java.util.List A list of PyPI trove classifiers that describe the project. > [https://pypi.org/classifiers/](https://pypi.org/classifiers/) --- ##### `description`^Optional ```java public java.lang.String getDescription(); ``` - *Type:* java.lang.String A short description of the package. --- ##### `homepage`^Optional ```java public java.lang.String getHomepage(); ``` - *Type:* java.lang.String A URL to the website of the project. --- ##### `license`^Optional ```java public java.lang.String getLicense(); ``` - *Type:* java.lang.String License of this package as an SPDX identifier. --- ##### `packageName`^Optional ```java public java.lang.String getPackageName(); ``` - *Type:* java.lang.String Package name. --- ##### `poetryOptions`^Optional ```java public PoetryPyprojectOptionsWithoutDeps getPoetryOptions(); ``` - *Type:* io.github.cdklabs.projen.python.PoetryPyprojectOptionsWithoutDeps Additional options to set for poetry if using poetry. --- ##### `setupConfig`^Optional ```java public java.util.Map getSetupConfig(); ``` - *Type:* java.util.Map Additional fields to pass in the setup() function if using setuptools. --- ##### `moduleName`^Required ```java public java.lang.String getModuleName(); ``` - *Type:* java.lang.String - *Default:* $PYTHON_MODULE_NAME Name of the python package as used in imports and filenames. Must only consist of alphanumeric characters and underscores. --- ##### `deps`^Optional ```java public java.util.List getDeps(); ``` - *Type:* java.util.List - *Default:* [] List of runtime dependencies for this project. Dependencies use the format: `@` Additional dependencies can be added via `project.addDependency()`. --- ##### `devDeps`^Optional ```java public java.util.List getDevDeps(); ``` - *Type:* java.util.List - *Default:* [] List of dev dependencies for this project. Dependencies use the format: `@` Additional dependencies can be added via `project.addDevDependency()`. --- ##### `pip`^Optional ```java public java.lang.Boolean getPip(); ``` - *Type:* java.lang.Boolean - *Default:* true, unless poetry is true, then false Use pip with a requirements.txt file to track project dependencies. --- ##### `poetry`^Optional ```java public java.lang.Boolean getPoetry(); ``` - *Type:* java.lang.Boolean - *Default:* false Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing. This feature is incompatible with pip, setuptools, or venv. If you set this option to `true`, then pip, setuptools, and venv must be set to `false`. --- ##### `projenrcJs`^Optional ```java public java.lang.Boolean getProjenrcJs(); ``` - *Type:* java.lang.Boolean - *Default:* false Use projenrc in javascript. This will install `projen` as a JavaScript dependency and add a `synth` task which will run `.projenrc.js`. --- ##### `projenrcJsOptions`^Optional ```java public ProjenrcOptions getProjenrcJsOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.ProjenrcOptions - *Default:* default options Options related to projenrc in JavaScript. --- ##### `projenrcPython`^Optional ```java public java.lang.Boolean getProjenrcPython(); ``` - *Type:* java.lang.Boolean - *Default:* true Use projenrc in Python. This will install `projen` as a Python dependency and add a `synth` task which will run `.projenrc.py`. --- ##### `projenrcPythonOptions`^Optional ```java public ProjenrcOptions getProjenrcPythonOptions(); ``` - *Type:* io.github.cdklabs.projen.python.ProjenrcOptions - *Default:* default options Options related to projenrc in python. --- ##### `projenrcTs`^Optional ```java public java.lang.Boolean getProjenrcTs(); ``` - *Type:* java.lang.Boolean - *Default:* false Use projenrc in TypeScript. This will create a tsconfig file (default: `tsconfig.projen.json`) and use `ts-node` in the default task to parse the project source files. --- ##### `projenrcTsOptions`^Optional ```java public ProjenrcTsOptions getProjenrcTsOptions(); ``` - *Type:* io.github.cdklabs.projen.typescript.ProjenrcTsOptions - *Default:* default options Options related to projenrc in TypeScript. --- ##### `pytest`^Optional ```java public java.lang.Boolean getPytest(); ``` - *Type:* java.lang.Boolean - *Default:* true Include pytest tests. --- ##### `pytestOptions`^Optional ```java public PytestOptions getPytestOptions(); ``` - *Type:* io.github.cdklabs.projen.python.PytestOptions - *Default:* defaults pytest options. --- ##### `pythonExec`^Optional ```java public java.lang.String getPythonExec(); ``` - *Type:* java.lang.String - *Default:* "python" Path to the python executable to use. --- ##### `sample`^Optional ```java public java.lang.Boolean getSample(); ``` - *Type:* java.lang.Boolean - *Default:* true Include sample code and test if the relevant directories don't exist. --- ##### `setuptools`^Optional ```java public java.lang.Boolean getSetuptools(); ``` - *Type:* java.lang.Boolean - *Default:* true, unless poetry is true, then false Use setuptools with a setup.py script for packaging and publishing. --- ##### `venv`^Optional ```java public java.lang.Boolean getVenv(); ``` - *Type:* java.lang.Boolean - *Default:* true, unless poetry is true, then false Use venv to manage a virtual environment for installing dependencies inside. --- ##### `venvOptions`^Optional ```java public VenvOptions getVenvOptions(); ``` - *Type:* io.github.cdklabs.projen.python.VenvOptions - *Default:* defaults Venv options. --- ##### `openApiGeneratorCliConfig`^Optional ```java public OpenApiGeneratorCliConfig getOpenApiGeneratorCliConfig(); ``` - *Type:* OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. Overrides default values if specified. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) --- ### GeneratedPythonInfrastructureOptions Options for configuring a generated python infrastructure project. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.GeneratedPythonInfrastructureOptions; GeneratedPythonInfrastructureOptions.builder() .name(java.lang.String) // .commitGenerated(java.lang.Boolean) // .gitIgnoreOptions(IgnoreFileOptions) // .gitOptions(GitOptions) // .logging(LoggerOptions) // .outdir(java.lang.String) // .parent(Project) // .projenCommand(java.lang.String) // .projenrcJson(java.lang.Boolean) // .projenrcJsonOptions(ProjenrcJsonOptions) // .renovatebot(java.lang.Boolean) // .renovatebotOptions(RenovatebotOptions) // .autoApproveOptions(AutoApproveOptions) // .autoMerge(java.lang.Boolean) // .autoMergeOptions(AutoMergeOptions) // .clobber(java.lang.Boolean) // .devContainer(java.lang.Boolean) // .github(java.lang.Boolean) // .githubOptions(GitHubOptions) // .gitpod(java.lang.Boolean) // .mergify(java.lang.Boolean) // .mergifyOptions(MergifyOptions) // .projectType(ProjectType) // .projenCredentials(GithubCredentials) // .projenTokenSecret(java.lang.String) // .readme(SampleReadmeProps) // .stale(java.lang.Boolean) // .staleOptions(StaleOptions) // .vscode(java.lang.Boolean) .authorEmail(java.lang.String) .authorName(java.lang.String) .version(java.lang.String) // .classifiers(java.util.List) // .description(java.lang.String) // .homepage(java.lang.String) // .license(java.lang.String) // .packageName(java.lang.String) // .poetryOptions(PoetryPyprojectOptionsWithoutDeps) // .setupConfig(java.util.Map) .moduleName(java.lang.String) // .deps(java.util.List) // .devDeps(java.util.List) // .pip(java.lang.Boolean) // .poetry(java.lang.Boolean) // .projenrcJs(java.lang.Boolean) // .projenrcJsOptions(ProjenrcOptions) // .projenrcPython(java.lang.Boolean) // .projenrcPythonOptions(ProjenrcOptions) // .projenrcTs(java.lang.Boolean) // .projenrcTsOptions(ProjenrcTsOptions) // .pytest(java.lang.Boolean) // .pytestOptions(PytestOptions) // .pythonExec(java.lang.String) // .sample(java.lang.Boolean) // .setuptools(java.lang.Boolean) // .venv(java.lang.Boolean) // .venvOptions(VenvOptions) // .openApiGeneratorCliConfig(OpenApiGeneratorCliConfig) // .mockDataOptions(MockResponseDataGenerationOptions) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | java.lang.String | This is the name of your project. | | commitGenerated | java.lang.Boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | io.github.cdklabs.projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | io.github.cdklabs.projen.GitOptions | Configuration options for git. | | logging | io.github.cdklabs.projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | java.lang.String | The root directory of the project. | | parent | io.github.cdklabs.projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | java.lang.String | The shell command to use in order to run the projen CLI. | | projenrcJson | java.lang.Boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | io.github.cdklabs.projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | java.lang.Boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | io.github.cdklabs.projen.RenovatebotOptions | Options for renovatebot. | | autoApproveOptions | io.github.cdklabs.projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoMerge | java.lang.Boolean | Enable automatic merging on GitHub. | | autoMergeOptions | io.github.cdklabs.projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | java.lang.Boolean | Add a `clobber` task which resets the repo to origin. | | devContainer | java.lang.Boolean | Add a VSCode development environment (used for GitHub Codespaces). | | github | java.lang.Boolean | Enable GitHub integration. | | githubOptions | io.github.cdklabs.projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | java.lang.Boolean | Add a Gitpod development environment. | | mergify | java.lang.Boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | io.github.cdklabs.projen.github.MergifyOptions | Options for mergify. | | projectType | io.github.cdklabs.projen.ProjectType | Which type of project this is (library/app). | | projenCredentials | io.github.cdklabs.projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projenTokenSecret | java.lang.String | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | io.github.cdklabs.projen.SampleReadmeProps | The README setup. | | stale | java.lang.Boolean | Auto-close of stale issues and pull request. | | staleOptions | io.github.cdklabs.projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | java.lang.Boolean | Enable VSCode integration. | | authorEmail | java.lang.String | Author's e-mail. | | authorName | java.lang.String | Author's name. | | version | java.lang.String | Version of the package. | | classifiers | java.util.List | A list of PyPI trove classifiers that describe the project. | | description | java.lang.String | A short description of the package. | | homepage | java.lang.String | A URL to the website of the project. | | license | java.lang.String | License of this package as an SPDX identifier. | | packageName | java.lang.String | Package name. | | poetryOptions | io.github.cdklabs.projen.python.PoetryPyprojectOptionsWithoutDeps | Additional options to set for poetry if using poetry. | | setupConfig | java.util.Map | Additional fields to pass in the setup() function if using setuptools. | | moduleName | java.lang.String | Name of the python package as used in imports and filenames. | | deps | java.util.List | List of runtime dependencies for this project. | | devDeps | java.util.List | List of dev dependencies for this project. | | pip | java.lang.Boolean | Use pip with a requirements.txt file to track project dependencies. | | poetry | java.lang.Boolean | Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing. | | projenrcJs | java.lang.Boolean | Use projenrc in javascript. | | projenrcJsOptions | io.github.cdklabs.projen.javascript.ProjenrcOptions | Options related to projenrc in JavaScript. | | projenrcPython | java.lang.Boolean | Use projenrc in Python. | | projenrcPythonOptions | io.github.cdklabs.projen.python.ProjenrcOptions | Options related to projenrc in python. | | projenrcTs | java.lang.Boolean | Use projenrc in TypeScript. | | projenrcTsOptions | io.github.cdklabs.projen.typescript.ProjenrcTsOptions | Options related to projenrc in TypeScript. | | pytest | java.lang.Boolean | Include pytest tests. | | pytestOptions | io.github.cdklabs.projen.python.PytestOptions | pytest options. | | pythonExec | java.lang.String | Path to the python executable to use. | | sample | java.lang.Boolean | Include sample code and test if the relevant directories don't exist. | | setuptools | java.lang.Boolean | Use setuptools with a setup.py script for packaging and publishing. | | venv | java.lang.Boolean | Use venv to manage a virtual environment for installing dependencies inside. | | venvOptions | io.github.cdklabs.projen.python.VenvOptions | Venv options. | | openApiGeneratorCliConfig | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. | | mockDataOptions | MockResponseDataGenerationOptions | Options for the generated mock response data. | --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional ```java public java.lang.Boolean getCommitGenerated(); ``` - *Type:* java.lang.Boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional ```java public IgnoreFileOptions getGitIgnoreOptions(); ``` - *Type:* io.github.cdklabs.projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```java public GitOptions getGitOptions(); ``` - *Type:* io.github.cdklabs.projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```java public LoggerOptions getLogging(); ``` - *Type:* io.github.cdklabs.projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```java public java.lang.String getOutdir(); ``` - *Type:* java.lang.String - *Default:* "." The root directory of the project. Relative to this directory, all files are synthesized. If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects. --- ##### `parent`^Optional ```java public Project getParent(); ``` - *Type:* io.github.cdklabs.projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional ```java public java.lang.String getProjenCommand(); ``` - *Type:* java.lang.String - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrcJson`^Optional ```java public java.lang.Boolean getProjenrcJson(); ``` - *Type:* java.lang.Boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional ```java public ProjenrcJsonOptions getProjenrcJsonOptions(); ``` - *Type:* io.github.cdklabs.projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```java public java.lang.Boolean getRenovatebot(); ``` - *Type:* java.lang.Boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```java public RenovatebotOptions getRenovatebotOptions(); ``` - *Type:* io.github.cdklabs.projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional ```java public AutoApproveOptions getAutoApproveOptions(); ``` - *Type:* io.github.cdklabs.projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional ```java public java.lang.Boolean getAutoMerge(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `autoMergeOptions`^Optional ```java public AutoMergeOptions getAutoMergeOptions(); ``` - *Type:* io.github.cdklabs.projen.github.AutoMergeOptions - *Default:* see defaults in `AutoMergeOptions` Configure options for automatic merging on GitHub. Has no effect if `github.mergify` or `autoMerge` is set to false. --- ##### `clobber`^Optional ```java public java.lang.Boolean getClobber(); ``` - *Type:* java.lang.Boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional ```java public java.lang.Boolean getDevContainer(); ``` - *Type:* java.lang.Boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```java public java.lang.Boolean getGithub(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```java public GitHubOptions getGithubOptions(); ``` - *Type:* io.github.cdklabs.projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```java public java.lang.Boolean getGitpod(); ``` - *Type:* java.lang.Boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```java public java.lang.Boolean getMergify(); ``` - *Type:* java.lang.Boolean - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergifyOptions`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead ```java public MergifyOptions getMergifyOptions(); ``` - *Type:* io.github.cdklabs.projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```java public ProjectType getProjectType(); ``` - *Type:* io.github.cdklabs.projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional ```java public GithubCredentials getProjenCredentials(); ``` - *Type:* io.github.cdklabs.projen.github.GithubCredentials - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN Choose a method of providing GitHub API access for projen workflows. --- ##### ~~`projenTokenSecret`~~^Optional - *Deprecated:* use `projenCredentials` ```java public java.lang.String getProjenTokenSecret(); ``` - *Type:* java.lang.String - *Default:* "PROJEN_GITHUB_TOKEN" The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This token needs to have the `repo`, `workflows` and `packages` scope. --- ##### `readme`^Optional ```java public SampleReadmeProps getReadme(); ``` - *Type:* io.github.cdklabs.projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```java "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```java public java.lang.Boolean getStale(); ``` - *Type:* java.lang.Boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```java public StaleOptions getStaleOptions(); ``` - *Type:* io.github.cdklabs.projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional ```java public java.lang.Boolean getVscode(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `authorEmail`^Required ```java public java.lang.String getAuthorEmail(); ``` - *Type:* java.lang.String - *Default:* $GIT_USER_EMAIL Author's e-mail. --- ##### `authorName`^Required ```java public java.lang.String getAuthorName(); ``` - *Type:* java.lang.String - *Default:* $GIT_USER_NAME Author's name. --- ##### `version`^Required ```java public java.lang.String getVersion(); ``` - *Type:* java.lang.String - *Default:* "0.1.0" Version of the package. --- ##### `classifiers`^Optional ```java public java.util.List getClassifiers(); ``` - *Type:* java.util.List A list of PyPI trove classifiers that describe the project. > [https://pypi.org/classifiers/](https://pypi.org/classifiers/) --- ##### `description`^Optional ```java public java.lang.String getDescription(); ``` - *Type:* java.lang.String A short description of the package. --- ##### `homepage`^Optional ```java public java.lang.String getHomepage(); ``` - *Type:* java.lang.String A URL to the website of the project. --- ##### `license`^Optional ```java public java.lang.String getLicense(); ``` - *Type:* java.lang.String License of this package as an SPDX identifier. --- ##### `packageName`^Optional ```java public java.lang.String getPackageName(); ``` - *Type:* java.lang.String Package name. --- ##### `poetryOptions`^Optional ```java public PoetryPyprojectOptionsWithoutDeps getPoetryOptions(); ``` - *Type:* io.github.cdklabs.projen.python.PoetryPyprojectOptionsWithoutDeps Additional options to set for poetry if using poetry. --- ##### `setupConfig`^Optional ```java public java.util.Map getSetupConfig(); ``` - *Type:* java.util.Map Additional fields to pass in the setup() function if using setuptools. --- ##### `moduleName`^Required ```java public java.lang.String getModuleName(); ``` - *Type:* java.lang.String - *Default:* $PYTHON_MODULE_NAME Name of the python package as used in imports and filenames. Must only consist of alphanumeric characters and underscores. --- ##### `deps`^Optional ```java public java.util.List getDeps(); ``` - *Type:* java.util.List - *Default:* [] List of runtime dependencies for this project. Dependencies use the format: `@` Additional dependencies can be added via `project.addDependency()`. --- ##### `devDeps`^Optional ```java public java.util.List getDevDeps(); ``` - *Type:* java.util.List - *Default:* [] List of dev dependencies for this project. Dependencies use the format: `@` Additional dependencies can be added via `project.addDevDependency()`. --- ##### `pip`^Optional ```java public java.lang.Boolean getPip(); ``` - *Type:* java.lang.Boolean - *Default:* true, unless poetry is true, then false Use pip with a requirements.txt file to track project dependencies. --- ##### `poetry`^Optional ```java public java.lang.Boolean getPoetry(); ``` - *Type:* java.lang.Boolean - *Default:* false Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing. This feature is incompatible with pip, setuptools, or venv. If you set this option to `true`, then pip, setuptools, and venv must be set to `false`. --- ##### `projenrcJs`^Optional ```java public java.lang.Boolean getProjenrcJs(); ``` - *Type:* java.lang.Boolean - *Default:* false Use projenrc in javascript. This will install `projen` as a JavaScript dependency and add a `synth` task which will run `.projenrc.js`. --- ##### `projenrcJsOptions`^Optional ```java public ProjenrcOptions getProjenrcJsOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.ProjenrcOptions - *Default:* default options Options related to projenrc in JavaScript. --- ##### `projenrcPython`^Optional ```java public java.lang.Boolean getProjenrcPython(); ``` - *Type:* java.lang.Boolean - *Default:* true Use projenrc in Python. This will install `projen` as a Python dependency and add a `synth` task which will run `.projenrc.py`. --- ##### `projenrcPythonOptions`^Optional ```java public ProjenrcOptions getProjenrcPythonOptions(); ``` - *Type:* io.github.cdklabs.projen.python.ProjenrcOptions - *Default:* default options Options related to projenrc in python. --- ##### `projenrcTs`^Optional ```java public java.lang.Boolean getProjenrcTs(); ``` - *Type:* java.lang.Boolean - *Default:* false Use projenrc in TypeScript. This will create a tsconfig file (default: `tsconfig.projen.json`) and use `ts-node` in the default task to parse the project source files. --- ##### `projenrcTsOptions`^Optional ```java public ProjenrcTsOptions getProjenrcTsOptions(); ``` - *Type:* io.github.cdklabs.projen.typescript.ProjenrcTsOptions - *Default:* default options Options related to projenrc in TypeScript. --- ##### `pytest`^Optional ```java public java.lang.Boolean getPytest(); ``` - *Type:* java.lang.Boolean - *Default:* true Include pytest tests. --- ##### `pytestOptions`^Optional ```java public PytestOptions getPytestOptions(); ``` - *Type:* io.github.cdklabs.projen.python.PytestOptions - *Default:* defaults pytest options. --- ##### `pythonExec`^Optional ```java public java.lang.String getPythonExec(); ``` - *Type:* java.lang.String - *Default:* "python" Path to the python executable to use. --- ##### `sample`^Optional ```java public java.lang.Boolean getSample(); ``` - *Type:* java.lang.Boolean - *Default:* true Include sample code and test if the relevant directories don't exist. --- ##### `setuptools`^Optional ```java public java.lang.Boolean getSetuptools(); ``` - *Type:* java.lang.Boolean - *Default:* true, unless poetry is true, then false Use setuptools with a setup.py script for packaging and publishing. --- ##### `venv`^Optional ```java public java.lang.Boolean getVenv(); ``` - *Type:* java.lang.Boolean - *Default:* true, unless poetry is true, then false Use venv to manage a virtual environment for installing dependencies inside. --- ##### `venvOptions`^Optional ```java public VenvOptions getVenvOptions(); ``` - *Type:* io.github.cdklabs.projen.python.VenvOptions - *Default:* defaults Venv options. --- ##### `openApiGeneratorCliConfig`^Optional ```java public OpenApiGeneratorCliConfig getOpenApiGeneratorCliConfig(); ``` - *Type:* OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. Overrides default values if specified. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) --- ##### `mockDataOptions`^Optional ```java public MockResponseDataGenerationOptions getMockDataOptions(); ``` - *Type:* MockResponseDataGenerationOptions Options for the generated mock response data. --- ### GeneratedPythonRuntimeOptions Options for configuring a generated python runtime project. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.GeneratedPythonRuntimeOptions; GeneratedPythonRuntimeOptions.builder() .name(java.lang.String) // .commitGenerated(java.lang.Boolean) // .gitIgnoreOptions(IgnoreFileOptions) // .gitOptions(GitOptions) // .logging(LoggerOptions) // .outdir(java.lang.String) // .parent(Project) // .projenCommand(java.lang.String) // .projenrcJson(java.lang.Boolean) // .projenrcJsonOptions(ProjenrcJsonOptions) // .renovatebot(java.lang.Boolean) // .renovatebotOptions(RenovatebotOptions) // .autoApproveOptions(AutoApproveOptions) // .autoMerge(java.lang.Boolean) // .autoMergeOptions(AutoMergeOptions) // .clobber(java.lang.Boolean) // .devContainer(java.lang.Boolean) // .github(java.lang.Boolean) // .githubOptions(GitHubOptions) // .gitpod(java.lang.Boolean) // .mergify(java.lang.Boolean) // .mergifyOptions(MergifyOptions) // .projectType(ProjectType) // .projenCredentials(GithubCredentials) // .projenTokenSecret(java.lang.String) // .readme(SampleReadmeProps) // .stale(java.lang.Boolean) // .staleOptions(StaleOptions) // .vscode(java.lang.Boolean) .authorEmail(java.lang.String) .authorName(java.lang.String) .version(java.lang.String) // .classifiers(java.util.List) // .description(java.lang.String) // .homepage(java.lang.String) // .license(java.lang.String) // .packageName(java.lang.String) // .poetryOptions(PoetryPyprojectOptionsWithoutDeps) // .setupConfig(java.util.Map) .moduleName(java.lang.String) // .deps(java.util.List) // .devDeps(java.util.List) // .pip(java.lang.Boolean) // .poetry(java.lang.Boolean) // .projenrcJs(java.lang.Boolean) // .projenrcJsOptions(ProjenrcOptions) // .projenrcPython(java.lang.Boolean) // .projenrcPythonOptions(ProjenrcOptions) // .projenrcTs(java.lang.Boolean) // .projenrcTsOptions(ProjenrcTsOptions) // .pytest(java.lang.Boolean) // .pytestOptions(PytestOptions) // .pythonExec(java.lang.String) // .sample(java.lang.Boolean) // .setuptools(java.lang.Boolean) // .venv(java.lang.Boolean) // .venvOptions(VenvOptions) // .openApiGeneratorCliConfig(OpenApiGeneratorCliConfig) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | java.lang.String | This is the name of your project. | | commitGenerated | java.lang.Boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | io.github.cdklabs.projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | io.github.cdklabs.projen.GitOptions | Configuration options for git. | | logging | io.github.cdklabs.projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | java.lang.String | The root directory of the project. | | parent | io.github.cdklabs.projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | java.lang.String | The shell command to use in order to run the projen CLI. | | projenrcJson | java.lang.Boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | io.github.cdklabs.projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | java.lang.Boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | io.github.cdklabs.projen.RenovatebotOptions | Options for renovatebot. | | autoApproveOptions | io.github.cdklabs.projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoMerge | java.lang.Boolean | Enable automatic merging on GitHub. | | autoMergeOptions | io.github.cdklabs.projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | java.lang.Boolean | Add a `clobber` task which resets the repo to origin. | | devContainer | java.lang.Boolean | Add a VSCode development environment (used for GitHub Codespaces). | | github | java.lang.Boolean | Enable GitHub integration. | | githubOptions | io.github.cdklabs.projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | java.lang.Boolean | Add a Gitpod development environment. | | mergify | java.lang.Boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | io.github.cdklabs.projen.github.MergifyOptions | Options for mergify. | | projectType | io.github.cdklabs.projen.ProjectType | Which type of project this is (library/app). | | projenCredentials | io.github.cdklabs.projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projenTokenSecret | java.lang.String | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | io.github.cdklabs.projen.SampleReadmeProps | The README setup. | | stale | java.lang.Boolean | Auto-close of stale issues and pull request. | | staleOptions | io.github.cdklabs.projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | java.lang.Boolean | Enable VSCode integration. | | authorEmail | java.lang.String | Author's e-mail. | | authorName | java.lang.String | Author's name. | | version | java.lang.String | Version of the package. | | classifiers | java.util.List | A list of PyPI trove classifiers that describe the project. | | description | java.lang.String | A short description of the package. | | homepage | java.lang.String | A URL to the website of the project. | | license | java.lang.String | License of this package as an SPDX identifier. | | packageName | java.lang.String | Package name. | | poetryOptions | io.github.cdklabs.projen.python.PoetryPyprojectOptionsWithoutDeps | Additional options to set for poetry if using poetry. | | setupConfig | java.util.Map | Additional fields to pass in the setup() function if using setuptools. | | moduleName | java.lang.String | Name of the python package as used in imports and filenames. | | deps | java.util.List | List of runtime dependencies for this project. | | devDeps | java.util.List | List of dev dependencies for this project. | | pip | java.lang.Boolean | Use pip with a requirements.txt file to track project dependencies. | | poetry | java.lang.Boolean | Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing. | | projenrcJs | java.lang.Boolean | Use projenrc in javascript. | | projenrcJsOptions | io.github.cdklabs.projen.javascript.ProjenrcOptions | Options related to projenrc in JavaScript. | | projenrcPython | java.lang.Boolean | Use projenrc in Python. | | projenrcPythonOptions | io.github.cdklabs.projen.python.ProjenrcOptions | Options related to projenrc in python. | | projenrcTs | java.lang.Boolean | Use projenrc in TypeScript. | | projenrcTsOptions | io.github.cdklabs.projen.typescript.ProjenrcTsOptions | Options related to projenrc in TypeScript. | | pytest | java.lang.Boolean | Include pytest tests. | | pytestOptions | io.github.cdklabs.projen.python.PytestOptions | pytest options. | | pythonExec | java.lang.String | Path to the python executable to use. | | sample | java.lang.Boolean | Include sample code and test if the relevant directories don't exist. | | setuptools | java.lang.Boolean | Use setuptools with a setup.py script for packaging and publishing. | | venv | java.lang.Boolean | Use venv to manage a virtual environment for installing dependencies inside. | | venvOptions | io.github.cdklabs.projen.python.VenvOptions | Venv options. | | openApiGeneratorCliConfig | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. | --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional ```java public java.lang.Boolean getCommitGenerated(); ``` - *Type:* java.lang.Boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional ```java public IgnoreFileOptions getGitIgnoreOptions(); ``` - *Type:* io.github.cdklabs.projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```java public GitOptions getGitOptions(); ``` - *Type:* io.github.cdklabs.projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```java public LoggerOptions getLogging(); ``` - *Type:* io.github.cdklabs.projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```java public java.lang.String getOutdir(); ``` - *Type:* java.lang.String - *Default:* "." The root directory of the project. Relative to this directory, all files are synthesized. If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects. --- ##### `parent`^Optional ```java public Project getParent(); ``` - *Type:* io.github.cdklabs.projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional ```java public java.lang.String getProjenCommand(); ``` - *Type:* java.lang.String - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrcJson`^Optional ```java public java.lang.Boolean getProjenrcJson(); ``` - *Type:* java.lang.Boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional ```java public ProjenrcJsonOptions getProjenrcJsonOptions(); ``` - *Type:* io.github.cdklabs.projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```java public java.lang.Boolean getRenovatebot(); ``` - *Type:* java.lang.Boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```java public RenovatebotOptions getRenovatebotOptions(); ``` - *Type:* io.github.cdklabs.projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional ```java public AutoApproveOptions getAutoApproveOptions(); ``` - *Type:* io.github.cdklabs.projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional ```java public java.lang.Boolean getAutoMerge(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `autoMergeOptions`^Optional ```java public AutoMergeOptions getAutoMergeOptions(); ``` - *Type:* io.github.cdklabs.projen.github.AutoMergeOptions - *Default:* see defaults in `AutoMergeOptions` Configure options for automatic merging on GitHub. Has no effect if `github.mergify` or `autoMerge` is set to false. --- ##### `clobber`^Optional ```java public java.lang.Boolean getClobber(); ``` - *Type:* java.lang.Boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional ```java public java.lang.Boolean getDevContainer(); ``` - *Type:* java.lang.Boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```java public java.lang.Boolean getGithub(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```java public GitHubOptions getGithubOptions(); ``` - *Type:* io.github.cdklabs.projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```java public java.lang.Boolean getGitpod(); ``` - *Type:* java.lang.Boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```java public java.lang.Boolean getMergify(); ``` - *Type:* java.lang.Boolean - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergifyOptions`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead ```java public MergifyOptions getMergifyOptions(); ``` - *Type:* io.github.cdklabs.projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```java public ProjectType getProjectType(); ``` - *Type:* io.github.cdklabs.projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional ```java public GithubCredentials getProjenCredentials(); ``` - *Type:* io.github.cdklabs.projen.github.GithubCredentials - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN Choose a method of providing GitHub API access for projen workflows. --- ##### ~~`projenTokenSecret`~~^Optional - *Deprecated:* use `projenCredentials` ```java public java.lang.String getProjenTokenSecret(); ``` - *Type:* java.lang.String - *Default:* "PROJEN_GITHUB_TOKEN" The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This token needs to have the `repo`, `workflows` and `packages` scope. --- ##### `readme`^Optional ```java public SampleReadmeProps getReadme(); ``` - *Type:* io.github.cdklabs.projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```java "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```java public java.lang.Boolean getStale(); ``` - *Type:* java.lang.Boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```java public StaleOptions getStaleOptions(); ``` - *Type:* io.github.cdklabs.projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional ```java public java.lang.Boolean getVscode(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `authorEmail`^Required ```java public java.lang.String getAuthorEmail(); ``` - *Type:* java.lang.String - *Default:* $GIT_USER_EMAIL Author's e-mail. --- ##### `authorName`^Required ```java public java.lang.String getAuthorName(); ``` - *Type:* java.lang.String - *Default:* $GIT_USER_NAME Author's name. --- ##### `version`^Required ```java public java.lang.String getVersion(); ``` - *Type:* java.lang.String - *Default:* "0.1.0" Version of the package. --- ##### `classifiers`^Optional ```java public java.util.List getClassifiers(); ``` - *Type:* java.util.List A list of PyPI trove classifiers that describe the project. > [https://pypi.org/classifiers/](https://pypi.org/classifiers/) --- ##### `description`^Optional ```java public java.lang.String getDescription(); ``` - *Type:* java.lang.String A short description of the package. --- ##### `homepage`^Optional ```java public java.lang.String getHomepage(); ``` - *Type:* java.lang.String A URL to the website of the project. --- ##### `license`^Optional ```java public java.lang.String getLicense(); ``` - *Type:* java.lang.String License of this package as an SPDX identifier. --- ##### `packageName`^Optional ```java public java.lang.String getPackageName(); ``` - *Type:* java.lang.String Package name. --- ##### `poetryOptions`^Optional ```java public PoetryPyprojectOptionsWithoutDeps getPoetryOptions(); ``` - *Type:* io.github.cdklabs.projen.python.PoetryPyprojectOptionsWithoutDeps Additional options to set for poetry if using poetry. --- ##### `setupConfig`^Optional ```java public java.util.Map getSetupConfig(); ``` - *Type:* java.util.Map Additional fields to pass in the setup() function if using setuptools. --- ##### `moduleName`^Required ```java public java.lang.String getModuleName(); ``` - *Type:* java.lang.String - *Default:* $PYTHON_MODULE_NAME Name of the python package as used in imports and filenames. Must only consist of alphanumeric characters and underscores. --- ##### `deps`^Optional ```java public java.util.List getDeps(); ``` - *Type:* java.util.List - *Default:* [] List of runtime dependencies for this project. Dependencies use the format: `@` Additional dependencies can be added via `project.addDependency()`. --- ##### `devDeps`^Optional ```java public java.util.List getDevDeps(); ``` - *Type:* java.util.List - *Default:* [] List of dev dependencies for this project. Dependencies use the format: `@` Additional dependencies can be added via `project.addDevDependency()`. --- ##### `pip`^Optional ```java public java.lang.Boolean getPip(); ``` - *Type:* java.lang.Boolean - *Default:* true, unless poetry is true, then false Use pip with a requirements.txt file to track project dependencies. --- ##### `poetry`^Optional ```java public java.lang.Boolean getPoetry(); ``` - *Type:* java.lang.Boolean - *Default:* false Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing. This feature is incompatible with pip, setuptools, or venv. If you set this option to `true`, then pip, setuptools, and venv must be set to `false`. --- ##### `projenrcJs`^Optional ```java public java.lang.Boolean getProjenrcJs(); ``` - *Type:* java.lang.Boolean - *Default:* false Use projenrc in javascript. This will install `projen` as a JavaScript dependency and add a `synth` task which will run `.projenrc.js`. --- ##### `projenrcJsOptions`^Optional ```java public ProjenrcOptions getProjenrcJsOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.ProjenrcOptions - *Default:* default options Options related to projenrc in JavaScript. --- ##### `projenrcPython`^Optional ```java public java.lang.Boolean getProjenrcPython(); ``` - *Type:* java.lang.Boolean - *Default:* true Use projenrc in Python. This will install `projen` as a Python dependency and add a `synth` task which will run `.projenrc.py`. --- ##### `projenrcPythonOptions`^Optional ```java public ProjenrcOptions getProjenrcPythonOptions(); ``` - *Type:* io.github.cdklabs.projen.python.ProjenrcOptions - *Default:* default options Options related to projenrc in python. --- ##### `projenrcTs`^Optional ```java public java.lang.Boolean getProjenrcTs(); ``` - *Type:* java.lang.Boolean - *Default:* false Use projenrc in TypeScript. This will create a tsconfig file (default: `tsconfig.projen.json`) and use `ts-node` in the default task to parse the project source files. --- ##### `projenrcTsOptions`^Optional ```java public ProjenrcTsOptions getProjenrcTsOptions(); ``` - *Type:* io.github.cdklabs.projen.typescript.ProjenrcTsOptions - *Default:* default options Options related to projenrc in TypeScript. --- ##### `pytest`^Optional ```java public java.lang.Boolean getPytest(); ``` - *Type:* java.lang.Boolean - *Default:* true Include pytest tests. --- ##### `pytestOptions`^Optional ```java public PytestOptions getPytestOptions(); ``` - *Type:* io.github.cdklabs.projen.python.PytestOptions - *Default:* defaults pytest options. --- ##### `pythonExec`^Optional ```java public java.lang.String getPythonExec(); ``` - *Type:* java.lang.String - *Default:* "python" Path to the python executable to use. --- ##### `sample`^Optional ```java public java.lang.Boolean getSample(); ``` - *Type:* java.lang.Boolean - *Default:* true Include sample code and test if the relevant directories don't exist. --- ##### `setuptools`^Optional ```java public java.lang.Boolean getSetuptools(); ``` - *Type:* java.lang.Boolean - *Default:* true, unless poetry is true, then false Use setuptools with a setup.py script for packaging and publishing. --- ##### `venv`^Optional ```java public java.lang.Boolean getVenv(); ``` - *Type:* java.lang.Boolean - *Default:* true, unless poetry is true, then false Use venv to manage a virtual environment for installing dependencies inside. --- ##### `venvOptions`^Optional ```java public VenvOptions getVenvOptions(); ``` - *Type:* io.github.cdklabs.projen.python.VenvOptions - *Default:* defaults Venv options. --- ##### `openApiGeneratorCliConfig`^Optional ```java public OpenApiGeneratorCliConfig getOpenApiGeneratorCliConfig(); ``` - *Type:* OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. Overrides default values if specified. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) --- ### GeneratedRuntimeCodeOptions Options for generated runtimes. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.GeneratedRuntimeCodeOptions; GeneratedRuntimeCodeOptions.builder() // .java(GeneratedJavaRuntimeOptions) // .python(GeneratedPythonRuntimeOptions) // .typescript(GeneratedTypeScriptRuntimeOptions) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | java | GeneratedJavaRuntimeOptions | Options for a generated java project. | | python | GeneratedPythonRuntimeOptions | Options for a generated python project. | | typescript | GeneratedTypeScriptRuntimeOptions | Options for a generated typescript project. | --- ##### `java`^Optional ```java public GeneratedJavaRuntimeOptions getJava(); ``` - *Type:* GeneratedJavaRuntimeOptions Options for a generated java project. These override the default inferred options. --- ##### `python`^Optional ```java public GeneratedPythonRuntimeOptions getPython(); ``` - *Type:* GeneratedPythonRuntimeOptions Options for a generated python project. These override the default inferred options. --- ##### `typescript`^Optional ```java public GeneratedTypeScriptRuntimeOptions getTypescript(); ``` - *Type:* GeneratedTypeScriptRuntimeOptions Options for a generated typescript project. These override the default inferred options. --- ### GeneratedTypeScriptHandlersOptions Options for configuring a generated typescript handlers project. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.GeneratedTypeScriptHandlersOptions; GeneratedTypeScriptHandlersOptions.builder() .name(java.lang.String) // .commitGenerated(java.lang.Boolean) // .gitIgnoreOptions(IgnoreFileOptions) // .gitOptions(GitOptions) // .logging(LoggerOptions) // .outdir(java.lang.String) // .parent(Project) // .projenCommand(java.lang.String) // .projenrcJson(java.lang.Boolean) // .projenrcJsonOptions(ProjenrcJsonOptions) // .renovatebot(java.lang.Boolean) // .renovatebotOptions(RenovatebotOptions) // .autoApproveOptions(AutoApproveOptions) // .autoMerge(java.lang.Boolean) // .autoMergeOptions(AutoMergeOptions) // .clobber(java.lang.Boolean) // .devContainer(java.lang.Boolean) // .github(java.lang.Boolean) // .githubOptions(GitHubOptions) // .gitpod(java.lang.Boolean) // .mergify(java.lang.Boolean) // .mergifyOptions(MergifyOptions) // .projectType(ProjectType) // .projenCredentials(GithubCredentials) // .projenTokenSecret(java.lang.String) // .readme(SampleReadmeProps) // .stale(java.lang.Boolean) // .staleOptions(StaleOptions) // .vscode(java.lang.Boolean) // .allowLibraryDependencies(java.lang.Boolean) // .authorEmail(java.lang.String) // .authorName(java.lang.String) // .authorOrganization(java.lang.Boolean) // .authorUrl(java.lang.String) // .autoDetectBin(java.lang.Boolean) // .bin(java.util.Map) // .bugsEmail(java.lang.String) // .bugsUrl(java.lang.String) // .bundledDeps(java.util.List) // .codeArtifactOptions(CodeArtifactOptions) // .deps(java.util.List) // .description(java.lang.String) // .devDeps(java.util.List) // .entrypoint(java.lang.String) // .homepage(java.lang.String) // .keywords(java.util.List) // .license(java.lang.String) // .licensed(java.lang.Boolean) // .maxNodeVersion(java.lang.String) // .minNodeVersion(java.lang.String) // .npmAccess(NpmAccess) // .npmRegistry(java.lang.String) // .npmRegistryUrl(java.lang.String) // .npmTokenSecret(java.lang.String) // .packageManager(NodePackageManager) // .packageName(java.lang.String) // .peerDependencyOptions(PeerDependencyOptions) // .peerDeps(java.util.List) // .pnpmVersion(java.lang.String) // .repository(java.lang.String) // .repositoryDirectory(java.lang.String) // .scopedPackagesOptions(java.util.List) // .scripts(java.util.Map) // .stability(java.lang.String) // .jsiiReleaseVersion(java.lang.String) // .majorVersion(java.lang.Number) // .minMajorVersion(java.lang.Number) // .npmDistTag(java.lang.String) // .postBuildSteps(java.util.List) // .prerelease(java.lang.String) // .publishDryRun(java.lang.Boolean) // .publishTasks(java.lang.Boolean) // .releaseBranches(java.util.Map) // .releaseEveryCommit(java.lang.Boolean) // .releaseFailureIssue(java.lang.Boolean) // .releaseFailureIssueLabel(java.lang.String) // .releaseSchedule(java.lang.String) // .releaseTagPrefix(java.lang.String) // .releaseTrigger(ReleaseTrigger) // .releaseWorkflowName(java.lang.String) // .releaseWorkflowSetupSteps(java.util.List) // .versionrcOptions(java.util.Map) // .workflowContainerImage(java.lang.String) // .workflowRunsOn(java.util.List) .defaultReleaseBranch(java.lang.String) // .artifactsDirectory(java.lang.String) // .autoApproveUpgrades(java.lang.Boolean) // .buildWorkflow(java.lang.Boolean) // .buildWorkflowTriggers(Triggers) // .bundlerOptions(BundlerOptions) // .codeCov(java.lang.Boolean) // .codeCovTokenSecret(java.lang.String) // .copyrightOwner(java.lang.String) // .copyrightPeriod(java.lang.String) // .dependabot(java.lang.Boolean) // .dependabotOptions(DependabotOptions) // .depsUpgrade(java.lang.Boolean) // .depsUpgradeOptions(UpgradeDependenciesOptions) // .gitignore(java.util.List) // .jest(java.lang.Boolean) // .jestOptions(JestOptions) // .mutableBuild(java.lang.Boolean) // .npmignore(java.util.List) // .npmignoreEnabled(java.lang.Boolean) // .npmIgnoreOptions(IgnoreFileOptions) // .package(java.lang.Boolean) // .prettier(java.lang.Boolean) // .prettierOptions(PrettierOptions) // .projenDevDependency(java.lang.Boolean) // .projenrcJs(java.lang.Boolean) // .projenrcJsOptions(ProjenrcOptions) // .projenVersion(java.lang.String) // .pullRequestTemplate(java.lang.Boolean) // .pullRequestTemplateContents(java.util.List) // .release(java.lang.Boolean) // .releaseToNpm(java.lang.Boolean) // .releaseWorkflow(java.lang.Boolean) // .workflowBootstrapSteps(java.util.List) // .workflowGitIdentity(GitIdentity) // .workflowNodeVersion(java.lang.String) // .workflowPackageCache(java.lang.Boolean) // .disableTsconfig(java.lang.Boolean) // .disableTsconfigDev(java.lang.Boolean) // .docgen(java.lang.Boolean) // .docsDirectory(java.lang.String) // .entrypointTypes(java.lang.String) // .eslint(java.lang.Boolean) // .eslintOptions(EslintOptions) // .libdir(java.lang.String) // .projenrcTs(java.lang.Boolean) // .projenrcTsOptions(ProjenrcOptions) // .sampleCode(java.lang.Boolean) // .srcdir(java.lang.String) // .testdir(java.lang.String) // .tsconfig(TypescriptConfigOptions) // .tsconfigDev(TypescriptConfigOptions) // .tsconfigDevFile(java.lang.String) // .typescriptVersion(java.lang.String) // .openApiGeneratorCliConfig(OpenApiGeneratorCliConfig) // .handlerEntryPoints(java.util.List) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | java.lang.String | This is the name of your project. | | commitGenerated | java.lang.Boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | io.github.cdklabs.projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | io.github.cdklabs.projen.GitOptions | Configuration options for git. | | logging | io.github.cdklabs.projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | java.lang.String | The root directory of the project. | | parent | io.github.cdklabs.projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | java.lang.String | The shell command to use in order to run the projen CLI. | | projenrcJson | java.lang.Boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | io.github.cdklabs.projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | java.lang.Boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | io.github.cdklabs.projen.RenovatebotOptions | Options for renovatebot. | | autoApproveOptions | io.github.cdklabs.projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoMerge | java.lang.Boolean | Enable automatic merging on GitHub. | | autoMergeOptions | io.github.cdklabs.projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | java.lang.Boolean | Add a `clobber` task which resets the repo to origin. | | devContainer | java.lang.Boolean | Add a VSCode development environment (used for GitHub Codespaces). | | github | java.lang.Boolean | Enable GitHub integration. | | githubOptions | io.github.cdklabs.projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | java.lang.Boolean | Add a Gitpod development environment. | | mergify | java.lang.Boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | io.github.cdklabs.projen.github.MergifyOptions | Options for mergify. | | projectType | io.github.cdklabs.projen.ProjectType | Which type of project this is (library/app). | | projenCredentials | io.github.cdklabs.projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projenTokenSecret | java.lang.String | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | io.github.cdklabs.projen.SampleReadmeProps | The README setup. | | stale | java.lang.Boolean | Auto-close of stale issues and pull request. | | staleOptions | io.github.cdklabs.projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | java.lang.Boolean | Enable VSCode integration. | | allowLibraryDependencies | java.lang.Boolean | Allow the project to include `peerDependencies` and `bundledDependencies`. | | authorEmail | java.lang.String | Author's e-mail. | | authorName | java.lang.String | Author's name. | | authorOrganization | java.lang.Boolean | Is the author an organization. | | authorUrl | java.lang.String | Author's URL / Website. | | autoDetectBin | java.lang.Boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. | | bin | java.util.Map | Binary programs vended with your module. | | bugsEmail | java.lang.String | The email address to which issues should be reported. | | bugsUrl | java.lang.String | The url to your project's issue tracker. | | bundledDeps | java.util.List | List of dependencies to bundle into this module. | | codeArtifactOptions | io.github.cdklabs.projen.javascript.CodeArtifactOptions | Options for npm packages using AWS CodeArtifact. | | deps | java.util.List | Runtime dependencies of this module. | | description | java.lang.String | The description is just a string that helps people understand the purpose of the package. | | devDeps | java.util.List | Build dependencies for this module. | | entrypoint | java.lang.String | Module entrypoint (`main` in `package.json`). | | homepage | java.lang.String | Package's Homepage / Website. | | keywords | java.util.List | Keywords to include in `package.json`. | | license | java.lang.String | License's SPDX identifier. | | licensed | java.lang.Boolean | Indicates if a license should be added. | | maxNodeVersion | java.lang.String | Minimum node.js version to require via `engines` (inclusive). | | minNodeVersion | java.lang.String | Minimum Node.js version to require via package.json `engines` (inclusive). | | npmAccess | io.github.cdklabs.projen.javascript.NpmAccess | Access level of the npm package. | | npmRegistry | java.lang.String | The host name of the npm registry to publish to. | | npmRegistryUrl | java.lang.String | The base URL of the npm package registry. | | npmTokenSecret | java.lang.String | GitHub secret which contains the NPM token to use when publishing packages. | | packageManager | io.github.cdklabs.projen.javascript.NodePackageManager | The Node Package Manager used to execute scripts. | | packageName | java.lang.String | The "name" in package.json. | | peerDependencyOptions | io.github.cdklabs.projen.javascript.PeerDependencyOptions | Options for `peerDeps`. | | peerDeps | java.util.List | Peer dependencies for this module. | | pnpmVersion | java.lang.String | The version of PNPM to use if using PNPM as a package manager. | | repository | java.lang.String | The repository is the location where the actual code for your package lives. | | repositoryDirectory | java.lang.String | 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. | | scopedPackagesOptions | java.util.List | Options for privately hosted scoped packages. | | scripts | java.util.Map | npm scripts to include. | | stability | java.lang.String | Package's Stability. | | jsiiReleaseVersion | java.lang.String | Version requirement of `publib` which is used to publish modules to npm. | | majorVersion | java.lang.Number | Major version to release from the default branch. | | minMajorVersion | java.lang.Number | Minimal Major version to release. | | npmDistTag | java.lang.String | The npmDistTag to use when publishing from the default branch. | | postBuildSteps | java.util.List | Steps to execute after build as part of the release workflow. | | prerelease | java.lang.String | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). | | publishDryRun | java.lang.Boolean | Instead of actually publishing to package managers, just print the publishing command. | | publishTasks | java.lang.Boolean | Define publishing tasks that can be executed manually as well as workflows. | | releaseBranches | java.util.Map | Defines additional release branches. | | releaseEveryCommit | java.lang.Boolean | Automatically release new versions every commit to one of branches in `releaseBranches`. | | releaseFailureIssue | java.lang.Boolean | Create a github issue on every failed publishing task. | | releaseFailureIssueLabel | java.lang.String | The label to apply to issues indicating publish failures. | | releaseSchedule | java.lang.String | CRON schedule to trigger new releases. | | releaseTagPrefix | java.lang.String | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. | | releaseTrigger | io.github.cdklabs.projen.release.ReleaseTrigger | The release trigger to use. | | releaseWorkflowName | java.lang.String | The name of the default release workflow. | | releaseWorkflowSetupSteps | java.util.List | A set of workflow steps to execute in order to setup the workflow container. | | versionrcOptions | java.util.Map | Custom configuration used when creating changelog with standard-version package. | | workflowContainerImage | java.lang.String | Container image to use for GitHub workflows. | | workflowRunsOn | java.util.List | Github Runner selection labels. | | defaultReleaseBranch | java.lang.String | The name of the main release branch. | | artifactsDirectory | java.lang.String | A directory which will contain build artifacts. | | autoApproveUpgrades | java.lang.Boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). | | buildWorkflow | java.lang.Boolean | Define a GitHub workflow for building PRs. | | buildWorkflowTriggers | io.github.cdklabs.projen.github.workflows.Triggers | Build workflow triggers. | | bundlerOptions | io.github.cdklabs.projen.javascript.BundlerOptions | Options for `Bundler`. | | codeCov | java.lang.Boolean | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. | | codeCovTokenSecret | java.lang.String | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. | | copyrightOwner | java.lang.String | License copyright owner. | | copyrightPeriod | java.lang.String | The copyright years to put in the LICENSE file. | | dependabot | java.lang.Boolean | Use dependabot to handle dependency upgrades. | | dependabotOptions | io.github.cdklabs.projen.github.DependabotOptions | Options for dependabot. | | depsUpgrade | java.lang.Boolean | Use github workflows to handle dependency upgrades. | | depsUpgradeOptions | io.github.cdklabs.projen.javascript.UpgradeDependenciesOptions | Options for `UpgradeDependencies`. | | gitignore | java.util.List | Additional entries to .gitignore. | | jest | java.lang.Boolean | Setup jest unit tests. | | jestOptions | io.github.cdklabs.projen.javascript.JestOptions | Jest options. | | mutableBuild | java.lang.Boolean | Automatically update files modified during builds to pull-request branches. | | npmignore | java.util.List | Additional entries to .npmignore. | | npmignoreEnabled | java.lang.Boolean | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. | | npmIgnoreOptions | io.github.cdklabs.projen.IgnoreFileOptions | Configuration options for .npmignore file. | | package | java.lang.Boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). | | prettier | java.lang.Boolean | Setup prettier. | | prettierOptions | io.github.cdklabs.projen.javascript.PrettierOptions | Prettier options. | | projenDevDependency | java.lang.Boolean | Indicates of "projen" should be installed as a devDependency. | | projenrcJs | java.lang.Boolean | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. | | projenrcJsOptions | io.github.cdklabs.projen.javascript.ProjenrcOptions | Options for .projenrc.js. | | projenVersion | java.lang.String | Version of projen to install. | | pullRequestTemplate | java.lang.Boolean | Include a GitHub pull request template. | | pullRequestTemplateContents | java.util.List | The contents of the pull request template. | | release | java.lang.Boolean | Add release management to this project. | | releaseToNpm | java.lang.Boolean | Automatically release to npm when new versions are introduced. | | releaseWorkflow | java.lang.Boolean | DEPRECATED: renamed to `release`. | | workflowBootstrapSteps | java.util.List | Workflow steps to use in order to bootstrap this repo. | | workflowGitIdentity | io.github.cdklabs.projen.github.GitIdentity | The git identity to use in workflows. | | workflowNodeVersion | java.lang.String | The node version to use in GitHub workflows. | | workflowPackageCache | java.lang.Boolean | Enable Node.js package cache in GitHub workflows. | | disableTsconfig | java.lang.Boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). | | disableTsconfigDev | java.lang.Boolean | Do not generate a `tsconfig.dev.json` file. | | docgen | java.lang.Boolean | Docgen by Typedoc. | | docsDirectory | java.lang.String | Docs directory. | | entrypointTypes | java.lang.String | The .d.ts file that includes the type declarations for this module. | | eslint | java.lang.Boolean | Setup eslint. | | eslintOptions | io.github.cdklabs.projen.javascript.EslintOptions | Eslint options. | | libdir | java.lang.String | Typescript artifacts output directory. | | projenrcTs | java.lang.Boolean | Use TypeScript for your projenrc file (`.projenrc.ts`). | | projenrcTsOptions | io.github.cdklabs.projen.typescript.ProjenrcOptions | Options for .projenrc.ts. | | sampleCode | java.lang.Boolean | Generate one-time sample in `src/` and `test/` if there are no files there. | | srcdir | java.lang.String | Typescript sources directory. | | testdir | java.lang.String | Jest tests directory. Tests files should be named `xxx.test.ts`. | | tsconfig | io.github.cdklabs.projen.javascript.TypescriptConfigOptions | Custom TSConfig. | | tsconfigDev | io.github.cdklabs.projen.javascript.TypescriptConfigOptions | Custom tsconfig options for the development tsconfig.json file (used for testing). | | tsconfigDevFile | java.lang.String | The name of the development tsconfig.json file. | | typescriptVersion | java.lang.String | TypeScript version to use. | | openApiGeneratorCliConfig | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. | | handlerEntryPoints | java.util.List | Globs for lambda handler entry points, used by esbuild. | --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional ```java public java.lang.Boolean getCommitGenerated(); ``` - *Type:* java.lang.Boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional ```java public IgnoreFileOptions getGitIgnoreOptions(); ``` - *Type:* io.github.cdklabs.projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```java public GitOptions getGitOptions(); ``` - *Type:* io.github.cdklabs.projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```java public LoggerOptions getLogging(); ``` - *Type:* io.github.cdklabs.projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```java public java.lang.String getOutdir(); ``` - *Type:* java.lang.String - *Default:* "." The root directory of the project. Relative to this directory, all files are synthesized. If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects. --- ##### `parent`^Optional ```java public Project getParent(); ``` - *Type:* io.github.cdklabs.projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional ```java public java.lang.String getProjenCommand(); ``` - *Type:* java.lang.String - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrcJson`^Optional ```java public java.lang.Boolean getProjenrcJson(); ``` - *Type:* java.lang.Boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional ```java public ProjenrcJsonOptions getProjenrcJsonOptions(); ``` - *Type:* io.github.cdklabs.projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```java public java.lang.Boolean getRenovatebot(); ``` - *Type:* java.lang.Boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```java public RenovatebotOptions getRenovatebotOptions(); ``` - *Type:* io.github.cdklabs.projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional ```java public AutoApproveOptions getAutoApproveOptions(); ``` - *Type:* io.github.cdklabs.projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional ```java public java.lang.Boolean getAutoMerge(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `autoMergeOptions`^Optional ```java public AutoMergeOptions getAutoMergeOptions(); ``` - *Type:* io.github.cdklabs.projen.github.AutoMergeOptions - *Default:* see defaults in `AutoMergeOptions` Configure options for automatic merging on GitHub. Has no effect if `github.mergify` or `autoMerge` is set to false. --- ##### `clobber`^Optional ```java public java.lang.Boolean getClobber(); ``` - *Type:* java.lang.Boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional ```java public java.lang.Boolean getDevContainer(); ``` - *Type:* java.lang.Boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```java public java.lang.Boolean getGithub(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```java public GitHubOptions getGithubOptions(); ``` - *Type:* io.github.cdklabs.projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```java public java.lang.Boolean getGitpod(); ``` - *Type:* java.lang.Boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```java public java.lang.Boolean getMergify(); ``` - *Type:* java.lang.Boolean - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergifyOptions`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead ```java public MergifyOptions getMergifyOptions(); ``` - *Type:* io.github.cdklabs.projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```java public ProjectType getProjectType(); ``` - *Type:* io.github.cdklabs.projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional ```java public GithubCredentials getProjenCredentials(); ``` - *Type:* io.github.cdklabs.projen.github.GithubCredentials - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN Choose a method of providing GitHub API access for projen workflows. --- ##### ~~`projenTokenSecret`~~^Optional - *Deprecated:* use `projenCredentials` ```java public java.lang.String getProjenTokenSecret(); ``` - *Type:* java.lang.String - *Default:* "PROJEN_GITHUB_TOKEN" The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This token needs to have the `repo`, `workflows` and `packages` scope. --- ##### `readme`^Optional ```java public SampleReadmeProps getReadme(); ``` - *Type:* io.github.cdklabs.projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```java "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```java public java.lang.Boolean getStale(); ``` - *Type:* java.lang.Boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```java public StaleOptions getStaleOptions(); ``` - *Type:* io.github.cdklabs.projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional ```java public java.lang.Boolean getVscode(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `allowLibraryDependencies`^Optional ```java public java.lang.Boolean getAllowLibraryDependencies(); ``` - *Type:* java.lang.Boolean - *Default:* true Allow the project to include `peerDependencies` and `bundledDependencies`. This is normally only allowed for libraries. For apps, there's no meaning for specifying these. --- ##### `authorEmail`^Optional ```java public java.lang.String getAuthorEmail(); ``` - *Type:* java.lang.String Author's e-mail. --- ##### `authorName`^Optional ```java public java.lang.String getAuthorName(); ``` - *Type:* java.lang.String Author's name. --- ##### `authorOrganization`^Optional ```java public java.lang.Boolean getAuthorOrganization(); ``` - *Type:* java.lang.Boolean Is the author an organization. --- ##### `authorUrl`^Optional ```java public java.lang.String getAuthorUrl(); ``` - *Type:* java.lang.String Author's URL / Website. --- ##### `autoDetectBin`^Optional ```java public java.lang.Boolean getAutoDetectBin(); ``` - *Type:* java.lang.Boolean - *Default:* true Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. --- ##### `bin`^Optional ```java public java.util.Map getBin(); ``` - *Type:* java.util.Map Binary programs vended with your module. You can use this option to add/customize how binaries are represented in your `package.json`, but unless `autoDetectBin` is `false`, every executable file under `bin` will automatically be added to this section. --- ##### `bugsEmail`^Optional ```java public java.lang.String getBugsEmail(); ``` - *Type:* java.lang.String The email address to which issues should be reported. --- ##### `bugsUrl`^Optional ```java public java.lang.String getBugsUrl(); ``` - *Type:* java.lang.String The url to your project's issue tracker. --- ##### `bundledDeps`^Optional ```java public java.util.List getBundledDeps(); ``` - *Type:* java.util.List List of dependencies to bundle into this module. These modules will be added both to the `dependencies` section and `bundledDependencies` section of your `package.json`. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `yarn add` or `npm install` in the sense that it will add the module as a dependency to your `package.json` file with the latest version (`^`). You can specify semver requirements in the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and this will be what you `package.json` will eventually include. --- ##### `codeArtifactOptions`^Optional ```java public CodeArtifactOptions getCodeArtifactOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.CodeArtifactOptions - *Default:* undefined Options for npm packages using AWS CodeArtifact. This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact --- ##### `deps`^Optional ```java public java.util.List getDeps(); ``` - *Type:* java.util.List - *Default:* [] Runtime dependencies of this module. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `yarn add` or `npm install` in the sense that it will add the module as a dependency to your `package.json` file with the latest version (`^`). You can specify semver requirements in the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and this will be what you `package.json` will eventually include. --- *Example* ```java [ 'express', 'lodash', 'foo@^2' ] ``` ##### `description`^Optional ```java public java.lang.String getDescription(); ``` - *Type:* java.lang.String The description is just a string that helps people understand the purpose of the package. It can be used when searching for packages in a package manager as well. See https://classic.yarnpkg.com/en/docs/package-json/#toc-description --- ##### `devDeps`^Optional ```java public java.util.List getDevDeps(); ``` - *Type:* java.util.List - *Default:* [] Build dependencies for this module. These dependencies will only be available in your build environment but will not be fetched when this module is consumed. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `yarn add` or `npm install` in the sense that it will add the module as a dependency to your `package.json` file with the latest version (`^`). You can specify semver requirements in the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and this will be what you `package.json` will eventually include. --- *Example* ```java [ 'typescript', '@types/express' ] ``` ##### `entrypoint`^Optional ```java public java.lang.String getEntrypoint(); ``` - *Type:* java.lang.String - *Default:* "lib/index.js" Module entrypoint (`main` in `package.json`). Set to an empty string to not include `main` in your package.json --- ##### `homepage`^Optional ```java public java.lang.String getHomepage(); ``` - *Type:* java.lang.String Package's Homepage / Website. --- ##### `keywords`^Optional ```java public java.util.List getKeywords(); ``` - *Type:* java.util.List Keywords to include in `package.json`. --- ##### `license`^Optional ```java public java.lang.String getLicense(); ``` - *Type:* java.lang.String - *Default:* "Apache-2.0" License's SPDX identifier. See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses. Use the `licensed` option if you want to no license to be specified. --- ##### `licensed`^Optional ```java public java.lang.Boolean getLicensed(); ``` - *Type:* java.lang.Boolean - *Default:* true Indicates if a license should be added. --- ##### `maxNodeVersion`^Optional ```java public java.lang.String getMaxNodeVersion(); ``` - *Type:* java.lang.String - *Default:* no max Minimum node.js version to require via `engines` (inclusive). --- ##### `minNodeVersion`^Optional ```java public java.lang.String getMinNodeVersion(); ``` - *Type:* java.lang.String - *Default:* no "engines" specified Minimum Node.js version to require via package.json `engines` (inclusive). --- ##### `npmAccess`^Optional ```java public NpmAccess getNpmAccess(); ``` - *Type:* io.github.cdklabs.projen.javascript.NpmAccess - *Default:* for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`. Access level of the npm package. --- ##### ~~`npmRegistry`~~^Optional - *Deprecated:* use `npmRegistryUrl` instead ```java public java.lang.String getNpmRegistry(); ``` - *Type:* java.lang.String The host name of the npm registry to publish to. Cannot be set together with `npmRegistryUrl`. --- ##### `npmRegistryUrl`^Optional ```java public java.lang.String getNpmRegistryUrl(); ``` - *Type:* java.lang.String - *Default:* "https://registry.npmjs.org" The base URL of the npm package registry. Must be a URL (e.g. start with "https://" or "http://") --- ##### `npmTokenSecret`^Optional ```java public java.lang.String getNpmTokenSecret(); ``` - *Type:* java.lang.String - *Default:* "NPM_TOKEN" GitHub secret which contains the NPM token to use when publishing packages. --- ##### `packageManager`^Optional ```java public NodePackageManager getPackageManager(); ``` - *Type:* io.github.cdklabs.projen.javascript.NodePackageManager - *Default:* NodePackageManager.YARN The Node Package Manager used to execute scripts. --- ##### `packageName`^Optional ```java public java.lang.String getPackageName(); ``` - *Type:* java.lang.String - *Default:* defaults to project name The "name" in package.json. --- ##### `peerDependencyOptions`^Optional ```java public PeerDependencyOptions getPeerDependencyOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.PeerDependencyOptions Options for `peerDeps`. --- ##### `peerDeps`^Optional ```java public java.util.List getPeerDeps(); ``` - *Type:* java.util.List - *Default:* [] Peer dependencies for this module. Dependencies listed here are required to be installed (and satisfied) by the _consumer_ of this library. Using peer dependencies allows you to ensure that only a single module of a certain library exists in the `node_modules` tree of your consumers. Note that prior to npm@7, peer dependencies are _not_ automatically installed, which means that adding peer dependencies to a library will be a breaking change for your customers. Unless `peerDependencyOptions.pinnedDevDependency` is disabled (it is enabled by default), projen will automatically add a dev dependency with a pinned version for each peer dependency. This will ensure that you build & test your module against the lowest peer version required. --- ##### `pnpmVersion`^Optional ```java public java.lang.String getPnpmVersion(); ``` - *Type:* java.lang.String - *Default:* "7" The version of PNPM to use if using PNPM as a package manager. --- ##### `repository`^Optional ```java public java.lang.String getRepository(); ``` - *Type:* java.lang.String The repository is the location where the actual code for your package lives. See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository --- ##### `repositoryDirectory`^Optional ```java public java.lang.String getRepositoryDirectory(); ``` - *Type:* java.lang.String 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. --- ##### `scopedPackagesOptions`^Optional ```java public java.util.List getScopedPackagesOptions(); ``` - *Type:* java.util.List - *Default:* fetch all scoped packages from the public npm registry Options for privately hosted scoped packages. --- ##### ~~`scripts`~~^Optional - *Deprecated:* use `project.addTask()` or `package.setScript()` ```java public java.util.Map getScripts(); ``` - *Type:* java.util.Map - *Default:* {} npm scripts to include. If a script has the same name as a standard script, the standard script will be overwritten. Also adds the script as a task. --- ##### `stability`^Optional ```java public java.lang.String getStability(); ``` - *Type:* java.lang.String Package's Stability. --- ##### `jsiiReleaseVersion`^Optional ```java public java.lang.String getJsiiReleaseVersion(); ``` - *Type:* java.lang.String - *Default:* "latest" Version requirement of `publib` which is used to publish modules to npm. --- ##### `majorVersion`^Optional ```java public java.lang.Number getMajorVersion(); ``` - *Type:* java.lang.Number - *Default:* Major version is not enforced. Major version to release from the default branch. If this is specified, we bump the latest version of this major version line. If not specified, we bump the global latest version. --- ##### `minMajorVersion`^Optional ```java public java.lang.Number getMinMajorVersion(); ``` - *Type:* java.lang.Number - *Default:* No minimum version is being enforced Minimal Major version to release. This can be useful to set to 1, as breaking changes before the 1.x major release are not incrementing the major version number. Can not be set together with `majorVersion`. --- ##### `npmDistTag`^Optional ```java public java.lang.String getNpmDistTag(); ``` - *Type:* java.lang.String - *Default:* "latest" The npmDistTag to use when publishing from the default branch. To set the npm dist-tag for release branches, set the `npmDistTag` property for each branch. --- ##### `postBuildSteps`^Optional ```java public java.util.List getPostBuildSteps(); ``` - *Type:* java.util.List - *Default:* [] Steps to execute after build as part of the release workflow. --- ##### `prerelease`^Optional ```java public java.lang.String getPrerelease(); ``` - *Type:* java.lang.String - *Default:* normal semantic versions Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). --- ##### `publishDryRun`^Optional ```java public java.lang.Boolean getPublishDryRun(); ``` - *Type:* java.lang.Boolean - *Default:* false Instead of actually publishing to package managers, just print the publishing command. --- ##### `publishTasks`^Optional ```java public java.lang.Boolean getPublishTasks(); ``` - *Type:* java.lang.Boolean - *Default:* false Define publishing tasks that can be executed manually as well as workflows. Normally, publishing only happens within automated workflows. Enable this in order to create a publishing task for each publishing activity. --- ##### `releaseBranches`^Optional ```java public java.util.Map getReleaseBranches(); ``` - *Type:* java.util.Map - *Default:* no additional branches are used for release. you can use `addBranch()` to add additional branches. Defines additional release branches. A workflow will be created for each release branch which will publish releases from commits in this branch. Each release branch _must_ be assigned a major version number which is used to enforce that versions published from that branch always use that major version. If multiple branches are used, the `majorVersion` field must also be provided for the default branch. --- ##### ~~`releaseEveryCommit`~~^Optional - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead ```java public java.lang.Boolean getReleaseEveryCommit(); ``` - *Type:* java.lang.Boolean - *Default:* true Automatically release new versions every commit to one of branches in `releaseBranches`. --- ##### `releaseFailureIssue`^Optional ```java public java.lang.Boolean getReleaseFailureIssue(); ``` - *Type:* java.lang.Boolean - *Default:* false Create a github issue on every failed publishing task. --- ##### `releaseFailureIssueLabel`^Optional ```java public java.lang.String getReleaseFailureIssueLabel(); ``` - *Type:* java.lang.String - *Default:* "failed-release" The label to apply to issues indicating publish failures. Only applies if `releaseFailureIssue` is true. --- ##### ~~`releaseSchedule`~~^Optional - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead ```java public java.lang.String getReleaseSchedule(); ``` - *Type:* java.lang.String - *Default:* no scheduled releases CRON schedule to trigger new releases. --- ##### `releaseTagPrefix`^Optional ```java public java.lang.String getReleaseTagPrefix(); ``` - *Type:* java.lang.String - *Default:* "v" Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. Note: this prefix is used to detect the latest tagged version when bumping, so if you change this on a project with an existing version history, you may need to manually tag your latest release with the new prefix. --- ##### `releaseTrigger`^Optional ```java public ReleaseTrigger getReleaseTrigger(); ``` - *Type:* io.github.cdklabs.projen.release.ReleaseTrigger - *Default:* Continuous releases (`ReleaseTrigger.continuous()`) The release trigger to use. --- ##### `releaseWorkflowName`^Optional ```java public java.lang.String getReleaseWorkflowName(); ``` - *Type:* java.lang.String - *Default:* "Release" The name of the default release workflow. --- ##### `releaseWorkflowSetupSteps`^Optional ```java public java.util.List getReleaseWorkflowSetupSteps(); ``` - *Type:* java.util.List A set of workflow steps to execute in order to setup the workflow container. --- ##### `versionrcOptions`^Optional ```java public java.util.Map getVersionrcOptions(); ``` - *Type:* java.util.Map - *Default:* standard configuration applicable for GitHub repositories Custom configuration used when creating changelog with standard-version package. Given values either append to default configuration or overwrite values in it. --- ##### `workflowContainerImage`^Optional ```java public java.lang.String getWorkflowContainerImage(); ``` - *Type:* java.lang.String - *Default:* default image Container image to use for GitHub workflows. --- ##### `workflowRunsOn`^Optional ```java public java.util.List getWorkflowRunsOn(); ``` - *Type:* java.util.List - *Default:* ["ubuntu-latest"] Github Runner selection labels. --- ##### `defaultReleaseBranch`^Required ```java public java.lang.String getDefaultReleaseBranch(); ``` - *Type:* java.lang.String - *Default:* "main" The name of the main release branch. --- ##### `artifactsDirectory`^Optional ```java public java.lang.String getArtifactsDirectory(); ``` - *Type:* java.lang.String - *Default:* "dist" A directory which will contain build artifacts. --- ##### `autoApproveUpgrades`^Optional ```java public java.lang.Boolean getAutoApproveUpgrades(); ``` - *Type:* java.lang.Boolean - *Default:* true Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). Throw if set to true but `autoApproveOptions` are not defined. --- ##### `buildWorkflow`^Optional ```java public java.lang.Boolean getBuildWorkflow(); ``` - *Type:* java.lang.Boolean - *Default:* true if not a subproject Define a GitHub workflow for building PRs. --- ##### `buildWorkflowTriggers`^Optional ```java public Triggers getBuildWorkflowTriggers(); ``` - *Type:* io.github.cdklabs.projen.github.workflows.Triggers - *Default:* "{ pullRequest: {}, workflowDispatch: {} }" Build workflow triggers. --- ##### `bundlerOptions`^Optional ```java public BundlerOptions getBundlerOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.BundlerOptions Options for `Bundler`. --- ##### `codeCov`^Optional ```java public java.lang.Boolean getCodeCov(); ``` - *Type:* java.lang.Boolean - *Default:* false Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. --- ##### `codeCovTokenSecret`^Optional ```java public java.lang.String getCodeCovTokenSecret(); ``` - *Type:* java.lang.String - *Default:* if this option is not specified, only public repositories are supported Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. --- ##### `copyrightOwner`^Optional ```java public java.lang.String getCopyrightOwner(); ``` - *Type:* java.lang.String - *Default:* defaults to the value of authorName or "" if `authorName` is undefined. License copyright owner. --- ##### `copyrightPeriod`^Optional ```java public java.lang.String getCopyrightPeriod(); ``` - *Type:* java.lang.String - *Default:* current year The copyright years to put in the LICENSE file. --- ##### `dependabot`^Optional ```java public java.lang.Boolean getDependabot(); ``` - *Type:* java.lang.Boolean - *Default:* false Use dependabot to handle dependency upgrades. Cannot be used in conjunction with `depsUpgrade`. --- ##### `dependabotOptions`^Optional ```java public DependabotOptions getDependabotOptions(); ``` - *Type:* io.github.cdklabs.projen.github.DependabotOptions - *Default:* default options Options for dependabot. --- ##### `depsUpgrade`^Optional ```java public java.lang.Boolean getDepsUpgrade(); ``` - *Type:* java.lang.Boolean - *Default:* true Use github workflows to handle dependency upgrades. Cannot be used in conjunction with `dependabot`. --- ##### `depsUpgradeOptions`^Optional ```java public UpgradeDependenciesOptions getDepsUpgradeOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.UpgradeDependenciesOptions - *Default:* default options Options for `UpgradeDependencies`. --- ##### `gitignore`^Optional ```java public java.util.List getGitignore(); ``` - *Type:* java.util.List Additional entries to .gitignore. --- ##### `jest`^Optional ```java public java.lang.Boolean getJest(); ``` - *Type:* java.lang.Boolean - *Default:* true Setup jest unit tests. --- ##### `jestOptions`^Optional ```java public JestOptions getJestOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.JestOptions - *Default:* default options Jest options. --- ##### `mutableBuild`^Optional ```java public java.lang.Boolean getMutableBuild(); ``` - *Type:* java.lang.Boolean - *Default:* true Automatically update files modified during builds to pull-request branches. This means that any files synthesized by projen or e.g. test snapshots will always be up-to-date before a PR is merged. Implies that PR builds do not have anti-tamper checks. --- ##### ~~`npmignore`~~^Optional - *Deprecated:* - use `project.addPackageIgnore` ```java public java.util.List getNpmignore(); ``` - *Type:* java.util.List Additional entries to .npmignore. --- ##### `npmignoreEnabled`^Optional ```java public java.lang.Boolean getNpmignoreEnabled(); ``` - *Type:* java.lang.Boolean - *Default:* true Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. --- ##### `npmIgnoreOptions`^Optional ```java public IgnoreFileOptions getNpmIgnoreOptions(); ``` - *Type:* io.github.cdklabs.projen.IgnoreFileOptions Configuration options for .npmignore file. --- ##### `package`^Optional ```java public java.lang.Boolean getPackage(); ``` - *Type:* java.lang.Boolean - *Default:* true Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). --- ##### `prettier`^Optional ```java public java.lang.Boolean getPrettier(); ``` - *Type:* java.lang.Boolean - *Default:* false Setup prettier. --- ##### `prettierOptions`^Optional ```java public PrettierOptions getPrettierOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.PrettierOptions - *Default:* default options Prettier options. --- ##### `projenDevDependency`^Optional ```java public java.lang.Boolean getProjenDevDependency(); ``` - *Type:* java.lang.Boolean - *Default:* true Indicates of "projen" should be installed as a devDependency. --- ##### `projenrcJs`^Optional ```java public java.lang.Boolean getProjenrcJs(); ``` - *Type:* java.lang.Boolean - *Default:* true if projenrcJson is false Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. --- ##### `projenrcJsOptions`^Optional ```java public ProjenrcOptions getProjenrcJsOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.ProjenrcOptions - *Default:* default options Options for .projenrc.js. --- ##### `projenVersion`^Optional ```java public java.lang.String getProjenVersion(); ``` - *Type:* java.lang.String - *Default:* Defaults to the latest version. Version of projen to install. --- ##### `pullRequestTemplate`^Optional ```java public java.lang.Boolean getPullRequestTemplate(); ``` - *Type:* java.lang.Boolean - *Default:* true Include a GitHub pull request template. --- ##### `pullRequestTemplateContents`^Optional ```java public java.util.List getPullRequestTemplateContents(); ``` - *Type:* java.util.List - *Default:* default content The contents of the pull request template. --- ##### `release`^Optional ```java public java.lang.Boolean getRelease(); ``` - *Type:* java.lang.Boolean - *Default:* true (false for subprojects) Add release management to this project. --- ##### `releaseToNpm`^Optional ```java public java.lang.Boolean getReleaseToNpm(); ``` - *Type:* java.lang.Boolean - *Default:* false Automatically release to npm when new versions are introduced. --- ##### ~~`releaseWorkflow`~~^Optional - *Deprecated:* see `release`. ```java public java.lang.Boolean getReleaseWorkflow(); ``` - *Type:* java.lang.Boolean - *Default:* true if not a subproject DEPRECATED: renamed to `release`. --- ##### `workflowBootstrapSteps`^Optional ```java public java.util.List getWorkflowBootstrapSteps(); ``` - *Type:* java.util.List - *Default:* "yarn install --frozen-lockfile && yarn projen" Workflow steps to use in order to bootstrap this repo. --- ##### `workflowGitIdentity`^Optional ```java public GitIdentity getWorkflowGitIdentity(); ``` - *Type:* io.github.cdklabs.projen.github.GitIdentity - *Default:* GitHub Actions The git identity to use in workflows. --- ##### `workflowNodeVersion`^Optional ```java public java.lang.String getWorkflowNodeVersion(); ``` - *Type:* java.lang.String - *Default:* same as `minNodeVersion` The node version to use in GitHub workflows. --- ##### `workflowPackageCache`^Optional ```java public java.lang.Boolean getWorkflowPackageCache(); ``` - *Type:* java.lang.Boolean - *Default:* false Enable Node.js package cache in GitHub workflows. --- ##### `disableTsconfig`^Optional ```java public java.lang.Boolean getDisableTsconfig(); ``` - *Type:* java.lang.Boolean - *Default:* false Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). --- ##### `disableTsconfigDev`^Optional ```java public java.lang.Boolean getDisableTsconfigDev(); ``` - *Type:* java.lang.Boolean - *Default:* false Do not generate a `tsconfig.dev.json` file. --- ##### `docgen`^Optional ```java public java.lang.Boolean getDocgen(); ``` - *Type:* java.lang.Boolean - *Default:* false Docgen by Typedoc. --- ##### `docsDirectory`^Optional ```java public java.lang.String getDocsDirectory(); ``` - *Type:* java.lang.String - *Default:* "docs" Docs directory. --- ##### `entrypointTypes`^Optional ```java public java.lang.String getEntrypointTypes(); ``` - *Type:* java.lang.String - *Default:* .d.ts file derived from the project's entrypoint (usually lib/index.d.ts) The .d.ts file that includes the type declarations for this module. --- ##### `eslint`^Optional ```java public java.lang.Boolean getEslint(); ``` - *Type:* java.lang.Boolean - *Default:* true Setup eslint. --- ##### `eslintOptions`^Optional ```java public EslintOptions getEslintOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.EslintOptions - *Default:* opinionated default options Eslint options. --- ##### `libdir`^Optional ```java public java.lang.String getLibdir(); ``` - *Type:* java.lang.String - *Default:* "lib" Typescript artifacts output directory. --- ##### `projenrcTs`^Optional ```java public java.lang.Boolean getProjenrcTs(); ``` - *Type:* java.lang.Boolean - *Default:* false Use TypeScript for your projenrc file (`.projenrc.ts`). --- ##### `projenrcTsOptions`^Optional ```java public ProjenrcOptions getProjenrcTsOptions(); ``` - *Type:* io.github.cdklabs.projen.typescript.ProjenrcOptions Options for .projenrc.ts. --- ##### `sampleCode`^Optional ```java public java.lang.Boolean getSampleCode(); ``` - *Type:* java.lang.Boolean - *Default:* true Generate one-time sample in `src/` and `test/` if there are no files there. --- ##### `srcdir`^Optional ```java public java.lang.String getSrcdir(); ``` - *Type:* java.lang.String - *Default:* "src" Typescript sources directory. --- ##### `testdir`^Optional ```java public java.lang.String getTestdir(); ``` - *Type:* java.lang.String - *Default:* "test" Jest tests directory. Tests files should be named `xxx.test.ts`. If this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`), then tests are going to be compiled into `lib/` and executed as javascript. If the test directory is outside of `src`, then we configure jest to compile the code in-memory. --- ##### `tsconfig`^Optional ```java public TypescriptConfigOptions getTsconfig(); ``` - *Type:* io.github.cdklabs.projen.javascript.TypescriptConfigOptions - *Default:* default options Custom TSConfig. --- ##### `tsconfigDev`^Optional ```java public TypescriptConfigOptions getTsconfigDev(); ``` - *Type:* io.github.cdklabs.projen.javascript.TypescriptConfigOptions - *Default:* use the production tsconfig options Custom tsconfig options for the development tsconfig.json file (used for testing). --- ##### `tsconfigDevFile`^Optional ```java public java.lang.String getTsconfigDevFile(); ``` - *Type:* java.lang.String - *Default:* "tsconfig.dev.json" The name of the development tsconfig.json file. --- ##### `typescriptVersion`^Optional ```java public java.lang.String getTypescriptVersion(); ``` - *Type:* java.lang.String - *Default:* "latest" TypeScript version to use. NOTE: Typescript is not semantically versioned and should remain on the same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`). --- ##### `openApiGeneratorCliConfig`^Optional ```java public OpenApiGeneratorCliConfig getOpenApiGeneratorCliConfig(); ``` - *Type:* OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. Overrides default values if specified. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) --- ##### `handlerEntryPoints`^Optional ```java public java.util.List getHandlerEntryPoints(); ``` - *Type:* java.util.List - *Default:* src/*.ts - all files directly under the src directory Globs for lambda handler entry points, used by esbuild. --- ### GeneratedTypeScriptInfrastructureOptions Options for configuring a generated typescript infrastructure project. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.GeneratedTypeScriptInfrastructureOptions; GeneratedTypeScriptInfrastructureOptions.builder() .name(java.lang.String) // .commitGenerated(java.lang.Boolean) // .gitIgnoreOptions(IgnoreFileOptions) // .gitOptions(GitOptions) // .logging(LoggerOptions) // .outdir(java.lang.String) // .parent(Project) // .projenCommand(java.lang.String) // .projenrcJson(java.lang.Boolean) // .projenrcJsonOptions(ProjenrcJsonOptions) // .renovatebot(java.lang.Boolean) // .renovatebotOptions(RenovatebotOptions) // .autoApproveOptions(AutoApproveOptions) // .autoMerge(java.lang.Boolean) // .autoMergeOptions(AutoMergeOptions) // .clobber(java.lang.Boolean) // .devContainer(java.lang.Boolean) // .github(java.lang.Boolean) // .githubOptions(GitHubOptions) // .gitpod(java.lang.Boolean) // .mergify(java.lang.Boolean) // .mergifyOptions(MergifyOptions) // .projectType(ProjectType) // .projenCredentials(GithubCredentials) // .projenTokenSecret(java.lang.String) // .readme(SampleReadmeProps) // .stale(java.lang.Boolean) // .staleOptions(StaleOptions) // .vscode(java.lang.Boolean) // .allowLibraryDependencies(java.lang.Boolean) // .authorEmail(java.lang.String) // .authorName(java.lang.String) // .authorOrganization(java.lang.Boolean) // .authorUrl(java.lang.String) // .autoDetectBin(java.lang.Boolean) // .bin(java.util.Map) // .bugsEmail(java.lang.String) // .bugsUrl(java.lang.String) // .bundledDeps(java.util.List) // .codeArtifactOptions(CodeArtifactOptions) // .deps(java.util.List) // .description(java.lang.String) // .devDeps(java.util.List) // .entrypoint(java.lang.String) // .homepage(java.lang.String) // .keywords(java.util.List) // .license(java.lang.String) // .licensed(java.lang.Boolean) // .maxNodeVersion(java.lang.String) // .minNodeVersion(java.lang.String) // .npmAccess(NpmAccess) // .npmRegistry(java.lang.String) // .npmRegistryUrl(java.lang.String) // .npmTokenSecret(java.lang.String) // .packageManager(NodePackageManager) // .packageName(java.lang.String) // .peerDependencyOptions(PeerDependencyOptions) // .peerDeps(java.util.List) // .pnpmVersion(java.lang.String) // .repository(java.lang.String) // .repositoryDirectory(java.lang.String) // .scopedPackagesOptions(java.util.List) // .scripts(java.util.Map) // .stability(java.lang.String) // .jsiiReleaseVersion(java.lang.String) // .majorVersion(java.lang.Number) // .minMajorVersion(java.lang.Number) // .npmDistTag(java.lang.String) // .postBuildSteps(java.util.List) // .prerelease(java.lang.String) // .publishDryRun(java.lang.Boolean) // .publishTasks(java.lang.Boolean) // .releaseBranches(java.util.Map) // .releaseEveryCommit(java.lang.Boolean) // .releaseFailureIssue(java.lang.Boolean) // .releaseFailureIssueLabel(java.lang.String) // .releaseSchedule(java.lang.String) // .releaseTagPrefix(java.lang.String) // .releaseTrigger(ReleaseTrigger) // .releaseWorkflowName(java.lang.String) // .releaseWorkflowSetupSteps(java.util.List) // .versionrcOptions(java.util.Map) // .workflowContainerImage(java.lang.String) // .workflowRunsOn(java.util.List) .defaultReleaseBranch(java.lang.String) // .artifactsDirectory(java.lang.String) // .autoApproveUpgrades(java.lang.Boolean) // .buildWorkflow(java.lang.Boolean) // .buildWorkflowTriggers(Triggers) // .bundlerOptions(BundlerOptions) // .codeCov(java.lang.Boolean) // .codeCovTokenSecret(java.lang.String) // .copyrightOwner(java.lang.String) // .copyrightPeriod(java.lang.String) // .dependabot(java.lang.Boolean) // .dependabotOptions(DependabotOptions) // .depsUpgrade(java.lang.Boolean) // .depsUpgradeOptions(UpgradeDependenciesOptions) // .gitignore(java.util.List) // .jest(java.lang.Boolean) // .jestOptions(JestOptions) // .mutableBuild(java.lang.Boolean) // .npmignore(java.util.List) // .npmignoreEnabled(java.lang.Boolean) // .npmIgnoreOptions(IgnoreFileOptions) // .package(java.lang.Boolean) // .prettier(java.lang.Boolean) // .prettierOptions(PrettierOptions) // .projenDevDependency(java.lang.Boolean) // .projenrcJs(java.lang.Boolean) // .projenrcJsOptions(ProjenrcOptions) // .projenVersion(java.lang.String) // .pullRequestTemplate(java.lang.Boolean) // .pullRequestTemplateContents(java.util.List) // .release(java.lang.Boolean) // .releaseToNpm(java.lang.Boolean) // .releaseWorkflow(java.lang.Boolean) // .workflowBootstrapSteps(java.util.List) // .workflowGitIdentity(GitIdentity) // .workflowNodeVersion(java.lang.String) // .workflowPackageCache(java.lang.Boolean) // .disableTsconfig(java.lang.Boolean) // .disableTsconfigDev(java.lang.Boolean) // .docgen(java.lang.Boolean) // .docsDirectory(java.lang.String) // .entrypointTypes(java.lang.String) // .eslint(java.lang.Boolean) // .eslintOptions(EslintOptions) // .libdir(java.lang.String) // .projenrcTs(java.lang.Boolean) // .projenrcTsOptions(ProjenrcOptions) // .sampleCode(java.lang.Boolean) // .srcdir(java.lang.String) // .testdir(java.lang.String) // .tsconfig(TypescriptConfigOptions) // .tsconfigDev(TypescriptConfigOptions) // .tsconfigDevFile(java.lang.String) // .typescriptVersion(java.lang.String) // .openApiGeneratorCliConfig(OpenApiGeneratorCliConfig) // .mockDataOptions(MockResponseDataGenerationOptions) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | java.lang.String | This is the name of your project. | | commitGenerated | java.lang.Boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | io.github.cdklabs.projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | io.github.cdklabs.projen.GitOptions | Configuration options for git. | | logging | io.github.cdklabs.projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | java.lang.String | The root directory of the project. | | parent | io.github.cdklabs.projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | java.lang.String | The shell command to use in order to run the projen CLI. | | projenrcJson | java.lang.Boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | io.github.cdklabs.projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | java.lang.Boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | io.github.cdklabs.projen.RenovatebotOptions | Options for renovatebot. | | autoApproveOptions | io.github.cdklabs.projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoMerge | java.lang.Boolean | Enable automatic merging on GitHub. | | autoMergeOptions | io.github.cdklabs.projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | java.lang.Boolean | Add a `clobber` task which resets the repo to origin. | | devContainer | java.lang.Boolean | Add a VSCode development environment (used for GitHub Codespaces). | | github | java.lang.Boolean | Enable GitHub integration. | | githubOptions | io.github.cdklabs.projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | java.lang.Boolean | Add a Gitpod development environment. | | mergify | java.lang.Boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | io.github.cdklabs.projen.github.MergifyOptions | Options for mergify. | | projectType | io.github.cdklabs.projen.ProjectType | Which type of project this is (library/app). | | projenCredentials | io.github.cdklabs.projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projenTokenSecret | java.lang.String | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | io.github.cdklabs.projen.SampleReadmeProps | The README setup. | | stale | java.lang.Boolean | Auto-close of stale issues and pull request. | | staleOptions | io.github.cdklabs.projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | java.lang.Boolean | Enable VSCode integration. | | allowLibraryDependencies | java.lang.Boolean | Allow the project to include `peerDependencies` and `bundledDependencies`. | | authorEmail | java.lang.String | Author's e-mail. | | authorName | java.lang.String | Author's name. | | authorOrganization | java.lang.Boolean | Is the author an organization. | | authorUrl | java.lang.String | Author's URL / Website. | | autoDetectBin | java.lang.Boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. | | bin | java.util.Map | Binary programs vended with your module. | | bugsEmail | java.lang.String | The email address to which issues should be reported. | | bugsUrl | java.lang.String | The url to your project's issue tracker. | | bundledDeps | java.util.List | List of dependencies to bundle into this module. | | codeArtifactOptions | io.github.cdklabs.projen.javascript.CodeArtifactOptions | Options for npm packages using AWS CodeArtifact. | | deps | java.util.List | Runtime dependencies of this module. | | description | java.lang.String | The description is just a string that helps people understand the purpose of the package. | | devDeps | java.util.List | Build dependencies for this module. | | entrypoint | java.lang.String | Module entrypoint (`main` in `package.json`). | | homepage | java.lang.String | Package's Homepage / Website. | | keywords | java.util.List | Keywords to include in `package.json`. | | license | java.lang.String | License's SPDX identifier. | | licensed | java.lang.Boolean | Indicates if a license should be added. | | maxNodeVersion | java.lang.String | Minimum node.js version to require via `engines` (inclusive). | | minNodeVersion | java.lang.String | Minimum Node.js version to require via package.json `engines` (inclusive). | | npmAccess | io.github.cdklabs.projen.javascript.NpmAccess | Access level of the npm package. | | npmRegistry | java.lang.String | The host name of the npm registry to publish to. | | npmRegistryUrl | java.lang.String | The base URL of the npm package registry. | | npmTokenSecret | java.lang.String | GitHub secret which contains the NPM token to use when publishing packages. | | packageManager | io.github.cdklabs.projen.javascript.NodePackageManager | The Node Package Manager used to execute scripts. | | packageName | java.lang.String | The "name" in package.json. | | peerDependencyOptions | io.github.cdklabs.projen.javascript.PeerDependencyOptions | Options for `peerDeps`. | | peerDeps | java.util.List | Peer dependencies for this module. | | pnpmVersion | java.lang.String | The version of PNPM to use if using PNPM as a package manager. | | repository | java.lang.String | The repository is the location where the actual code for your package lives. | | repositoryDirectory | java.lang.String | 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. | | scopedPackagesOptions | java.util.List | Options for privately hosted scoped packages. | | scripts | java.util.Map | npm scripts to include. | | stability | java.lang.String | Package's Stability. | | jsiiReleaseVersion | java.lang.String | Version requirement of `publib` which is used to publish modules to npm. | | majorVersion | java.lang.Number | Major version to release from the default branch. | | minMajorVersion | java.lang.Number | Minimal Major version to release. | | npmDistTag | java.lang.String | The npmDistTag to use when publishing from the default branch. | | postBuildSteps | java.util.List | Steps to execute after build as part of the release workflow. | | prerelease | java.lang.String | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). | | publishDryRun | java.lang.Boolean | Instead of actually publishing to package managers, just print the publishing command. | | publishTasks | java.lang.Boolean | Define publishing tasks that can be executed manually as well as workflows. | | releaseBranches | java.util.Map | Defines additional release branches. | | releaseEveryCommit | java.lang.Boolean | Automatically release new versions every commit to one of branches in `releaseBranches`. | | releaseFailureIssue | java.lang.Boolean | Create a github issue on every failed publishing task. | | releaseFailureIssueLabel | java.lang.String | The label to apply to issues indicating publish failures. | | releaseSchedule | java.lang.String | CRON schedule to trigger new releases. | | releaseTagPrefix | java.lang.String | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. | | releaseTrigger | io.github.cdklabs.projen.release.ReleaseTrigger | The release trigger to use. | | releaseWorkflowName | java.lang.String | The name of the default release workflow. | | releaseWorkflowSetupSteps | java.util.List | A set of workflow steps to execute in order to setup the workflow container. | | versionrcOptions | java.util.Map | Custom configuration used when creating changelog with standard-version package. | | workflowContainerImage | java.lang.String | Container image to use for GitHub workflows. | | workflowRunsOn | java.util.List | Github Runner selection labels. | | defaultReleaseBranch | java.lang.String | The name of the main release branch. | | artifactsDirectory | java.lang.String | A directory which will contain build artifacts. | | autoApproveUpgrades | java.lang.Boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). | | buildWorkflow | java.lang.Boolean | Define a GitHub workflow for building PRs. | | buildWorkflowTriggers | io.github.cdklabs.projen.github.workflows.Triggers | Build workflow triggers. | | bundlerOptions | io.github.cdklabs.projen.javascript.BundlerOptions | Options for `Bundler`. | | codeCov | java.lang.Boolean | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. | | codeCovTokenSecret | java.lang.String | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. | | copyrightOwner | java.lang.String | License copyright owner. | | copyrightPeriod | java.lang.String | The copyright years to put in the LICENSE file. | | dependabot | java.lang.Boolean | Use dependabot to handle dependency upgrades. | | dependabotOptions | io.github.cdklabs.projen.github.DependabotOptions | Options for dependabot. | | depsUpgrade | java.lang.Boolean | Use github workflows to handle dependency upgrades. | | depsUpgradeOptions | io.github.cdklabs.projen.javascript.UpgradeDependenciesOptions | Options for `UpgradeDependencies`. | | gitignore | java.util.List | Additional entries to .gitignore. | | jest | java.lang.Boolean | Setup jest unit tests. | | jestOptions | io.github.cdklabs.projen.javascript.JestOptions | Jest options. | | mutableBuild | java.lang.Boolean | Automatically update files modified during builds to pull-request branches. | | npmignore | java.util.List | Additional entries to .npmignore. | | npmignoreEnabled | java.lang.Boolean | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. | | npmIgnoreOptions | io.github.cdklabs.projen.IgnoreFileOptions | Configuration options for .npmignore file. | | package | java.lang.Boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). | | prettier | java.lang.Boolean | Setup prettier. | | prettierOptions | io.github.cdklabs.projen.javascript.PrettierOptions | Prettier options. | | projenDevDependency | java.lang.Boolean | Indicates of "projen" should be installed as a devDependency. | | projenrcJs | java.lang.Boolean | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. | | projenrcJsOptions | io.github.cdklabs.projen.javascript.ProjenrcOptions | Options for .projenrc.js. | | projenVersion | java.lang.String | Version of projen to install. | | pullRequestTemplate | java.lang.Boolean | Include a GitHub pull request template. | | pullRequestTemplateContents | java.util.List | The contents of the pull request template. | | release | java.lang.Boolean | Add release management to this project. | | releaseToNpm | java.lang.Boolean | Automatically release to npm when new versions are introduced. | | releaseWorkflow | java.lang.Boolean | DEPRECATED: renamed to `release`. | | workflowBootstrapSteps | java.util.List | Workflow steps to use in order to bootstrap this repo. | | workflowGitIdentity | io.github.cdklabs.projen.github.GitIdentity | The git identity to use in workflows. | | workflowNodeVersion | java.lang.String | The node version to use in GitHub workflows. | | workflowPackageCache | java.lang.Boolean | Enable Node.js package cache in GitHub workflows. | | disableTsconfig | java.lang.Boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). | | disableTsconfigDev | java.lang.Boolean | Do not generate a `tsconfig.dev.json` file. | | docgen | java.lang.Boolean | Docgen by Typedoc. | | docsDirectory | java.lang.String | Docs directory. | | entrypointTypes | java.lang.String | The .d.ts file that includes the type declarations for this module. | | eslint | java.lang.Boolean | Setup eslint. | | eslintOptions | io.github.cdklabs.projen.javascript.EslintOptions | Eslint options. | | libdir | java.lang.String | Typescript artifacts output directory. | | projenrcTs | java.lang.Boolean | Use TypeScript for your projenrc file (`.projenrc.ts`). | | projenrcTsOptions | io.github.cdklabs.projen.typescript.ProjenrcOptions | Options for .projenrc.ts. | | sampleCode | java.lang.Boolean | Generate one-time sample in `src/` and `test/` if there are no files there. | | srcdir | java.lang.String | Typescript sources directory. | | testdir | java.lang.String | Jest tests directory. Tests files should be named `xxx.test.ts`. | | tsconfig | io.github.cdklabs.projen.javascript.TypescriptConfigOptions | Custom TSConfig. | | tsconfigDev | io.github.cdklabs.projen.javascript.TypescriptConfigOptions | Custom tsconfig options for the development tsconfig.json file (used for testing). | | tsconfigDevFile | java.lang.String | The name of the development tsconfig.json file. | | typescriptVersion | java.lang.String | TypeScript version to use. | | openApiGeneratorCliConfig | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. | | mockDataOptions | MockResponseDataGenerationOptions | Options for the generated mock response data. | --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional ```java public java.lang.Boolean getCommitGenerated(); ``` - *Type:* java.lang.Boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional ```java public IgnoreFileOptions getGitIgnoreOptions(); ``` - *Type:* io.github.cdklabs.projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```java public GitOptions getGitOptions(); ``` - *Type:* io.github.cdklabs.projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```java public LoggerOptions getLogging(); ``` - *Type:* io.github.cdklabs.projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```java public java.lang.String getOutdir(); ``` - *Type:* java.lang.String - *Default:* "." The root directory of the project. Relative to this directory, all files are synthesized. If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects. --- ##### `parent`^Optional ```java public Project getParent(); ``` - *Type:* io.github.cdklabs.projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional ```java public java.lang.String getProjenCommand(); ``` - *Type:* java.lang.String - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrcJson`^Optional ```java public java.lang.Boolean getProjenrcJson(); ``` - *Type:* java.lang.Boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional ```java public ProjenrcJsonOptions getProjenrcJsonOptions(); ``` - *Type:* io.github.cdklabs.projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```java public java.lang.Boolean getRenovatebot(); ``` - *Type:* java.lang.Boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```java public RenovatebotOptions getRenovatebotOptions(); ``` - *Type:* io.github.cdklabs.projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional ```java public AutoApproveOptions getAutoApproveOptions(); ``` - *Type:* io.github.cdklabs.projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional ```java public java.lang.Boolean getAutoMerge(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `autoMergeOptions`^Optional ```java public AutoMergeOptions getAutoMergeOptions(); ``` - *Type:* io.github.cdklabs.projen.github.AutoMergeOptions - *Default:* see defaults in `AutoMergeOptions` Configure options for automatic merging on GitHub. Has no effect if `github.mergify` or `autoMerge` is set to false. --- ##### `clobber`^Optional ```java public java.lang.Boolean getClobber(); ``` - *Type:* java.lang.Boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional ```java public java.lang.Boolean getDevContainer(); ``` - *Type:* java.lang.Boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```java public java.lang.Boolean getGithub(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```java public GitHubOptions getGithubOptions(); ``` - *Type:* io.github.cdklabs.projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```java public java.lang.Boolean getGitpod(); ``` - *Type:* java.lang.Boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```java public java.lang.Boolean getMergify(); ``` - *Type:* java.lang.Boolean - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergifyOptions`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead ```java public MergifyOptions getMergifyOptions(); ``` - *Type:* io.github.cdklabs.projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```java public ProjectType getProjectType(); ``` - *Type:* io.github.cdklabs.projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional ```java public GithubCredentials getProjenCredentials(); ``` - *Type:* io.github.cdklabs.projen.github.GithubCredentials - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN Choose a method of providing GitHub API access for projen workflows. --- ##### ~~`projenTokenSecret`~~^Optional - *Deprecated:* use `projenCredentials` ```java public java.lang.String getProjenTokenSecret(); ``` - *Type:* java.lang.String - *Default:* "PROJEN_GITHUB_TOKEN" The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This token needs to have the `repo`, `workflows` and `packages` scope. --- ##### `readme`^Optional ```java public SampleReadmeProps getReadme(); ``` - *Type:* io.github.cdklabs.projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```java "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```java public java.lang.Boolean getStale(); ``` - *Type:* java.lang.Boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```java public StaleOptions getStaleOptions(); ``` - *Type:* io.github.cdklabs.projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional ```java public java.lang.Boolean getVscode(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `allowLibraryDependencies`^Optional ```java public java.lang.Boolean getAllowLibraryDependencies(); ``` - *Type:* java.lang.Boolean - *Default:* true Allow the project to include `peerDependencies` and `bundledDependencies`. This is normally only allowed for libraries. For apps, there's no meaning for specifying these. --- ##### `authorEmail`^Optional ```java public java.lang.String getAuthorEmail(); ``` - *Type:* java.lang.String Author's e-mail. --- ##### `authorName`^Optional ```java public java.lang.String getAuthorName(); ``` - *Type:* java.lang.String Author's name. --- ##### `authorOrganization`^Optional ```java public java.lang.Boolean getAuthorOrganization(); ``` - *Type:* java.lang.Boolean Is the author an organization. --- ##### `authorUrl`^Optional ```java public java.lang.String getAuthorUrl(); ``` - *Type:* java.lang.String Author's URL / Website. --- ##### `autoDetectBin`^Optional ```java public java.lang.Boolean getAutoDetectBin(); ``` - *Type:* java.lang.Boolean - *Default:* true Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. --- ##### `bin`^Optional ```java public java.util.Map getBin(); ``` - *Type:* java.util.Map Binary programs vended with your module. You can use this option to add/customize how binaries are represented in your `package.json`, but unless `autoDetectBin` is `false`, every executable file under `bin` will automatically be added to this section. --- ##### `bugsEmail`^Optional ```java public java.lang.String getBugsEmail(); ``` - *Type:* java.lang.String The email address to which issues should be reported. --- ##### `bugsUrl`^Optional ```java public java.lang.String getBugsUrl(); ``` - *Type:* java.lang.String The url to your project's issue tracker. --- ##### `bundledDeps`^Optional ```java public java.util.List getBundledDeps(); ``` - *Type:* java.util.List List of dependencies to bundle into this module. These modules will be added both to the `dependencies` section and `bundledDependencies` section of your `package.json`. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `yarn add` or `npm install` in the sense that it will add the module as a dependency to your `package.json` file with the latest version (`^`). You can specify semver requirements in the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and this will be what you `package.json` will eventually include. --- ##### `codeArtifactOptions`^Optional ```java public CodeArtifactOptions getCodeArtifactOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.CodeArtifactOptions - *Default:* undefined Options for npm packages using AWS CodeArtifact. This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact --- ##### `deps`^Optional ```java public java.util.List getDeps(); ``` - *Type:* java.util.List - *Default:* [] Runtime dependencies of this module. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `yarn add` or `npm install` in the sense that it will add the module as a dependency to your `package.json` file with the latest version (`^`). You can specify semver requirements in the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and this will be what you `package.json` will eventually include. --- *Example* ```java [ 'express', 'lodash', 'foo@^2' ] ``` ##### `description`^Optional ```java public java.lang.String getDescription(); ``` - *Type:* java.lang.String The description is just a string that helps people understand the purpose of the package. It can be used when searching for packages in a package manager as well. See https://classic.yarnpkg.com/en/docs/package-json/#toc-description --- ##### `devDeps`^Optional ```java public java.util.List getDevDeps(); ``` - *Type:* java.util.List - *Default:* [] Build dependencies for this module. These dependencies will only be available in your build environment but will not be fetched when this module is consumed. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `yarn add` or `npm install` in the sense that it will add the module as a dependency to your `package.json` file with the latest version (`^`). You can specify semver requirements in the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and this will be what you `package.json` will eventually include. --- *Example* ```java [ 'typescript', '@types/express' ] ``` ##### `entrypoint`^Optional ```java public java.lang.String getEntrypoint(); ``` - *Type:* java.lang.String - *Default:* "lib/index.js" Module entrypoint (`main` in `package.json`). Set to an empty string to not include `main` in your package.json --- ##### `homepage`^Optional ```java public java.lang.String getHomepage(); ``` - *Type:* java.lang.String Package's Homepage / Website. --- ##### `keywords`^Optional ```java public java.util.List getKeywords(); ``` - *Type:* java.util.List Keywords to include in `package.json`. --- ##### `license`^Optional ```java public java.lang.String getLicense(); ``` - *Type:* java.lang.String - *Default:* "Apache-2.0" License's SPDX identifier. See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses. Use the `licensed` option if you want to no license to be specified. --- ##### `licensed`^Optional ```java public java.lang.Boolean getLicensed(); ``` - *Type:* java.lang.Boolean - *Default:* true Indicates if a license should be added. --- ##### `maxNodeVersion`^Optional ```java public java.lang.String getMaxNodeVersion(); ``` - *Type:* java.lang.String - *Default:* no max Minimum node.js version to require via `engines` (inclusive). --- ##### `minNodeVersion`^Optional ```java public java.lang.String getMinNodeVersion(); ``` - *Type:* java.lang.String - *Default:* no "engines" specified Minimum Node.js version to require via package.json `engines` (inclusive). --- ##### `npmAccess`^Optional ```java public NpmAccess getNpmAccess(); ``` - *Type:* io.github.cdklabs.projen.javascript.NpmAccess - *Default:* for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`. Access level of the npm package. --- ##### ~~`npmRegistry`~~^Optional - *Deprecated:* use `npmRegistryUrl` instead ```java public java.lang.String getNpmRegistry(); ``` - *Type:* java.lang.String The host name of the npm registry to publish to. Cannot be set together with `npmRegistryUrl`. --- ##### `npmRegistryUrl`^Optional ```java public java.lang.String getNpmRegistryUrl(); ``` - *Type:* java.lang.String - *Default:* "https://registry.npmjs.org" The base URL of the npm package registry. Must be a URL (e.g. start with "https://" or "http://") --- ##### `npmTokenSecret`^Optional ```java public java.lang.String getNpmTokenSecret(); ``` - *Type:* java.lang.String - *Default:* "NPM_TOKEN" GitHub secret which contains the NPM token to use when publishing packages. --- ##### `packageManager`^Optional ```java public NodePackageManager getPackageManager(); ``` - *Type:* io.github.cdklabs.projen.javascript.NodePackageManager - *Default:* NodePackageManager.YARN The Node Package Manager used to execute scripts. --- ##### `packageName`^Optional ```java public java.lang.String getPackageName(); ``` - *Type:* java.lang.String - *Default:* defaults to project name The "name" in package.json. --- ##### `peerDependencyOptions`^Optional ```java public PeerDependencyOptions getPeerDependencyOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.PeerDependencyOptions Options for `peerDeps`. --- ##### `peerDeps`^Optional ```java public java.util.List getPeerDeps(); ``` - *Type:* java.util.List - *Default:* [] Peer dependencies for this module. Dependencies listed here are required to be installed (and satisfied) by the _consumer_ of this library. Using peer dependencies allows you to ensure that only a single module of a certain library exists in the `node_modules` tree of your consumers. Note that prior to npm@7, peer dependencies are _not_ automatically installed, which means that adding peer dependencies to a library will be a breaking change for your customers. Unless `peerDependencyOptions.pinnedDevDependency` is disabled (it is enabled by default), projen will automatically add a dev dependency with a pinned version for each peer dependency. This will ensure that you build & test your module against the lowest peer version required. --- ##### `pnpmVersion`^Optional ```java public java.lang.String getPnpmVersion(); ``` - *Type:* java.lang.String - *Default:* "7" The version of PNPM to use if using PNPM as a package manager. --- ##### `repository`^Optional ```java public java.lang.String getRepository(); ``` - *Type:* java.lang.String The repository is the location where the actual code for your package lives. See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository --- ##### `repositoryDirectory`^Optional ```java public java.lang.String getRepositoryDirectory(); ``` - *Type:* java.lang.String 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. --- ##### `scopedPackagesOptions`^Optional ```java public java.util.List getScopedPackagesOptions(); ``` - *Type:* java.util.List - *Default:* fetch all scoped packages from the public npm registry Options for privately hosted scoped packages. --- ##### ~~`scripts`~~^Optional - *Deprecated:* use `project.addTask()` or `package.setScript()` ```java public java.util.Map getScripts(); ``` - *Type:* java.util.Map - *Default:* {} npm scripts to include. If a script has the same name as a standard script, the standard script will be overwritten. Also adds the script as a task. --- ##### `stability`^Optional ```java public java.lang.String getStability(); ``` - *Type:* java.lang.String Package's Stability. --- ##### `jsiiReleaseVersion`^Optional ```java public java.lang.String getJsiiReleaseVersion(); ``` - *Type:* java.lang.String - *Default:* "latest" Version requirement of `publib` which is used to publish modules to npm. --- ##### `majorVersion`^Optional ```java public java.lang.Number getMajorVersion(); ``` - *Type:* java.lang.Number - *Default:* Major version is not enforced. Major version to release from the default branch. If this is specified, we bump the latest version of this major version line. If not specified, we bump the global latest version. --- ##### `minMajorVersion`^Optional ```java public java.lang.Number getMinMajorVersion(); ``` - *Type:* java.lang.Number - *Default:* No minimum version is being enforced Minimal Major version to release. This can be useful to set to 1, as breaking changes before the 1.x major release are not incrementing the major version number. Can not be set together with `majorVersion`. --- ##### `npmDistTag`^Optional ```java public java.lang.String getNpmDistTag(); ``` - *Type:* java.lang.String - *Default:* "latest" The npmDistTag to use when publishing from the default branch. To set the npm dist-tag for release branches, set the `npmDistTag` property for each branch. --- ##### `postBuildSteps`^Optional ```java public java.util.List getPostBuildSteps(); ``` - *Type:* java.util.List - *Default:* [] Steps to execute after build as part of the release workflow. --- ##### `prerelease`^Optional ```java public java.lang.String getPrerelease(); ``` - *Type:* java.lang.String - *Default:* normal semantic versions Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). --- ##### `publishDryRun`^Optional ```java public java.lang.Boolean getPublishDryRun(); ``` - *Type:* java.lang.Boolean - *Default:* false Instead of actually publishing to package managers, just print the publishing command. --- ##### `publishTasks`^Optional ```java public java.lang.Boolean getPublishTasks(); ``` - *Type:* java.lang.Boolean - *Default:* false Define publishing tasks that can be executed manually as well as workflows. Normally, publishing only happens within automated workflows. Enable this in order to create a publishing task for each publishing activity. --- ##### `releaseBranches`^Optional ```java public java.util.Map getReleaseBranches(); ``` - *Type:* java.util.Map - *Default:* no additional branches are used for release. you can use `addBranch()` to add additional branches. Defines additional release branches. A workflow will be created for each release branch which will publish releases from commits in this branch. Each release branch _must_ be assigned a major version number which is used to enforce that versions published from that branch always use that major version. If multiple branches are used, the `majorVersion` field must also be provided for the default branch. --- ##### ~~`releaseEveryCommit`~~^Optional - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead ```java public java.lang.Boolean getReleaseEveryCommit(); ``` - *Type:* java.lang.Boolean - *Default:* true Automatically release new versions every commit to one of branches in `releaseBranches`. --- ##### `releaseFailureIssue`^Optional ```java public java.lang.Boolean getReleaseFailureIssue(); ``` - *Type:* java.lang.Boolean - *Default:* false Create a github issue on every failed publishing task. --- ##### `releaseFailureIssueLabel`^Optional ```java public java.lang.String getReleaseFailureIssueLabel(); ``` - *Type:* java.lang.String - *Default:* "failed-release" The label to apply to issues indicating publish failures. Only applies if `releaseFailureIssue` is true. --- ##### ~~`releaseSchedule`~~^Optional - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead ```java public java.lang.String getReleaseSchedule(); ``` - *Type:* java.lang.String - *Default:* no scheduled releases CRON schedule to trigger new releases. --- ##### `releaseTagPrefix`^Optional ```java public java.lang.String getReleaseTagPrefix(); ``` - *Type:* java.lang.String - *Default:* "v" Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. Note: this prefix is used to detect the latest tagged version when bumping, so if you change this on a project with an existing version history, you may need to manually tag your latest release with the new prefix. --- ##### `releaseTrigger`^Optional ```java public ReleaseTrigger getReleaseTrigger(); ``` - *Type:* io.github.cdklabs.projen.release.ReleaseTrigger - *Default:* Continuous releases (`ReleaseTrigger.continuous()`) The release trigger to use. --- ##### `releaseWorkflowName`^Optional ```java public java.lang.String getReleaseWorkflowName(); ``` - *Type:* java.lang.String - *Default:* "Release" The name of the default release workflow. --- ##### `releaseWorkflowSetupSteps`^Optional ```java public java.util.List getReleaseWorkflowSetupSteps(); ``` - *Type:* java.util.List A set of workflow steps to execute in order to setup the workflow container. --- ##### `versionrcOptions`^Optional ```java public java.util.Map getVersionrcOptions(); ``` - *Type:* java.util.Map - *Default:* standard configuration applicable for GitHub repositories Custom configuration used when creating changelog with standard-version package. Given values either append to default configuration or overwrite values in it. --- ##### `workflowContainerImage`^Optional ```java public java.lang.String getWorkflowContainerImage(); ``` - *Type:* java.lang.String - *Default:* default image Container image to use for GitHub workflows. --- ##### `workflowRunsOn`^Optional ```java public java.util.List getWorkflowRunsOn(); ``` - *Type:* java.util.List - *Default:* ["ubuntu-latest"] Github Runner selection labels. --- ##### `defaultReleaseBranch`^Required ```java public java.lang.String getDefaultReleaseBranch(); ``` - *Type:* java.lang.String - *Default:* "main" The name of the main release branch. --- ##### `artifactsDirectory`^Optional ```java public java.lang.String getArtifactsDirectory(); ``` - *Type:* java.lang.String - *Default:* "dist" A directory which will contain build artifacts. --- ##### `autoApproveUpgrades`^Optional ```java public java.lang.Boolean getAutoApproveUpgrades(); ``` - *Type:* java.lang.Boolean - *Default:* true Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). Throw if set to true but `autoApproveOptions` are not defined. --- ##### `buildWorkflow`^Optional ```java public java.lang.Boolean getBuildWorkflow(); ``` - *Type:* java.lang.Boolean - *Default:* true if not a subproject Define a GitHub workflow for building PRs. --- ##### `buildWorkflowTriggers`^Optional ```java public Triggers getBuildWorkflowTriggers(); ``` - *Type:* io.github.cdklabs.projen.github.workflows.Triggers - *Default:* "{ pullRequest: {}, workflowDispatch: {} }" Build workflow triggers. --- ##### `bundlerOptions`^Optional ```java public BundlerOptions getBundlerOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.BundlerOptions Options for `Bundler`. --- ##### `codeCov`^Optional ```java public java.lang.Boolean getCodeCov(); ``` - *Type:* java.lang.Boolean - *Default:* false Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. --- ##### `codeCovTokenSecret`^Optional ```java public java.lang.String getCodeCovTokenSecret(); ``` - *Type:* java.lang.String - *Default:* if this option is not specified, only public repositories are supported Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. --- ##### `copyrightOwner`^Optional ```java public java.lang.String getCopyrightOwner(); ``` - *Type:* java.lang.String - *Default:* defaults to the value of authorName or "" if `authorName` is undefined. License copyright owner. --- ##### `copyrightPeriod`^Optional ```java public java.lang.String getCopyrightPeriod(); ``` - *Type:* java.lang.String - *Default:* current year The copyright years to put in the LICENSE file. --- ##### `dependabot`^Optional ```java public java.lang.Boolean getDependabot(); ``` - *Type:* java.lang.Boolean - *Default:* false Use dependabot to handle dependency upgrades. Cannot be used in conjunction with `depsUpgrade`. --- ##### `dependabotOptions`^Optional ```java public DependabotOptions getDependabotOptions(); ``` - *Type:* io.github.cdklabs.projen.github.DependabotOptions - *Default:* default options Options for dependabot. --- ##### `depsUpgrade`^Optional ```java public java.lang.Boolean getDepsUpgrade(); ``` - *Type:* java.lang.Boolean - *Default:* true Use github workflows to handle dependency upgrades. Cannot be used in conjunction with `dependabot`. --- ##### `depsUpgradeOptions`^Optional ```java public UpgradeDependenciesOptions getDepsUpgradeOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.UpgradeDependenciesOptions - *Default:* default options Options for `UpgradeDependencies`. --- ##### `gitignore`^Optional ```java public java.util.List getGitignore(); ``` - *Type:* java.util.List Additional entries to .gitignore. --- ##### `jest`^Optional ```java public java.lang.Boolean getJest(); ``` - *Type:* java.lang.Boolean - *Default:* true Setup jest unit tests. --- ##### `jestOptions`^Optional ```java public JestOptions getJestOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.JestOptions - *Default:* default options Jest options. --- ##### `mutableBuild`^Optional ```java public java.lang.Boolean getMutableBuild(); ``` - *Type:* java.lang.Boolean - *Default:* true Automatically update files modified during builds to pull-request branches. This means that any files synthesized by projen or e.g. test snapshots will always be up-to-date before a PR is merged. Implies that PR builds do not have anti-tamper checks. --- ##### ~~`npmignore`~~^Optional - *Deprecated:* - use `project.addPackageIgnore` ```java public java.util.List getNpmignore(); ``` - *Type:* java.util.List Additional entries to .npmignore. --- ##### `npmignoreEnabled`^Optional ```java public java.lang.Boolean getNpmignoreEnabled(); ``` - *Type:* java.lang.Boolean - *Default:* true Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. --- ##### `npmIgnoreOptions`^Optional ```java public IgnoreFileOptions getNpmIgnoreOptions(); ``` - *Type:* io.github.cdklabs.projen.IgnoreFileOptions Configuration options for .npmignore file. --- ##### `package`^Optional ```java public java.lang.Boolean getPackage(); ``` - *Type:* java.lang.Boolean - *Default:* true Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). --- ##### `prettier`^Optional ```java public java.lang.Boolean getPrettier(); ``` - *Type:* java.lang.Boolean - *Default:* false Setup prettier. --- ##### `prettierOptions`^Optional ```java public PrettierOptions getPrettierOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.PrettierOptions - *Default:* default options Prettier options. --- ##### `projenDevDependency`^Optional ```java public java.lang.Boolean getProjenDevDependency(); ``` - *Type:* java.lang.Boolean - *Default:* true Indicates of "projen" should be installed as a devDependency. --- ##### `projenrcJs`^Optional ```java public java.lang.Boolean getProjenrcJs(); ``` - *Type:* java.lang.Boolean - *Default:* true if projenrcJson is false Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. --- ##### `projenrcJsOptions`^Optional ```java public ProjenrcOptions getProjenrcJsOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.ProjenrcOptions - *Default:* default options Options for .projenrc.js. --- ##### `projenVersion`^Optional ```java public java.lang.String getProjenVersion(); ``` - *Type:* java.lang.String - *Default:* Defaults to the latest version. Version of projen to install. --- ##### `pullRequestTemplate`^Optional ```java public java.lang.Boolean getPullRequestTemplate(); ``` - *Type:* java.lang.Boolean - *Default:* true Include a GitHub pull request template. --- ##### `pullRequestTemplateContents`^Optional ```java public java.util.List getPullRequestTemplateContents(); ``` - *Type:* java.util.List - *Default:* default content The contents of the pull request template. --- ##### `release`^Optional ```java public java.lang.Boolean getRelease(); ``` - *Type:* java.lang.Boolean - *Default:* true (false for subprojects) Add release management to this project. --- ##### `releaseToNpm`^Optional ```java public java.lang.Boolean getReleaseToNpm(); ``` - *Type:* java.lang.Boolean - *Default:* false Automatically release to npm when new versions are introduced. --- ##### ~~`releaseWorkflow`~~^Optional - *Deprecated:* see `release`. ```java public java.lang.Boolean getReleaseWorkflow(); ``` - *Type:* java.lang.Boolean - *Default:* true if not a subproject DEPRECATED: renamed to `release`. --- ##### `workflowBootstrapSteps`^Optional ```java public java.util.List getWorkflowBootstrapSteps(); ``` - *Type:* java.util.List - *Default:* "yarn install --frozen-lockfile && yarn projen" Workflow steps to use in order to bootstrap this repo. --- ##### `workflowGitIdentity`^Optional ```java public GitIdentity getWorkflowGitIdentity(); ``` - *Type:* io.github.cdklabs.projen.github.GitIdentity - *Default:* GitHub Actions The git identity to use in workflows. --- ##### `workflowNodeVersion`^Optional ```java public java.lang.String getWorkflowNodeVersion(); ``` - *Type:* java.lang.String - *Default:* same as `minNodeVersion` The node version to use in GitHub workflows. --- ##### `workflowPackageCache`^Optional ```java public java.lang.Boolean getWorkflowPackageCache(); ``` - *Type:* java.lang.Boolean - *Default:* false Enable Node.js package cache in GitHub workflows. --- ##### `disableTsconfig`^Optional ```java public java.lang.Boolean getDisableTsconfig(); ``` - *Type:* java.lang.Boolean - *Default:* false Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). --- ##### `disableTsconfigDev`^Optional ```java public java.lang.Boolean getDisableTsconfigDev(); ``` - *Type:* java.lang.Boolean - *Default:* false Do not generate a `tsconfig.dev.json` file. --- ##### `docgen`^Optional ```java public java.lang.Boolean getDocgen(); ``` - *Type:* java.lang.Boolean - *Default:* false Docgen by Typedoc. --- ##### `docsDirectory`^Optional ```java public java.lang.String getDocsDirectory(); ``` - *Type:* java.lang.String - *Default:* "docs" Docs directory. --- ##### `entrypointTypes`^Optional ```java public java.lang.String getEntrypointTypes(); ``` - *Type:* java.lang.String - *Default:* .d.ts file derived from the project's entrypoint (usually lib/index.d.ts) The .d.ts file that includes the type declarations for this module. --- ##### `eslint`^Optional ```java public java.lang.Boolean getEslint(); ``` - *Type:* java.lang.Boolean - *Default:* true Setup eslint. --- ##### `eslintOptions`^Optional ```java public EslintOptions getEslintOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.EslintOptions - *Default:* opinionated default options Eslint options. --- ##### `libdir`^Optional ```java public java.lang.String getLibdir(); ``` - *Type:* java.lang.String - *Default:* "lib" Typescript artifacts output directory. --- ##### `projenrcTs`^Optional ```java public java.lang.Boolean getProjenrcTs(); ``` - *Type:* java.lang.Boolean - *Default:* false Use TypeScript for your projenrc file (`.projenrc.ts`). --- ##### `projenrcTsOptions`^Optional ```java public ProjenrcOptions getProjenrcTsOptions(); ``` - *Type:* io.github.cdklabs.projen.typescript.ProjenrcOptions Options for .projenrc.ts. --- ##### `sampleCode`^Optional ```java public java.lang.Boolean getSampleCode(); ``` - *Type:* java.lang.Boolean - *Default:* true Generate one-time sample in `src/` and `test/` if there are no files there. --- ##### `srcdir`^Optional ```java public java.lang.String getSrcdir(); ``` - *Type:* java.lang.String - *Default:* "src" Typescript sources directory. --- ##### `testdir`^Optional ```java public java.lang.String getTestdir(); ``` - *Type:* java.lang.String - *Default:* "test" Jest tests directory. Tests files should be named `xxx.test.ts`. If this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`), then tests are going to be compiled into `lib/` and executed as javascript. If the test directory is outside of `src`, then we configure jest to compile the code in-memory. --- ##### `tsconfig`^Optional ```java public TypescriptConfigOptions getTsconfig(); ``` - *Type:* io.github.cdklabs.projen.javascript.TypescriptConfigOptions - *Default:* default options Custom TSConfig. --- ##### `tsconfigDev`^Optional ```java public TypescriptConfigOptions getTsconfigDev(); ``` - *Type:* io.github.cdklabs.projen.javascript.TypescriptConfigOptions - *Default:* use the production tsconfig options Custom tsconfig options for the development tsconfig.json file (used for testing). --- ##### `tsconfigDevFile`^Optional ```java public java.lang.String getTsconfigDevFile(); ``` - *Type:* java.lang.String - *Default:* "tsconfig.dev.json" The name of the development tsconfig.json file. --- ##### `typescriptVersion`^Optional ```java public java.lang.String getTypescriptVersion(); ``` - *Type:* java.lang.String - *Default:* "latest" TypeScript version to use. NOTE: Typescript is not semantically versioned and should remain on the same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`). --- ##### `openApiGeneratorCliConfig`^Optional ```java public OpenApiGeneratorCliConfig getOpenApiGeneratorCliConfig(); ``` - *Type:* OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. Overrides default values if specified. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) --- ##### `mockDataOptions`^Optional ```java public MockResponseDataGenerationOptions getMockDataOptions(); ``` - *Type:* MockResponseDataGenerationOptions Options for the generated mock response data. --- ### GeneratedTypeScriptReactQueryHooksOptions Options for configuring a generated typescript hooks library project. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.GeneratedTypeScriptReactQueryHooksOptions; GeneratedTypeScriptReactQueryHooksOptions.builder() .name(java.lang.String) // .commitGenerated(java.lang.Boolean) // .gitIgnoreOptions(IgnoreFileOptions) // .gitOptions(GitOptions) // .logging(LoggerOptions) // .outdir(java.lang.String) // .parent(Project) // .projenCommand(java.lang.String) // .projenrcJson(java.lang.Boolean) // .projenrcJsonOptions(ProjenrcJsonOptions) // .renovatebot(java.lang.Boolean) // .renovatebotOptions(RenovatebotOptions) // .autoApproveOptions(AutoApproveOptions) // .autoMerge(java.lang.Boolean) // .autoMergeOptions(AutoMergeOptions) // .clobber(java.lang.Boolean) // .devContainer(java.lang.Boolean) // .github(java.lang.Boolean) // .githubOptions(GitHubOptions) // .gitpod(java.lang.Boolean) // .mergify(java.lang.Boolean) // .mergifyOptions(MergifyOptions) // .projectType(ProjectType) // .projenCredentials(GithubCredentials) // .projenTokenSecret(java.lang.String) // .readme(SampleReadmeProps) // .stale(java.lang.Boolean) // .staleOptions(StaleOptions) // .vscode(java.lang.Boolean) // .allowLibraryDependencies(java.lang.Boolean) // .authorEmail(java.lang.String) // .authorName(java.lang.String) // .authorOrganization(java.lang.Boolean) // .authorUrl(java.lang.String) // .autoDetectBin(java.lang.Boolean) // .bin(java.util.Map) // .bugsEmail(java.lang.String) // .bugsUrl(java.lang.String) // .bundledDeps(java.util.List) // .codeArtifactOptions(CodeArtifactOptions) // .deps(java.util.List) // .description(java.lang.String) // .devDeps(java.util.List) // .entrypoint(java.lang.String) // .homepage(java.lang.String) // .keywords(java.util.List) // .license(java.lang.String) // .licensed(java.lang.Boolean) // .maxNodeVersion(java.lang.String) // .minNodeVersion(java.lang.String) // .npmAccess(NpmAccess) // .npmRegistry(java.lang.String) // .npmRegistryUrl(java.lang.String) // .npmTokenSecret(java.lang.String) // .packageManager(NodePackageManager) // .packageName(java.lang.String) // .peerDependencyOptions(PeerDependencyOptions) // .peerDeps(java.util.List) // .pnpmVersion(java.lang.String) // .repository(java.lang.String) // .repositoryDirectory(java.lang.String) // .scopedPackagesOptions(java.util.List) // .scripts(java.util.Map) // .stability(java.lang.String) // .jsiiReleaseVersion(java.lang.String) // .majorVersion(java.lang.Number) // .minMajorVersion(java.lang.Number) // .npmDistTag(java.lang.String) // .postBuildSteps(java.util.List) // .prerelease(java.lang.String) // .publishDryRun(java.lang.Boolean) // .publishTasks(java.lang.Boolean) // .releaseBranches(java.util.Map) // .releaseEveryCommit(java.lang.Boolean) // .releaseFailureIssue(java.lang.Boolean) // .releaseFailureIssueLabel(java.lang.String) // .releaseSchedule(java.lang.String) // .releaseTagPrefix(java.lang.String) // .releaseTrigger(ReleaseTrigger) // .releaseWorkflowName(java.lang.String) // .releaseWorkflowSetupSteps(java.util.List) // .versionrcOptions(java.util.Map) // .workflowContainerImage(java.lang.String) // .workflowRunsOn(java.util.List) .defaultReleaseBranch(java.lang.String) // .artifactsDirectory(java.lang.String) // .autoApproveUpgrades(java.lang.Boolean) // .buildWorkflow(java.lang.Boolean) // .buildWorkflowTriggers(Triggers) // .bundlerOptions(BundlerOptions) // .codeCov(java.lang.Boolean) // .codeCovTokenSecret(java.lang.String) // .copyrightOwner(java.lang.String) // .copyrightPeriod(java.lang.String) // .dependabot(java.lang.Boolean) // .dependabotOptions(DependabotOptions) // .depsUpgrade(java.lang.Boolean) // .depsUpgradeOptions(UpgradeDependenciesOptions) // .gitignore(java.util.List) // .jest(java.lang.Boolean) // .jestOptions(JestOptions) // .mutableBuild(java.lang.Boolean) // .npmignore(java.util.List) // .npmignoreEnabled(java.lang.Boolean) // .npmIgnoreOptions(IgnoreFileOptions) // .package(java.lang.Boolean) // .prettier(java.lang.Boolean) // .prettierOptions(PrettierOptions) // .projenDevDependency(java.lang.Boolean) // .projenrcJs(java.lang.Boolean) // .projenrcJsOptions(ProjenrcOptions) // .projenVersion(java.lang.String) // .pullRequestTemplate(java.lang.Boolean) // .pullRequestTemplateContents(java.util.List) // .release(java.lang.Boolean) // .releaseToNpm(java.lang.Boolean) // .releaseWorkflow(java.lang.Boolean) // .workflowBootstrapSteps(java.util.List) // .workflowGitIdentity(GitIdentity) // .workflowNodeVersion(java.lang.String) // .workflowPackageCache(java.lang.Boolean) // .disableTsconfig(java.lang.Boolean) // .disableTsconfigDev(java.lang.Boolean) // .docgen(java.lang.Boolean) // .docsDirectory(java.lang.String) // .entrypointTypes(java.lang.String) // .eslint(java.lang.Boolean) // .eslintOptions(EslintOptions) // .libdir(java.lang.String) // .projenrcTs(java.lang.Boolean) // .projenrcTsOptions(ProjenrcOptions) // .sampleCode(java.lang.Boolean) // .srcdir(java.lang.String) // .testdir(java.lang.String) // .tsconfig(TypescriptConfigOptions) // .tsconfigDev(TypescriptConfigOptions) // .tsconfigDevFile(java.lang.String) // .typescriptVersion(java.lang.String) // .openApiGeneratorCliConfig(OpenApiGeneratorCliConfig) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | java.lang.String | This is the name of your project. | | commitGenerated | java.lang.Boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | io.github.cdklabs.projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | io.github.cdklabs.projen.GitOptions | Configuration options for git. | | logging | io.github.cdklabs.projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | java.lang.String | The root directory of the project. | | parent | io.github.cdklabs.projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | java.lang.String | The shell command to use in order to run the projen CLI. | | projenrcJson | java.lang.Boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | io.github.cdklabs.projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | java.lang.Boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | io.github.cdklabs.projen.RenovatebotOptions | Options for renovatebot. | | autoApproveOptions | io.github.cdklabs.projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoMerge | java.lang.Boolean | Enable automatic merging on GitHub. | | autoMergeOptions | io.github.cdklabs.projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | java.lang.Boolean | Add a `clobber` task which resets the repo to origin. | | devContainer | java.lang.Boolean | Add a VSCode development environment (used for GitHub Codespaces). | | github | java.lang.Boolean | Enable GitHub integration. | | githubOptions | io.github.cdklabs.projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | java.lang.Boolean | Add a Gitpod development environment. | | mergify | java.lang.Boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | io.github.cdklabs.projen.github.MergifyOptions | Options for mergify. | | projectType | io.github.cdklabs.projen.ProjectType | Which type of project this is (library/app). | | projenCredentials | io.github.cdklabs.projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projenTokenSecret | java.lang.String | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | io.github.cdklabs.projen.SampleReadmeProps | The README setup. | | stale | java.lang.Boolean | Auto-close of stale issues and pull request. | | staleOptions | io.github.cdklabs.projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | java.lang.Boolean | Enable VSCode integration. | | allowLibraryDependencies | java.lang.Boolean | Allow the project to include `peerDependencies` and `bundledDependencies`. | | authorEmail | java.lang.String | Author's e-mail. | | authorName | java.lang.String | Author's name. | | authorOrganization | java.lang.Boolean | Is the author an organization. | | authorUrl | java.lang.String | Author's URL / Website. | | autoDetectBin | java.lang.Boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. | | bin | java.util.Map | Binary programs vended with your module. | | bugsEmail | java.lang.String | The email address to which issues should be reported. | | bugsUrl | java.lang.String | The url to your project's issue tracker. | | bundledDeps | java.util.List | List of dependencies to bundle into this module. | | codeArtifactOptions | io.github.cdklabs.projen.javascript.CodeArtifactOptions | Options for npm packages using AWS CodeArtifact. | | deps | java.util.List | Runtime dependencies of this module. | | description | java.lang.String | The description is just a string that helps people understand the purpose of the package. | | devDeps | java.util.List | Build dependencies for this module. | | entrypoint | java.lang.String | Module entrypoint (`main` in `package.json`). | | homepage | java.lang.String | Package's Homepage / Website. | | keywords | java.util.List | Keywords to include in `package.json`. | | license | java.lang.String | License's SPDX identifier. | | licensed | java.lang.Boolean | Indicates if a license should be added. | | maxNodeVersion | java.lang.String | Minimum node.js version to require via `engines` (inclusive). | | minNodeVersion | java.lang.String | Minimum Node.js version to require via package.json `engines` (inclusive). | | npmAccess | io.github.cdklabs.projen.javascript.NpmAccess | Access level of the npm package. | | npmRegistry | java.lang.String | The host name of the npm registry to publish to. | | npmRegistryUrl | java.lang.String | The base URL of the npm package registry. | | npmTokenSecret | java.lang.String | GitHub secret which contains the NPM token to use when publishing packages. | | packageManager | io.github.cdklabs.projen.javascript.NodePackageManager | The Node Package Manager used to execute scripts. | | packageName | java.lang.String | The "name" in package.json. | | peerDependencyOptions | io.github.cdklabs.projen.javascript.PeerDependencyOptions | Options for `peerDeps`. | | peerDeps | java.util.List | Peer dependencies for this module. | | pnpmVersion | java.lang.String | The version of PNPM to use if using PNPM as a package manager. | | repository | java.lang.String | The repository is the location where the actual code for your package lives. | | repositoryDirectory | java.lang.String | 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. | | scopedPackagesOptions | java.util.List | Options for privately hosted scoped packages. | | scripts | java.util.Map | npm scripts to include. | | stability | java.lang.String | Package's Stability. | | jsiiReleaseVersion | java.lang.String | Version requirement of `publib` which is used to publish modules to npm. | | majorVersion | java.lang.Number | Major version to release from the default branch. | | minMajorVersion | java.lang.Number | Minimal Major version to release. | | npmDistTag | java.lang.String | The npmDistTag to use when publishing from the default branch. | | postBuildSteps | java.util.List | Steps to execute after build as part of the release workflow. | | prerelease | java.lang.String | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). | | publishDryRun | java.lang.Boolean | Instead of actually publishing to package managers, just print the publishing command. | | publishTasks | java.lang.Boolean | Define publishing tasks that can be executed manually as well as workflows. | | releaseBranches | java.util.Map | Defines additional release branches. | | releaseEveryCommit | java.lang.Boolean | Automatically release new versions every commit to one of branches in `releaseBranches`. | | releaseFailureIssue | java.lang.Boolean | Create a github issue on every failed publishing task. | | releaseFailureIssueLabel | java.lang.String | The label to apply to issues indicating publish failures. | | releaseSchedule | java.lang.String | CRON schedule to trigger new releases. | | releaseTagPrefix | java.lang.String | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. | | releaseTrigger | io.github.cdklabs.projen.release.ReleaseTrigger | The release trigger to use. | | releaseWorkflowName | java.lang.String | The name of the default release workflow. | | releaseWorkflowSetupSteps | java.util.List | A set of workflow steps to execute in order to setup the workflow container. | | versionrcOptions | java.util.Map | Custom configuration used when creating changelog with standard-version package. | | workflowContainerImage | java.lang.String | Container image to use for GitHub workflows. | | workflowRunsOn | java.util.List | Github Runner selection labels. | | defaultReleaseBranch | java.lang.String | The name of the main release branch. | | artifactsDirectory | java.lang.String | A directory which will contain build artifacts. | | autoApproveUpgrades | java.lang.Boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). | | buildWorkflow | java.lang.Boolean | Define a GitHub workflow for building PRs. | | buildWorkflowTriggers | io.github.cdklabs.projen.github.workflows.Triggers | Build workflow triggers. | | bundlerOptions | io.github.cdklabs.projen.javascript.BundlerOptions | Options for `Bundler`. | | codeCov | java.lang.Boolean | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. | | codeCovTokenSecret | java.lang.String | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. | | copyrightOwner | java.lang.String | License copyright owner. | | copyrightPeriod | java.lang.String | The copyright years to put in the LICENSE file. | | dependabot | java.lang.Boolean | Use dependabot to handle dependency upgrades. | | dependabotOptions | io.github.cdklabs.projen.github.DependabotOptions | Options for dependabot. | | depsUpgrade | java.lang.Boolean | Use github workflows to handle dependency upgrades. | | depsUpgradeOptions | io.github.cdklabs.projen.javascript.UpgradeDependenciesOptions | Options for `UpgradeDependencies`. | | gitignore | java.util.List | Additional entries to .gitignore. | | jest | java.lang.Boolean | Setup jest unit tests. | | jestOptions | io.github.cdklabs.projen.javascript.JestOptions | Jest options. | | mutableBuild | java.lang.Boolean | Automatically update files modified during builds to pull-request branches. | | npmignore | java.util.List | Additional entries to .npmignore. | | npmignoreEnabled | java.lang.Boolean | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. | | npmIgnoreOptions | io.github.cdklabs.projen.IgnoreFileOptions | Configuration options for .npmignore file. | | package | java.lang.Boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). | | prettier | java.lang.Boolean | Setup prettier. | | prettierOptions | io.github.cdklabs.projen.javascript.PrettierOptions | Prettier options. | | projenDevDependency | java.lang.Boolean | Indicates of "projen" should be installed as a devDependency. | | projenrcJs | java.lang.Boolean | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. | | projenrcJsOptions | io.github.cdklabs.projen.javascript.ProjenrcOptions | Options for .projenrc.js. | | projenVersion | java.lang.String | Version of projen to install. | | pullRequestTemplate | java.lang.Boolean | Include a GitHub pull request template. | | pullRequestTemplateContents | java.util.List | The contents of the pull request template. | | release | java.lang.Boolean | Add release management to this project. | | releaseToNpm | java.lang.Boolean | Automatically release to npm when new versions are introduced. | | releaseWorkflow | java.lang.Boolean | DEPRECATED: renamed to `release`. | | workflowBootstrapSteps | java.util.List | Workflow steps to use in order to bootstrap this repo. | | workflowGitIdentity | io.github.cdklabs.projen.github.GitIdentity | The git identity to use in workflows. | | workflowNodeVersion | java.lang.String | The node version to use in GitHub workflows. | | workflowPackageCache | java.lang.Boolean | Enable Node.js package cache in GitHub workflows. | | disableTsconfig | java.lang.Boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). | | disableTsconfigDev | java.lang.Boolean | Do not generate a `tsconfig.dev.json` file. | | docgen | java.lang.Boolean | Docgen by Typedoc. | | docsDirectory | java.lang.String | Docs directory. | | entrypointTypes | java.lang.String | The .d.ts file that includes the type declarations for this module. | | eslint | java.lang.Boolean | Setup eslint. | | eslintOptions | io.github.cdklabs.projen.javascript.EslintOptions | Eslint options. | | libdir | java.lang.String | Typescript artifacts output directory. | | projenrcTs | java.lang.Boolean | Use TypeScript for your projenrc file (`.projenrc.ts`). | | projenrcTsOptions | io.github.cdklabs.projen.typescript.ProjenrcOptions | Options for .projenrc.ts. | | sampleCode | java.lang.Boolean | Generate one-time sample in `src/` and `test/` if there are no files there. | | srcdir | java.lang.String | Typescript sources directory. | | testdir | java.lang.String | Jest tests directory. Tests files should be named `xxx.test.ts`. | | tsconfig | io.github.cdklabs.projen.javascript.TypescriptConfigOptions | Custom TSConfig. | | tsconfigDev | io.github.cdklabs.projen.javascript.TypescriptConfigOptions | Custom tsconfig options for the development tsconfig.json file (used for testing). | | tsconfigDevFile | java.lang.String | The name of the development tsconfig.json file. | | typescriptVersion | java.lang.String | TypeScript version to use. | | openApiGeneratorCliConfig | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. | --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional ```java public java.lang.Boolean getCommitGenerated(); ``` - *Type:* java.lang.Boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional ```java public IgnoreFileOptions getGitIgnoreOptions(); ``` - *Type:* io.github.cdklabs.projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```java public GitOptions getGitOptions(); ``` - *Type:* io.github.cdklabs.projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```java public LoggerOptions getLogging(); ``` - *Type:* io.github.cdklabs.projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```java public java.lang.String getOutdir(); ``` - *Type:* java.lang.String - *Default:* "." The root directory of the project. Relative to this directory, all files are synthesized. If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects. --- ##### `parent`^Optional ```java public Project getParent(); ``` - *Type:* io.github.cdklabs.projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional ```java public java.lang.String getProjenCommand(); ``` - *Type:* java.lang.String - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrcJson`^Optional ```java public java.lang.Boolean getProjenrcJson(); ``` - *Type:* java.lang.Boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional ```java public ProjenrcJsonOptions getProjenrcJsonOptions(); ``` - *Type:* io.github.cdklabs.projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```java public java.lang.Boolean getRenovatebot(); ``` - *Type:* java.lang.Boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```java public RenovatebotOptions getRenovatebotOptions(); ``` - *Type:* io.github.cdklabs.projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional ```java public AutoApproveOptions getAutoApproveOptions(); ``` - *Type:* io.github.cdklabs.projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional ```java public java.lang.Boolean getAutoMerge(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `autoMergeOptions`^Optional ```java public AutoMergeOptions getAutoMergeOptions(); ``` - *Type:* io.github.cdklabs.projen.github.AutoMergeOptions - *Default:* see defaults in `AutoMergeOptions` Configure options for automatic merging on GitHub. Has no effect if `github.mergify` or `autoMerge` is set to false. --- ##### `clobber`^Optional ```java public java.lang.Boolean getClobber(); ``` - *Type:* java.lang.Boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional ```java public java.lang.Boolean getDevContainer(); ``` - *Type:* java.lang.Boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```java public java.lang.Boolean getGithub(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```java public GitHubOptions getGithubOptions(); ``` - *Type:* io.github.cdklabs.projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```java public java.lang.Boolean getGitpod(); ``` - *Type:* java.lang.Boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```java public java.lang.Boolean getMergify(); ``` - *Type:* java.lang.Boolean - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergifyOptions`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead ```java public MergifyOptions getMergifyOptions(); ``` - *Type:* io.github.cdklabs.projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```java public ProjectType getProjectType(); ``` - *Type:* io.github.cdklabs.projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional ```java public GithubCredentials getProjenCredentials(); ``` - *Type:* io.github.cdklabs.projen.github.GithubCredentials - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN Choose a method of providing GitHub API access for projen workflows. --- ##### ~~`projenTokenSecret`~~^Optional - *Deprecated:* use `projenCredentials` ```java public java.lang.String getProjenTokenSecret(); ``` - *Type:* java.lang.String - *Default:* "PROJEN_GITHUB_TOKEN" The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This token needs to have the `repo`, `workflows` and `packages` scope. --- ##### `readme`^Optional ```java public SampleReadmeProps getReadme(); ``` - *Type:* io.github.cdklabs.projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```java "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```java public java.lang.Boolean getStale(); ``` - *Type:* java.lang.Boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```java public StaleOptions getStaleOptions(); ``` - *Type:* io.github.cdklabs.projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional ```java public java.lang.Boolean getVscode(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `allowLibraryDependencies`^Optional ```java public java.lang.Boolean getAllowLibraryDependencies(); ``` - *Type:* java.lang.Boolean - *Default:* true Allow the project to include `peerDependencies` and `bundledDependencies`. This is normally only allowed for libraries. For apps, there's no meaning for specifying these. --- ##### `authorEmail`^Optional ```java public java.lang.String getAuthorEmail(); ``` - *Type:* java.lang.String Author's e-mail. --- ##### `authorName`^Optional ```java public java.lang.String getAuthorName(); ``` - *Type:* java.lang.String Author's name. --- ##### `authorOrganization`^Optional ```java public java.lang.Boolean getAuthorOrganization(); ``` - *Type:* java.lang.Boolean Is the author an organization. --- ##### `authorUrl`^Optional ```java public java.lang.String getAuthorUrl(); ``` - *Type:* java.lang.String Author's URL / Website. --- ##### `autoDetectBin`^Optional ```java public java.lang.Boolean getAutoDetectBin(); ``` - *Type:* java.lang.Boolean - *Default:* true Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. --- ##### `bin`^Optional ```java public java.util.Map getBin(); ``` - *Type:* java.util.Map Binary programs vended with your module. You can use this option to add/customize how binaries are represented in your `package.json`, but unless `autoDetectBin` is `false`, every executable file under `bin` will automatically be added to this section. --- ##### `bugsEmail`^Optional ```java public java.lang.String getBugsEmail(); ``` - *Type:* java.lang.String The email address to which issues should be reported. --- ##### `bugsUrl`^Optional ```java public java.lang.String getBugsUrl(); ``` - *Type:* java.lang.String The url to your project's issue tracker. --- ##### `bundledDeps`^Optional ```java public java.util.List getBundledDeps(); ``` - *Type:* java.util.List List of dependencies to bundle into this module. These modules will be added both to the `dependencies` section and `bundledDependencies` section of your `package.json`. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `yarn add` or `npm install` in the sense that it will add the module as a dependency to your `package.json` file with the latest version (`^`). You can specify semver requirements in the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and this will be what you `package.json` will eventually include. --- ##### `codeArtifactOptions`^Optional ```java public CodeArtifactOptions getCodeArtifactOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.CodeArtifactOptions - *Default:* undefined Options for npm packages using AWS CodeArtifact. This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact --- ##### `deps`^Optional ```java public java.util.List getDeps(); ``` - *Type:* java.util.List - *Default:* [] Runtime dependencies of this module. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `yarn add` or `npm install` in the sense that it will add the module as a dependency to your `package.json` file with the latest version (`^`). You can specify semver requirements in the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and this will be what you `package.json` will eventually include. --- *Example* ```java [ 'express', 'lodash', 'foo@^2' ] ``` ##### `description`^Optional ```java public java.lang.String getDescription(); ``` - *Type:* java.lang.String The description is just a string that helps people understand the purpose of the package. It can be used when searching for packages in a package manager as well. See https://classic.yarnpkg.com/en/docs/package-json/#toc-description --- ##### `devDeps`^Optional ```java public java.util.List getDevDeps(); ``` - *Type:* java.util.List - *Default:* [] Build dependencies for this module. These dependencies will only be available in your build environment but will not be fetched when this module is consumed. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `yarn add` or `npm install` in the sense that it will add the module as a dependency to your `package.json` file with the latest version (`^`). You can specify semver requirements in the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and this will be what you `package.json` will eventually include. --- *Example* ```java [ 'typescript', '@types/express' ] ``` ##### `entrypoint`^Optional ```java public java.lang.String getEntrypoint(); ``` - *Type:* java.lang.String - *Default:* "lib/index.js" Module entrypoint (`main` in `package.json`). Set to an empty string to not include `main` in your package.json --- ##### `homepage`^Optional ```java public java.lang.String getHomepage(); ``` - *Type:* java.lang.String Package's Homepage / Website. --- ##### `keywords`^Optional ```java public java.util.List getKeywords(); ``` - *Type:* java.util.List Keywords to include in `package.json`. --- ##### `license`^Optional ```java public java.lang.String getLicense(); ``` - *Type:* java.lang.String - *Default:* "Apache-2.0" License's SPDX identifier. See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses. Use the `licensed` option if you want to no license to be specified. --- ##### `licensed`^Optional ```java public java.lang.Boolean getLicensed(); ``` - *Type:* java.lang.Boolean - *Default:* true Indicates if a license should be added. --- ##### `maxNodeVersion`^Optional ```java public java.lang.String getMaxNodeVersion(); ``` - *Type:* java.lang.String - *Default:* no max Minimum node.js version to require via `engines` (inclusive). --- ##### `minNodeVersion`^Optional ```java public java.lang.String getMinNodeVersion(); ``` - *Type:* java.lang.String - *Default:* no "engines" specified Minimum Node.js version to require via package.json `engines` (inclusive). --- ##### `npmAccess`^Optional ```java public NpmAccess getNpmAccess(); ``` - *Type:* io.github.cdklabs.projen.javascript.NpmAccess - *Default:* for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`. Access level of the npm package. --- ##### ~~`npmRegistry`~~^Optional - *Deprecated:* use `npmRegistryUrl` instead ```java public java.lang.String getNpmRegistry(); ``` - *Type:* java.lang.String The host name of the npm registry to publish to. Cannot be set together with `npmRegistryUrl`. --- ##### `npmRegistryUrl`^Optional ```java public java.lang.String getNpmRegistryUrl(); ``` - *Type:* java.lang.String - *Default:* "https://registry.npmjs.org" The base URL of the npm package registry. Must be a URL (e.g. start with "https://" or "http://") --- ##### `npmTokenSecret`^Optional ```java public java.lang.String getNpmTokenSecret(); ``` - *Type:* java.lang.String - *Default:* "NPM_TOKEN" GitHub secret which contains the NPM token to use when publishing packages. --- ##### `packageManager`^Optional ```java public NodePackageManager getPackageManager(); ``` - *Type:* io.github.cdklabs.projen.javascript.NodePackageManager - *Default:* NodePackageManager.YARN The Node Package Manager used to execute scripts. --- ##### `packageName`^Optional ```java public java.lang.String getPackageName(); ``` - *Type:* java.lang.String - *Default:* defaults to project name The "name" in package.json. --- ##### `peerDependencyOptions`^Optional ```java public PeerDependencyOptions getPeerDependencyOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.PeerDependencyOptions Options for `peerDeps`. --- ##### `peerDeps`^Optional ```java public java.util.List getPeerDeps(); ``` - *Type:* java.util.List - *Default:* [] Peer dependencies for this module. Dependencies listed here are required to be installed (and satisfied) by the _consumer_ of this library. Using peer dependencies allows you to ensure that only a single module of a certain library exists in the `node_modules` tree of your consumers. Note that prior to npm@7, peer dependencies are _not_ automatically installed, which means that adding peer dependencies to a library will be a breaking change for your customers. Unless `peerDependencyOptions.pinnedDevDependency` is disabled (it is enabled by default), projen will automatically add a dev dependency with a pinned version for each peer dependency. This will ensure that you build & test your module against the lowest peer version required. --- ##### `pnpmVersion`^Optional ```java public java.lang.String getPnpmVersion(); ``` - *Type:* java.lang.String - *Default:* "7" The version of PNPM to use if using PNPM as a package manager. --- ##### `repository`^Optional ```java public java.lang.String getRepository(); ``` - *Type:* java.lang.String The repository is the location where the actual code for your package lives. See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository --- ##### `repositoryDirectory`^Optional ```java public java.lang.String getRepositoryDirectory(); ``` - *Type:* java.lang.String 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. --- ##### `scopedPackagesOptions`^Optional ```java public java.util.List getScopedPackagesOptions(); ``` - *Type:* java.util.List - *Default:* fetch all scoped packages from the public npm registry Options for privately hosted scoped packages. --- ##### ~~`scripts`~~^Optional - *Deprecated:* use `project.addTask()` or `package.setScript()` ```java public java.util.Map getScripts(); ``` - *Type:* java.util.Map - *Default:* {} npm scripts to include. If a script has the same name as a standard script, the standard script will be overwritten. Also adds the script as a task. --- ##### `stability`^Optional ```java public java.lang.String getStability(); ``` - *Type:* java.lang.String Package's Stability. --- ##### `jsiiReleaseVersion`^Optional ```java public java.lang.String getJsiiReleaseVersion(); ``` - *Type:* java.lang.String - *Default:* "latest" Version requirement of `publib` which is used to publish modules to npm. --- ##### `majorVersion`^Optional ```java public java.lang.Number getMajorVersion(); ``` - *Type:* java.lang.Number - *Default:* Major version is not enforced. Major version to release from the default branch. If this is specified, we bump the latest version of this major version line. If not specified, we bump the global latest version. --- ##### `minMajorVersion`^Optional ```java public java.lang.Number getMinMajorVersion(); ``` - *Type:* java.lang.Number - *Default:* No minimum version is being enforced Minimal Major version to release. This can be useful to set to 1, as breaking changes before the 1.x major release are not incrementing the major version number. Can not be set together with `majorVersion`. --- ##### `npmDistTag`^Optional ```java public java.lang.String getNpmDistTag(); ``` - *Type:* java.lang.String - *Default:* "latest" The npmDistTag to use when publishing from the default branch. To set the npm dist-tag for release branches, set the `npmDistTag` property for each branch. --- ##### `postBuildSteps`^Optional ```java public java.util.List getPostBuildSteps(); ``` - *Type:* java.util.List - *Default:* [] Steps to execute after build as part of the release workflow. --- ##### `prerelease`^Optional ```java public java.lang.String getPrerelease(); ``` - *Type:* java.lang.String - *Default:* normal semantic versions Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). --- ##### `publishDryRun`^Optional ```java public java.lang.Boolean getPublishDryRun(); ``` - *Type:* java.lang.Boolean - *Default:* false Instead of actually publishing to package managers, just print the publishing command. --- ##### `publishTasks`^Optional ```java public java.lang.Boolean getPublishTasks(); ``` - *Type:* java.lang.Boolean - *Default:* false Define publishing tasks that can be executed manually as well as workflows. Normally, publishing only happens within automated workflows. Enable this in order to create a publishing task for each publishing activity. --- ##### `releaseBranches`^Optional ```java public java.util.Map getReleaseBranches(); ``` - *Type:* java.util.Map - *Default:* no additional branches are used for release. you can use `addBranch()` to add additional branches. Defines additional release branches. A workflow will be created for each release branch which will publish releases from commits in this branch. Each release branch _must_ be assigned a major version number which is used to enforce that versions published from that branch always use that major version. If multiple branches are used, the `majorVersion` field must also be provided for the default branch. --- ##### ~~`releaseEveryCommit`~~^Optional - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead ```java public java.lang.Boolean getReleaseEveryCommit(); ``` - *Type:* java.lang.Boolean - *Default:* true Automatically release new versions every commit to one of branches in `releaseBranches`. --- ##### `releaseFailureIssue`^Optional ```java public java.lang.Boolean getReleaseFailureIssue(); ``` - *Type:* java.lang.Boolean - *Default:* false Create a github issue on every failed publishing task. --- ##### `releaseFailureIssueLabel`^Optional ```java public java.lang.String getReleaseFailureIssueLabel(); ``` - *Type:* java.lang.String - *Default:* "failed-release" The label to apply to issues indicating publish failures. Only applies if `releaseFailureIssue` is true. --- ##### ~~`releaseSchedule`~~^Optional - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead ```java public java.lang.String getReleaseSchedule(); ``` - *Type:* java.lang.String - *Default:* no scheduled releases CRON schedule to trigger new releases. --- ##### `releaseTagPrefix`^Optional ```java public java.lang.String getReleaseTagPrefix(); ``` - *Type:* java.lang.String - *Default:* "v" Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. Note: this prefix is used to detect the latest tagged version when bumping, so if you change this on a project with an existing version history, you may need to manually tag your latest release with the new prefix. --- ##### `releaseTrigger`^Optional ```java public ReleaseTrigger getReleaseTrigger(); ``` - *Type:* io.github.cdklabs.projen.release.ReleaseTrigger - *Default:* Continuous releases (`ReleaseTrigger.continuous()`) The release trigger to use. --- ##### `releaseWorkflowName`^Optional ```java public java.lang.String getReleaseWorkflowName(); ``` - *Type:* java.lang.String - *Default:* "Release" The name of the default release workflow. --- ##### `releaseWorkflowSetupSteps`^Optional ```java public java.util.List getReleaseWorkflowSetupSteps(); ``` - *Type:* java.util.List A set of workflow steps to execute in order to setup the workflow container. --- ##### `versionrcOptions`^Optional ```java public java.util.Map getVersionrcOptions(); ``` - *Type:* java.util.Map - *Default:* standard configuration applicable for GitHub repositories Custom configuration used when creating changelog with standard-version package. Given values either append to default configuration or overwrite values in it. --- ##### `workflowContainerImage`^Optional ```java public java.lang.String getWorkflowContainerImage(); ``` - *Type:* java.lang.String - *Default:* default image Container image to use for GitHub workflows. --- ##### `workflowRunsOn`^Optional ```java public java.util.List getWorkflowRunsOn(); ``` - *Type:* java.util.List - *Default:* ["ubuntu-latest"] Github Runner selection labels. --- ##### `defaultReleaseBranch`^Required ```java public java.lang.String getDefaultReleaseBranch(); ``` - *Type:* java.lang.String - *Default:* "main" The name of the main release branch. --- ##### `artifactsDirectory`^Optional ```java public java.lang.String getArtifactsDirectory(); ``` - *Type:* java.lang.String - *Default:* "dist" A directory which will contain build artifacts. --- ##### `autoApproveUpgrades`^Optional ```java public java.lang.Boolean getAutoApproveUpgrades(); ``` - *Type:* java.lang.Boolean - *Default:* true Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). Throw if set to true but `autoApproveOptions` are not defined. --- ##### `buildWorkflow`^Optional ```java public java.lang.Boolean getBuildWorkflow(); ``` - *Type:* java.lang.Boolean - *Default:* true if not a subproject Define a GitHub workflow for building PRs. --- ##### `buildWorkflowTriggers`^Optional ```java public Triggers getBuildWorkflowTriggers(); ``` - *Type:* io.github.cdklabs.projen.github.workflows.Triggers - *Default:* "{ pullRequest: {}, workflowDispatch: {} }" Build workflow triggers. --- ##### `bundlerOptions`^Optional ```java public BundlerOptions getBundlerOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.BundlerOptions Options for `Bundler`. --- ##### `codeCov`^Optional ```java public java.lang.Boolean getCodeCov(); ``` - *Type:* java.lang.Boolean - *Default:* false Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. --- ##### `codeCovTokenSecret`^Optional ```java public java.lang.String getCodeCovTokenSecret(); ``` - *Type:* java.lang.String - *Default:* if this option is not specified, only public repositories are supported Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. --- ##### `copyrightOwner`^Optional ```java public java.lang.String getCopyrightOwner(); ``` - *Type:* java.lang.String - *Default:* defaults to the value of authorName or "" if `authorName` is undefined. License copyright owner. --- ##### `copyrightPeriod`^Optional ```java public java.lang.String getCopyrightPeriod(); ``` - *Type:* java.lang.String - *Default:* current year The copyright years to put in the LICENSE file. --- ##### `dependabot`^Optional ```java public java.lang.Boolean getDependabot(); ``` - *Type:* java.lang.Boolean - *Default:* false Use dependabot to handle dependency upgrades. Cannot be used in conjunction with `depsUpgrade`. --- ##### `dependabotOptions`^Optional ```java public DependabotOptions getDependabotOptions(); ``` - *Type:* io.github.cdklabs.projen.github.DependabotOptions - *Default:* default options Options for dependabot. --- ##### `depsUpgrade`^Optional ```java public java.lang.Boolean getDepsUpgrade(); ``` - *Type:* java.lang.Boolean - *Default:* true Use github workflows to handle dependency upgrades. Cannot be used in conjunction with `dependabot`. --- ##### `depsUpgradeOptions`^Optional ```java public UpgradeDependenciesOptions getDepsUpgradeOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.UpgradeDependenciesOptions - *Default:* default options Options for `UpgradeDependencies`. --- ##### `gitignore`^Optional ```java public java.util.List getGitignore(); ``` - *Type:* java.util.List Additional entries to .gitignore. --- ##### `jest`^Optional ```java public java.lang.Boolean getJest(); ``` - *Type:* java.lang.Boolean - *Default:* true Setup jest unit tests. --- ##### `jestOptions`^Optional ```java public JestOptions getJestOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.JestOptions - *Default:* default options Jest options. --- ##### `mutableBuild`^Optional ```java public java.lang.Boolean getMutableBuild(); ``` - *Type:* java.lang.Boolean - *Default:* true Automatically update files modified during builds to pull-request branches. This means that any files synthesized by projen or e.g. test snapshots will always be up-to-date before a PR is merged. Implies that PR builds do not have anti-tamper checks. --- ##### ~~`npmignore`~~^Optional - *Deprecated:* - use `project.addPackageIgnore` ```java public java.util.List getNpmignore(); ``` - *Type:* java.util.List Additional entries to .npmignore. --- ##### `npmignoreEnabled`^Optional ```java public java.lang.Boolean getNpmignoreEnabled(); ``` - *Type:* java.lang.Boolean - *Default:* true Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. --- ##### `npmIgnoreOptions`^Optional ```java public IgnoreFileOptions getNpmIgnoreOptions(); ``` - *Type:* io.github.cdklabs.projen.IgnoreFileOptions Configuration options for .npmignore file. --- ##### `package`^Optional ```java public java.lang.Boolean getPackage(); ``` - *Type:* java.lang.Boolean - *Default:* true Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). --- ##### `prettier`^Optional ```java public java.lang.Boolean getPrettier(); ``` - *Type:* java.lang.Boolean - *Default:* false Setup prettier. --- ##### `prettierOptions`^Optional ```java public PrettierOptions getPrettierOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.PrettierOptions - *Default:* default options Prettier options. --- ##### `projenDevDependency`^Optional ```java public java.lang.Boolean getProjenDevDependency(); ``` - *Type:* java.lang.Boolean - *Default:* true Indicates of "projen" should be installed as a devDependency. --- ##### `projenrcJs`^Optional ```java public java.lang.Boolean getProjenrcJs(); ``` - *Type:* java.lang.Boolean - *Default:* true if projenrcJson is false Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. --- ##### `projenrcJsOptions`^Optional ```java public ProjenrcOptions getProjenrcJsOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.ProjenrcOptions - *Default:* default options Options for .projenrc.js. --- ##### `projenVersion`^Optional ```java public java.lang.String getProjenVersion(); ``` - *Type:* java.lang.String - *Default:* Defaults to the latest version. Version of projen to install. --- ##### `pullRequestTemplate`^Optional ```java public java.lang.Boolean getPullRequestTemplate(); ``` - *Type:* java.lang.Boolean - *Default:* true Include a GitHub pull request template. --- ##### `pullRequestTemplateContents`^Optional ```java public java.util.List getPullRequestTemplateContents(); ``` - *Type:* java.util.List - *Default:* default content The contents of the pull request template. --- ##### `release`^Optional ```java public java.lang.Boolean getRelease(); ``` - *Type:* java.lang.Boolean - *Default:* true (false for subprojects) Add release management to this project. --- ##### `releaseToNpm`^Optional ```java public java.lang.Boolean getReleaseToNpm(); ``` - *Type:* java.lang.Boolean - *Default:* false Automatically release to npm when new versions are introduced. --- ##### ~~`releaseWorkflow`~~^Optional - *Deprecated:* see `release`. ```java public java.lang.Boolean getReleaseWorkflow(); ``` - *Type:* java.lang.Boolean - *Default:* true if not a subproject DEPRECATED: renamed to `release`. --- ##### `workflowBootstrapSteps`^Optional ```java public java.util.List getWorkflowBootstrapSteps(); ``` - *Type:* java.util.List - *Default:* "yarn install --frozen-lockfile && yarn projen" Workflow steps to use in order to bootstrap this repo. --- ##### `workflowGitIdentity`^Optional ```java public GitIdentity getWorkflowGitIdentity(); ``` - *Type:* io.github.cdklabs.projen.github.GitIdentity - *Default:* GitHub Actions The git identity to use in workflows. --- ##### `workflowNodeVersion`^Optional ```java public java.lang.String getWorkflowNodeVersion(); ``` - *Type:* java.lang.String - *Default:* same as `minNodeVersion` The node version to use in GitHub workflows. --- ##### `workflowPackageCache`^Optional ```java public java.lang.Boolean getWorkflowPackageCache(); ``` - *Type:* java.lang.Boolean - *Default:* false Enable Node.js package cache in GitHub workflows. --- ##### `disableTsconfig`^Optional ```java public java.lang.Boolean getDisableTsconfig(); ``` - *Type:* java.lang.Boolean - *Default:* false Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). --- ##### `disableTsconfigDev`^Optional ```java public java.lang.Boolean getDisableTsconfigDev(); ``` - *Type:* java.lang.Boolean - *Default:* false Do not generate a `tsconfig.dev.json` file. --- ##### `docgen`^Optional ```java public java.lang.Boolean getDocgen(); ``` - *Type:* java.lang.Boolean - *Default:* false Docgen by Typedoc. --- ##### `docsDirectory`^Optional ```java public java.lang.String getDocsDirectory(); ``` - *Type:* java.lang.String - *Default:* "docs" Docs directory. --- ##### `entrypointTypes`^Optional ```java public java.lang.String getEntrypointTypes(); ``` - *Type:* java.lang.String - *Default:* .d.ts file derived from the project's entrypoint (usually lib/index.d.ts) The .d.ts file that includes the type declarations for this module. --- ##### `eslint`^Optional ```java public java.lang.Boolean getEslint(); ``` - *Type:* java.lang.Boolean - *Default:* true Setup eslint. --- ##### `eslintOptions`^Optional ```java public EslintOptions getEslintOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.EslintOptions - *Default:* opinionated default options Eslint options. --- ##### `libdir`^Optional ```java public java.lang.String getLibdir(); ``` - *Type:* java.lang.String - *Default:* "lib" Typescript artifacts output directory. --- ##### `projenrcTs`^Optional ```java public java.lang.Boolean getProjenrcTs(); ``` - *Type:* java.lang.Boolean - *Default:* false Use TypeScript for your projenrc file (`.projenrc.ts`). --- ##### `projenrcTsOptions`^Optional ```java public ProjenrcOptions getProjenrcTsOptions(); ``` - *Type:* io.github.cdklabs.projen.typescript.ProjenrcOptions Options for .projenrc.ts. --- ##### `sampleCode`^Optional ```java public java.lang.Boolean getSampleCode(); ``` - *Type:* java.lang.Boolean - *Default:* true Generate one-time sample in `src/` and `test/` if there are no files there. --- ##### `srcdir`^Optional ```java public java.lang.String getSrcdir(); ``` - *Type:* java.lang.String - *Default:* "src" Typescript sources directory. --- ##### `testdir`^Optional ```java public java.lang.String getTestdir(); ``` - *Type:* java.lang.String - *Default:* "test" Jest tests directory. Tests files should be named `xxx.test.ts`. If this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`), then tests are going to be compiled into `lib/` and executed as javascript. If the test directory is outside of `src`, then we configure jest to compile the code in-memory. --- ##### `tsconfig`^Optional ```java public TypescriptConfigOptions getTsconfig(); ``` - *Type:* io.github.cdklabs.projen.javascript.TypescriptConfigOptions - *Default:* default options Custom TSConfig. --- ##### `tsconfigDev`^Optional ```java public TypescriptConfigOptions getTsconfigDev(); ``` - *Type:* io.github.cdklabs.projen.javascript.TypescriptConfigOptions - *Default:* use the production tsconfig options Custom tsconfig options for the development tsconfig.json file (used for testing). --- ##### `tsconfigDevFile`^Optional ```java public java.lang.String getTsconfigDevFile(); ``` - *Type:* java.lang.String - *Default:* "tsconfig.dev.json" The name of the development tsconfig.json file. --- ##### `typescriptVersion`^Optional ```java public java.lang.String getTypescriptVersion(); ``` - *Type:* java.lang.String - *Default:* "latest" TypeScript version to use. NOTE: Typescript is not semantically versioned and should remain on the same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`). --- ##### `openApiGeneratorCliConfig`^Optional ```java public OpenApiGeneratorCliConfig getOpenApiGeneratorCliConfig(); ``` - *Type:* OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. Overrides default values if specified. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) --- ### GeneratedTypeScriptRuntimeOptions Options for configuring a generated typescript runtime project. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.GeneratedTypeScriptRuntimeOptions; GeneratedTypeScriptRuntimeOptions.builder() .name(java.lang.String) // .commitGenerated(java.lang.Boolean) // .gitIgnoreOptions(IgnoreFileOptions) // .gitOptions(GitOptions) // .logging(LoggerOptions) // .outdir(java.lang.String) // .parent(Project) // .projenCommand(java.lang.String) // .projenrcJson(java.lang.Boolean) // .projenrcJsonOptions(ProjenrcJsonOptions) // .renovatebot(java.lang.Boolean) // .renovatebotOptions(RenovatebotOptions) // .autoApproveOptions(AutoApproveOptions) // .autoMerge(java.lang.Boolean) // .autoMergeOptions(AutoMergeOptions) // .clobber(java.lang.Boolean) // .devContainer(java.lang.Boolean) // .github(java.lang.Boolean) // .githubOptions(GitHubOptions) // .gitpod(java.lang.Boolean) // .mergify(java.lang.Boolean) // .mergifyOptions(MergifyOptions) // .projectType(ProjectType) // .projenCredentials(GithubCredentials) // .projenTokenSecret(java.lang.String) // .readme(SampleReadmeProps) // .stale(java.lang.Boolean) // .staleOptions(StaleOptions) // .vscode(java.lang.Boolean) // .allowLibraryDependencies(java.lang.Boolean) // .authorEmail(java.lang.String) // .authorName(java.lang.String) // .authorOrganization(java.lang.Boolean) // .authorUrl(java.lang.String) // .autoDetectBin(java.lang.Boolean) // .bin(java.util.Map) // .bugsEmail(java.lang.String) // .bugsUrl(java.lang.String) // .bundledDeps(java.util.List) // .codeArtifactOptions(CodeArtifactOptions) // .deps(java.util.List) // .description(java.lang.String) // .devDeps(java.util.List) // .entrypoint(java.lang.String) // .homepage(java.lang.String) // .keywords(java.util.List) // .license(java.lang.String) // .licensed(java.lang.Boolean) // .maxNodeVersion(java.lang.String) // .minNodeVersion(java.lang.String) // .npmAccess(NpmAccess) // .npmRegistry(java.lang.String) // .npmRegistryUrl(java.lang.String) // .npmTokenSecret(java.lang.String) // .packageManager(NodePackageManager) // .packageName(java.lang.String) // .peerDependencyOptions(PeerDependencyOptions) // .peerDeps(java.util.List) // .pnpmVersion(java.lang.String) // .repository(java.lang.String) // .repositoryDirectory(java.lang.String) // .scopedPackagesOptions(java.util.List) // .scripts(java.util.Map) // .stability(java.lang.String) // .jsiiReleaseVersion(java.lang.String) // .majorVersion(java.lang.Number) // .minMajorVersion(java.lang.Number) // .npmDistTag(java.lang.String) // .postBuildSteps(java.util.List) // .prerelease(java.lang.String) // .publishDryRun(java.lang.Boolean) // .publishTasks(java.lang.Boolean) // .releaseBranches(java.util.Map) // .releaseEveryCommit(java.lang.Boolean) // .releaseFailureIssue(java.lang.Boolean) // .releaseFailureIssueLabel(java.lang.String) // .releaseSchedule(java.lang.String) // .releaseTagPrefix(java.lang.String) // .releaseTrigger(ReleaseTrigger) // .releaseWorkflowName(java.lang.String) // .releaseWorkflowSetupSteps(java.util.List) // .versionrcOptions(java.util.Map) // .workflowContainerImage(java.lang.String) // .workflowRunsOn(java.util.List) .defaultReleaseBranch(java.lang.String) // .artifactsDirectory(java.lang.String) // .autoApproveUpgrades(java.lang.Boolean) // .buildWorkflow(java.lang.Boolean) // .buildWorkflowTriggers(Triggers) // .bundlerOptions(BundlerOptions) // .codeCov(java.lang.Boolean) // .codeCovTokenSecret(java.lang.String) // .copyrightOwner(java.lang.String) // .copyrightPeriod(java.lang.String) // .dependabot(java.lang.Boolean) // .dependabotOptions(DependabotOptions) // .depsUpgrade(java.lang.Boolean) // .depsUpgradeOptions(UpgradeDependenciesOptions) // .gitignore(java.util.List) // .jest(java.lang.Boolean) // .jestOptions(JestOptions) // .mutableBuild(java.lang.Boolean) // .npmignore(java.util.List) // .npmignoreEnabled(java.lang.Boolean) // .npmIgnoreOptions(IgnoreFileOptions) // .package(java.lang.Boolean) // .prettier(java.lang.Boolean) // .prettierOptions(PrettierOptions) // .projenDevDependency(java.lang.Boolean) // .projenrcJs(java.lang.Boolean) // .projenrcJsOptions(ProjenrcOptions) // .projenVersion(java.lang.String) // .pullRequestTemplate(java.lang.Boolean) // .pullRequestTemplateContents(java.util.List) // .release(java.lang.Boolean) // .releaseToNpm(java.lang.Boolean) // .releaseWorkflow(java.lang.Boolean) // .workflowBootstrapSteps(java.util.List) // .workflowGitIdentity(GitIdentity) // .workflowNodeVersion(java.lang.String) // .workflowPackageCache(java.lang.Boolean) // .disableTsconfig(java.lang.Boolean) // .disableTsconfigDev(java.lang.Boolean) // .docgen(java.lang.Boolean) // .docsDirectory(java.lang.String) // .entrypointTypes(java.lang.String) // .eslint(java.lang.Boolean) // .eslintOptions(EslintOptions) // .libdir(java.lang.String) // .projenrcTs(java.lang.Boolean) // .projenrcTsOptions(ProjenrcOptions) // .sampleCode(java.lang.Boolean) // .srcdir(java.lang.String) // .testdir(java.lang.String) // .tsconfig(TypescriptConfigOptions) // .tsconfigDev(TypescriptConfigOptions) // .tsconfigDevFile(java.lang.String) // .typescriptVersion(java.lang.String) // .openApiGeneratorCliConfig(OpenApiGeneratorCliConfig) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | java.lang.String | This is the name of your project. | | commitGenerated | java.lang.Boolean | Whether to commit the managed files by default. | | gitIgnoreOptions | io.github.cdklabs.projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | io.github.cdklabs.projen.GitOptions | Configuration options for git. | | logging | io.github.cdklabs.projen.LoggerOptions | Configure logging options such as verbosity. | | outdir | java.lang.String | The root directory of the project. | | parent | io.github.cdklabs.projen.Project | The parent project, if this project is part of a bigger project. | | projenCommand | java.lang.String | The shell command to use in order to run the projen CLI. | | projenrcJson | java.lang.Boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. | | projenrcJsonOptions | io.github.cdklabs.projen.ProjenrcJsonOptions | Options for .projenrc.json. | | renovatebot | java.lang.Boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | io.github.cdklabs.projen.RenovatebotOptions | Options for renovatebot. | | autoApproveOptions | io.github.cdklabs.projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoMerge | java.lang.Boolean | Enable automatic merging on GitHub. | | autoMergeOptions | io.github.cdklabs.projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | clobber | java.lang.Boolean | Add a `clobber` task which resets the repo to origin. | | devContainer | java.lang.Boolean | Add a VSCode development environment (used for GitHub Codespaces). | | github | java.lang.Boolean | Enable GitHub integration. | | githubOptions | io.github.cdklabs.projen.github.GitHubOptions | Options for GitHub integration. | | gitpod | java.lang.Boolean | Add a Gitpod development environment. | | mergify | java.lang.Boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | io.github.cdklabs.projen.github.MergifyOptions | Options for mergify. | | projectType | io.github.cdklabs.projen.ProjectType | Which type of project this is (library/app). | | projenCredentials | io.github.cdklabs.projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | projenTokenSecret | java.lang.String | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | readme | io.github.cdklabs.projen.SampleReadmeProps | The README setup. | | stale | java.lang.Boolean | Auto-close of stale issues and pull request. | | staleOptions | io.github.cdklabs.projen.github.StaleOptions | Auto-close stale issues and pull requests. | | vscode | java.lang.Boolean | Enable VSCode integration. | | allowLibraryDependencies | java.lang.Boolean | Allow the project to include `peerDependencies` and `bundledDependencies`. | | authorEmail | java.lang.String | Author's e-mail. | | authorName | java.lang.String | Author's name. | | authorOrganization | java.lang.Boolean | Is the author an organization. | | authorUrl | java.lang.String | Author's URL / Website. | | autoDetectBin | java.lang.Boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. | | bin | java.util.Map | Binary programs vended with your module. | | bugsEmail | java.lang.String | The email address to which issues should be reported. | | bugsUrl | java.lang.String | The url to your project's issue tracker. | | bundledDeps | java.util.List | List of dependencies to bundle into this module. | | codeArtifactOptions | io.github.cdklabs.projen.javascript.CodeArtifactOptions | Options for npm packages using AWS CodeArtifact. | | deps | java.util.List | Runtime dependencies of this module. | | description | java.lang.String | The description is just a string that helps people understand the purpose of the package. | | devDeps | java.util.List | Build dependencies for this module. | | entrypoint | java.lang.String | Module entrypoint (`main` in `package.json`). | | homepage | java.lang.String | Package's Homepage / Website. | | keywords | java.util.List | Keywords to include in `package.json`. | | license | java.lang.String | License's SPDX identifier. | | licensed | java.lang.Boolean | Indicates if a license should be added. | | maxNodeVersion | java.lang.String | Minimum node.js version to require via `engines` (inclusive). | | minNodeVersion | java.lang.String | Minimum Node.js version to require via package.json `engines` (inclusive). | | npmAccess | io.github.cdklabs.projen.javascript.NpmAccess | Access level of the npm package. | | npmRegistry | java.lang.String | The host name of the npm registry to publish to. | | npmRegistryUrl | java.lang.String | The base URL of the npm package registry. | | npmTokenSecret | java.lang.String | GitHub secret which contains the NPM token to use when publishing packages. | | packageManager | io.github.cdklabs.projen.javascript.NodePackageManager | The Node Package Manager used to execute scripts. | | packageName | java.lang.String | The "name" in package.json. | | peerDependencyOptions | io.github.cdklabs.projen.javascript.PeerDependencyOptions | Options for `peerDeps`. | | peerDeps | java.util.List | Peer dependencies for this module. | | pnpmVersion | java.lang.String | The version of PNPM to use if using PNPM as a package manager. | | repository | java.lang.String | The repository is the location where the actual code for your package lives. | | repositoryDirectory | java.lang.String | 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. | | scopedPackagesOptions | java.util.List | Options for privately hosted scoped packages. | | scripts | java.util.Map | npm scripts to include. | | stability | java.lang.String | Package's Stability. | | jsiiReleaseVersion | java.lang.String | Version requirement of `publib` which is used to publish modules to npm. | | majorVersion | java.lang.Number | Major version to release from the default branch. | | minMajorVersion | java.lang.Number | Minimal Major version to release. | | npmDistTag | java.lang.String | The npmDistTag to use when publishing from the default branch. | | postBuildSteps | java.util.List | Steps to execute after build as part of the release workflow. | | prerelease | java.lang.String | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). | | publishDryRun | java.lang.Boolean | Instead of actually publishing to package managers, just print the publishing command. | | publishTasks | java.lang.Boolean | Define publishing tasks that can be executed manually as well as workflows. | | releaseBranches | java.util.Map | Defines additional release branches. | | releaseEveryCommit | java.lang.Boolean | Automatically release new versions every commit to one of branches in `releaseBranches`. | | releaseFailureIssue | java.lang.Boolean | Create a github issue on every failed publishing task. | | releaseFailureIssueLabel | java.lang.String | The label to apply to issues indicating publish failures. | | releaseSchedule | java.lang.String | CRON schedule to trigger new releases. | | releaseTagPrefix | java.lang.String | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. | | releaseTrigger | io.github.cdklabs.projen.release.ReleaseTrigger | The release trigger to use. | | releaseWorkflowName | java.lang.String | The name of the default release workflow. | | releaseWorkflowSetupSteps | java.util.List | A set of workflow steps to execute in order to setup the workflow container. | | versionrcOptions | java.util.Map | Custom configuration used when creating changelog with standard-version package. | | workflowContainerImage | java.lang.String | Container image to use for GitHub workflows. | | workflowRunsOn | java.util.List | Github Runner selection labels. | | defaultReleaseBranch | java.lang.String | The name of the main release branch. | | artifactsDirectory | java.lang.String | A directory which will contain build artifacts. | | autoApproveUpgrades | java.lang.Boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). | | buildWorkflow | java.lang.Boolean | Define a GitHub workflow for building PRs. | | buildWorkflowTriggers | io.github.cdklabs.projen.github.workflows.Triggers | Build workflow triggers. | | bundlerOptions | io.github.cdklabs.projen.javascript.BundlerOptions | Options for `Bundler`. | | codeCov | java.lang.Boolean | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. | | codeCovTokenSecret | java.lang.String | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. | | copyrightOwner | java.lang.String | License copyright owner. | | copyrightPeriod | java.lang.String | The copyright years to put in the LICENSE file. | | dependabot | java.lang.Boolean | Use dependabot to handle dependency upgrades. | | dependabotOptions | io.github.cdklabs.projen.github.DependabotOptions | Options for dependabot. | | depsUpgrade | java.lang.Boolean | Use github workflows to handle dependency upgrades. | | depsUpgradeOptions | io.github.cdklabs.projen.javascript.UpgradeDependenciesOptions | Options for `UpgradeDependencies`. | | gitignore | java.util.List | Additional entries to .gitignore. | | jest | java.lang.Boolean | Setup jest unit tests. | | jestOptions | io.github.cdklabs.projen.javascript.JestOptions | Jest options. | | mutableBuild | java.lang.Boolean | Automatically update files modified during builds to pull-request branches. | | npmignore | java.util.List | Additional entries to .npmignore. | | npmignoreEnabled | java.lang.Boolean | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. | | npmIgnoreOptions | io.github.cdklabs.projen.IgnoreFileOptions | Configuration options for .npmignore file. | | package | java.lang.Boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). | | prettier | java.lang.Boolean | Setup prettier. | | prettierOptions | io.github.cdklabs.projen.javascript.PrettierOptions | Prettier options. | | projenDevDependency | java.lang.Boolean | Indicates of "projen" should be installed as a devDependency. | | projenrcJs | java.lang.Boolean | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. | | projenrcJsOptions | io.github.cdklabs.projen.javascript.ProjenrcOptions | Options for .projenrc.js. | | projenVersion | java.lang.String | Version of projen to install. | | pullRequestTemplate | java.lang.Boolean | Include a GitHub pull request template. | | pullRequestTemplateContents | java.util.List | The contents of the pull request template. | | release | java.lang.Boolean | Add release management to this project. | | releaseToNpm | java.lang.Boolean | Automatically release to npm when new versions are introduced. | | releaseWorkflow | java.lang.Boolean | DEPRECATED: renamed to `release`. | | workflowBootstrapSteps | java.util.List | Workflow steps to use in order to bootstrap this repo. | | workflowGitIdentity | io.github.cdklabs.projen.github.GitIdentity | The git identity to use in workflows. | | workflowNodeVersion | java.lang.String | The node version to use in GitHub workflows. | | workflowPackageCache | java.lang.Boolean | Enable Node.js package cache in GitHub workflows. | | disableTsconfig | java.lang.Boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). | | disableTsconfigDev | java.lang.Boolean | Do not generate a `tsconfig.dev.json` file. | | docgen | java.lang.Boolean | Docgen by Typedoc. | | docsDirectory | java.lang.String | Docs directory. | | entrypointTypes | java.lang.String | The .d.ts file that includes the type declarations for this module. | | eslint | java.lang.Boolean | Setup eslint. | | eslintOptions | io.github.cdklabs.projen.javascript.EslintOptions | Eslint options. | | libdir | java.lang.String | Typescript artifacts output directory. | | projenrcTs | java.lang.Boolean | Use TypeScript for your projenrc file (`.projenrc.ts`). | | projenrcTsOptions | io.github.cdklabs.projen.typescript.ProjenrcOptions | Options for .projenrc.ts. | | sampleCode | java.lang.Boolean | Generate one-time sample in `src/` and `test/` if there are no files there. | | srcdir | java.lang.String | Typescript sources directory. | | testdir | java.lang.String | Jest tests directory. Tests files should be named `xxx.test.ts`. | | tsconfig | io.github.cdklabs.projen.javascript.TypescriptConfigOptions | Custom TSConfig. | | tsconfigDev | io.github.cdklabs.projen.javascript.TypescriptConfigOptions | Custom tsconfig options for the development tsconfig.json file (used for testing). | | tsconfigDevFile | java.lang.String | The name of the development tsconfig.json file. | | typescriptVersion | java.lang.String | TypeScript version to use. | | openApiGeneratorCliConfig | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. | --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional ```java public java.lang.Boolean getCommitGenerated(); ``` - *Type:* java.lang.Boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional ```java public IgnoreFileOptions getGitIgnoreOptions(); ``` - *Type:* io.github.cdklabs.projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```java public GitOptions getGitOptions(); ``` - *Type:* io.github.cdklabs.projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```java public LoggerOptions getLogging(); ``` - *Type:* io.github.cdklabs.projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```java public java.lang.String getOutdir(); ``` - *Type:* java.lang.String - *Default:* "." The root directory of the project. Relative to this directory, all files are synthesized. If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects. --- ##### `parent`^Optional ```java public Project getParent(); ``` - *Type:* io.github.cdklabs.projen.Project The parent project, if this project is part of a bigger project. --- ##### `projenCommand`^Optional ```java public java.lang.String getProjenCommand(); ``` - *Type:* java.lang.String - *Default:* "npx projen" The shell command to use in order to run the projen CLI. Can be used to customize in special environments. --- ##### `projenrcJson`^Optional ```java public java.lang.Boolean getProjenrcJson(); ``` - *Type:* java.lang.Boolean - *Default:* false Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. --- ##### `projenrcJsonOptions`^Optional ```java public ProjenrcJsonOptions getProjenrcJsonOptions(); ``` - *Type:* io.github.cdklabs.projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```java public java.lang.Boolean getRenovatebot(); ``` - *Type:* java.lang.Boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```java public RenovatebotOptions getRenovatebotOptions(); ``` - *Type:* io.github.cdklabs.projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional ```java public AutoApproveOptions getAutoApproveOptions(); ``` - *Type:* io.github.cdklabs.projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional ```java public java.lang.Boolean getAutoMerge(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable automatic merging on GitHub. Has no effect if `github.mergify` is set to false. --- ##### `autoMergeOptions`^Optional ```java public AutoMergeOptions getAutoMergeOptions(); ``` - *Type:* io.github.cdklabs.projen.github.AutoMergeOptions - *Default:* see defaults in `AutoMergeOptions` Configure options for automatic merging on GitHub. Has no effect if `github.mergify` or `autoMerge` is set to false. --- ##### `clobber`^Optional ```java public java.lang.Boolean getClobber(); ``` - *Type:* java.lang.Boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional ```java public java.lang.Boolean getDevContainer(); ``` - *Type:* java.lang.Boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```java public java.lang.Boolean getGithub(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```java public GitHubOptions getGithubOptions(); ``` - *Type:* io.github.cdklabs.projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```java public java.lang.Boolean getGitpod(); ``` - *Type:* java.lang.Boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```java public java.lang.Boolean getMergify(); ``` - *Type:* java.lang.Boolean - *Default:* true Whether mergify should be enabled on this repository or not. --- ##### ~~`mergifyOptions`~~^Optional - *Deprecated:* use `githubOptions.mergifyOptions` instead ```java public MergifyOptions getMergifyOptions(); ``` - *Type:* io.github.cdklabs.projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```java public ProjectType getProjectType(); ``` - *Type:* io.github.cdklabs.projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional ```java public GithubCredentials getProjenCredentials(); ``` - *Type:* io.github.cdklabs.projen.github.GithubCredentials - *Default:* use a personal access token named PROJEN_GITHUB_TOKEN Choose a method of providing GitHub API access for projen workflows. --- ##### ~~`projenTokenSecret`~~^Optional - *Deprecated:* use `projenCredentials` ```java public java.lang.String getProjenTokenSecret(); ``` - *Type:* java.lang.String - *Default:* "PROJEN_GITHUB_TOKEN" The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This token needs to have the `repo`, `workflows` and `packages` scope. --- ##### `readme`^Optional ```java public SampleReadmeProps getReadme(); ``` - *Type:* io.github.cdklabs.projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```java "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```java public java.lang.Boolean getStale(); ``` - *Type:* java.lang.Boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```java public StaleOptions getStaleOptions(); ``` - *Type:* io.github.cdklabs.projen.github.StaleOptions - *Default:* see defaults in `StaleOptions` Auto-close stale issues and pull requests. To disable set `stale` to `false`. --- ##### `vscode`^Optional ```java public java.lang.Boolean getVscode(); ``` - *Type:* java.lang.Boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `allowLibraryDependencies`^Optional ```java public java.lang.Boolean getAllowLibraryDependencies(); ``` - *Type:* java.lang.Boolean - *Default:* true Allow the project to include `peerDependencies` and `bundledDependencies`. This is normally only allowed for libraries. For apps, there's no meaning for specifying these. --- ##### `authorEmail`^Optional ```java public java.lang.String getAuthorEmail(); ``` - *Type:* java.lang.String Author's e-mail. --- ##### `authorName`^Optional ```java public java.lang.String getAuthorName(); ``` - *Type:* java.lang.String Author's name. --- ##### `authorOrganization`^Optional ```java public java.lang.Boolean getAuthorOrganization(); ``` - *Type:* java.lang.Boolean Is the author an organization. --- ##### `authorUrl`^Optional ```java public java.lang.String getAuthorUrl(); ``` - *Type:* java.lang.String Author's URL / Website. --- ##### `autoDetectBin`^Optional ```java public java.lang.Boolean getAutoDetectBin(); ``` - *Type:* java.lang.Boolean - *Default:* true Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. --- ##### `bin`^Optional ```java public java.util.Map getBin(); ``` - *Type:* java.util.Map Binary programs vended with your module. You can use this option to add/customize how binaries are represented in your `package.json`, but unless `autoDetectBin` is `false`, every executable file under `bin` will automatically be added to this section. --- ##### `bugsEmail`^Optional ```java public java.lang.String getBugsEmail(); ``` - *Type:* java.lang.String The email address to which issues should be reported. --- ##### `bugsUrl`^Optional ```java public java.lang.String getBugsUrl(); ``` - *Type:* java.lang.String The url to your project's issue tracker. --- ##### `bundledDeps`^Optional ```java public java.util.List getBundledDeps(); ``` - *Type:* java.util.List List of dependencies to bundle into this module. These modules will be added both to the `dependencies` section and `bundledDependencies` section of your `package.json`. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `yarn add` or `npm install` in the sense that it will add the module as a dependency to your `package.json` file with the latest version (`^`). You can specify semver requirements in the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and this will be what you `package.json` will eventually include. --- ##### `codeArtifactOptions`^Optional ```java public CodeArtifactOptions getCodeArtifactOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.CodeArtifactOptions - *Default:* undefined Options for npm packages using AWS CodeArtifact. This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact --- ##### `deps`^Optional ```java public java.util.List getDeps(); ``` - *Type:* java.util.List - *Default:* [] Runtime dependencies of this module. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `yarn add` or `npm install` in the sense that it will add the module as a dependency to your `package.json` file with the latest version (`^`). You can specify semver requirements in the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and this will be what you `package.json` will eventually include. --- *Example* ```java [ 'express', 'lodash', 'foo@^2' ] ``` ##### `description`^Optional ```java public java.lang.String getDescription(); ``` - *Type:* java.lang.String The description is just a string that helps people understand the purpose of the package. It can be used when searching for packages in a package manager as well. See https://classic.yarnpkg.com/en/docs/package-json/#toc-description --- ##### `devDeps`^Optional ```java public java.util.List getDevDeps(); ``` - *Type:* java.util.List - *Default:* [] Build dependencies for this module. These dependencies will only be available in your build environment but will not be fetched when this module is consumed. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `yarn add` or `npm install` in the sense that it will add the module as a dependency to your `package.json` file with the latest version (`^`). You can specify semver requirements in the same syntax passed to `npm i` or `yarn add` (e.g. `express@^2`) and this will be what you `package.json` will eventually include. --- *Example* ```java [ 'typescript', '@types/express' ] ``` ##### `entrypoint`^Optional ```java public java.lang.String getEntrypoint(); ``` - *Type:* java.lang.String - *Default:* "lib/index.js" Module entrypoint (`main` in `package.json`). Set to an empty string to not include `main` in your package.json --- ##### `homepage`^Optional ```java public java.lang.String getHomepage(); ``` - *Type:* java.lang.String Package's Homepage / Website. --- ##### `keywords`^Optional ```java public java.util.List getKeywords(); ``` - *Type:* java.util.List Keywords to include in `package.json`. --- ##### `license`^Optional ```java public java.lang.String getLicense(); ``` - *Type:* java.lang.String - *Default:* "Apache-2.0" License's SPDX identifier. See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses. Use the `licensed` option if you want to no license to be specified. --- ##### `licensed`^Optional ```java public java.lang.Boolean getLicensed(); ``` - *Type:* java.lang.Boolean - *Default:* true Indicates if a license should be added. --- ##### `maxNodeVersion`^Optional ```java public java.lang.String getMaxNodeVersion(); ``` - *Type:* java.lang.String - *Default:* no max Minimum node.js version to require via `engines` (inclusive). --- ##### `minNodeVersion`^Optional ```java public java.lang.String getMinNodeVersion(); ``` - *Type:* java.lang.String - *Default:* no "engines" specified Minimum Node.js version to require via package.json `engines` (inclusive). --- ##### `npmAccess`^Optional ```java public NpmAccess getNpmAccess(); ``` - *Type:* io.github.cdklabs.projen.javascript.NpmAccess - *Default:* for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`. Access level of the npm package. --- ##### ~~`npmRegistry`~~^Optional - *Deprecated:* use `npmRegistryUrl` instead ```java public java.lang.String getNpmRegistry(); ``` - *Type:* java.lang.String The host name of the npm registry to publish to. Cannot be set together with `npmRegistryUrl`. --- ##### `npmRegistryUrl`^Optional ```java public java.lang.String getNpmRegistryUrl(); ``` - *Type:* java.lang.String - *Default:* "https://registry.npmjs.org" The base URL of the npm package registry. Must be a URL (e.g. start with "https://" or "http://") --- ##### `npmTokenSecret`^Optional ```java public java.lang.String getNpmTokenSecret(); ``` - *Type:* java.lang.String - *Default:* "NPM_TOKEN" GitHub secret which contains the NPM token to use when publishing packages. --- ##### `packageManager`^Optional ```java public NodePackageManager getPackageManager(); ``` - *Type:* io.github.cdklabs.projen.javascript.NodePackageManager - *Default:* NodePackageManager.YARN The Node Package Manager used to execute scripts. --- ##### `packageName`^Optional ```java public java.lang.String getPackageName(); ``` - *Type:* java.lang.String - *Default:* defaults to project name The "name" in package.json. --- ##### `peerDependencyOptions`^Optional ```java public PeerDependencyOptions getPeerDependencyOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.PeerDependencyOptions Options for `peerDeps`. --- ##### `peerDeps`^Optional ```java public java.util.List getPeerDeps(); ``` - *Type:* java.util.List - *Default:* [] Peer dependencies for this module. Dependencies listed here are required to be installed (and satisfied) by the _consumer_ of this library. Using peer dependencies allows you to ensure that only a single module of a certain library exists in the `node_modules` tree of your consumers. Note that prior to npm@7, peer dependencies are _not_ automatically installed, which means that adding peer dependencies to a library will be a breaking change for your customers. Unless `peerDependencyOptions.pinnedDevDependency` is disabled (it is enabled by default), projen will automatically add a dev dependency with a pinned version for each peer dependency. This will ensure that you build & test your module against the lowest peer version required. --- ##### `pnpmVersion`^Optional ```java public java.lang.String getPnpmVersion(); ``` - *Type:* java.lang.String - *Default:* "7" The version of PNPM to use if using PNPM as a package manager. --- ##### `repository`^Optional ```java public java.lang.String getRepository(); ``` - *Type:* java.lang.String The repository is the location where the actual code for your package lives. See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository --- ##### `repositoryDirectory`^Optional ```java public java.lang.String getRepositoryDirectory(); ``` - *Type:* java.lang.String 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. --- ##### `scopedPackagesOptions`^Optional ```java public java.util.List getScopedPackagesOptions(); ``` - *Type:* java.util.List - *Default:* fetch all scoped packages from the public npm registry Options for privately hosted scoped packages. --- ##### ~~`scripts`~~^Optional - *Deprecated:* use `project.addTask()` or `package.setScript()` ```java public java.util.Map getScripts(); ``` - *Type:* java.util.Map - *Default:* {} npm scripts to include. If a script has the same name as a standard script, the standard script will be overwritten. Also adds the script as a task. --- ##### `stability`^Optional ```java public java.lang.String getStability(); ``` - *Type:* java.lang.String Package's Stability. --- ##### `jsiiReleaseVersion`^Optional ```java public java.lang.String getJsiiReleaseVersion(); ``` - *Type:* java.lang.String - *Default:* "latest" Version requirement of `publib` which is used to publish modules to npm. --- ##### `majorVersion`^Optional ```java public java.lang.Number getMajorVersion(); ``` - *Type:* java.lang.Number - *Default:* Major version is not enforced. Major version to release from the default branch. If this is specified, we bump the latest version of this major version line. If not specified, we bump the global latest version. --- ##### `minMajorVersion`^Optional ```java public java.lang.Number getMinMajorVersion(); ``` - *Type:* java.lang.Number - *Default:* No minimum version is being enforced Minimal Major version to release. This can be useful to set to 1, as breaking changes before the 1.x major release are not incrementing the major version number. Can not be set together with `majorVersion`. --- ##### `npmDistTag`^Optional ```java public java.lang.String getNpmDistTag(); ``` - *Type:* java.lang.String - *Default:* "latest" The npmDistTag to use when publishing from the default branch. To set the npm dist-tag for release branches, set the `npmDistTag` property for each branch. --- ##### `postBuildSteps`^Optional ```java public java.util.List getPostBuildSteps(); ``` - *Type:* java.util.List - *Default:* [] Steps to execute after build as part of the release workflow. --- ##### `prerelease`^Optional ```java public java.lang.String getPrerelease(); ``` - *Type:* java.lang.String - *Default:* normal semantic versions Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). --- ##### `publishDryRun`^Optional ```java public java.lang.Boolean getPublishDryRun(); ``` - *Type:* java.lang.Boolean - *Default:* false Instead of actually publishing to package managers, just print the publishing command. --- ##### `publishTasks`^Optional ```java public java.lang.Boolean getPublishTasks(); ``` - *Type:* java.lang.Boolean - *Default:* false Define publishing tasks that can be executed manually as well as workflows. Normally, publishing only happens within automated workflows. Enable this in order to create a publishing task for each publishing activity. --- ##### `releaseBranches`^Optional ```java public java.util.Map getReleaseBranches(); ``` - *Type:* java.util.Map - *Default:* no additional branches are used for release. you can use `addBranch()` to add additional branches. Defines additional release branches. A workflow will be created for each release branch which will publish releases from commits in this branch. Each release branch _must_ be assigned a major version number which is used to enforce that versions published from that branch always use that major version. If multiple branches are used, the `majorVersion` field must also be provided for the default branch. --- ##### ~~`releaseEveryCommit`~~^Optional - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.continuous()` instead ```java public java.lang.Boolean getReleaseEveryCommit(); ``` - *Type:* java.lang.Boolean - *Default:* true Automatically release new versions every commit to one of branches in `releaseBranches`. --- ##### `releaseFailureIssue`^Optional ```java public java.lang.Boolean getReleaseFailureIssue(); ``` - *Type:* java.lang.Boolean - *Default:* false Create a github issue on every failed publishing task. --- ##### `releaseFailureIssueLabel`^Optional ```java public java.lang.String getReleaseFailureIssueLabel(); ``` - *Type:* java.lang.String - *Default:* "failed-release" The label to apply to issues indicating publish failures. Only applies if `releaseFailureIssue` is true. --- ##### ~~`releaseSchedule`~~^Optional - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead ```java public java.lang.String getReleaseSchedule(); ``` - *Type:* java.lang.String - *Default:* no scheduled releases CRON schedule to trigger new releases. --- ##### `releaseTagPrefix`^Optional ```java public java.lang.String getReleaseTagPrefix(); ``` - *Type:* java.lang.String - *Default:* "v" Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. Note: this prefix is used to detect the latest tagged version when bumping, so if you change this on a project with an existing version history, you may need to manually tag your latest release with the new prefix. --- ##### `releaseTrigger`^Optional ```java public ReleaseTrigger getReleaseTrigger(); ``` - *Type:* io.github.cdklabs.projen.release.ReleaseTrigger - *Default:* Continuous releases (`ReleaseTrigger.continuous()`) The release trigger to use. --- ##### `releaseWorkflowName`^Optional ```java public java.lang.String getReleaseWorkflowName(); ``` - *Type:* java.lang.String - *Default:* "Release" The name of the default release workflow. --- ##### `releaseWorkflowSetupSteps`^Optional ```java public java.util.List getReleaseWorkflowSetupSteps(); ``` - *Type:* java.util.List A set of workflow steps to execute in order to setup the workflow container. --- ##### `versionrcOptions`^Optional ```java public java.util.Map getVersionrcOptions(); ``` - *Type:* java.util.Map - *Default:* standard configuration applicable for GitHub repositories Custom configuration used when creating changelog with standard-version package. Given values either append to default configuration or overwrite values in it. --- ##### `workflowContainerImage`^Optional ```java public java.lang.String getWorkflowContainerImage(); ``` - *Type:* java.lang.String - *Default:* default image Container image to use for GitHub workflows. --- ##### `workflowRunsOn`^Optional ```java public java.util.List getWorkflowRunsOn(); ``` - *Type:* java.util.List - *Default:* ["ubuntu-latest"] Github Runner selection labels. --- ##### `defaultReleaseBranch`^Required ```java public java.lang.String getDefaultReleaseBranch(); ``` - *Type:* java.lang.String - *Default:* "main" The name of the main release branch. --- ##### `artifactsDirectory`^Optional ```java public java.lang.String getArtifactsDirectory(); ``` - *Type:* java.lang.String - *Default:* "dist" A directory which will contain build artifacts. --- ##### `autoApproveUpgrades`^Optional ```java public java.lang.Boolean getAutoApproveUpgrades(); ``` - *Type:* java.lang.Boolean - *Default:* true Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). Throw if set to true but `autoApproveOptions` are not defined. --- ##### `buildWorkflow`^Optional ```java public java.lang.Boolean getBuildWorkflow(); ``` - *Type:* java.lang.Boolean - *Default:* true if not a subproject Define a GitHub workflow for building PRs. --- ##### `buildWorkflowTriggers`^Optional ```java public Triggers getBuildWorkflowTriggers(); ``` - *Type:* io.github.cdklabs.projen.github.workflows.Triggers - *Default:* "{ pullRequest: {}, workflowDispatch: {} }" Build workflow triggers. --- ##### `bundlerOptions`^Optional ```java public BundlerOptions getBundlerOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.BundlerOptions Options for `Bundler`. --- ##### `codeCov`^Optional ```java public java.lang.Boolean getCodeCov(); ``` - *Type:* java.lang.Boolean - *Default:* false Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. --- ##### `codeCovTokenSecret`^Optional ```java public java.lang.String getCodeCovTokenSecret(); ``` - *Type:* java.lang.String - *Default:* if this option is not specified, only public repositories are supported Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. --- ##### `copyrightOwner`^Optional ```java public java.lang.String getCopyrightOwner(); ``` - *Type:* java.lang.String - *Default:* defaults to the value of authorName or "" if `authorName` is undefined. License copyright owner. --- ##### `copyrightPeriod`^Optional ```java public java.lang.String getCopyrightPeriod(); ``` - *Type:* java.lang.String - *Default:* current year The copyright years to put in the LICENSE file. --- ##### `dependabot`^Optional ```java public java.lang.Boolean getDependabot(); ``` - *Type:* java.lang.Boolean - *Default:* false Use dependabot to handle dependency upgrades. Cannot be used in conjunction with `depsUpgrade`. --- ##### `dependabotOptions`^Optional ```java public DependabotOptions getDependabotOptions(); ``` - *Type:* io.github.cdklabs.projen.github.DependabotOptions - *Default:* default options Options for dependabot. --- ##### `depsUpgrade`^Optional ```java public java.lang.Boolean getDepsUpgrade(); ``` - *Type:* java.lang.Boolean - *Default:* true Use github workflows to handle dependency upgrades. Cannot be used in conjunction with `dependabot`. --- ##### `depsUpgradeOptions`^Optional ```java public UpgradeDependenciesOptions getDepsUpgradeOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.UpgradeDependenciesOptions - *Default:* default options Options for `UpgradeDependencies`. --- ##### `gitignore`^Optional ```java public java.util.List getGitignore(); ``` - *Type:* java.util.List Additional entries to .gitignore. --- ##### `jest`^Optional ```java public java.lang.Boolean getJest(); ``` - *Type:* java.lang.Boolean - *Default:* true Setup jest unit tests. --- ##### `jestOptions`^Optional ```java public JestOptions getJestOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.JestOptions - *Default:* default options Jest options. --- ##### `mutableBuild`^Optional ```java public java.lang.Boolean getMutableBuild(); ``` - *Type:* java.lang.Boolean - *Default:* true Automatically update files modified during builds to pull-request branches. This means that any files synthesized by projen or e.g. test snapshots will always be up-to-date before a PR is merged. Implies that PR builds do not have anti-tamper checks. --- ##### ~~`npmignore`~~^Optional - *Deprecated:* - use `project.addPackageIgnore` ```java public java.util.List getNpmignore(); ``` - *Type:* java.util.List Additional entries to .npmignore. --- ##### `npmignoreEnabled`^Optional ```java public java.lang.Boolean getNpmignoreEnabled(); ``` - *Type:* java.lang.Boolean - *Default:* true Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. --- ##### `npmIgnoreOptions`^Optional ```java public IgnoreFileOptions getNpmIgnoreOptions(); ``` - *Type:* io.github.cdklabs.projen.IgnoreFileOptions Configuration options for .npmignore file. --- ##### `package`^Optional ```java public java.lang.Boolean getPackage(); ``` - *Type:* java.lang.Boolean - *Default:* true Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). --- ##### `prettier`^Optional ```java public java.lang.Boolean getPrettier(); ``` - *Type:* java.lang.Boolean - *Default:* false Setup prettier. --- ##### `prettierOptions`^Optional ```java public PrettierOptions getPrettierOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.PrettierOptions - *Default:* default options Prettier options. --- ##### `projenDevDependency`^Optional ```java public java.lang.Boolean getProjenDevDependency(); ``` - *Type:* java.lang.Boolean - *Default:* true Indicates of "projen" should be installed as a devDependency. --- ##### `projenrcJs`^Optional ```java public java.lang.Boolean getProjenrcJs(); ``` - *Type:* java.lang.Boolean - *Default:* true if projenrcJson is false Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. --- ##### `projenrcJsOptions`^Optional ```java public ProjenrcOptions getProjenrcJsOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.ProjenrcOptions - *Default:* default options Options for .projenrc.js. --- ##### `projenVersion`^Optional ```java public java.lang.String getProjenVersion(); ``` - *Type:* java.lang.String - *Default:* Defaults to the latest version. Version of projen to install. --- ##### `pullRequestTemplate`^Optional ```java public java.lang.Boolean getPullRequestTemplate(); ``` - *Type:* java.lang.Boolean - *Default:* true Include a GitHub pull request template. --- ##### `pullRequestTemplateContents`^Optional ```java public java.util.List getPullRequestTemplateContents(); ``` - *Type:* java.util.List - *Default:* default content The contents of the pull request template. --- ##### `release`^Optional ```java public java.lang.Boolean getRelease(); ``` - *Type:* java.lang.Boolean - *Default:* true (false for subprojects) Add release management to this project. --- ##### `releaseToNpm`^Optional ```java public java.lang.Boolean getReleaseToNpm(); ``` - *Type:* java.lang.Boolean - *Default:* false Automatically release to npm when new versions are introduced. --- ##### ~~`releaseWorkflow`~~^Optional - *Deprecated:* see `release`. ```java public java.lang.Boolean getReleaseWorkflow(); ``` - *Type:* java.lang.Boolean - *Default:* true if not a subproject DEPRECATED: renamed to `release`. --- ##### `workflowBootstrapSteps`^Optional ```java public java.util.List getWorkflowBootstrapSteps(); ``` - *Type:* java.util.List - *Default:* "yarn install --frozen-lockfile && yarn projen" Workflow steps to use in order to bootstrap this repo. --- ##### `workflowGitIdentity`^Optional ```java public GitIdentity getWorkflowGitIdentity(); ``` - *Type:* io.github.cdklabs.projen.github.GitIdentity - *Default:* GitHub Actions The git identity to use in workflows. --- ##### `workflowNodeVersion`^Optional ```java public java.lang.String getWorkflowNodeVersion(); ``` - *Type:* java.lang.String - *Default:* same as `minNodeVersion` The node version to use in GitHub workflows. --- ##### `workflowPackageCache`^Optional ```java public java.lang.Boolean getWorkflowPackageCache(); ``` - *Type:* java.lang.Boolean - *Default:* false Enable Node.js package cache in GitHub workflows. --- ##### `disableTsconfig`^Optional ```java public java.lang.Boolean getDisableTsconfig(); ``` - *Type:* java.lang.Boolean - *Default:* false Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). --- ##### `disableTsconfigDev`^Optional ```java public java.lang.Boolean getDisableTsconfigDev(); ``` - *Type:* java.lang.Boolean - *Default:* false Do not generate a `tsconfig.dev.json` file. --- ##### `docgen`^Optional ```java public java.lang.Boolean getDocgen(); ``` - *Type:* java.lang.Boolean - *Default:* false Docgen by Typedoc. --- ##### `docsDirectory`^Optional ```java public java.lang.String getDocsDirectory(); ``` - *Type:* java.lang.String - *Default:* "docs" Docs directory. --- ##### `entrypointTypes`^Optional ```java public java.lang.String getEntrypointTypes(); ``` - *Type:* java.lang.String - *Default:* .d.ts file derived from the project's entrypoint (usually lib/index.d.ts) The .d.ts file that includes the type declarations for this module. --- ##### `eslint`^Optional ```java public java.lang.Boolean getEslint(); ``` - *Type:* java.lang.Boolean - *Default:* true Setup eslint. --- ##### `eslintOptions`^Optional ```java public EslintOptions getEslintOptions(); ``` - *Type:* io.github.cdklabs.projen.javascript.EslintOptions - *Default:* opinionated default options Eslint options. --- ##### `libdir`^Optional ```java public java.lang.String getLibdir(); ``` - *Type:* java.lang.String - *Default:* "lib" Typescript artifacts output directory. --- ##### `projenrcTs`^Optional ```java public java.lang.Boolean getProjenrcTs(); ``` - *Type:* java.lang.Boolean - *Default:* false Use TypeScript for your projenrc file (`.projenrc.ts`). --- ##### `projenrcTsOptions`^Optional ```java public ProjenrcOptions getProjenrcTsOptions(); ``` - *Type:* io.github.cdklabs.projen.typescript.ProjenrcOptions Options for .projenrc.ts. --- ##### `sampleCode`^Optional ```java public java.lang.Boolean getSampleCode(); ``` - *Type:* java.lang.Boolean - *Default:* true Generate one-time sample in `src/` and `test/` if there are no files there. --- ##### `srcdir`^Optional ```java public java.lang.String getSrcdir(); ``` - *Type:* java.lang.String - *Default:* "src" Typescript sources directory. --- ##### `testdir`^Optional ```java public java.lang.String getTestdir(); ``` - *Type:* java.lang.String - *Default:* "test" Jest tests directory. Tests files should be named `xxx.test.ts`. If this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`), then tests are going to be compiled into `lib/` and executed as javascript. If the test directory is outside of `src`, then we configure jest to compile the code in-memory. --- ##### `tsconfig`^Optional ```java public TypescriptConfigOptions getTsconfig(); ``` - *Type:* io.github.cdklabs.projen.javascript.TypescriptConfigOptions - *Default:* default options Custom TSConfig. --- ##### `tsconfigDev`^Optional ```java public TypescriptConfigOptions getTsconfigDev(); ``` - *Type:* io.github.cdklabs.projen.javascript.TypescriptConfigOptions - *Default:* use the production tsconfig options Custom tsconfig options for the development tsconfig.json file (used for testing). --- ##### `tsconfigDevFile`^Optional ```java public java.lang.String getTsconfigDevFile(); ``` - *Type:* java.lang.String - *Default:* "tsconfig.dev.json" The name of the development tsconfig.json file. --- ##### `typescriptVersion`^Optional ```java public java.lang.String getTypescriptVersion(); ``` - *Type:* java.lang.String - *Default:* "latest" TypeScript version to use. NOTE: Typescript is not semantically versioned and should remain on the same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`). --- ##### `openApiGeneratorCliConfig`^Optional ```java public OpenApiGeneratorCliConfig getOpenApiGeneratorCliConfig(); ``` - *Type:* OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. Overrides default values if specified. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) --- ### GeneratedWithOpenApiGeneratorOptions Options for a code project generated with OpenAPI Generator. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.GeneratedWithOpenApiGeneratorOptions; GeneratedWithOpenApiGeneratorOptions.builder() // .openApiGeneratorCliConfig(OpenApiGeneratorCliConfig) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | openApiGeneratorCliConfig | OpenApiGeneratorCliConfig | Configuration for the OpenAPI Generator CLI. | --- ##### `openApiGeneratorCliConfig`^Optional ```java public OpenApiGeneratorCliConfig getOpenApiGeneratorCliConfig(); ``` - *Type:* OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. Overrides default values if specified. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) --- ### HandlersConfiguration Configuration for generated lambda handlers. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.HandlersConfiguration; HandlersConfiguration.builder() .languages(java.util.List) // .options(GeneratedHandlersCodeOptions) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | languages | java.util.List<Language> | The languages lambda handlers are written in. | | options | GeneratedHandlersCodeOptions | Options for the infrastructure package. | --- ##### `languages`^Required ```java public java.util.List getLanguages(); ``` - *Type:* java.util.List<Language> The languages lambda handlers are written in. Specify multiple languages if you wish to implement different operations as AWS Lambda functions in different languages. --- ##### `options`^Optional ```java public GeneratedHandlersCodeOptions getOptions(); ``` - *Type:* GeneratedHandlersCodeOptions Options for the infrastructure package. Note that only those provided for the specified language will apply. --- ### InfrastructureConfiguration Configuration for generated infrastructure. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.InfrastructureConfiguration; InfrastructureConfiguration.builder() .language(Language) // .options(GeneratedInfrastructureCodeOptions) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | language | Language | The language to generate the type-safe CDK infrastructure in. | | options | GeneratedInfrastructureCodeOptions | Options for the infrastructure package. | --- ##### `language`^Required ```java public Language getLanguage(); ``` - *Type:* Language The language to generate the type-safe CDK infrastructure in. --- ##### `options`^Optional ```java public GeneratedInfrastructureCodeOptions getOptions(); ``` - *Type:* GeneratedInfrastructureCodeOptions Options for the infrastructure package. Note that only those provided for the specified language will apply. --- ### IntegrationGrantProps Properties for granting the API access to invoke the operation. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.IntegrationGrantProps; IntegrationGrantProps.builder() .method(java.lang.String) .path(java.lang.String) // .contentTypes(java.util.List) .api(SpecRestApi) .operationId(java.lang.String) .scope(Construct) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | method | java.lang.String | The http method of this operation. | | path | java.lang.String | The path of this operation in the api. | | contentTypes | java.util.List | Content types accepted by this operation. | | api | software.amazon.awscdk.services.apigateway.SpecRestApi | The api to grant permissions for. | | operationId | java.lang.String | The ID of the operation for which permissions are being granted. | | scope | software.constructs.Construct | The scope in which permission resources can be created. | --- ##### `method`^Required ```java public java.lang.String getMethod(); ``` - *Type:* java.lang.String The http method of this operation. --- ##### `path`^Required ```java public java.lang.String getPath(); ``` - *Type:* java.lang.String The path of this operation in the api. --- ##### `contentTypes`^Optional ```java public java.util.List getContentTypes(); ``` - *Type:* java.util.List - *Default:* application/json Content types accepted by this operation. --- ##### `api`^Required ```java public SpecRestApi getApi(); ``` - *Type:* software.amazon.awscdk.services.apigateway.SpecRestApi The api to grant permissions for. --- ##### `operationId`^Required ```java public java.lang.String getOperationId(); ``` - *Type:* java.lang.String The ID of the operation for which permissions are being granted. --- ##### `scope`^Required ```java public Construct getScope(); ``` - *Type:* software.constructs.Construct The scope in which permission resources can be created. --- ### IntegrationRenderProps Properties for rendering an integration into an API Gateway OpenAPI extension. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.IntegrationRenderProps; IntegrationRenderProps.builder() .method(java.lang.String) .path(java.lang.String) // .contentTypes(java.util.List) .operationId(java.lang.String) .scope(Construct) // .corsOptions(SerializedCorsOptions) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | method | java.lang.String | The http method of this operation. | | path | java.lang.String | The path of this operation in the api. | | contentTypes | java.util.List | Content types accepted by this operation. | | operationId | java.lang.String | The ID of the operation being rendered. | | scope | software.constructs.Construct | The scope in which the integration is being rendered. | | corsOptions | SerializedCorsOptions | Cross Origin Resource Sharing options for the API. | --- ##### `method`^Required ```java public java.lang.String getMethod(); ``` - *Type:* java.lang.String The http method of this operation. --- ##### `path`^Required ```java public java.lang.String getPath(); ``` - *Type:* java.lang.String The path of this operation in the api. --- ##### `contentTypes`^Optional ```java public java.util.List getContentTypes(); ``` - *Type:* java.util.List - *Default:* application/json Content types accepted by this operation. --- ##### `operationId`^Required ```java public java.lang.String getOperationId(); ``` - *Type:* java.lang.String The ID of the operation being rendered. --- ##### `scope`^Required ```java public Construct getScope(); ``` - *Type:* software.constructs.Construct The scope in which the integration is being rendered. --- ##### `corsOptions`^Optional ```java public SerializedCorsOptions getCorsOptions(); ``` - *Type:* SerializedCorsOptions Cross Origin Resource Sharing options for the API. --- ### LibraryConfiguration Configuration for generated libraries. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.LibraryConfiguration; LibraryConfiguration.builder() .libraries(java.util.List) // .options(GeneratedLibraryOptions) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | libraries | java.util.List<Library> | The library to generate. | | options | GeneratedLibraryOptions | Options for the generated library package. | --- ##### `libraries`^Required ```java public java.util.List getLibraries(); ``` - *Type:* java.util.List<Library> The library to generate. --- ##### `options`^Optional ```java public GeneratedLibraryOptions getOptions(); ``` - *Type:* GeneratedLibraryOptions Options for the generated library package. Note that only options for the specified libraries will apply --- ### ManagedRule #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.ManagedRule; ManagedRule.builder() .name(java.lang.String) .vendor(java.lang.String) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | java.lang.String | The name of the managed rule group. | | vendor | java.lang.String | The name of the managed rule group vendor. | --- ##### `name`^Required ```java public java.lang.String getName(); ``` - *Type:* java.lang.String The name of the managed rule group. You use this, along with the vendor name, to identify the rule group. --- ##### `vendor`^Required ```java public java.lang.String getVendor(); ``` - *Type:* java.lang.String The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group. --- ### MethodAndPath Structure to contain an API operation's method and path. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.MethodAndPath; MethodAndPath.builder() .method(java.lang.String) .path(java.lang.String) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | method | java.lang.String | The http method of this operation. | | path | java.lang.String | The path of this operation in the api. | --- ##### `method`^Required ```java public java.lang.String getMethod(); ``` - *Type:* java.lang.String The http method of this operation. --- ##### `path`^Required ```java public java.lang.String getPath(); ``` - *Type:* java.lang.String The path of this operation in the api. --- ### MockIntegrationResponse Properties for a mock integration response. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.MockIntegrationResponse; MockIntegrationResponse.builder() .statusCode(java.lang.Number) // .body(java.lang.String) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | statusCode | java.lang.Number | HTTP response status code. | | body | java.lang.String | Response body. | --- ##### `statusCode`^Required ```java public java.lang.Number getStatusCode(); ``` - *Type:* java.lang.Number HTTP response status code. --- ##### `body`^Optional ```java public java.lang.String getBody(); ``` - *Type:* java.lang.String Response body. --- ### MockResponseDataGenerationOptions Options for generating mock data. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.MockResponseDataGenerationOptions; MockResponseDataGenerationOptions.builder() // .disable(java.lang.Boolean) // .locale(java.lang.String) // .maxArrayLength(java.lang.Number) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | disable | java.lang.Boolean | Set to true to disable generating mock data. | | locale | java.lang.String | Locale of generated data. | | maxArrayLength | java.lang.Number | Maximum length of generated arrays. | --- ##### `disable`^Optional ```java public java.lang.Boolean getDisable(); ``` - *Type:* java.lang.Boolean - *Default:* false Set to true to disable generating mock data. --- ##### `locale`^Optional ```java public java.lang.String getLocale(); ``` - *Type:* java.lang.String - *Default:* en Locale of generated data. > [https://fakerjs.dev/guide/localization.html#available-locales](https://fakerjs.dev/guide/localization.html#available-locales) --- ##### `maxArrayLength`^Optional ```java public java.lang.Number getMaxArrayLength(); ``` - *Type:* java.lang.Number - *Default:* 3 Maximum length of generated arrays. --- ### MockResponseGenerationOptions Options for generating mock data. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.MockResponseGenerationOptions; MockResponseGenerationOptions.builder() // .mockDataOptions(MockResponseDataGenerationOptions) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | mockDataOptions | MockResponseDataGenerationOptions | Options for the generated mock response data. | --- ##### `mockDataOptions`^Optional ```java public MockResponseDataGenerationOptions getMockDataOptions(); ``` - *Type:* MockResponseDataGenerationOptions Options for the generated mock response data. --- ### ModelConfiguration Configuration for modelling the API. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.ModelConfiguration; ModelConfiguration.builder() .language(ModelLanguage) .options(ModelOptions) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | language | ModelLanguage | The language the API model is defined in. | | options | ModelOptions | Options for the API model. | --- ##### `language`^Required ```java public ModelLanguage getLanguage(); ``` - *Type:* ModelLanguage The language the API model is defined in. --- ##### `options`^Required ```java public ModelOptions getOptions(); ``` - *Type:* ModelOptions Options for the API model. --- ### ModelOptions Options for models. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.ModelOptions; ModelOptions.builder() // .openapi(OpenApiModelOptions) // .smithy(SmithyModelOptions) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | openapi | OpenApiModelOptions | Options for the OpenAPI model - required when model language is OPENAPI. | | smithy | SmithyModelOptions | Options for the Smithy model - required when model language is SMITHY. | --- ##### `openapi`^Optional ```java public OpenApiModelOptions getOpenapi(); ``` - *Type:* OpenApiModelOptions Options for the OpenAPI model - required when model language is OPENAPI. --- ##### `smithy`^Optional ```java public SmithyModelOptions getSmithy(); ``` - *Type:* SmithyModelOptions Options for the Smithy model - required when model language is SMITHY. --- ### OpenApiDefinitionOptions Options for the OpenAPI Spec. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.OpenApiDefinitionOptions; OpenApiDefinitionOptions.builder() .openApiOptions(OpenApiModelOptions) // .handlerLanguages(java.util.List) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | openApiOptions | OpenApiModelOptions | Options for the openapi model. | | handlerLanguages | java.util.List<Language> | The languages users have specified for handler projects (if any). | --- ##### `openApiOptions`^Required ```java public OpenApiModelOptions getOpenApiOptions(); ``` - *Type:* OpenApiModelOptions Options for the openapi model. --- ##### `handlerLanguages`^Optional ```java public java.util.List getHandlerLanguages(); ``` - *Type:* java.util.List<Language> The languages users have specified for handler projects (if any). --- ### OpenApiGeneratorCliConfig Configuration for the OpenAPI Generator CLI. > [https://github.com/OpenAPITools/openapi-generator-cli#configuration](https://github.com/OpenAPITools/openapi-generator-cli#configuration) #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.OpenApiGeneratorCliConfig; OpenApiGeneratorCliConfig.builder() // .repository(OpenApiGeneratorCliConfigRepository) // .storageDir(java.lang.String) // .useDocker(java.lang.Boolean) // .version(java.lang.String) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | repository | OpenApiGeneratorCliConfigRepository | Maven repository info for fetching the OpenAPI Generator jar. | | storageDir | java.lang.String | The directory in which OpenAPI Generator jars are cached. | | useDocker | java.lang.Boolean | Use docker instead of your locally installed Java version. | | version | java.lang.String | OpenAPI Generator version to use. | --- ##### `repository`^Optional ```java public OpenApiGeneratorCliConfigRepository getRepository(); ``` - *Type:* OpenApiGeneratorCliConfigRepository - *Default:* public maven repository Maven repository info for fetching the OpenAPI Generator jar. > [https://github.com/OpenAPITools/openapi-generator-cli#using-custom--private-maven-registry](https://github.com/OpenAPITools/openapi-generator-cli#using-custom--private-maven-registry) --- ##### `storageDir`^Optional ```java public java.lang.String getStorageDir(); ``` - *Type:* java.lang.String - *Default:* ~/.open-api-generator-cli The directory in which OpenAPI Generator jars are cached. --- ##### `useDocker`^Optional ```java public java.lang.Boolean getUseDocker(); ``` - *Type:* java.lang.Boolean - *Default:* false Use docker instead of your locally installed Java version. > [https://github.com/OpenAPITools/openapi-generator-cli#use-docker-instead-of-running-java-locally](https://github.com/OpenAPITools/openapi-generator-cli#use-docker-instead-of-running-java-locally) --- ##### `version`^Optional ```java public java.lang.String getVersion(); ``` - *Type:* java.lang.String - *Default:* 6.3.0 OpenAPI Generator version to use. Edit with caution - using the non-default version may result in broken generated code. --- ### OpenApiGeneratorCliConfigRepository Maven repository info for fetching the OpenAPI Generator jar. > [https://github.com/OpenAPITools/openapi-generator-cli#using-custom--private-maven-registry](https://github.com/OpenAPITools/openapi-generator-cli#using-custom--private-maven-registry) #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.OpenApiGeneratorCliConfigRepository; OpenApiGeneratorCliConfigRepository.builder() .downloadUrl(java.lang.String) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | downloadUrl | java.lang.String | Maven repository URL for downloading the OpenAPI Generator jar. | --- ##### `downloadUrl`^Required ```java public java.lang.String getDownloadUrl(); ``` - *Type:* java.lang.String Maven repository URL for downloading the OpenAPI Generator jar. This must specify the full url, and can include placeholders for the groupId, artifactId and versionName. For example: https://private.maven.intern/maven2/${groupId}/${artifactId}/${versionName}/${artifactId}-${versionName}.jar > [https://github.com/OpenAPITools/openapi-generator-cli#using-custom--private-maven-registry](https://github.com/OpenAPITools/openapi-generator-cli#using-custom--private-maven-registry) --- ### OpenApiModelOptions Options for the OpenAPI model. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.OpenApiModelOptions; OpenApiModelOptions.builder() .title(java.lang.String) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | title | java.lang.String | The title in the OpenAPI specification. | --- ##### `title`^Required ```java public java.lang.String getTitle(); ``` - *Type:* java.lang.String The title in the OpenAPI specification. --- ### OperationDetails Details about an API operation. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.OperationDetails; OperationDetails.builder() .method(java.lang.String) .path(java.lang.String) // .contentTypes(java.util.List) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | method | java.lang.String | The http method of this operation. | | path | java.lang.String | The path of this operation in the api. | | contentTypes | java.util.List | Content types accepted by this operation. | --- ##### `method`^Required ```java public java.lang.String getMethod(); ``` - *Type:* java.lang.String The http method of this operation. --- ##### `path`^Required ```java public java.lang.String getPath(); ``` - *Type:* java.lang.String The path of this operation in the api. --- ##### `contentTypes`^Optional ```java public java.util.List getContentTypes(); ``` - *Type:* java.util.List - *Default:* application/json Content types accepted by this operation. --- ### ProjectCollections Collections of projects managed by type-safe-api. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.ProjectCollections; ProjectCollections.builder() .documentation(java.util.List) .handlers(java.util.List) .infrastructure(java.util.List) .libraries(java.util.List) .model(java.util.List) .projects(java.util.List) .runtimes(java.util.List) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | documentation | java.util.List | Array of all documentation projects. | | handlers | java.util.List | Array of all handler projects. | | infrastructure | java.util.List | Array of all infrastructure projects. | | libraries | java.util.List | Array of all library projects. | | model | java.util.List | Array of all model projects. | | projects | java.util.List | Array of all projects managed by type-safe-api. | | runtimes | java.util.List | Array of all runtime projects. | --- ##### `documentation`^Required ```java public java.util.List getDocumentation(); ``` - *Type:* java.util.List Array of all documentation projects. --- ##### `handlers`^Required ```java public java.util.List getHandlers(); ``` - *Type:* java.util.List Array of all handler projects. --- ##### `infrastructure`^Required ```java public java.util.List getInfrastructure(); ``` - *Type:* java.util.List Array of all infrastructure projects. --- ##### `libraries`^Required ```java public java.util.List getLibraries(); ``` - *Type:* java.util.List Array of all library projects. --- ##### `model`^Required ```java public java.util.List getModel(); ``` - *Type:* java.util.List Array of all model projects. --- ##### `projects`^Required ```java public java.util.List getProjects(); ``` - *Type:* java.util.List Array of all projects managed by type-safe-api. --- ##### `runtimes`^Required ```java public java.util.List getRuntimes(); ``` - *Type:* java.util.List Array of all runtime projects. --- ### RuntimeConfiguration Configuration for generated runtime projects. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.RuntimeConfiguration; RuntimeConfiguration.builder() .languages(java.util.List) // .options(GeneratedRuntimeCodeOptions) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | languages | java.util.List<Language> | The languages that runtime projects will be generated in. | | options | GeneratedRuntimeCodeOptions | Options for the generated runtimes. | --- ##### `languages`^Required ```java public java.util.List getLanguages(); ``` - *Type:* java.util.List<Language> The languages that runtime projects will be generated in. These projects can be used to provide type safety for both client and server projects. --- ##### `options`^Optional ```java public GeneratedRuntimeCodeOptions getOptions(); ``` - *Type:* GeneratedRuntimeCodeOptions Options for the generated runtimes. Note that only options provided for the specified languages will apply. --- ### SerializedCorsOptions Cross-origin resource sharing options. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.SerializedCorsOptions; SerializedCorsOptions.builder() .allowHeaders(java.util.List) .allowMethods(java.util.List) .allowOrigins(java.util.List) .statusCode(java.lang.Number) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | allowHeaders | java.util.List | Headers to allow. | | allowMethods | java.util.List | HTTP methods to allow. | | allowOrigins | java.util.List | Origins to allow. | | statusCode | java.lang.Number | HTTP status code to be returned by preflight requests. | --- ##### `allowHeaders`^Required ```java public java.util.List getAllowHeaders(); ``` - *Type:* java.util.List Headers to allow. --- ##### `allowMethods`^Required ```java public java.util.List getAllowMethods(); ``` - *Type:* java.util.List HTTP methods to allow. --- ##### `allowOrigins`^Required ```java public java.util.List getAllowOrigins(); ``` - *Type:* java.util.List Origins to allow. --- ##### `statusCode`^Required ```java public java.lang.Number getStatusCode(); ``` - *Type:* java.lang.Number HTTP status code to be returned by preflight requests. --- ### SmithyBuildOptions Options for the smithy build files. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.SmithyBuildOptions; SmithyBuildOptions.builder() // .imports(java.util.List) // .plugins(java.util.Map>) // .additionalSources(java.util.List) // .ignoreMissingPlugins(java.lang.Boolean) // .maven(SmithyMavenConfiguration) // .projections(java.util.Map) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | imports | java.util.List | List of imports. | | plugins | java.util.Map> | Plugins keyed by plugin id. | | additionalSources | java.util.List | Paths to any additional model files or directories to be used as sources for the smithy build. | | ignoreMissingPlugins | java.lang.Boolean | If a plugin can't be found, Smithy will by default fail the build. | | maven | SmithyMavenConfiguration | Maven configuration for the Smithy build project, used to specify dependencies and repositories in the build.gradle and smithy-build.json files. | | projections | java.util.MapSmithyProjection> | Map of projections name to projection configurations https://awslabs.github.io/smithy/2.0/guides/building-models/build-config.html#projections. | --- ##### `imports`^Optional ```java public java.util.List getImports(); ``` - *Type:* java.util.List List of imports. --- ##### `plugins`^Optional ```java public java.util.Map> getPlugins(); ``` - *Type:* java.util.Map> Plugins keyed by plugin id. --- ##### `additionalSources`^Optional ```java public java.util.List getAdditionalSources(); ``` - *Type:* java.util.List Paths to any additional model files or directories to be used as sources for the smithy build. The src/main/smithy directory is always included. Paths must be relative to the model project directory. Absolute paths will be resolved as relative paths. --- ##### `ignoreMissingPlugins`^Optional ```java public java.lang.Boolean getIgnoreMissingPlugins(); ``` - *Type:* java.lang.Boolean - *Default:* no ignoreMissingPlugins set in the smithy-build.json file If a plugin can't be found, Smithy will by default fail the build. This setting can be set to true to allow the build to progress even if a plugin can't be found on the classpath. --- ##### `maven`^Optional ```java public SmithyMavenConfiguration getMaven(); ``` - *Type:* SmithyMavenConfiguration - *Default:* the default configuration required for Smithy to OpenAPI conversion Maven configuration for the Smithy build project, used to specify dependencies and repositories in the build.gradle and smithy-build.json files. --- ##### `projections`^Optional ```java public java.util.Map getProjections(); ``` - *Type:* java.util.MapSmithyProjection> - *Default:* no projections Map of projections name to projection configurations https://awslabs.github.io/smithy/2.0/guides/building-models/build-config.html#projections. --- ### SmithyCommon Properties common to smithy plugins and the root smithy build. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.SmithyCommon; SmithyCommon.builder() // .imports(java.util.List) // .plugins(java.util.Map>) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | imports | java.util.List | List of imports. | | plugins | java.util.Map> | Plugins keyed by plugin id. | --- ##### `imports`^Optional ```java public java.util.List getImports(); ``` - *Type:* java.util.List List of imports. --- ##### `plugins`^Optional ```java public java.util.Map> getPlugins(); ``` - *Type:* java.util.Map> Plugins keyed by plugin id. --- ### SmithyDefinitionOptions Options for a smithy build project. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.SmithyDefinitionOptions; SmithyDefinitionOptions.builder() .smithyOptions(SmithyModelOptions) // .handlerLanguages(java.util.List) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | smithyOptions | SmithyModelOptions | Smithy engine options. | | handlerLanguages | java.util.List<Language> | The languages users have specified for handler projects (if any). | --- ##### `smithyOptions`^Required ```java public SmithyModelOptions getSmithyOptions(); ``` - *Type:* SmithyModelOptions Smithy engine options. --- ##### `handlerLanguages`^Optional ```java public java.util.List getHandlerLanguages(); ``` - *Type:* java.util.List<Language> The languages users have specified for handler projects (if any). --- ### SmithyMavenConfiguration Configuration for smithy maven dependencies. #### Initializer ```java import software.aws.awsprototypingsdk.typesafeapi.SmithyMavenConfiguration; SmithyMavenConfiguration.builder() // .dependencies(java.util.List) // .repositoryUrls(java.util.List) .build(); ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | dependencies | java.util.List | The dependencies used in the build.gradle and smithy-build.json files eg. software.amazon.smithy:smithy-validation-model:1.28.0 The following required dependencies are always added: - software.amazon.smithy:smithy-cli:1.28.0 - software.amazon.smithy:smithy-model:1.28.0 - software.amazon.smithy:smithy-openapi:1.28.0 - software.amazon.smithy:smithy-aws-traits:1.28.0 You can however override the version of these dependencies if required. | | repositoryUrls | java.util.List | The repository urls used in the build.gradle and smithy-build.json files. | --- ##### `dependencies`^Optional ```java public java.util.List