projen 0.95.1__py3-none-any.whl → 0.95.2__py3-none-any.whl

projen/javascript/__init__.py

@@ -144,6 +144,7 @@ class Biome(
         assist: typing.Optional[builtins.bool] = None,
         biome_config: typing.Optional[typing.Union[_BiomeConfiguration_dd1a6c83, typing.Dict[builtins.str, typing.Any]]] = None,
         formatter: typing.Optional[builtins.bool] = None,
+        ignore_generated_files: typing.Optional[builtins.bool] = None,
         linter: typing.Optional[builtins.bool] = None,
         merge_arrays_in_configuration: typing.Optional[builtins.bool] = None,
         version: typing.Optional[builtins.str] = None,
@@ -153,6 +154,7 @@ class Biome(
         :param assist: (experimental) Enable code assist with recommended actions. Default: true
         :param biome_config: (experimental) Full Biome configuration. This configuration dictates the final outcome if value is set. For example, if the linter is disabled at the top-level, it can be enabled with ``biomeConfig.linter.enabled``.
         :param formatter: (experimental) Enable code formatter with recommended settings. Default: true
+        :param ignore_generated_files: (experimental) Automatically ignore all generated files. This prevents Biome from trying to format or lint files that are marked as generated, which would fail since generated files are typically read-only. Default: true
         :param linter: (experimental) Enable linting with recommended rules. Default: true
         :param merge_arrays_in_configuration: (experimental) Should arrays be merged or overwritten when creating Biome configuration. By default arrays are merged and duplicate values are removed Default: true
         :param version: (experimental) Version of Biome to use. Default: "^2"
@@ -166,6 +168,7 @@ class Biome(
             assist=assist,
             biome_config=biome_config,
             formatter=formatter,
+            ignore_generated_files=ignore_generated_files,
             linter=linter,
             merge_arrays_in_configuration=merge_arrays_in_configuration,
             version=version,
@@ -224,6 +227,7 @@ class Biome(
         "assist": "assist",
         "biome_config": "biomeConfig",
         "formatter": "formatter",
+        "ignore_generated_files": "ignoreGeneratedFiles",
         "linter": "linter",
         "merge_arrays_in_configuration": "mergeArraysInConfiguration",
         "version": "version",
@@ -236,6 +240,7 @@ class BiomeOptions:
         assist: typing.Optional[builtins.bool] = None,
         biome_config: typing.Optional[typing.Union[_BiomeConfiguration_dd1a6c83, typing.Dict[builtins.str, typing.Any]]] = None,
         formatter: typing.Optional[builtins.bool] = None,
+        ignore_generated_files: typing.Optional[builtins.bool] = None,
         linter: typing.Optional[builtins.bool] = None,
         merge_arrays_in_configuration: typing.Optional[builtins.bool] = None,
         version: typing.Optional[builtins.str] = None,
@@ -244,6 +249,7 @@ class BiomeOptions:
         :param assist: (experimental) Enable code assist with recommended actions. Default: true
         :param biome_config: (experimental) Full Biome configuration. This configuration dictates the final outcome if value is set. For example, if the linter is disabled at the top-level, it can be enabled with ``biomeConfig.linter.enabled``.
         :param formatter: (experimental) Enable code formatter with recommended settings. Default: true
+        :param ignore_generated_files: (experimental) Automatically ignore all generated files. This prevents Biome from trying to format or lint files that are marked as generated, which would fail since generated files are typically read-only. Default: true
         :param linter: (experimental) Enable linting with recommended rules. Default: true
         :param merge_arrays_in_configuration: (experimental) Should arrays be merged or overwritten when creating Biome configuration. By default arrays are merged and duplicate values are removed Default: true
         :param version: (experimental) Version of Biome to use. Default: "^2"
@@ -257,6 +263,7 @@ class BiomeOptions:
             check_type(argname="argument assist", value=assist, expected_type=type_hints["assist"])
             check_type(argname="argument biome_config", value=biome_config, expected_type=type_hints["biome_config"])
             check_type(argname="argument formatter", value=formatter, expected_type=type_hints["formatter"])
+            check_type(argname="argument ignore_generated_files", value=ignore_generated_files, expected_type=type_hints["ignore_generated_files"])
             check_type(argname="argument linter", value=linter, expected_type=type_hints["linter"])
             check_type(argname="argument merge_arrays_in_configuration", value=merge_arrays_in_configuration, expected_type=type_hints["merge_arrays_in_configuration"])
             check_type(argname="argument version", value=version, expected_type=type_hints["version"])
@@ -267,6 +274,8 @@ class BiomeOptions:
             self._values["biome_config"] = biome_config
         if formatter is not None:
             self._values["formatter"] = formatter
+        if ignore_generated_files is not None:
+            self._values["ignore_generated_files"] = ignore_generated_files
         if linter is not None:
             self._values["linter"] = linter
         if merge_arrays_in_configuration is not None:
@@ -308,6 +317,20 @@ class BiomeOptions:
         result = self._values.get("formatter")
         return typing.cast(typing.Optional[builtins.bool], result)
 
+    @builtins.property
+    def ignore_generated_files(self) -> typing.Optional[builtins.bool]:
+        '''(experimental) Automatically ignore all generated files.
+
+        This prevents Biome from trying to format or lint files that are marked as generated,
+        which would fail since generated files are typically read-only.
+
+        :default: true
+
+        :stability: experimental
+        '''
+        result = self._values.get("ignore_generated_files")
+        return typing.cast(typing.Optional[builtins.bool], result)
+
     @builtins.property
     def linter(self) -> typing.Optional[builtins.bool]:
         '''(experimental) Enable linting with recommended rules.
@@ -5761,6 +5784,7 @@ class NodeProject(
         publish_tasks: typing.Optional[builtins.bool] = None,
         releasable_commits: typing.Optional[_ReleasableCommits_d481ce10] = None,
         release_branches: typing.Optional[typing.Mapping[builtins.str, typing.Union[_BranchOptions_13663d08, typing.Dict[builtins.str, typing.Any]]]] = None,
+        release_environment: typing.Optional[builtins.str] = None,
         release_every_commit: typing.Optional[builtins.bool] = None,
         release_failure_issue: typing.Optional[builtins.bool] = None,
         release_failure_issue_label: typing.Optional[builtins.str] = None,
@@ -5895,6 +5919,7 @@ class NodeProject(
         :param publish_tasks: (experimental) 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. Default: false
         :param releasable_commits: (experimental) Find commits that should be considered releasable Used to decide if a release is required. Default: ReleasableCommits.everyCommit()
         :param release_branches: (experimental) 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. Default: - no additional branches are used for release. you can use ``addBranch()`` to add additional branches.
+        :param release_environment: (experimental) The GitHub Actions environment used for the release. This can be used to add an explicit approval step to the release or limit who can initiate a release through environment protection rules. When multiple artifacts are released, the environment can be overwritten on a per artifact basis. Default: - no environment used, unless set at the artifact level
         :param release_every_commit: (deprecated) Automatically release new versions every commit to one of branches in ``releaseBranches``. Default: true
         :param release_failure_issue: (experimental) Create a github issue on every failed publishing task. Default: false
         :param release_failure_issue_label: (experimental) The label to apply to issues indicating publish failures. Only applies if ``releaseFailureIssue`` is true. Default: "failed-release"
@@ -6031,6 +6056,7 @@ class NodeProject(
             publish_tasks=publish_tasks,
             releasable_commits=releasable_commits,
             release_branches=release_branches,
+            release_environment=release_environment,
             release_every_commit=release_every_commit,
             release_failure_issue=release_failure_issue,
             release_failure_issue_label=release_failure_issue_label,
@@ -6621,6 +6647,7 @@ class NodeProject(
         "publish_tasks": "publishTasks",
         "releasable_commits": "releasableCommits",
         "release_branches": "releaseBranches",
+        "release_environment": "releaseEnvironment",
         "release_every_commit": "releaseEveryCommit",
         "release_failure_issue": "releaseFailureIssue",
         "release_failure_issue_label": "releaseFailureIssueLabel",
@@ -6763,6 +6790,7 @@ class NodeProjectOptions(
         publish_tasks: typing.Optional[builtins.bool] = None,
         releasable_commits: typing.Optional[_ReleasableCommits_d481ce10] = None,
         release_branches: typing.Optional[typing.Mapping[builtins.str, typing.Union[_BranchOptions_13663d08, typing.Dict[builtins.str, typing.Any]]]] = None,
+        release_environment: typing.Optional[builtins.str] = None,
         release_every_commit: typing.Optional[builtins.bool] = None,
         release_failure_issue: typing.Optional[builtins.bool] = None,
         release_failure_issue_label: typing.Optional[builtins.str] = None,
@@ -6897,6 +6925,7 @@ class NodeProjectOptions(
         :param publish_tasks: (experimental) 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. Default: false
         :param releasable_commits: (experimental) Find commits that should be considered releasable Used to decide if a release is required. Default: ReleasableCommits.everyCommit()
         :param release_branches: (experimental) 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. Default: - no additional branches are used for release. you can use ``addBranch()`` to add additional branches.
+        :param release_environment: (experimental) The GitHub Actions environment used for the release. This can be used to add an explicit approval step to the release or limit who can initiate a release through environment protection rules. When multiple artifacts are released, the environment can be overwritten on a per artifact basis. Default: - no environment used, unless set at the artifact level
         :param release_every_commit: (deprecated) Automatically release new versions every commit to one of branches in ``releaseBranches``. Default: true
         :param release_failure_issue: (experimental) Create a github issue on every failed publishing task. Default: false
         :param release_failure_issue_label: (experimental) The label to apply to issues indicating publish failures. Only applies if ``releaseFailureIssue`` is true. Default: "failed-release"
@@ -7088,6 +7117,7 @@ class NodeProjectOptions(
             check_type(argname="argument publish_tasks", value=publish_tasks, expected_type=type_hints["publish_tasks"])
             check_type(argname="argument releasable_commits", value=releasable_commits, expected_type=type_hints["releasable_commits"])
             check_type(argname="argument release_branches", value=release_branches, expected_type=type_hints["release_branches"])
+            check_type(argname="argument release_environment", value=release_environment, expected_type=type_hints["release_environment"])
             check_type(argname="argument release_every_commit", value=release_every_commit, expected_type=type_hints["release_every_commit"])
             check_type(argname="argument release_failure_issue", value=release_failure_issue, expected_type=type_hints["release_failure_issue"])
             check_type(argname="argument release_failure_issue_label", value=release_failure_issue_label, expected_type=type_hints["release_failure_issue_label"])
@@ -7301,6 +7331,8 @@ class NodeProjectOptions(
             self._values["releasable_commits"] = releasable_commits
         if release_branches is not None:
             self._values["release_branches"] = release_branches
+        if release_environment is not None:
+            self._values["release_environment"] = release_environment
         if release_every_commit is not None:
             self._values["release_every_commit"] = release_every_commit
         if release_failure_issue is not None:
@@ -8438,6 +8470,23 @@ class NodeProjectOptions(
         result = self._values.get("release_branches")
         return typing.cast(typing.Optional[typing.Mapping[builtins.str, _BranchOptions_13663d08]], result)
 
+    @builtins.property
+    def release_environment(self) -> typing.Optional[builtins.str]:
+        '''(experimental) The GitHub Actions environment used for the release.
+
+        This can be used to add an explicit approval step to the release
+        or limit who can initiate a release through environment protection rules.
+
+        When multiple artifacts are released, the environment can be overwritten
+        on a per artifact basis.
+
+        :default: - no environment used, unless set at the artifact level
+
+        :stability: experimental
+        '''
+        result = self._values.get("release_environment")
+        return typing.cast(typing.Optional[builtins.str], result)
+
     @builtins.property
     def release_every_commit(self) -> typing.Optional[builtins.bool]:
         '''(deprecated) Automatically release new versions every commit to one of branches in ``releaseBranches``.
@@ -16136,6 +16185,7 @@ def _typecheckingstub__9f2264088409136f62af7e2ac4488206c06c3b9a69056be8b9ead20ab
     assist: typing.Optional[builtins.bool] = None,
     biome_config: typing.Optional[typing.Union[_BiomeConfiguration_dd1a6c83, typing.Dict[builtins.str, typing.Any]]] = None,
     formatter: typing.Optional[builtins.bool] = None,
+    ignore_generated_files: typing.Optional[builtins.bool] = None,
     linter: typing.Optional[builtins.bool] = None,
     merge_arrays_in_configuration: typing.Optional[builtins.bool] = None,
     version: typing.Optional[builtins.str] = None,
@@ -16160,6 +16210,7 @@ def _typecheckingstub__b53a2988afa9afc23bda2fe96e2de8ffaff18ab919e00b69a6c8d3d22
     assist: typing.Optional[builtins.bool] = None,
     biome_config: typing.Optional[typing.Union[_BiomeConfiguration_dd1a6c83, typing.Dict[builtins.str, typing.Any]]] = None,
     formatter: typing.Optional[builtins.bool] = None,
+    ignore_generated_files: typing.Optional[builtins.bool] = None,
     linter: typing.Optional[builtins.bool] = None,
     merge_arrays_in_configuration: typing.Optional[builtins.bool] = None,
     version: typing.Optional[builtins.str] = None,
@@ -16963,6 +17014,7 @@ def _typecheckingstub__05c2eb8aa04095bbe6af788737363089516ccd341e3a6624f153e8ff7
     publish_tasks: typing.Optional[builtins.bool] = None,
     releasable_commits: typing.Optional[_ReleasableCommits_d481ce10] = None,
     release_branches: typing.Optional[typing.Mapping[builtins.str, typing.Union[_BranchOptions_13663d08, typing.Dict[builtins.str, typing.Any]]]] = None,
+    release_environment: typing.Optional[builtins.str] = None,
     release_every_commit: typing.Optional[builtins.bool] = None,
     release_failure_issue: typing.Optional[builtins.bool] = None,
     release_failure_issue_label: typing.Optional[builtins.str] = None,