From 4a3022c1cac3cfd2b100a4f31b4531db858a014b Mon Sep 17 00:00:00 2001 From: "Worker Pants (Pantsbuild GitHub Automation Bot)" <133242086+WorkerPants@users.noreply.github.com> Date: Wed, 31 Jul 2024 04:18:07 -0400 Subject: [PATCH] Update docs site for version 2.20.3 (#241) Docs from https://github.com/pantsbuild/pants/releases/tag/release_2.20.3 --- .../version-2.20/reference/help-all.json | 1428 +++++++++-------- .../subsystems/google-java-format.mdx | 2 +- .../reference/subsystems/jarjar.mdx | 2 +- .../reference/subsystems/java-avro.mdx | 2 +- .../reference/subsystems/junit.mdx | 2 +- .../reference/subsystems/ktlint.mdx | 2 +- .../subsystems/openapi-generator.mdx | 2 +- .../subsystems/protobuf-java-grpc.mdx | 2 +- .../reference/subsystems/scalafmt.mdx | 2 +- .../reference/subsystems/scalapb.mdx | 2 +- .../reference/subsystems/scalatest.mdx | 2 +- .../reference/subsystems/scrooge.mdx | 2 +- .../reference/targets/jvm_artifact.mdx | 2 +- .../reference/targets/pants_requirements.mdx | 2 +- .../reference/targets/python_requirement.mdx | 4 +- .../reference/targets/scala_artifact.mdx | 2 +- 16 files changed, 736 insertions(+), 724 deletions(-) diff --git a/versioned_docs/version-2.20/reference/help-all.json b/versioned_docs/version-2.20/reference/help-all.json index 0f04c3d3..32cd6a10 100644 --- a/versioned_docs/version-2.20/reference/help-all.json +++ b/versioned_docs/version-2.20/reference/help-all.json @@ -10882,7 +10882,7 @@ ], "env_var": "PANTS_GOOGLE_JAVA_FORMAT_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/java/lint/google_java_format/google_java_format.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=google-java-format`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/java/lint/google_java_format/google_java_format.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=google-java-format`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -14208,7 +14208,7 @@ ], "env_var": "PANTS_JARJAR_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/jvm/shading/jarjar.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=jarjar`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/jvm/shading/jarjar.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=jarjar`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -14528,7 +14528,7 @@ ], "env_var": "PANTS_JAVA_AVRO_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/codegen/avro/java/avro-tools.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=java-avro`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/codegen/avro/java/avro-tools.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=java-avro`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -14892,7 +14892,7 @@ ], "env_var": "PANTS_JUNIT_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/jvm/test/junit.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=junit`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/jvm/test/junit.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=junit`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -15694,7 +15694,7 @@ ], "env_var": "PANTS_KTLINT_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/kotlin/lint/ktlint/ktlint.lock for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=ktlint`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/kotlin/lint/ktlint/ktlint.lock for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=ktlint`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -18423,7 +18423,7 @@ ], "env_var": "PANTS_OPENAPI_GENERATOR_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/openapi/subsystems/openapi_generator.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=openapi-generator`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/openapi/subsystems/openapi_generator.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=openapi-generator`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -20276,7 +20276,7 @@ ], "env_var": "PANTS_PROTOBUF_JAVA_GRPC_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/codegen/protobuf/java/grpc-java.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=protobuf-java-grpc`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/codegen/protobuf/java/grpc-java.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=protobuf-java-grpc`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -26093,7 +26093,7 @@ "details": "", "rank": "HARDCODED", "value": { - "user-agent": "pants/2.20.3rc1" + "user-agent": "pants/2.20.3" } } ] @@ -26469,7 +26469,7 @@ "details": "", "rank": "HARDCODED", "value": { - "user-agent": "pants/2.20.3rc1" + "user-agent": "pants/2.20.3" } } ] @@ -27613,7 +27613,7 @@ ], "env_var": "PANTS_SCALAFMT_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/scala/lint/scalafmt/scalafmt.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalafmt`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/scala/lint/scalafmt/scalafmt.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalafmt`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -27896,7 +27896,7 @@ ], "env_var": "PANTS_SCALAPB_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/codegen/protobuf/scala/scalapbc.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalapb`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/codegen/protobuf/scala/scalapbc.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalapb`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -28096,7 +28096,7 @@ ], "env_var": "PANTS_SCALATEST_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/scala/subsystems/scalatest.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalatest`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/scala/subsystems/scalatest.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalatest`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -28799,7 +28799,7 @@ ], "env_var": "PANTS_SCROOGE_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/codegen/thrift/scrooge/scrooge.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scrooge`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/codegen/thrift/scrooge/scrooge.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scrooge`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -34009,12 +34009,12 @@ { "details": null, "rank": "HARDCODED", - "value": "2.20.3rc1" + "value": "2.20.3" }, { "details": "from env var PANTS_VERSION", "rank": "ENVIRONMENT", - "value": "2.20.3rc1" + "value": "2.20.3" } ] } @@ -35044,22 +35044,22 @@ "name_to_api_type_info": { "abc.EnvironmentAware": { "consumed_by_rules": [ - "pants.backend.python.providers.pyenv.rules.get_pyenv_install_info" + "pants.jvm.jdk_rules.prepare_jdk_environment" ], "dependencies": [ "pants.backend.experimental.javascript", "pants.core" ], "dependents": [ - "pants.backend.python.providers.experimental.pyenv" + "pants.backend.experimental.java" ], "documentation": null, "is_union": false, "module": "abc", "name": "EnvironmentAware", - "provider": "pants.backend.python.providers.experimental.pyenv", + "provider": "pants.backend.experimental.java", "returned_by_rules": [ - "construct_env_aware_scope_pyenv_python_provider" + "construct_env_aware_scope_jvm" ], "union_members": [], "union_type": null, @@ -58530,19 +58530,19 @@ }, "pants.core.goals.fix.Batch": { "consumed_by_rules": [ - "pants.backend.cc.lint.clangformat.rules.clangformat_fmt" + "pants.backend.openapi.lint.openapi_format.rules.run_openapi_format" ], "dependencies": [ "pants.core" ], "dependents": [ - "pants.backend.experimental.cc.lint.clangformat" + "pants.backend.experimental.openapi.lint.openapi_format" ], "documentation": "Batch(tool_name: 'str', elements: 'tuple[PartitionElementT, ...]', partition_metadata: 'PartitionMetadataT', snapshot: 'Snapshot')", "is_union": true, "module": "pants.core.goals.fix", "name": "Batch", - "provider": "pants.backend.experimental.cc.lint.clangformat", + "provider": "pants.backend.experimental.openapi.lint.openapi_format", "returned_by_rules": [], "union_members": [], "union_type": "Batch", @@ -59433,19 +59433,19 @@ }, "pants.core.goals.lint.Batch": { "consumed_by_rules": [ - "pants.backend.project_info.regex_lint.lint_with_regex_patterns" + "pants.backend.tools.yamllint.rules.run_yamllint" ], "dependencies": [ "pants.core" ], "dependents": [ - "pants.backend.project_info" + "pants.backend.experimental.tools.yamllint" ], "documentation": null, "is_union": true, "module": "pants.core.goals.lint", "name": "Batch", - "provider": "pants.backend.project_info", + "provider": "pants.backend.experimental.tools.yamllint", "returned_by_rules": [], "union_members": [], "union_type": "Batch", @@ -59622,19 +59622,19 @@ }, "pants.core.goals.lint.PartitionRequest": { "consumed_by_rules": [ - "pants.backend.tools.taplo.rules.partition_inputs" + "pants.core.util_rules.partitions._single_partition_field_set_rules.partitioner_HadolintRequest" ], "dependencies": [ "pants.core" ], "dependents": [ - "pants.backend.tools.taplo" + "pants.backend.docker.lint.hadolint" ], "documentation": null, "is_union": true, "module": "pants.core.goals.lint", "name": "PartitionRequest", - "provider": "pants.backend.tools.taplo", + "provider": "pants.backend.docker.lint.hadolint", "returned_by_rules": [], "union_members": [], "union_type": "PartitionRequest", @@ -60876,24 +60876,37 @@ ] }, "pants.core.goals.test.PartitionRequest": { - "consumed_by_rules": [ - "pants.core.util_rules.partitions._partition_per_input_field_set_rules.partitioner_ScalatestTestRequest" - ], - "dependencies": [ - "pants.core" - ], + "consumed_by_rules": [], + "dependencies": [], "dependents": [ - "pants.backend.experimental.scala" + "pants.backend.experimental.go", + "pants.backend.experimental.helm", + "pants.backend.experimental.java", + "pants.backend.experimental.javascript", + "pants.backend.experimental.scala", + "pants.backend.python", + "pants.backend.shell" ], "documentation": null, "is_union": true, "module": "pants.core.goals.test", "name": "PartitionRequest", - "provider": "pants.backend.experimental.scala", + "provider": "pants.core", "returned_by_rules": [], - "union_members": [], - "union_type": "PartitionRequest", - "used_in_rules": [] + "union_members": [ + "PartitionRequest", + "PartitionRequest", + "PartitionRequest", + "PartitionRequest", + "PartitionRequest", + "PartitionRequest", + "PartitionRequest", + "PartitionRequest" + ], + "union_type": null, + "used_in_rules": [ + "pants.core.goals.test.run_tests" + ] }, "pants.core.goals.test.Test": { "consumed_by_rules": [], @@ -62503,7 +62516,7 @@ "is_union": false, "module": "pants.core.util_rules.environments", "name": "OptionField", - "provider": "pants.backend.shell", + "provider": "pants.backend.experimental.go", "returned_by_rules": [], "union_members": [], "union_type": "PluginField", @@ -63838,19 +63851,19 @@ }, "pants.core.util_rules.wrap_source.GenerateWrapSourceSourcesRequest": { "consumed_by_rules": [ - "pants.core.util_rules.wrap_source.wrap_source_rule_and_target.wrap_source_ScalaSourceField" + "pants.core.util_rules.wrap_source.wrap_source_rule_and_target.wrap_source_KotlinSourceField" ], "dependencies": [ "pants.engine.target" ], "dependents": [ - "pants.backend.experimental.scala" + "pants.backend.experimental.kotlin" ], "documentation": null, "is_union": false, "module": "pants.core.util_rules.wrap_source", "name": "GenerateWrapSourceSourcesRequest", - "provider": "pants.backend.experimental.scala", + "provider": "pants.backend.experimental.kotlin", "returned_by_rules": [], "union_members": [], "union_type": "GenerateSourcesRequest", @@ -66794,7 +66807,7 @@ "consumed_by_rules": [], "dependencies": [], "dependents": [ - "pants.backend.experimental.codegen.avro.java" + "pants.backend.experimental.kotlin.lint.ktlint" ], "documentation": null, "is_union": true, @@ -66803,8 +66816,7 @@ "provider": "pants.engine.target", "returned_by_rules": [], "union_members": [ - "PrefixedJvmJdkField", - "PrefixedJvmResolveField" + "SkipKtlintField" ], "union_type": null, "used_in_rules": [] @@ -70001,7 +70013,7 @@ "consumed_by_rules": [], "dependencies": [], "dependents": [ - "pants.backend.experimental.docker.podman" + "pants.backend.python" ], "documentation": null, "is_union": true, @@ -70010,7 +70022,7 @@ "provider": "pants.option.subsystem", "returned_by_rules": [], "union_members": [ - "ExperimentalPodmanOptions" + "ExportPluginOptions" ], "union_type": null, "used_in_rules": [] @@ -88748,25 +88760,41 @@ "type_hint": "str | None" }, { - "alias": "system_binaries_system_binary_paths", + "alias": "jvm_global_options", "default": null, - "description": "Overrides the default value from the option `[system-binaries].system_binary_paths` when this environment target is active.", + "description": "Overrides the default value from the option `[jvm].global_options` when this environment target is active.", + "provider": "pants.backend.experimental.java", + "required": false, + "type_hint": "Iterable[str] | None" + }, + { + "alias": "python_bootstrap_names", + "default": null, + "description": "Overrides the default value from the option `[python-bootstrap].names` when this environment target is active.", "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_go_search_paths", + "alias": "docker_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[golang].go_search_paths` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[docker].executable_search_paths` when this environment target is active.", + "provider": "pants.backend.docker", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "nodejs_search_path", + "alias": "python_native_code_cpp_flags", "default": null, - "description": "Overrides the default value from the option `[nodejs].search_path` when this environment target is active.", + "description": "Overrides the default value from the option `[python-native-code].cpp_flags` when this environment target is active.", + "provider": "pants.core", + "required": false, + "type_hint": "Iterable[str] | None" + }, + { + "alias": "nodejs_corepack_env_vars", + "default": null, + "description": "Overrides the default value from the option `[nodejs].corepack_env_vars` when this environment target is active.", "provider": "pants.backend.experimental.javascript", "required": false, "type_hint": "Iterable[str] | None" @@ -88780,17 +88808,17 @@ "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_tool_search_paths", + "alias": "test_extra_env_vars", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_tool_search_paths` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[test].extra_env_vars` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_bootstrap_names", + "alias": "python_bootstrap_search_path", "default": null, - "description": "Overrides the default value from the option `[python-bootstrap].names` when this environment target is active.", + "description": "Overrides the default value from the option `[python-bootstrap].search_path` when this environment target is active.", "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" @@ -88804,44 +88832,36 @@ "type_hint": "str | None" }, { - "alias": "docker_env_vars", - "default": null, - "description": "Overrides the default value from the option `[docker].env_vars` when this environment target is active.", - "provider": "pants.backend.docker", - "required": false, - "type_hint": "Iterable[str] | None" - }, - { - "alias": "test_extra_env_vars", + "alias": "nodejs_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[test].extra_env_vars` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[nodejs].executable_search_paths` when this environment target is active.", + "provider": "pants.backend.experimental.javascript", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_gcc_binary_name", + "alias": "golang_cgo_cxx_flags", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_gcc_binary_name` when this environment target is active.", + "description": "Overrides the default value from the option `[golang].cgo_cxx_flags` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, - "type_hint": "str | None" + "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_cxx_flags", + "alias": "go_generate_env_vars", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_cxx_flags` when this environment target is active.", + "description": "Overrides the default value from the option `[go-generate].env_vars` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "docker_executable_search_paths", + "alias": "golang_cgo_gcc_binary_name", "default": null, - "description": "Overrides the default value from the option `[docker].executable_search_paths` when this environment target is active.", - "provider": "pants.backend.docker", + "description": "Overrides the default value from the option `[golang].cgo_gcc_binary_name` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, - "type_hint": "Iterable[str] | None" + "type_hint": "str | None" }, { "alias": "golang_external_linker_binary_name", @@ -88852,74 +88872,74 @@ "type_hint": "str | None" }, { - "alias": "jvm_global_options", + "alias": "golang_cgo_tool_search_paths", "default": null, - "description": "Overrides the default value from the option `[jvm].global_options` when this environment target is active.", - "provider": "pants.backend.experimental.java", + "description": "Overrides the default value from the option `[golang].cgo_tool_search_paths` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_native_code_ld_flags", + "alias": "system_binaries_system_binary_paths", "default": null, - "description": "Overrides the default value from the option `[python-native-code].ld_flags` when this environment target is active.", + "description": "Overrides the default value from the option `[system-binaries].system_binary_paths` when this environment target is active.", "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_subprocess_env_vars", + "alias": "golang_go_search_paths", "default": null, - "description": "Overrides the default value from the option `[golang].subprocess_env_vars` when this environment target is active.", + "description": "Overrides the default value from the option `[golang].go_search_paths` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "nodejs_executable_search_paths", + "alias": "nodejs_search_path", "default": null, - "description": "Overrides the default value from the option `[nodejs].executable_search_paths` when this environment target is active.", + "description": "Overrides the default value from the option `[nodejs].search_path` when this environment target is active.", "provider": "pants.backend.experimental.javascript", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "nodejs_corepack_env_vars", + "alias": "golang_subprocess_env_vars", "default": null, - "description": "Overrides the default value from the option `[nodejs].corepack_env_vars` when this environment target is active.", - "provider": "pants.backend.experimental.javascript", + "description": "Overrides the default value from the option `[golang].subprocess_env_vars` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_bootstrap_search_path", + "alias": "golang_cgo_fortran_flags", "default": null, - "description": "Overrides the default value from the option `[python-bootstrap].search_path` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[golang].cgo_fortran_flags` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "shell_setup_executable_search_paths", + "alias": "python_native_code_ld_flags", "default": null, - "description": "Overrides the default value from the option `[shell-setup].executable_search_paths` when this environment target is active.", - "provider": "pants.backend.shell", + "description": "Overrides the default value from the option `[python-native-code].ld_flags` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_native_code_cpp_flags", + "alias": "golang_cgo_linker_flags", "default": null, - "description": "Overrides the default value from the option `[python-native-code].cpp_flags` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[golang].cgo_linker_flags` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "subprocess_environment_env_vars", + "alias": "shell_setup_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[subprocess-environment].env_vars` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[shell-setup].executable_search_paths` when this environment target is active.", + "provider": "pants.backend.shell", "required": false, "type_hint": "Iterable[str] | None" }, @@ -88932,50 +88952,42 @@ "type_hint": "str | None" }, { - "alias": "apache_thrift_thrift_search_paths", + "alias": "pyenv_python_provider_installation_extra_env_vars", "default": null, - "description": "Overrides the default value from the option `[apache-thrift].thrift_search_paths` when this environment target is active.", - "provider": "pants.backend.codegen.thrift.apache.python", + "description": "Overrides the default value from the option `[pyenv-python-provider].installation_extra_env_vars` when this environment target is active.", + "provider": "pants.backend.python.providers.experimental.pyenv", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "go_generate_env_vars", + "alias": "golang_cgo_c_flags", "default": null, - "description": "Overrides the default value from the option `[go-generate].env_vars` when this environment target is active.", + "description": "Overrides the default value from the option `[golang].cgo_c_flags` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "pyenv_python_provider_installation_extra_env_vars", - "default": null, - "description": "Overrides the default value from the option `[pyenv-python-provider].installation_extra_env_vars` when this environment target is active.", - "provider": "pants.backend.python.providers.experimental.pyenv", - "required": false, - "type_hint": "Iterable[str] | None" - }, - { - "alias": "golang_cgo_fortran_flags", + "alias": "docker_env_vars", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_fortran_flags` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[docker].env_vars` when this environment target is active.", + "provider": "pants.backend.docker", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_linker_flags", + "alias": "apache_thrift_thrift_search_paths", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_linker_flags` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[apache-thrift].thrift_search_paths` when this environment target is active.", + "provider": "pants.backend.codegen.thrift.apache.python", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_c_flags", + "alias": "subprocess_environment_env_vars", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_c_flags` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[subprocess-environment].env_vars` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" } @@ -89915,6 +89927,14 @@ "required": false, "type_hint": "bool" }, + { + "alias": "skip_golangci_lint", + "default": "False", + "description": "If true, don't run `golangci-lint` on this target's code.", + "provider": "pants.backend.experimental.go.lint.golangci_lint", + "required": false, + "type_hint": "bool" + }, { "alias": "skip_gofmt", "default": "False", @@ -89930,14 +89950,6 @@ "provider": "pants.backend.experimental.go.lint.vet", "required": false, "type_hint": "bool" - }, - { - "alias": "skip_golangci_lint", - "default": "False", - "description": "If true, don't run `golangci-lint` on this target's code.", - "provider": "pants.backend.experimental.go.lint.golangci_lint", - "required": false, - "type_hint": "bool" } ], "provider": "pants.backend.experimental.go", @@ -90147,38 +90159,6 @@ "required": false, "type_hint": "bool" }, - { - "alias": "kubeconform_strict", - "default": null, - "description": "Run Kubeconform in strict mode.", - "provider": "pants.backend.experimental.helm.check.kubeconform", - "required": false, - "type_hint": "bool | None" - }, - { - "alias": "kubeconform_ignore_sources", - "default": null, - "description": "Regular expression patterns specifying paths to ignore.", - "provider": "pants.backend.experimental.helm.check.kubeconform", - "required": false, - "type_hint": "Iterable[str] | None" - }, - { - "alias": "kubeconform_kubernetes_version", - "default": null, - "description": "Kubernetes version to use for the validation.", - "provider": "pants.backend.experimental.helm.check.kubeconform", - "required": false, - "type_hint": "str | None" - }, - { - "alias": "kubeconform_ignore_missing_schemas", - "default": null, - "description": "Whether to fail if there are missing schemas for custom resources.", - "provider": "pants.backend.experimental.helm.check.kubeconform", - "required": false, - "type_hint": "bool | None" - }, { "alias": "kubeconform_reject_kinds", "default": null, @@ -90202,6 +90182,38 @@ "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, "type_hint": "bool" + }, + { + "alias": "kubeconform_strict", + "default": null, + "description": "Run Kubeconform in strict mode.", + "provider": "pants.backend.experimental.helm.check.kubeconform", + "required": false, + "type_hint": "bool | None" + }, + { + "alias": "kubeconform_ignore_missing_schemas", + "default": null, + "description": "Whether to fail if there are missing schemas for custom resources.", + "provider": "pants.backend.experimental.helm.check.kubeconform", + "required": false, + "type_hint": "bool | None" + }, + { + "alias": "kubeconform_kubernetes_version", + "default": null, + "description": "Kubernetes version to use for the validation.", + "provider": "pants.backend.experimental.helm.check.kubeconform", + "required": false, + "type_hint": "str | None" + }, + { + "alias": "kubeconform_ignore_sources", + "default": null, + "description": "Regular expression patterns specifying paths to ignore.", + "provider": "pants.backend.experimental.helm.check.kubeconform", + "required": false, + "type_hint": "Iterable[str] | None" } ], "provider": "pants.backend.experimental.helm", @@ -90316,60 +90328,60 @@ "type_hint": "bool" }, { - "alias": "kubeconform_strict", + "alias": "kubeconform_reject_kinds", "default": null, - "description": "Run Kubeconform in strict mode.", + "description": "List of kinds or GVKs to reject.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, - "type_hint": "bool | None" + "type_hint": "Iterable[str] | None" }, { - "alias": "kubeconform_ignore_sources", + "alias": "kubeconform_skip_kinds", "default": null, - "description": "Regular expression patterns specifying paths to ignore.", + "description": "List of kinds or GVKs to ignore.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "kubeconform_kubernetes_version", - "default": null, - "description": "Kubernetes version to use for the validation.", + "alias": "skip_kubeconform", + "default": "False", + "description": "If set to true, do not run any kubeconform checking in this Helm target when running `pants check`.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, - "type_hint": "str | None" + "type_hint": "bool" }, { - "alias": "kubeconform_ignore_missing_schemas", + "alias": "kubeconform_strict", "default": null, - "description": "Whether to fail if there are missing schemas for custom resources.", + "description": "Run Kubeconform in strict mode.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, "type_hint": "bool | None" }, { - "alias": "kubeconform_reject_kinds", + "alias": "kubeconform_ignore_missing_schemas", "default": null, - "description": "List of kinds or GVKs to reject.", + "description": "Whether to fail if there are missing schemas for custom resources.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, - "type_hint": "Iterable[str] | None" + "type_hint": "bool | None" }, { - "alias": "kubeconform_skip_kinds", + "alias": "kubeconform_kubernetes_version", "default": null, - "description": "List of kinds or GVKs to ignore.", + "description": "Kubernetes version to use for the validation.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, - "type_hint": "Iterable[str] | None" + "type_hint": "str | None" }, { - "alias": "skip_kubeconform", - "default": "False", - "description": "If set to true, do not run any kubeconform checking in this Helm target when running `pants check`.", + "alias": "kubeconform_ignore_sources", + "default": null, + "description": "Regular expression patterns specifying paths to ignore.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, - "type_hint": "bool" + "type_hint": "Iterable[str] | None" } ], "provider": "pants.backend.experimental.helm", @@ -91102,7 +91114,7 @@ { "alias": "packages", "default": null, - "description": "The JVM packages this artifact provides for the purposes of dependency inference.\n\nFor example, the JVM artifact `junit:junit` might provide `[\"org.junit.**\"]`.\n\nUsually you can leave this field off. If unspecified, Pants will fall back to the `[java-infer].third_party_import_mapping`, then to a built in mapping (https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/jvm/dependency_inference/jvm_artifact_mappings.py), and then finally it will default to the normalized `group` of the artifact. For example, in the absence of any other mapping the artifact `io.confluent:common-config` would default to providing `[\"io.confluent.**\"]`.\n\nThe package path may be made recursive to match symbols in subpackages by adding `.**` to the end of the package path. For example, specify `[\"org.junit.**\"]` to infer a dependency on the artifact for any file importing a symbol from `org.junit` or its subpackages.", + "description": "The JVM packages this artifact provides for the purposes of dependency inference.\n\nFor example, the JVM artifact `junit:junit` might provide `[\"org.junit.**\"]`.\n\nUsually you can leave this field off. If unspecified, Pants will fall back to the `[java-infer].third_party_import_mapping`, then to a built in mapping (https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/jvm/dependency_inference/jvm_artifact_mappings.py), and then finally it will default to the normalized `group` of the artifact. For example, in the absence of any other mapping the artifact `io.confluent:common-config` would default to providing `[\"io.confluent.**\"]`.\n\nThe package path may be made recursive to match symbols in subpackages by adding `.**` to the end of the package path. For example, specify `[\"org.junit.**\"]` to infer a dependency on the artifact for any file importing a symbol from `org.junit` or its subpackages.", "provider": "", "required": false, "type_hint": "Iterable[str] | None" @@ -91724,25 +91736,41 @@ "type_hint": "str | None" }, { - "alias": "system_binaries_system_binary_paths", + "alias": "jvm_global_options", "default": null, - "description": "Overrides the default value from the option `[system-binaries].system_binary_paths` when this environment target is active.", + "description": "Overrides the default value from the option `[jvm].global_options` when this environment target is active.", + "provider": "pants.backend.experimental.java", + "required": false, + "type_hint": "Iterable[str] | None" + }, + { + "alias": "python_bootstrap_names", + "default": null, + "description": "Overrides the default value from the option `[python-bootstrap].names` when this environment target is active.", "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_go_search_paths", + "alias": "docker_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[golang].go_search_paths` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[docker].executable_search_paths` when this environment target is active.", + "provider": "pants.backend.docker", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "nodejs_search_path", + "alias": "python_native_code_cpp_flags", "default": null, - "description": "Overrides the default value from the option `[nodejs].search_path` when this environment target is active.", + "description": "Overrides the default value from the option `[python-native-code].cpp_flags` when this environment target is active.", + "provider": "pants.core", + "required": false, + "type_hint": "Iterable[str] | None" + }, + { + "alias": "nodejs_corepack_env_vars", + "default": null, + "description": "Overrides the default value from the option `[nodejs].corepack_env_vars` when this environment target is active.", "provider": "pants.backend.experimental.javascript", "required": false, "type_hint": "Iterable[str] | None" @@ -91756,17 +91784,17 @@ "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_tool_search_paths", + "alias": "test_extra_env_vars", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_tool_search_paths` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[test].extra_env_vars` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_bootstrap_names", + "alias": "python_bootstrap_search_path", "default": null, - "description": "Overrides the default value from the option `[python-bootstrap].names` when this environment target is active.", + "description": "Overrides the default value from the option `[python-bootstrap].search_path` when this environment target is active.", "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" @@ -91780,44 +91808,36 @@ "type_hint": "str | None" }, { - "alias": "docker_env_vars", - "default": null, - "description": "Overrides the default value from the option `[docker].env_vars` when this environment target is active.", - "provider": "pants.backend.docker", - "required": false, - "type_hint": "Iterable[str] | None" - }, - { - "alias": "test_extra_env_vars", + "alias": "nodejs_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[test].extra_env_vars` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[nodejs].executable_search_paths` when this environment target is active.", + "provider": "pants.backend.experimental.javascript", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_gcc_binary_name", + "alias": "golang_cgo_cxx_flags", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_gcc_binary_name` when this environment target is active.", + "description": "Overrides the default value from the option `[golang].cgo_cxx_flags` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, - "type_hint": "str | None" + "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_cxx_flags", + "alias": "go_generate_env_vars", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_cxx_flags` when this environment target is active.", + "description": "Overrides the default value from the option `[go-generate].env_vars` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "docker_executable_search_paths", + "alias": "golang_cgo_gcc_binary_name", "default": null, - "description": "Overrides the default value from the option `[docker].executable_search_paths` when this environment target is active.", - "provider": "pants.backend.docker", + "description": "Overrides the default value from the option `[golang].cgo_gcc_binary_name` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, - "type_hint": "Iterable[str] | None" + "type_hint": "str | None" }, { "alias": "golang_external_linker_binary_name", @@ -91828,74 +91848,74 @@ "type_hint": "str | None" }, { - "alias": "jvm_global_options", + "alias": "golang_cgo_tool_search_paths", "default": null, - "description": "Overrides the default value from the option `[jvm].global_options` when this environment target is active.", - "provider": "pants.backend.experimental.java", + "description": "Overrides the default value from the option `[golang].cgo_tool_search_paths` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_native_code_ld_flags", + "alias": "system_binaries_system_binary_paths", "default": null, - "description": "Overrides the default value from the option `[python-native-code].ld_flags` when this environment target is active.", + "description": "Overrides the default value from the option `[system-binaries].system_binary_paths` when this environment target is active.", "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_subprocess_env_vars", + "alias": "golang_go_search_paths", "default": null, - "description": "Overrides the default value from the option `[golang].subprocess_env_vars` when this environment target is active.", + "description": "Overrides the default value from the option `[golang].go_search_paths` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "nodejs_executable_search_paths", + "alias": "nodejs_search_path", "default": null, - "description": "Overrides the default value from the option `[nodejs].executable_search_paths` when this environment target is active.", + "description": "Overrides the default value from the option `[nodejs].search_path` when this environment target is active.", "provider": "pants.backend.experimental.javascript", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "nodejs_corepack_env_vars", + "alias": "golang_subprocess_env_vars", "default": null, - "description": "Overrides the default value from the option `[nodejs].corepack_env_vars` when this environment target is active.", - "provider": "pants.backend.experimental.javascript", + "description": "Overrides the default value from the option `[golang].subprocess_env_vars` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_bootstrap_search_path", + "alias": "golang_cgo_fortran_flags", "default": null, - "description": "Overrides the default value from the option `[python-bootstrap].search_path` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[golang].cgo_fortran_flags` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "shell_setup_executable_search_paths", + "alias": "python_native_code_ld_flags", "default": null, - "description": "Overrides the default value from the option `[shell-setup].executable_search_paths` when this environment target is active.", - "provider": "pants.backend.shell", + "description": "Overrides the default value from the option `[python-native-code].ld_flags` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_native_code_cpp_flags", + "alias": "golang_cgo_linker_flags", "default": null, - "description": "Overrides the default value from the option `[python-native-code].cpp_flags` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[golang].cgo_linker_flags` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "subprocess_environment_env_vars", + "alias": "shell_setup_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[subprocess-environment].env_vars` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[shell-setup].executable_search_paths` when this environment target is active.", + "provider": "pants.backend.shell", "required": false, "type_hint": "Iterable[str] | None" }, @@ -91908,50 +91928,42 @@ "type_hint": "str | None" }, { - "alias": "apache_thrift_thrift_search_paths", + "alias": "pyenv_python_provider_installation_extra_env_vars", "default": null, - "description": "Overrides the default value from the option `[apache-thrift].thrift_search_paths` when this environment target is active.", - "provider": "pants.backend.codegen.thrift.apache.python", + "description": "Overrides the default value from the option `[pyenv-python-provider].installation_extra_env_vars` when this environment target is active.", + "provider": "pants.backend.python.providers.experimental.pyenv", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "go_generate_env_vars", + "alias": "golang_cgo_c_flags", "default": null, - "description": "Overrides the default value from the option `[go-generate].env_vars` when this environment target is active.", + "description": "Overrides the default value from the option `[golang].cgo_c_flags` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "pyenv_python_provider_installation_extra_env_vars", - "default": null, - "description": "Overrides the default value from the option `[pyenv-python-provider].installation_extra_env_vars` when this environment target is active.", - "provider": "pants.backend.python.providers.experimental.pyenv", - "required": false, - "type_hint": "Iterable[str] | None" - }, - { - "alias": "golang_cgo_fortran_flags", + "alias": "docker_env_vars", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_fortran_flags` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[docker].env_vars` when this environment target is active.", + "provider": "pants.backend.docker", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_linker_flags", + "alias": "apache_thrift_thrift_search_paths", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_linker_flags` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[apache-thrift].thrift_search_paths` when this environment target is active.", + "provider": "pants.backend.codegen.thrift.apache.python", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_c_flags", + "alias": "subprocess_environment_env_vars", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_c_flags` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[subprocess-environment].env_vars` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" } @@ -92100,25 +92112,25 @@ "type_hint": "str" }, { - "alias": "jvm_jdk", + "alias": "java_model_package", "default": null, - "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", + "description": "Root package for generated model code", "provider": "pants.backend.experimental.openapi.codegen.java", "required": false, "type_hint": "str | None" }, { - "alias": "skip_java", - "default": "False", - "description": "If true, skips generation of Java sources from this target", + "alias": "jvm_resolve", + "default": null, + "description": "The resolve from `[jvm].resolves` to use when compiling this target.\n\nIf not defined, will default to `[jvm].default_resolve`.", "provider": "pants.backend.experimental.openapi.codegen.java", "required": false, - "type_hint": "bool" + "type_hint": "str | None" }, { - "alias": "java_api_package", + "alias": "jvm_jdk", "default": null, - "description": "Root package for generated API code", + "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", "provider": "pants.backend.experimental.openapi.codegen.java", "required": false, "type_hint": "str | None" @@ -92132,17 +92144,17 @@ "type_hint": "bool" }, { - "alias": "java_model_package", - "default": null, - "description": "Root package for generated model code", + "alias": "skip_java", + "default": "False", + "description": "If true, skips generation of Java sources from this target", "provider": "pants.backend.experimental.openapi.codegen.java", "required": false, - "type_hint": "str | None" + "type_hint": "bool" }, { - "alias": "jvm_resolve", + "alias": "java_api_package", "default": null, - "description": "The resolve from `[jvm].resolves` to use when compiling this target.\n\nIf not defined, will default to `[jvm].default_resolve`.", + "description": "Root package for generated API code", "provider": "pants.backend.experimental.openapi.codegen.java", "required": false, "type_hint": "str | None" @@ -92180,25 +92192,25 @@ "type_hint": "Iterable[str] | None" }, { - "alias": "jvm_jdk", + "alias": "java_model_package", "default": null, - "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", + "description": "Root package for generated model code", "provider": "pants.backend.experimental.openapi.codegen.java", "required": false, "type_hint": "str | None" }, { - "alias": "skip_java", - "default": "False", - "description": "If true, skips generation of Java sources from this target", + "alias": "jvm_resolve", + "default": null, + "description": "The resolve from `[jvm].resolves` to use when compiling this target.\n\nIf not defined, will default to `[jvm].default_resolve`.", "provider": "pants.backend.experimental.openapi.codegen.java", "required": false, - "type_hint": "bool" + "type_hint": "str | None" }, { - "alias": "java_api_package", + "alias": "jvm_jdk", "default": null, - "description": "Root package for generated API code", + "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", "provider": "pants.backend.experimental.openapi.codegen.java", "required": false, "type_hint": "str | None" @@ -92212,17 +92224,17 @@ "type_hint": "bool" }, { - "alias": "java_model_package", - "default": null, - "description": "Root package for generated model code", + "alias": "skip_java", + "default": "False", + "description": "If true, skips generation of Java sources from this target", "provider": "pants.backend.experimental.openapi.codegen.java", "required": false, - "type_hint": "str | None" + "type_hint": "bool" }, { - "alias": "jvm_resolve", + "alias": "java_api_package", "default": null, - "description": "The resolve from `[jvm].resolves` to use when compiling this target.\n\nIf not defined, will default to `[jvm].default_resolve`.", + "description": "Root package for generated API code", "provider": "pants.backend.experimental.openapi.codegen.java", "required": false, "type_hint": "str | None" @@ -92405,7 +92417,7 @@ }, { "alias": "version_spec", - "default": "'== 2.20.3rc1'", + "default": "'== 2.20.3'", "description": "The PEP 440 version specifier version of Pants to target. E.g. `== 2.15.*`, or `>= 2.16.0, < 2.17.0`", "provider": "", "required": false, @@ -93052,52 +93064,52 @@ "type_hint": "bool" }, { - "alias": "jvm_jdk", + "alias": "python_source_root", "default": null, - "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", - "provider": "pants.backend.experimental.codegen.protobuf.java", + "description": "The source root to generate Python sources under.\n\nIf unspecified, the source root the `protobuf_sources` is under will be used.", + "provider": "pants.backend.codegen.protobuf.python", "required": false, "type_hint": "str | None" }, { - "alias": "python_source_root", + "alias": "jvm_resolve", "default": null, - "description": "The source root to generate Python sources under.\n\nIf unspecified, the source root the `protobuf_sources` is under will be used.", - "provider": "pants.backend.codegen.protobuf.python", + "description": "The resolve from `[jvm].resolves` to use when compiling this target.\n\nIf not defined, will default to `[jvm].default_resolve`.", + "provider": "pants.backend.experimental.codegen.protobuf.java", "required": false, "type_hint": "str | None" }, { - "alias": "skip_buf_lint", + "alias": "skip_buf_format", "default": "False", - "description": "If true, don't run `buf lint` on this target's code.", + "description": "If true, don't run `buf format` on this target's code.", "provider": "pants.backend.codegen.protobuf.lint.buf", "required": false, "type_hint": "bool" }, { - "alias": "go_mod_address", + "alias": "python_resolve", "default": null, - "description": "Address of the `go_mod` target representing the Go module that this target is part of.\n\nThis field is similar to the `resolve` field used in the Python and JVM backends. If a codegen target such as `protobuf_sources` will be used in multiple Go modules, then you should use the `parametrize` built-in to parametrize that `protobuf_sources` target for each Go module.\n\nIf there is a single `go_mod` target in the repository, then this field defaults to the address for that single `go_mod` target.", - "provider": "pants.backend.experimental.codegen.protobuf.go", + "description": "The resolve from `[python].resolves` to use.\n\nIf not defined, will default to `[python].default_resolve`.\n\nAll dependencies must share the same value for their `resolve` field.", + "provider": "pants.backend.codegen.protobuf.python", "required": false, "type_hint": "str | None" }, { - "alias": "python_resolve", + "alias": "jvm_jdk", "default": null, - "description": "The resolve from `[python].resolves` to use.\n\nIf not defined, will default to `[python].default_resolve`.\n\nAll dependencies must share the same value for their `resolve` field.", - "provider": "pants.backend.codegen.protobuf.python", + "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", + "provider": "pants.backend.experimental.codegen.protobuf.java", "required": false, "type_hint": "str | None" }, { - "alias": "skip_buf_format", - "default": "False", - "description": "If true, don't run `buf format` on this target's code.", - "provider": "pants.backend.codegen.protobuf.lint.buf", + "alias": "go_mod_address", + "default": null, + "description": "Address of the `go_mod` target representing the Go module that this target is part of.\n\nThis field is similar to the `resolve` field used in the Python and JVM backends. If a codegen target such as `protobuf_sources` will be used in multiple Go modules, then you should use the `parametrize` built-in to parametrize that `protobuf_sources` target for each Go module.\n\nIf there is a single `go_mod` target in the repository, then this field defaults to the address for that single `go_mod` target.", + "provider": "pants.backend.experimental.codegen.protobuf.go", "required": false, - "type_hint": "bool" + "type_hint": "str | None" }, { "alias": "python_interpreter_constraints", @@ -93108,12 +93120,12 @@ "type_hint": "Iterable[str] | None" }, { - "alias": "jvm_resolve", - "default": null, - "description": "The resolve from `[jvm].resolves` to use when compiling this target.\n\nIf not defined, will default to `[jvm].default_resolve`.", - "provider": "pants.backend.experimental.codegen.protobuf.java", + "alias": "skip_buf_lint", + "default": "False", + "description": "If true, don't run `buf lint` on this target's code.", + "provider": "pants.backend.codegen.protobuf.lint.buf", "required": false, - "type_hint": "str | None" + "type_hint": "bool" } ], "provider": "pants.backend.codegen.protobuf.python", @@ -93156,21 +93168,29 @@ "type_hint": "Dict[Union[str, Tuple[str, ...]], Dict[str, Any]] | None" }, { - "alias": "jvm_jdk", + "alias": "jvm_resolve", "default": null, - "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", + "description": "The resolve from `[jvm].resolves` to use when compiling this target.\n\nIf not defined, will default to `[jvm].default_resolve`.", "provider": "pants.backend.experimental.codegen.protobuf.java", "required": false, "type_hint": "str | None" }, { - "alias": "skip_buf_lint", + "alias": "skip_buf_format", "default": "False", - "description": "If true, don't run `buf lint` on this target's code.", + "description": "If true, don't run `buf format` on this target's code.", "provider": "pants.backend.codegen.protobuf.lint.buf", "required": false, "type_hint": "bool" }, + { + "alias": "jvm_jdk", + "default": null, + "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", + "provider": "pants.backend.experimental.codegen.protobuf.java", + "required": false, + "type_hint": "str | None" + }, { "alias": "go_mod_address", "default": null, @@ -93180,21 +93200,13 @@ "type_hint": "str | None" }, { - "alias": "skip_buf_format", + "alias": "skip_buf_lint", "default": "False", - "description": "If true, don't run `buf format` on this target's code.", + "description": "If true, don't run `buf lint` on this target's code.", "provider": "pants.backend.codegen.protobuf.lint.buf", "required": false, "type_hint": "bool" }, - { - "alias": "jvm_resolve", - "default": null, - "description": "The resolve from `[jvm].resolves` to use when compiling this target.\n\nIf not defined, will default to `[jvm].default_resolve`.", - "provider": "pants.backend.experimental.codegen.protobuf.java", - "required": false, - "type_hint": "str | None" - }, { "alias": "python_resolve", "default": null, @@ -93628,12 +93640,12 @@ "type_hint": "str | None" }, { - "alias": "repositories", - "default": null, - "description": "List of URL addresses or Twine repository aliases where to publish the Python package.\n\nTwine is used for publishing Python packages, so the address to any kind of repository that Twine supports may be used here.\n\nAliases are prefixed with `@` to refer to a config section in your Twine configuration, such as a `.pypirc` file. Use `@pypi` to upload to the public PyPi repository, which is the default when using Twine directly.", + "alias": "skip_twine", + "default": "False", + "description": "If true, don't publish this target's packages using Twine.", "provider": "pants.backend.experimental.python", "required": false, - "type_hint": "Iterable[str] | None" + "type_hint": "bool" }, { "alias": "uses_mypyc", @@ -93644,12 +93656,12 @@ "type_hint": "bool" }, { - "alias": "skip_twine", - "default": "False", - "description": "If true, don't publish this target's packages using Twine.", + "alias": "repositories", + "default": null, + "description": "List of URL addresses or Twine repository aliases where to publish the Python package.\n\nTwine is used for publishing Python packages, so the address to any kind of repository that Twine supports may be used here.\n\nAliases are prefixed with `@` to refer to a config section in your Twine configuration, such as a `.pypirc` file. Use `@pypi` to upload to the public PyPi repository, which is the default when using Twine directly.", "provider": "pants.backend.experimental.python", "required": false, - "type_hint": "bool" + "type_hint": "Iterable[str] | None" } ], "provider": "pants.backend.python", @@ -93790,7 +93802,7 @@ { "alias": "modules", "default": null, - "description": "The modules this requirement provides (used for dependency inference).\n\nFor example, the requirement `setuptools` provides `[\"setuptools\", \"pkg_resources\", \"easy_install\"]`.\n\nUsually you can leave this field off. If unspecified, Pants will first look at the default module mapping (https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/python/dependency_inference/default_module_mapping.py), and then will default to the normalized project name. For example, the requirement `Django` would default to the module `django`.\n\nMutually exclusive with the `type_stub_modules` field.", + "description": "The modules this requirement provides (used for dependency inference).\n\nFor example, the requirement `setuptools` provides `[\"setuptools\", \"pkg_resources\", \"easy_install\"]`.\n\nUsually you can leave this field off. If unspecified, Pants will first look at the default module mapping (https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/python/dependency_inference/default_module_mapping.py), and then will default to the normalized project name. For example, the requirement `Django` would default to the module `django`.\n\nMutually exclusive with the `type_stub_modules` field.", "provider": "", "required": false, "type_hint": "Iterable[str] | None" @@ -93798,7 +93810,7 @@ { "alias": "type_stub_modules", "default": null, - "description": "The modules this requirement provides if the requirement is a type stub (used for dependency inference).\n\nFor example, the requirement `types-requests` provides `[\"requests\"]`.\n\nUsually you can leave this field off. If unspecified, Pants will first look at the default module mapping (https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/python/dependency_inference/default_module_mapping.py). If not found _and_ the requirement name starts with `types-` or `stubs-`, or ends with `-types` or `-stubs`, will default to that requirement name without the prefix/suffix. For example, `types-requests` would default to `requests`. Otherwise, will be treated like a normal requirement (see the `modules` field).\n\nMutually exclusive with the `modules` field.", + "description": "The modules this requirement provides if the requirement is a type stub (used for dependency inference).\n\nFor example, the requirement `types-requests` provides `[\"requests\"]`.\n\nUsually you can leave this field off. If unspecified, Pants will first look at the default module mapping (https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/python/dependency_inference/default_module_mapping.py). If not found _and_ the requirement name starts with `types-` or `stubs-`, or ends with `-types` or `-stubs`, will default to that requirement name without the prefix/suffix. For example, `types-requests` would default to `requests`. Otherwise, will be treated like a normal requirement (see the `modules` field).\n\nMutually exclusive with the `modules` field.", "provider": "", "required": false, "type_hint": "Iterable[str] | None" @@ -93956,66 +93968,58 @@ "type_hint": "bool" }, { - "alias": "skip_yapf", - "default": "False", - "description": "If true, don't run yapf on this target's code.", - "provider": "pants.backend.python.lint.yapf", - "required": false, - "type_hint": "bool" - }, - { - "alias": "skip_pytype", + "alias": "skip_add_trailing_comma", "default": "False", - "description": "If true, don't run pytype on this target's code.", - "provider": "pants.backend.experimental.python.typecheck.pytype", + "description": "If true, don't run add-trailing-comma on this target's code.", + "provider": "pants.backend.experimental.python.lint.add_trailing_comma", "required": false, "type_hint": "bool" }, { - "alias": "skip_isort", + "alias": "skip_ruff", "default": "False", - "description": "If true, don't run isort on this target's code.", - "provider": "pants.backend.python.lint.isort", + "description": "If true, don't run ruff on this target's code.", + "provider": "pants.backend.experimental.python.lint.ruff", "required": false, "type_hint": "bool" }, { - "alias": "skip_flake8", + "alias": "skip_pyupgrade", "default": "False", - "description": "If true, don't run Flake8 on this target's code.", - "provider": "pants.backend.python.lint.flake8", + "description": "If true, don't run pyupgrade on this target's code.", + "provider": "pants.backend.python.lint.pyupgrade", "required": false, "type_hint": "bool" }, { - "alias": "skip_mypy", + "alias": "skip_docformatter", "default": "False", - "description": "If true, don't run MyPy on this target's code.", - "provider": "pants.backend.python.typecheck.mypy", + "description": "If true, don't run Docformatter on this target's code.", + "provider": "pants.backend.python.lint.docformatter", "required": false, "type_hint": "bool" }, { - "alias": "skip_bandit", + "alias": "skip_pyright", "default": "False", - "description": "If true, don't run Bandit on this target's code.", - "provider": "pants.backend.python.lint.bandit", + "description": "If true, don't run Pyright on this target's code.", + "provider": "pants.backend.experimental.python.typecheck.pyright", "required": false, "type_hint": "bool" }, { - "alias": "skip_black", + "alias": "skip_pytype", "default": "False", - "description": "If true, don't run Black on this target's code.", - "provider": "pants.backend.python.lint.black", + "description": "If true, don't run pytype on this target's code.", + "provider": "pants.backend.experimental.python.typecheck.pytype", "required": false, "type_hint": "bool" }, { - "alias": "skip_docformatter", + "alias": "skip_mypy", "default": "False", - "description": "If true, don't run Docformatter on this target's code.", - "provider": "pants.backend.python.lint.docformatter", + "description": "If true, don't run MyPy on this target's code.", + "provider": "pants.backend.python.typecheck.mypy", "required": false, "type_hint": "bool" }, @@ -94028,34 +94032,34 @@ "type_hint": "bool" }, { - "alias": "skip_pydocstyle", + "alias": "skip_flake8", "default": "False", - "description": "If true, don't run pydocstyle on this target's code.", - "provider": "pants.backend.python.lint.pydocstyle", + "description": "If true, don't run Flake8 on this target's code.", + "provider": "pants.backend.python.lint.flake8", "required": false, "type_hint": "bool" }, { - "alias": "skip_pyright", + "alias": "skip_bandit", "default": "False", - "description": "If true, don't run Pyright on this target's code.", - "provider": "pants.backend.experimental.python.typecheck.pyright", + "description": "If true, don't run Bandit on this target's code.", + "provider": "pants.backend.python.lint.bandit", "required": false, "type_hint": "bool" }, { - "alias": "skip_add_trailing_comma", + "alias": "skip_black", "default": "False", - "description": "If true, don't run add-trailing-comma on this target's code.", - "provider": "pants.backend.experimental.python.lint.add_trailing_comma", + "description": "If true, don't run Black on this target's code.", + "provider": "pants.backend.python.lint.black", "required": false, "type_hint": "bool" }, { - "alias": "skip_pyupgrade", + "alias": "skip_pydocstyle", "default": "False", - "description": "If true, don't run pyupgrade on this target's code.", - "provider": "pants.backend.python.lint.pyupgrade", + "description": "If true, don't run pydocstyle on this target's code.", + "provider": "pants.backend.python.lint.pydocstyle", "required": false, "type_hint": "bool" }, @@ -94068,10 +94072,18 @@ "type_hint": "bool" }, { - "alias": "skip_ruff", + "alias": "skip_yapf", "default": "False", - "description": "If true, don't run ruff on this target's code.", - "provider": "pants.backend.experimental.python.lint.ruff", + "description": "If true, don't run yapf on this target's code.", + "provider": "pants.backend.python.lint.yapf", + "required": false, + "type_hint": "bool" + }, + { + "alias": "skip_isort", + "default": "False", + "description": "If true, don't run isort on this target's code.", + "provider": "pants.backend.python.lint.isort", "required": false, "type_hint": "bool" } @@ -94116,66 +94128,58 @@ "type_hint": "Dict[Union[str, Tuple[str, ...]], Dict[str, Any]] | None" }, { - "alias": "skip_yapf", - "default": "False", - "description": "If true, don't run yapf on this target's code.", - "provider": "pants.backend.python.lint.yapf", - "required": false, - "type_hint": "bool" - }, - { - "alias": "skip_pytype", + "alias": "skip_add_trailing_comma", "default": "False", - "description": "If true, don't run pytype on this target's code.", - "provider": "pants.backend.experimental.python.typecheck.pytype", + "description": "If true, don't run add-trailing-comma on this target's code.", + "provider": "pants.backend.experimental.python.lint.add_trailing_comma", "required": false, "type_hint": "bool" }, { - "alias": "skip_isort", + "alias": "skip_ruff", "default": "False", - "description": "If true, don't run isort on this target's code.", - "provider": "pants.backend.python.lint.isort", + "description": "If true, don't run ruff on this target's code.", + "provider": "pants.backend.experimental.python.lint.ruff", "required": false, "type_hint": "bool" }, { - "alias": "skip_flake8", + "alias": "skip_pyupgrade", "default": "False", - "description": "If true, don't run Flake8 on this target's code.", - "provider": "pants.backend.python.lint.flake8", + "description": "If true, don't run pyupgrade on this target's code.", + "provider": "pants.backend.python.lint.pyupgrade", "required": false, "type_hint": "bool" }, { - "alias": "skip_mypy", + "alias": "skip_docformatter", "default": "False", - "description": "If true, don't run MyPy on this target's code.", - "provider": "pants.backend.python.typecheck.mypy", + "description": "If true, don't run Docformatter on this target's code.", + "provider": "pants.backend.python.lint.docformatter", "required": false, "type_hint": "bool" }, { - "alias": "skip_bandit", + "alias": "skip_pyright", "default": "False", - "description": "If true, don't run Bandit on this target's code.", - "provider": "pants.backend.python.lint.bandit", + "description": "If true, don't run Pyright on this target's code.", + "provider": "pants.backend.experimental.python.typecheck.pyright", "required": false, "type_hint": "bool" }, { - "alias": "skip_black", + "alias": "skip_pytype", "default": "False", - "description": "If true, don't run Black on this target's code.", - "provider": "pants.backend.python.lint.black", + "description": "If true, don't run pytype on this target's code.", + "provider": "pants.backend.experimental.python.typecheck.pytype", "required": false, "type_hint": "bool" }, { - "alias": "skip_docformatter", + "alias": "skip_mypy", "default": "False", - "description": "If true, don't run Docformatter on this target's code.", - "provider": "pants.backend.python.lint.docformatter", + "description": "If true, don't run MyPy on this target's code.", + "provider": "pants.backend.python.typecheck.mypy", "required": false, "type_hint": "bool" }, @@ -94188,34 +94192,34 @@ "type_hint": "bool" }, { - "alias": "skip_pydocstyle", + "alias": "skip_flake8", "default": "False", - "description": "If true, don't run pydocstyle on this target's code.", - "provider": "pants.backend.python.lint.pydocstyle", + "description": "If true, don't run Flake8 on this target's code.", + "provider": "pants.backend.python.lint.flake8", "required": false, "type_hint": "bool" }, { - "alias": "skip_pyright", + "alias": "skip_bandit", "default": "False", - "description": "If true, don't run Pyright on this target's code.", - "provider": "pants.backend.experimental.python.typecheck.pyright", + "description": "If true, don't run Bandit on this target's code.", + "provider": "pants.backend.python.lint.bandit", "required": false, "type_hint": "bool" }, { - "alias": "skip_add_trailing_comma", + "alias": "skip_black", "default": "False", - "description": "If true, don't run add-trailing-comma on this target's code.", - "provider": "pants.backend.experimental.python.lint.add_trailing_comma", + "description": "If true, don't run Black on this target's code.", + "provider": "pants.backend.python.lint.black", "required": false, "type_hint": "bool" }, { - "alias": "skip_pyupgrade", + "alias": "skip_pydocstyle", "default": "False", - "description": "If true, don't run pyupgrade on this target's code.", - "provider": "pants.backend.python.lint.pyupgrade", + "description": "If true, don't run pydocstyle on this target's code.", + "provider": "pants.backend.python.lint.pydocstyle", "required": false, "type_hint": "bool" }, @@ -94228,10 +94232,18 @@ "type_hint": "bool" }, { - "alias": "skip_ruff", + "alias": "skip_yapf", "default": "False", - "description": "If true, don't run ruff on this target's code.", - "provider": "pants.backend.experimental.python.lint.ruff", + "description": "If true, don't run yapf on this target's code.", + "provider": "pants.backend.python.lint.yapf", + "required": false, + "type_hint": "bool" + }, + { + "alias": "skip_isort", + "default": "False", + "description": "If true, don't run isort on this target's code.", + "provider": "pants.backend.python.lint.isort", "required": false, "type_hint": "bool" }, @@ -94396,34 +94408,50 @@ "type_hint": "str" }, { - "alias": "skip_yapf", + "alias": "skip_add_trailing_comma", "default": "False", - "description": "If true, don't run yapf on this target's code.", - "provider": "pants.backend.python.lint.yapf", + "description": "If true, don't run add-trailing-comma on this target's code.", + "provider": "pants.backend.experimental.python.lint.add_trailing_comma", "required": false, "type_hint": "bool" }, { - "alias": "skip_pytype", + "alias": "skip_ruff", "default": "False", - "description": "If true, don't run pytype on this target's code.", - "provider": "pants.backend.experimental.python.typecheck.pytype", + "description": "If true, don't run ruff on this target's code.", + "provider": "pants.backend.experimental.python.lint.ruff", "required": false, "type_hint": "bool" }, { - "alias": "skip_isort", + "alias": "skip_pyupgrade", "default": "False", - "description": "If true, don't run isort on this target's code.", - "provider": "pants.backend.python.lint.isort", + "description": "If true, don't run pyupgrade on this target's code.", + "provider": "pants.backend.python.lint.pyupgrade", "required": false, "type_hint": "bool" }, { - "alias": "skip_flake8", + "alias": "skip_docformatter", "default": "False", - "description": "If true, don't run Flake8 on this target's code.", - "provider": "pants.backend.python.lint.flake8", + "description": "If true, don't run Docformatter on this target's code.", + "provider": "pants.backend.python.lint.docformatter", + "required": false, + "type_hint": "bool" + }, + { + "alias": "skip_pyright", + "default": "False", + "description": "If true, don't run Pyright on this target's code.", + "provider": "pants.backend.experimental.python.typecheck.pyright", + "required": false, + "type_hint": "bool" + }, + { + "alias": "skip_pytype", + "default": "False", + "description": "If true, don't run pytype on this target's code.", + "provider": "pants.backend.experimental.python.typecheck.pytype", "required": false, "type_hint": "bool" }, @@ -94436,34 +94464,34 @@ "type_hint": "bool" }, { - "alias": "skip_bandit", + "alias": "skip_pylint", "default": "False", - "description": "If true, don't run Bandit on this target's code.", - "provider": "pants.backend.python.lint.bandit", + "description": "If true, don't run Pylint on this target's code.", + "provider": "pants.backend.python.lint.pylint", "required": false, "type_hint": "bool" }, { - "alias": "skip_black", + "alias": "skip_flake8", "default": "False", - "description": "If true, don't run Black on this target's code.", - "provider": "pants.backend.python.lint.black", + "description": "If true, don't run Flake8 on this target's code.", + "provider": "pants.backend.python.lint.flake8", "required": false, "type_hint": "bool" }, { - "alias": "skip_docformatter", + "alias": "skip_bandit", "default": "False", - "description": "If true, don't run Docformatter on this target's code.", - "provider": "pants.backend.python.lint.docformatter", + "description": "If true, don't run Bandit on this target's code.", + "provider": "pants.backend.python.lint.bandit", "required": false, "type_hint": "bool" }, { - "alias": "skip_pylint", + "alias": "skip_black", "default": "False", - "description": "If true, don't run Pylint on this target's code.", - "provider": "pants.backend.python.lint.pylint", + "description": "If true, don't run Black on this target's code.", + "provider": "pants.backend.python.lint.black", "required": false, "type_hint": "bool" }, @@ -94476,26 +94504,26 @@ "type_hint": "bool" }, { - "alias": "skip_add_trailing_comma", + "alias": "skip_autoflake", "default": "False", - "description": "If true, don't run add-trailing-comma on this target's code.", - "provider": "pants.backend.experimental.python.lint.add_trailing_comma", + "description": "If true, don't run Autoflake on this target's code.", + "provider": "pants.backend.python.lint.autoflake", "required": false, "type_hint": "bool" }, { - "alias": "skip_pyupgrade", + "alias": "skip_yapf", "default": "False", - "description": "If true, don't run pyupgrade on this target's code.", - "provider": "pants.backend.python.lint.pyupgrade", + "description": "If true, don't run yapf on this target's code.", + "provider": "pants.backend.python.lint.yapf", "required": false, "type_hint": "bool" }, { - "alias": "skip_pyright", + "alias": "skip_isort", "default": "False", - "description": "If true, don't run Pyright on this target's code.", - "provider": "pants.backend.experimental.python.typecheck.pyright", + "description": "If true, don't run isort on this target's code.", + "provider": "pants.backend.python.lint.isort", "required": false, "type_hint": "bool" }, @@ -94506,22 +94534,6 @@ "provider": "pants.backend.experimental.python.framework.stevedore", "required": false, "type_hint": "Iterable[str] | None" - }, - { - "alias": "skip_autoflake", - "default": "False", - "description": "If true, don't run Autoflake on this target's code.", - "provider": "pants.backend.python.lint.autoflake", - "required": false, - "type_hint": "bool" - }, - { - "alias": "skip_ruff", - "default": "False", - "description": "If true, don't run ruff on this target's code.", - "provider": "pants.backend.experimental.python.lint.ruff", - "required": false, - "type_hint": "bool" } ], "provider": "pants.backend.python", @@ -94564,66 +94576,58 @@ "type_hint": "Dict[Union[str, Tuple[str, ...]], Dict[str, Any]] | None" }, { - "alias": "skip_yapf", - "default": "False", - "description": "If true, don't run yapf on this target's code.", - "provider": "pants.backend.python.lint.yapf", - "required": false, - "type_hint": "bool" - }, - { - "alias": "skip_pytype", + "alias": "skip_add_trailing_comma", "default": "False", - "description": "If true, don't run pytype on this target's code.", - "provider": "pants.backend.experimental.python.typecheck.pytype", + "description": "If true, don't run add-trailing-comma on this target's code.", + "provider": "pants.backend.experimental.python.lint.add_trailing_comma", "required": false, "type_hint": "bool" }, { - "alias": "skip_isort", + "alias": "skip_ruff", "default": "False", - "description": "If true, don't run isort on this target's code.", - "provider": "pants.backend.python.lint.isort", + "description": "If true, don't run ruff on this target's code.", + "provider": "pants.backend.experimental.python.lint.ruff", "required": false, "type_hint": "bool" }, { - "alias": "skip_flake8", + "alias": "skip_pyupgrade", "default": "False", - "description": "If true, don't run Flake8 on this target's code.", - "provider": "pants.backend.python.lint.flake8", + "description": "If true, don't run pyupgrade on this target's code.", + "provider": "pants.backend.python.lint.pyupgrade", "required": false, "type_hint": "bool" }, { - "alias": "skip_mypy", + "alias": "skip_docformatter", "default": "False", - "description": "If true, don't run MyPy on this target's code.", - "provider": "pants.backend.python.typecheck.mypy", + "description": "If true, don't run Docformatter on this target's code.", + "provider": "pants.backend.python.lint.docformatter", "required": false, "type_hint": "bool" }, { - "alias": "skip_bandit", + "alias": "skip_pyright", "default": "False", - "description": "If true, don't run Bandit on this target's code.", - "provider": "pants.backend.python.lint.bandit", + "description": "If true, don't run Pyright on this target's code.", + "provider": "pants.backend.experimental.python.typecheck.pyright", "required": false, "type_hint": "bool" }, { - "alias": "skip_black", + "alias": "skip_pytype", "default": "False", - "description": "If true, don't run Black on this target's code.", - "provider": "pants.backend.python.lint.black", + "description": "If true, don't run pytype on this target's code.", + "provider": "pants.backend.experimental.python.typecheck.pytype", "required": false, "type_hint": "bool" }, { - "alias": "skip_docformatter", + "alias": "skip_mypy", "default": "False", - "description": "If true, don't run Docformatter on this target's code.", - "provider": "pants.backend.python.lint.docformatter", + "description": "If true, don't run MyPy on this target's code.", + "provider": "pants.backend.python.typecheck.mypy", "required": false, "type_hint": "bool" }, @@ -94636,34 +94640,34 @@ "type_hint": "bool" }, { - "alias": "skip_pydocstyle", + "alias": "skip_flake8", "default": "False", - "description": "If true, don't run pydocstyle on this target's code.", - "provider": "pants.backend.python.lint.pydocstyle", + "description": "If true, don't run Flake8 on this target's code.", + "provider": "pants.backend.python.lint.flake8", "required": false, "type_hint": "bool" }, { - "alias": "skip_pyright", + "alias": "skip_bandit", "default": "False", - "description": "If true, don't run Pyright on this target's code.", - "provider": "pants.backend.experimental.python.typecheck.pyright", + "description": "If true, don't run Bandit on this target's code.", + "provider": "pants.backend.python.lint.bandit", "required": false, "type_hint": "bool" }, { - "alias": "skip_add_trailing_comma", + "alias": "skip_black", "default": "False", - "description": "If true, don't run add-trailing-comma on this target's code.", - "provider": "pants.backend.experimental.python.lint.add_trailing_comma", + "description": "If true, don't run Black on this target's code.", + "provider": "pants.backend.python.lint.black", "required": false, "type_hint": "bool" }, { - "alias": "skip_pyupgrade", + "alias": "skip_pydocstyle", "default": "False", - "description": "If true, don't run pyupgrade on this target's code.", - "provider": "pants.backend.python.lint.pyupgrade", + "description": "If true, don't run pydocstyle on this target's code.", + "provider": "pants.backend.python.lint.pydocstyle", "required": false, "type_hint": "bool" }, @@ -94676,10 +94680,18 @@ "type_hint": "bool" }, { - "alias": "skip_ruff", + "alias": "skip_yapf", "default": "False", - "description": "If true, don't run ruff on this target's code.", - "provider": "pants.backend.experimental.python.lint.ruff", + "description": "If true, don't run yapf on this target's code.", + "provider": "pants.backend.python.lint.yapf", + "required": false, + "type_hint": "bool" + }, + { + "alias": "skip_isort", + "default": "False", + "description": "If true, don't run isort on this target's code.", + "provider": "pants.backend.python.lint.isort", "required": false, "type_hint": "bool" }, @@ -94756,34 +94768,50 @@ "type_hint": "Dict[Union[str, Tuple[str, ...]], Dict[str, Any]] | None" }, { - "alias": "skip_yapf", + "alias": "skip_add_trailing_comma", "default": "False", - "description": "If true, don't run yapf on this target's code.", - "provider": "pants.backend.python.lint.yapf", + "description": "If true, don't run add-trailing-comma on this target's code.", + "provider": "pants.backend.experimental.python.lint.add_trailing_comma", "required": false, "type_hint": "bool" }, { - "alias": "skip_pytype", + "alias": "skip_ruff", "default": "False", - "description": "If true, don't run pytype on this target's code.", - "provider": "pants.backend.experimental.python.typecheck.pytype", + "description": "If true, don't run ruff on this target's code.", + "provider": "pants.backend.experimental.python.lint.ruff", "required": false, "type_hint": "bool" }, { - "alias": "skip_isort", + "alias": "skip_pyupgrade", "default": "False", - "description": "If true, don't run isort on this target's code.", - "provider": "pants.backend.python.lint.isort", + "description": "If true, don't run pyupgrade on this target's code.", + "provider": "pants.backend.python.lint.pyupgrade", "required": false, "type_hint": "bool" }, { - "alias": "skip_flake8", + "alias": "skip_docformatter", "default": "False", - "description": "If true, don't run Flake8 on this target's code.", - "provider": "pants.backend.python.lint.flake8", + "description": "If true, don't run Docformatter on this target's code.", + "provider": "pants.backend.python.lint.docformatter", + "required": false, + "type_hint": "bool" + }, + { + "alias": "skip_pyright", + "default": "False", + "description": "If true, don't run Pyright on this target's code.", + "provider": "pants.backend.experimental.python.typecheck.pyright", + "required": false, + "type_hint": "bool" + }, + { + "alias": "skip_pytype", + "default": "False", + "description": "If true, don't run pytype on this target's code.", + "provider": "pants.backend.experimental.python.typecheck.pytype", "required": false, "type_hint": "bool" }, @@ -94796,34 +94824,34 @@ "type_hint": "bool" }, { - "alias": "skip_bandit", + "alias": "skip_pylint", "default": "False", - "description": "If true, don't run Bandit on this target's code.", - "provider": "pants.backend.python.lint.bandit", + "description": "If true, don't run Pylint on this target's code.", + "provider": "pants.backend.python.lint.pylint", "required": false, "type_hint": "bool" }, { - "alias": "skip_black", + "alias": "skip_flake8", "default": "False", - "description": "If true, don't run Black on this target's code.", - "provider": "pants.backend.python.lint.black", + "description": "If true, don't run Flake8 on this target's code.", + "provider": "pants.backend.python.lint.flake8", "required": false, "type_hint": "bool" }, { - "alias": "skip_docformatter", + "alias": "skip_bandit", "default": "False", - "description": "If true, don't run Docformatter on this target's code.", - "provider": "pants.backend.python.lint.docformatter", + "description": "If true, don't run Bandit on this target's code.", + "provider": "pants.backend.python.lint.bandit", "required": false, "type_hint": "bool" }, { - "alias": "skip_pylint", + "alias": "skip_black", "default": "False", - "description": "If true, don't run Pylint on this target's code.", - "provider": "pants.backend.python.lint.pylint", + "description": "If true, don't run Black on this target's code.", + "provider": "pants.backend.python.lint.black", "required": false, "type_hint": "bool" }, @@ -94836,26 +94864,26 @@ "type_hint": "bool" }, { - "alias": "skip_add_trailing_comma", + "alias": "skip_autoflake", "default": "False", - "description": "If true, don't run add-trailing-comma on this target's code.", - "provider": "pants.backend.experimental.python.lint.add_trailing_comma", + "description": "If true, don't run Autoflake on this target's code.", + "provider": "pants.backend.python.lint.autoflake", "required": false, "type_hint": "bool" }, { - "alias": "skip_pyupgrade", + "alias": "skip_yapf", "default": "False", - "description": "If true, don't run pyupgrade on this target's code.", - "provider": "pants.backend.python.lint.pyupgrade", + "description": "If true, don't run yapf on this target's code.", + "provider": "pants.backend.python.lint.yapf", "required": false, "type_hint": "bool" }, { - "alias": "skip_pyright", + "alias": "skip_isort", "default": "False", - "description": "If true, don't run Pyright on this target's code.", - "provider": "pants.backend.experimental.python.typecheck.pyright", + "description": "If true, don't run isort on this target's code.", + "provider": "pants.backend.python.lint.isort", "required": false, "type_hint": "bool" }, @@ -94867,22 +94895,6 @@ "required": false, "type_hint": "Iterable[str] | None" }, - { - "alias": "skip_autoflake", - "default": "False", - "description": "If true, don't run Autoflake on this target's code.", - "provider": "pants.backend.python.lint.autoflake", - "required": false, - "type_hint": "bool" - }, - { - "alias": "skip_ruff", - "default": "False", - "description": "If true, don't run ruff on this target's code.", - "provider": "pants.backend.experimental.python.lint.ruff", - "required": false, - "type_hint": "bool" - }, { "alias": "dependencies", "default": null, @@ -95076,33 +95088,41 @@ "type_hint": "bool" }, { - "alias": "system_binaries_system_binary_paths", + "alias": "jvm_global_options", "default": null, - "description": "Overrides the default value from the option `[system-binaries].system_binary_paths` when this environment target is active.", + "description": "Overrides the default value from the option `[jvm].global_options` when this environment target is active.", + "provider": "pants.backend.experimental.java", + "required": false, + "type_hint": "Iterable[str] | None" + }, + { + "alias": "python_bootstrap_names", + "default": null, + "description": "Overrides the default value from the option `[python-bootstrap].names` when this environment target is active.", "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_c_flags", + "alias": "docker_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_c_flags` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[docker].executable_search_paths` when this environment target is active.", + "provider": "pants.backend.docker", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_go_search_paths", + "alias": "python_native_code_cpp_flags", "default": null, - "description": "Overrides the default value from the option `[golang].go_search_paths` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[python-native-code].cpp_flags` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "nodejs_search_path", + "alias": "nodejs_corepack_env_vars", "default": null, - "description": "Overrides the default value from the option `[nodejs].search_path` when this environment target is active.", + "description": "Overrides the default value from the option `[nodejs].corepack_env_vars` when this environment target is active.", "provider": "pants.backend.experimental.javascript", "required": false, "type_hint": "Iterable[str] | None" @@ -95116,17 +95136,17 @@ "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_tool_search_paths", + "alias": "test_extra_env_vars", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_tool_search_paths` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[test].extra_env_vars` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_bootstrap_names", + "alias": "python_bootstrap_search_path", "default": null, - "description": "Overrides the default value from the option `[python-bootstrap].names` when this environment target is active.", + "description": "Overrides the default value from the option `[python-bootstrap].search_path` when this environment target is active.", "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" @@ -95140,36 +95160,36 @@ "type_hint": "str | None" }, { - "alias": "docker_env_vars", + "alias": "nodejs_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[docker].env_vars` when this environment target is active.", - "provider": "pants.backend.docker", + "description": "Overrides the default value from the option `[nodejs].executable_search_paths` when this environment target is active.", + "provider": "pants.backend.experimental.javascript", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "test_extra_env_vars", + "alias": "golang_cgo_cxx_flags", "default": null, - "description": "Overrides the default value from the option `[test].extra_env_vars` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[golang].cgo_cxx_flags` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_gcc_binary_name", + "alias": "go_generate_env_vars", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_gcc_binary_name` when this environment target is active.", + "description": "Overrides the default value from the option `[go-generate].env_vars` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, - "type_hint": "str | None" + "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_cxx_flags", + "alias": "golang_cgo_gcc_binary_name", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_cxx_flags` when this environment target is active.", + "description": "Overrides the default value from the option `[golang].cgo_gcc_binary_name` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, - "type_hint": "Iterable[str] | None" + "type_hint": "str | None" }, { "alias": "golang_external_linker_binary_name", @@ -95180,74 +95200,74 @@ "type_hint": "str | None" }, { - "alias": "jvm_global_options", + "alias": "golang_cgo_tool_search_paths", "default": null, - "description": "Overrides the default value from the option `[jvm].global_options` when this environment target is active.", - "provider": "pants.backend.experimental.java", + "description": "Overrides the default value from the option `[golang].cgo_tool_search_paths` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_native_code_ld_flags", + "alias": "system_binaries_system_binary_paths", "default": null, - "description": "Overrides the default value from the option `[python-native-code].ld_flags` when this environment target is active.", + "description": "Overrides the default value from the option `[system-binaries].system_binary_paths` when this environment target is active.", "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_subprocess_env_vars", + "alias": "golang_go_search_paths", "default": null, - "description": "Overrides the default value from the option `[golang].subprocess_env_vars` when this environment target is active.", + "description": "Overrides the default value from the option `[golang].go_search_paths` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "nodejs_executable_search_paths", + "alias": "nodejs_search_path", "default": null, - "description": "Overrides the default value from the option `[nodejs].executable_search_paths` when this environment target is active.", + "description": "Overrides the default value from the option `[nodejs].search_path` when this environment target is active.", "provider": "pants.backend.experimental.javascript", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "nodejs_corepack_env_vars", + "alias": "golang_subprocess_env_vars", "default": null, - "description": "Overrides the default value from the option `[nodejs].corepack_env_vars` when this environment target is active.", - "provider": "pants.backend.experimental.javascript", + "description": "Overrides the default value from the option `[golang].subprocess_env_vars` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_bootstrap_search_path", + "alias": "golang_cgo_fortran_flags", "default": null, - "description": "Overrides the default value from the option `[python-bootstrap].search_path` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[golang].cgo_fortran_flags` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "shell_setup_executable_search_paths", + "alias": "python_native_code_ld_flags", "default": null, - "description": "Overrides the default value from the option `[shell-setup].executable_search_paths` when this environment target is active.", - "provider": "pants.backend.shell", + "description": "Overrides the default value from the option `[python-native-code].ld_flags` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_native_code_cpp_flags", + "alias": "golang_cgo_linker_flags", "default": null, - "description": "Overrides the default value from the option `[python-native-code].cpp_flags` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[golang].cgo_linker_flags` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "subprocess_environment_env_vars", + "alias": "shell_setup_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[subprocess-environment].env_vars` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[shell-setup].executable_search_paths` when this environment target is active.", + "provider": "pants.backend.shell", "required": false, "type_hint": "Iterable[str] | None" }, @@ -95260,50 +95280,42 @@ "type_hint": "str | None" }, { - "alias": "apache_thrift_thrift_search_paths", + "alias": "pyenv_python_provider_installation_extra_env_vars", "default": null, - "description": "Overrides the default value from the option `[apache-thrift].thrift_search_paths` when this environment target is active.", - "provider": "pants.backend.codegen.thrift.apache.python", + "description": "Overrides the default value from the option `[pyenv-python-provider].installation_extra_env_vars` when this environment target is active.", + "provider": "pants.backend.python.providers.experimental.pyenv", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "go_generate_env_vars", + "alias": "golang_cgo_c_flags", "default": null, - "description": "Overrides the default value from the option `[go-generate].env_vars` when this environment target is active.", + "description": "Overrides the default value from the option `[golang].cgo_c_flags` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "pyenv_python_provider_installation_extra_env_vars", - "default": null, - "description": "Overrides the default value from the option `[pyenv-python-provider].installation_extra_env_vars` when this environment target is active.", - "provider": "pants.backend.python.providers.experimental.pyenv", - "required": false, - "type_hint": "Iterable[str] | None" - }, - { - "alias": "golang_cgo_fortran_flags", + "alias": "docker_env_vars", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_fortran_flags` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[docker].env_vars` when this environment target is active.", + "provider": "pants.backend.docker", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_linker_flags", + "alias": "apache_thrift_thrift_search_paths", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_linker_flags` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[apache-thrift].thrift_search_paths` when this environment target is active.", + "provider": "pants.backend.codegen.thrift.apache.python", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "docker_executable_search_paths", + "alias": "subprocess_environment_env_vars", "default": null, - "description": "Overrides the default value from the option `[docker].executable_search_paths` when this environment target is active.", - "provider": "pants.backend.docker", + "description": "Overrides the default value from the option `[subprocess-environment].env_vars` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" } @@ -95542,7 +95554,7 @@ { "alias": "packages", "default": null, - "description": "The JVM packages this artifact provides for the purposes of dependency inference.\n\nFor example, the JVM artifact `junit:junit` might provide `[\"org.junit.**\"]`.\n\nUsually you can leave this field off. If unspecified, Pants will fall back to the `[java-infer].third_party_import_mapping`, then to a built in mapping (https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/jvm/dependency_inference/jvm_artifact_mappings.py), and then finally it will default to the normalized `group` of the artifact. For example, in the absence of any other mapping the artifact `io.confluent:common-config` would default to providing `[\"io.confluent.**\"]`.\n\nThe package path may be made recursive to match symbols in subpackages by adding `.**` to the end of the package path. For example, specify `[\"org.junit.**\"]` to infer a dependency on the artifact for any file importing a symbol from `org.junit` or its subpackages.", + "description": "The JVM packages this artifact provides for the purposes of dependency inference.\n\nFor example, the JVM artifact `junit:junit` might provide `[\"org.junit.**\"]`.\n\nUsually you can leave this field off. If unspecified, Pants will fall back to the `[java-infer].third_party_import_mapping`, then to a built in mapping (https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/jvm/dependency_inference/jvm_artifact_mappings.py), and then finally it will default to the normalized `group` of the artifact. For example, in the absence of any other mapping the artifact `io.confluent:common-config` would default to providing `[\"io.confluent.**\"]`.\n\nThe package path may be made recursive to match symbols in subpackages by adding `.**` to the end of the package path. For example, specify `[\"org.junit.**\"]` to infer a dependency on the artifact for any file importing a symbol from `org.junit` or its subpackages.", "provider": "", "required": false, "type_hint": "Iterable[str] | None" @@ -96380,18 +96392,18 @@ "type_hint": "str" }, { - "alias": "skip_shellcheck", + "alias": "skip_shfmt", "default": "False", - "description": "If true, don't run Shellcheck on this target's code.", - "provider": "pants.backend.shell.lint.shellcheck", + "description": "If true, don't run shfmt on this target's code.", + "provider": "pants.backend.shell.lint.shfmt", "required": false, "type_hint": "bool" }, { - "alias": "skip_shfmt", + "alias": "skip_shellcheck", "default": "False", - "description": "If true, don't run shfmt on this target's code.", - "provider": "pants.backend.shell.lint.shfmt", + "description": "If true, don't run Shellcheck on this target's code.", + "provider": "pants.backend.shell.lint.shellcheck", "required": false, "type_hint": "bool" } @@ -96436,18 +96448,18 @@ "type_hint": "Dict[Union[str, Tuple[str, ...]], Dict[str, Any]] | None" }, { - "alias": "skip_shellcheck", + "alias": "skip_shfmt", "default": "False", - "description": "If true, don't run Shellcheck on this target's code.", - "provider": "pants.backend.shell.lint.shellcheck", + "description": "If true, don't run shfmt on this target's code.", + "provider": "pants.backend.shell.lint.shfmt", "required": false, "type_hint": "bool" }, { - "alias": "skip_shfmt", + "alias": "skip_shellcheck", "default": "False", - "description": "If true, don't run shfmt on this target's code.", - "provider": "pants.backend.shell.lint.shfmt", + "description": "If true, don't run Shellcheck on this target's code.", + "provider": "pants.backend.shell.lint.shellcheck", "required": false, "type_hint": "bool" }, @@ -96532,18 +96544,18 @@ "type_hint": "Iterable[str] | None" }, { - "alias": "skip_shellcheck", + "alias": "skip_shfmt", "default": "False", - "description": "If true, don't run Shellcheck on this target's code.", - "provider": "pants.backend.shell.lint.shellcheck", + "description": "If true, don't run shfmt on this target's code.", + "provider": "pants.backend.shell.lint.shfmt", "required": false, "type_hint": "bool" }, { - "alias": "skip_shfmt", + "alias": "skip_shellcheck", "default": "False", - "description": "If true, don't run shfmt on this target's code.", - "provider": "pants.backend.shell.lint.shfmt", + "description": "If true, don't run Shellcheck on this target's code.", + "provider": "pants.backend.shell.lint.shellcheck", "required": false, "type_hint": "bool" } @@ -96588,18 +96600,18 @@ "type_hint": "Dict[Union[str, Tuple[str, ...]], Dict[str, Any]] | None" }, { - "alias": "skip_shellcheck", + "alias": "skip_shfmt", "default": "False", - "description": "If true, don't run Shellcheck on this target's code.", - "provider": "pants.backend.shell.lint.shellcheck", + "description": "If true, don't run shfmt on this target's code.", + "provider": "pants.backend.shell.lint.shfmt", "required": false, "type_hint": "bool" }, { - "alias": "skip_shfmt", + "alias": "skip_shellcheck", "default": "False", - "description": "If true, don't run shfmt on this target's code.", - "provider": "pants.backend.shell.lint.shfmt", + "description": "If true, don't run Shellcheck on this target's code.", + "provider": "pants.backend.shell.lint.shellcheck", "required": false, "type_hint": "bool" }, @@ -96940,18 +96952,18 @@ "type_hint": "Iterable[str] | None" }, { - "alias": "skip_tfsec", + "alias": "skip_terraform_validate", "default": "False", - "description": "If true, don't run tfsec on this target's Terraform files.", - "provider": "pants.backend.experimental.terraform.lint.tfsec", + "description": "If true, don't run `terraform validate` on this target's code. If this target is a module, `terraform validate might still be run on a `terraform_deployment that references this module.", + "provider": "pants.backend.experimental.terraform", "required": false, "type_hint": "bool" }, { - "alias": "skip_terraform_validate", + "alias": "skip_tfsec", "default": "False", - "description": "If true, don't run `terraform validate` on this target's code. If this target is a module, `terraform validate might still be run on a `terraform_deployment that references this module.", - "provider": "pants.backend.experimental.terraform", + "description": "If true, don't run tfsec on this target's Terraform files.", + "provider": "pants.backend.experimental.terraform.lint.tfsec", "required": false, "type_hint": "bool" } @@ -97035,14 +97047,6 @@ "required": false, "type_hint": "bool" }, - { - "alias": "jvm_jdk", - "default": null, - "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", - "provider": "pants.backend.experimental.codegen.thrift.apache.java", - "required": false, - "type_hint": "str | None" - }, { "alias": "python_resolve", "default": null, @@ -97058,6 +97062,14 @@ "provider": "pants.backend.experimental.codegen.thrift.apache.java", "required": false, "type_hint": "str | None" + }, + { + "alias": "jvm_jdk", + "default": null, + "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", + "provider": "pants.backend.experimental.codegen.thrift.apache.java", + "required": false, + "type_hint": "str | None" } ], "provider": "pants.backend.codegen.thrift.apache.python", @@ -97107,14 +97119,6 @@ "required": false, "type_hint": "bool" }, - { - "alias": "jvm_jdk", - "default": null, - "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", - "provider": "pants.backend.experimental.codegen.thrift.apache.java", - "required": false, - "type_hint": "str | None" - }, { "alias": "python_resolve", "default": null, @@ -97131,6 +97135,14 @@ "required": false, "type_hint": "str | None" }, + { + "alias": "jvm_jdk", + "default": null, + "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", + "provider": "pants.backend.experimental.codegen.thrift.apache.java", + "required": false, + "type_hint": "str | None" + }, { "alias": "dependencies", "default": null, @@ -97853,12 +97865,12 @@ { "details": null, "rank": "HARDCODED", - "value": "2.20.3rc1" + "value": "2.20.3" }, { "details": "from env var PANTS_VERSION", "rank": "ENVIRONMENT", - "value": "2.20.3rc1" + "value": "2.20.3" } ] } @@ -99596,7 +99608,7 @@ "details": "", "rank": "HARDCODED", "value": { - "user-agent": "pants/2.20.3rc1" + "user-agent": "pants/2.20.3" } } ] @@ -99988,7 +100000,7 @@ "details": "", "rank": "HARDCODED", "value": { - "user-agent": "pants/2.20.3rc1" + "user-agent": "pants/2.20.3" } } ] @@ -112820,7 +112832,7 @@ ], "env_var": "PANTS_GOOGLE_JAVA_FORMAT_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/java/lint/google_java_format/google_java_format.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=google-java-format`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/java/lint/google_java_format/google_java_format.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=google-java-format`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -115488,7 +115500,7 @@ ], "env_var": "PANTS_JARJAR_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/jvm/shading/jarjar.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=jarjar`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/jvm/shading/jarjar.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=jarjar`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -115740,7 +115752,7 @@ ], "env_var": "PANTS_JAVA_AVRO_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/codegen/avro/java/avro-tools.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=java-avro`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/codegen/avro/java/avro-tools.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=java-avro`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -116199,7 +116211,7 @@ ], "env_var": "PANTS_JUNIT_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/jvm/test/junit.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=junit`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/jvm/test/junit.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=junit`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -117076,7 +117088,7 @@ ], "env_var": "PANTS_KTLINT_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/kotlin/lint/ktlint/ktlint.lock for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=ktlint`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/kotlin/lint/ktlint/ktlint.lock for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=ktlint`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -119418,7 +119430,7 @@ ], "env_var": "PANTS_OPENAPI_GENERATOR_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/openapi/subsystems/openapi_generator.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=openapi-generator`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/openapi/subsystems/openapi_generator.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=openapi-generator`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -120584,7 +120596,7 @@ ], "env_var": "PANTS_PROTOBUF_JAVA_GRPC_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/codegen/protobuf/java/grpc-java.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=protobuf-java-grpc`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/codegen/protobuf/java/grpc-java.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=protobuf-java-grpc`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -127394,7 +127406,7 @@ ], "env_var": "PANTS_SCALAFMT_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/scala/lint/scalafmt/scalafmt.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalafmt`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/scala/lint/scalafmt/scalafmt.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalafmt`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -127689,7 +127701,7 @@ ], "env_var": "PANTS_SCALAPB_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/codegen/protobuf/scala/scalapbc.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalapb`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/codegen/protobuf/scala/scalapbc.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalapb`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -127900,7 +127912,7 @@ ], "env_var": "PANTS_SCALATEST_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/scala/subsystems/scalatest.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalatest`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/scala/subsystems/scalatest.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalatest`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -128423,7 +128435,7 @@ ], "env_var": "PANTS_SCROOGE_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/codegen/thrift/scrooge/scrooge.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scrooge`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/codegen/thrift/scrooge/scrooge.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scrooge`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ diff --git a/versioned_docs/version-2.20/reference/subsystems/google-java-format.mdx b/versioned_docs/version-2.20/reference/subsystems/google-java-format.mdx index cd6d8c41..3393187d 100644 --- a/versioned_docs/version-2.20/reference/subsystems/google-java-format.mdx +++ b/versioned_docs/version-2.20/reference/subsystems/google-java-format.mdx @@ -99,7 +99,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/java/lint/google_java_format/google_java_format.default.lockfile.txt for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/java/lint/google_java_format/google_java_format.default.lockfile.txt for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=google-java-format`. diff --git a/versioned_docs/version-2.20/reference/subsystems/jarjar.mdx b/versioned_docs/version-2.20/reference/subsystems/jarjar.mdx index 1501e601..2339fc40 100644 --- a/versioned_docs/version-2.20/reference/subsystems/jarjar.mdx +++ b/versioned_docs/version-2.20/reference/subsystems/jarjar.mdx @@ -100,7 +100,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/jvm/shading/jarjar.default.lockfile.txt for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/jvm/shading/jarjar.default.lockfile.txt for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=jarjar`. diff --git a/versioned_docs/version-2.20/reference/subsystems/java-avro.mdx b/versioned_docs/version-2.20/reference/subsystems/java-avro.mdx index 9482ca6d..5c687a49 100644 --- a/versioned_docs/version-2.20/reference/subsystems/java-avro.mdx +++ b/versioned_docs/version-2.20/reference/subsystems/java-avro.mdx @@ -73,7 +73,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/codegen/avro/java/avro-tools.default.lockfile.txt for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/codegen/avro/java/avro-tools.default.lockfile.txt for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=java-avro`. diff --git a/versioned_docs/version-2.20/reference/subsystems/junit.mdx b/versioned_docs/version-2.20/reference/subsystems/junit.mdx index b5d5de52..4606299d 100644 --- a/versioned_docs/version-2.20/reference/subsystems/junit.mdx +++ b/versioned_docs/version-2.20/reference/subsystems/junit.mdx @@ -103,7 +103,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/jvm/test/junit.default.lockfile.txt for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/jvm/test/junit.default.lockfile.txt for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=junit`. diff --git a/versioned_docs/version-2.20/reference/subsystems/ktlint.mdx b/versioned_docs/version-2.20/reference/subsystems/ktlint.mdx index f4681005..9f13ec52 100644 --- a/versioned_docs/version-2.20/reference/subsystems/ktlint.mdx +++ b/versioned_docs/version-2.20/reference/subsystems/ktlint.mdx @@ -85,7 +85,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/kotlin/lint/ktlint/ktlint.lock for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/kotlin/lint/ktlint/ktlint.lock for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=ktlint`. diff --git a/versioned_docs/version-2.20/reference/subsystems/openapi-generator.mdx b/versioned_docs/version-2.20/reference/subsystems/openapi-generator.mdx index b3801b4c..a258de5e 100644 --- a/versioned_docs/version-2.20/reference/subsystems/openapi-generator.mdx +++ b/versioned_docs/version-2.20/reference/subsystems/openapi-generator.mdx @@ -73,7 +73,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/openapi/subsystems/openapi_generator.default.lockfile.txt for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/openapi/subsystems/openapi_generator.default.lockfile.txt for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=openapi-generator`. diff --git a/versioned_docs/version-2.20/reference/subsystems/protobuf-java-grpc.mdx b/versioned_docs/version-2.20/reference/subsystems/protobuf-java-grpc.mdx index 8df7ffef..cb0929d5 100644 --- a/versioned_docs/version-2.20/reference/subsystems/protobuf-java-grpc.mdx +++ b/versioned_docs/version-2.20/reference/subsystems/protobuf-java-grpc.mdx @@ -73,7 +73,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/codegen/protobuf/java/grpc-java.default.lockfile.txt for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/codegen/protobuf/java/grpc-java.default.lockfile.txt for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=protobuf-java-grpc`. diff --git a/versioned_docs/version-2.20/reference/subsystems/scalafmt.mdx b/versioned_docs/version-2.20/reference/subsystems/scalafmt.mdx index 3b9095c2..f568d6b6 100644 --- a/versioned_docs/version-2.20/reference/subsystems/scalafmt.mdx +++ b/versioned_docs/version-2.20/reference/subsystems/scalafmt.mdx @@ -99,7 +99,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/scala/lint/scalafmt/scalafmt.default.lockfile.txt for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/scala/lint/scalafmt/scalafmt.default.lockfile.txt for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalafmt`. diff --git a/versioned_docs/version-2.20/reference/subsystems/scalapb.mdx b/versioned_docs/version-2.20/reference/subsystems/scalapb.mdx index c20af28a..69bf2975 100644 --- a/versioned_docs/version-2.20/reference/subsystems/scalapb.mdx +++ b/versioned_docs/version-2.20/reference/subsystems/scalapb.mdx @@ -91,7 +91,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/codegen/protobuf/scala/scalapbc.default.lockfile.txt for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/codegen/protobuf/scala/scalapbc.default.lockfile.txt for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalapb`. diff --git a/versioned_docs/version-2.20/reference/subsystems/scalatest.mdx b/versioned_docs/version-2.20/reference/subsystems/scalatest.mdx index 89627a82..8cc9846c 100644 --- a/versioned_docs/version-2.20/reference/subsystems/scalatest.mdx +++ b/versioned_docs/version-2.20/reference/subsystems/scalatest.mdx @@ -105,7 +105,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/scala/subsystems/scalatest.default.lockfile.txt for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/scala/subsystems/scalatest.default.lockfile.txt for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalatest`. diff --git a/versioned_docs/version-2.20/reference/subsystems/scrooge.mdx b/versioned_docs/version-2.20/reference/subsystems/scrooge.mdx index 200a55e2..2829da25 100644 --- a/versioned_docs/version-2.20/reference/subsystems/scrooge.mdx +++ b/versioned_docs/version-2.20/reference/subsystems/scrooge.mdx @@ -73,7 +73,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/codegen/thrift/scrooge/scrooge.default.lockfile.txt for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/codegen/thrift/scrooge/scrooge.default.lockfile.txt for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scrooge`. diff --git a/versioned_docs/version-2.20/reference/targets/jvm_artifact.mdx b/versioned_docs/version-2.20/reference/targets/jvm_artifact.mdx index d6f9587d..300f6da7 100644 --- a/versioned_docs/version-2.20/reference/targets/jvm_artifact.mdx +++ b/versioned_docs/version-2.20/reference/targets/jvm_artifact.mdx @@ -148,7 +148,7 @@ The JVM packages this artifact provides for the purposes of dependency inference For example, the JVM artifact `junit:junit` might provide `["org.junit.**"]`. -Usually you can leave this field off. If unspecified, Pants will fall back to the `[java-infer].third_party_import_mapping`, then to a built in mapping (https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/jvm/dependency_inference/jvm_artifact_mappings.py), and then finally it will default to the normalized `group` of the artifact. For example, in the absence of any other mapping the artifact `io.confluent:common-config` would default to providing `["io.confluent.**"]`. +Usually you can leave this field off. If unspecified, Pants will fall back to the `[java-infer].third_party_import_mapping`, then to a built in mapping (https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/jvm/dependency_inference/jvm_artifact_mappings.py), and then finally it will default to the normalized `group` of the artifact. For example, in the absence of any other mapping the artifact `io.confluent:common-config` would default to providing `["io.confluent.**"]`. The package path may be made recursive to match symbols in subpackages by adding `.**` to the end of the package path. For example, specify `["org.junit.**"]` to infer a dependency on the artifact for any file importing a symbol from `org.junit` or its subpackages. diff --git a/versioned_docs/version-2.20/reference/targets/pants_requirements.mdx b/versioned_docs/version-2.20/reference/targets/pants_requirements.mdx index 39fbe8c9..d3cbd860 100644 --- a/versioned_docs/version-2.20/reference/targets/pants_requirements.mdx +++ b/versioned_docs/version-2.20/reference/targets/pants_requirements.mdx @@ -79,7 +79,7 @@ If true, include `pantsbuild.pants.testutil` to write tests for your plugin. The PEP 440 version specifier version of Pants to target. E.g. `== 2.15.*`, or `>= 2.16.0, < 2.17.0` diff --git a/versioned_docs/version-2.20/reference/targets/python_requirement.mdx b/versioned_docs/version-2.20/reference/targets/python_requirement.mdx index e248970c..41977952 100644 --- a/versioned_docs/version-2.20/reference/targets/python_requirement.mdx +++ b/versioned_docs/version-2.20/reference/targets/python_requirement.mdx @@ -96,7 +96,7 @@ The modules this requirement provides (used for dependency inference). For example, the requirement `setuptools` provides `["setuptools", "pkg_resources", "easy_install"]`. -Usually you can leave this field off. If unspecified, Pants will first look at the default module mapping (https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/python/dependency_inference/default_module_mapping.py), and then will default to the normalized project name. For example, the requirement `Django` would default to the module `django`. +Usually you can leave this field off. If unspecified, Pants will first look at the default module mapping (https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/python/dependency_inference/default_module_mapping.py), and then will default to the normalized project name. For example, the requirement `Django` would default to the module `django`. Mutually exclusive with the `type_stub_modules` field. @@ -141,7 +141,7 @@ The modules this requirement provides if the requirement is a type stub (used fo For example, the requirement `types-requests` provides `["requests"]`. -Usually you can leave this field off. If unspecified, Pants will first look at the default module mapping (https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/backend/python/dependency_inference/default_module_mapping.py). If not found _and_ the requirement name starts with `types-` or `stubs-`, or ends with `-types` or `-stubs`, will default to that requirement name without the prefix/suffix. For example, `types-requests` would default to `requests`. Otherwise, will be treated like a normal requirement (see the `modules` field). +Usually you can leave this field off. If unspecified, Pants will first look at the default module mapping (https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/python/dependency_inference/default_module_mapping.py). If not found _and_ the requirement name starts with `types-` or `stubs-`, or ends with `-types` or `-stubs`, will default to that requirement name without the prefix/suffix. For example, `types-requests` would default to `requests`. Otherwise, will be treated like a normal requirement (see the `modules` field). Mutually exclusive with the `modules` field. diff --git a/versioned_docs/version-2.20/reference/targets/scala_artifact.mdx b/versioned_docs/version-2.20/reference/targets/scala_artifact.mdx index 9bdacdc7..79259701 100644 --- a/versioned_docs/version-2.20/reference/targets/scala_artifact.mdx +++ b/versioned_docs/version-2.20/reference/targets/scala_artifact.mdx @@ -151,7 +151,7 @@ The JVM packages this artifact provides for the purposes of dependency inference For example, the JVM artifact `junit:junit` might provide `["org.junit.**"]`. -Usually you can leave this field off. If unspecified, Pants will fall back to the `[java-infer].third_party_import_mapping`, then to a built in mapping (https://github.com/pantsbuild/pants/blob/release_2.20.3rc1/src/python/pants/jvm/dependency_inference/jvm_artifact_mappings.py), and then finally it will default to the normalized `group` of the artifact. For example, in the absence of any other mapping the artifact `io.confluent:common-config` would default to providing `["io.confluent.**"]`. +Usually you can leave this field off. If unspecified, Pants will fall back to the `[java-infer].third_party_import_mapping`, then to a built in mapping (https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/jvm/dependency_inference/jvm_artifact_mappings.py), and then finally it will default to the normalized `group` of the artifact. For example, in the absence of any other mapping the artifact `io.confluent:common-config` would default to providing `["io.confluent.**"]`. The package path may be made recursive to match symbols in subpackages by adding `.**` to the end of the package path. For example, specify `["org.junit.**"]` to infer a dependency on the artifact for any file importing a symbol from `org.junit` or its subpackages.