From 7dad340de2feeb4983491dee084df9d358e4746f Mon Sep 17 00:00:00 2001 From: "Worker Pants (Pantsbuild GitHub Automation Bot)" <133242086+WorkerPants@users.noreply.github.com> Date: Mon, 16 Sep 2024 18:52:05 -0400 Subject: [PATCH] Update docs site for version 2.21.2rc1 (#263) Docs from https://github.com/pantsbuild/pants/releases/tag/release_2.21.2rc1 --- .../version-2.21/reference/help-all.json | 1472 ++++++++--------- .../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/scalafix.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 +- 17 files changed, 752 insertions(+), 754 deletions(-) diff --git a/versioned_docs/version-2.21/reference/help-all.json b/versioned_docs/version-2.21/reference/help-all.json index bbb0e69e..394d7031 100644 --- a/versioned_docs/version-2.21/reference/help-all.json +++ b/versioned_docs/version-2.21/reference/help-all.json @@ -11007,7 +11007,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.21.2rc0/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.21.2rc1/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": [ @@ -14349,7 +14349,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.21.2rc0/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.21.2rc1/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": [ @@ -14669,7 +14669,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.21.2rc0/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.21.2rc1/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": [ @@ -15033,7 +15033,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.21.2rc0/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.21.2rc1/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": [ @@ -15835,7 +15835,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.21.2rc0/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.21.2rc1/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": [ @@ -18605,7 +18605,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.21.2rc0/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.21.2rc1/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": [ @@ -20499,7 +20499,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.21.2rc0/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.21.2rc1/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": [ @@ -26316,7 +26316,7 @@ "details": "", "rank": "HARDCODED", "value": { - "user-agent": "pants/2.21.2rc0" + "user-agent": "pants/2.21.2rc1" } } ] @@ -26692,7 +26692,7 @@ "details": "", "rank": "HARDCODED", "value": { - "user-agent": "pants/2.21.2rc0" + "user-agent": "pants/2.21.2rc1" } } ] @@ -27836,7 +27836,7 @@ ], "env_var": "PANTS_SCALAFIX_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.21.2rc0/src/python/pants/backend/scala/lint/scalafix/scalafix.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=scalafix`.", + "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.21.2rc1/src/python/pants/backend/scala/lint/scalafix/scalafix.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=scalafix`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -28199,7 +28199,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.21.2rc0/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.21.2rc1/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": [ @@ -28482,7 +28482,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.21.2rc0/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.21.2rc1/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": [ @@ -28682,7 +28682,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.21.2rc0/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.21.2rc1/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": [ @@ -29385,7 +29385,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.21.2rc0/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.21.2rc1/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": [ @@ -34678,12 +34678,12 @@ { "details": null, "rank": "HARDCODED", - "value": "2.21.2rc0" + "value": "2.21.2rc1" }, { "details": "from env var PANTS_VERSION", "rank": "ENVIRONMENT", - "value": "2.21.2rc0" + "value": "2.21.2rc1" } ] } @@ -35713,22 +35713,21 @@ "name_to_api_type_info": { "abc.EnvironmentAware": { "consumed_by_rules": [ - "pants.backend.python.providers.pyenv.rules.get_pyenv_install_info" + "pants.core.util_rules.subprocess_environment.get_subprocess_environment" ], "dependencies": [ - "pants.backend.experimental.javascript", - "pants.core" + "pants.backend.experimental.javascript" ], "dependents": [ - "pants.backend.python.providers.experimental.pyenv" + "pants.core" ], "documentation": null, "is_union": false, "module": "abc", "name": "EnvironmentAware", - "provider": "pants.backend.python.providers.experimental.pyenv", + "provider": "pants.core", "returned_by_rules": [ - "construct_env_aware_scope_pyenv_python_provider" + "construct_env_aware_scope_subprocess_environment" ], "union_members": [], "union_type": null, @@ -59437,19 +59436,19 @@ }, "pants.core.goals.fix.Batch": { "consumed_by_rules": [ - "pants.backend.python.lint.docformatter.rules.docformatter_fmt" + "pants.backend.python.lint.add_trailing_comma.rules.add_trailing_comma_fmt" ], "dependencies": [ "pants.core" ], "dependents": [ - "pants.backend.python.lint.docformatter" + "pants.backend.experimental.python.lint.add_trailing_comma" ], "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.python.lint.docformatter", + "provider": "pants.backend.experimental.python.lint.add_trailing_comma", "returned_by_rules": [], "union_members": [], "union_type": "Batch", @@ -60348,19 +60347,19 @@ }, "pants.core.goals.lint.Batch": { "consumed_by_rules": [ - "pants.backend.python.lint.pylint.rules.run_pylint" + "pants.backend.terraform.lint.tfsec.rules.run_tfsec" ], "dependencies": [ "pants.core" ], "dependents": [ - "pants.backend.python.lint.pylint" + "pants.backend.experimental.terraform.lint.tfsec" ], "documentation": null, "is_union": true, "module": "pants.core.goals.lint", "name": "Batch", - "provider": "pants.backend.python.lint.pylint", + "provider": "pants.backend.experimental.terraform.lint.tfsec", "returned_by_rules": [], "union_members": [], "union_type": "Batch", @@ -60537,19 +60536,19 @@ }, "pants.core.goals.lint.PartitionRequest": { "consumed_by_rules": [ - "pants.backend.python.lint.pylint.rules.partition_pylint" + "pants.core.util_rules.partitions._single_partition_file_rules.partitioner_DocformatterRequest" ], "dependencies": [ "pants.core" ], "dependents": [ - "pants.backend.python.lint.pylint" + "pants.backend.python.lint.docformatter" ], "documentation": null, "is_union": true, "module": "pants.core.goals.lint", "name": "PartitionRequest", - "provider": "pants.backend.python.lint.pylint", + "provider": "pants.backend.python.lint.docformatter", "returned_by_rules": [], "union_members": [], "union_type": "PartitionRequest", @@ -61663,21 +61662,21 @@ }, "pants.core.goals.test.Batch": { "consumed_by_rules": [ - "pants.core.goals.test._unsupported_debug_adapter_rules.get_test_debug_adapter_request_JunitTestRequest", - "pants.jvm.test.junit.run_junit_test", - "pants.jvm.test.junit.setup_junit_debug_request" + "pants.backend.scala.test.scalatest.run_scalatest_test", + "pants.backend.scala.test.scalatest.setup_scalatest_debug_request", + "pants.core.goals.test._unsupported_debug_adapter_rules.get_test_debug_adapter_request_ScalatestTestRequest" ], "dependencies": [ "pants.core" ], "dependents": [ - "pants.backend.experimental.java" + "pants.backend.experimental.scala" ], "documentation": null, "is_union": true, "module": "pants.core.goals.test", "name": "Batch", - "provider": "pants.backend.experimental.java", + "provider": "pants.backend.experimental.scala", "returned_by_rules": [], "union_members": [], "union_type": "Batch", @@ -61795,19 +61794,19 @@ }, "pants.core.goals.test.PartitionRequest": { "consumed_by_rules": [ - "pants.core.util_rules.partitions._partition_per_input_field_set_rules.partitioner_HelmUnitTestRequest" + "pants.core.util_rules.partitions._partition_per_input_field_set_rules.partitioner_JunitTestRequest" ], "dependencies": [ "pants.core" ], "dependents": [ - "pants.backend.experimental.helm" + "pants.backend.experimental.java" ], "documentation": null, "is_union": true, "module": "pants.core.goals.test", "name": "PartitionRequest", - "provider": "pants.backend.experimental.helm", + "provider": "pants.backend.experimental.java", "returned_by_rules": [], "union_members": [], "union_type": "PartitionRequest", @@ -63424,7 +63423,7 @@ "is_union": false, "module": "pants.core.util_rules.environments", "name": "OptionField", - "provider": "pants.backend.python.providers.experimental.pyenv", + "provider": "pants.backend.docker", "returned_by_rules": [], "union_members": [], "union_type": "PluginField", @@ -64767,19 +64766,19 @@ }, "pants.core.util_rules.wrap_source.GenerateWrapSourceSourcesRequest": { "consumed_by_rules": [ - "pants.core.util_rules.wrap_source.wrap_source_rule_and_target.wrap_source_JavaSourceField" + "pants.core.util_rules.wrap_source.wrap_source_rule_and_target.wrap_source_KotlinSourceField" ], "dependencies": [ "pants.engine.target" ], "dependents": [ - "pants.backend.experimental.java" + "pants.backend.experimental.kotlin" ], "documentation": null, "is_union": false, "module": "pants.core.util_rules.wrap_source", "name": "GenerateWrapSourceSourcesRequest", - "provider": "pants.backend.experimental.java", + "provider": "pants.backend.experimental.kotlin", "returned_by_rules": [], "union_members": [], "union_type": "GenerateSourcesRequest", @@ -67754,7 +67753,7 @@ "consumed_by_rules": [], "dependencies": [], "dependents": [ - "pants.backend.experimental.codegen.avro.java" + "pants.backend.experimental.openapi.lint.openapi_format" ], "documentation": null, "is_union": true, @@ -67763,8 +67762,7 @@ "provider": "pants.engine.target", "returned_by_rules": [], "union_members": [ - "PrefixedJvmJdkField", - "PrefixedJvmResolveField" + "SkipOpenApiFormatField" ], "union_type": null, "used_in_rules": [] @@ -70993,7 +70991,7 @@ "consumed_by_rules": [], "dependencies": [], "dependents": [ - "pants.backend.python" + "pants.backend.experimental.docker.podman" ], "documentation": null, "is_union": true, @@ -71002,7 +71000,7 @@ "provider": "pants.option.subsystem", "returned_by_rules": [], "union_members": [ - "ExportPluginOptions" + "ExperimentalPodmanOptions" ], "union_type": null, "used_in_rules": [] @@ -89899,76 +89897,76 @@ "type_hint": "str | None" }, { - "alias": "test_extra_env_vars", + "alias": "go_generate_env_vars", "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 `[go-generate].env_vars` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_linker_flags", + "alias": "golang_cgo_fortran_flags", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_linker_flags` when this environment target is active.", + "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": "nodejs_search_path", + "alias": "golang_cgo_linker_flags", "default": null, - "description": "Overrides the default value from the option `[nodejs].search_path` when this environment target is active.", - "provider": "pants.backend.experimental.javascript", + "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": "golang_go_search_paths", + "alias": "pyenv_python_provider_installation_extra_env_vars", "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 `[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_cxx_flags", + "alias": "golang_cgo_tool_search_paths", "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_tool_search_paths` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_bootstrap_names", + "alias": "nodejs_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[python-bootstrap].names` 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": "pex_executable_search_paths", + "alias": "python_bootstrap_names", "default": null, - "description": "Overrides the default value from the option `[pex].executable_search_paths` when this environment target is active.", + "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_subprocess_env_vars", + "alias": "golang_external_linker_binary_name", "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].external_linker_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", + "alias": "nodejs_corepack_env_vars", "default": null, - "description": "Overrides the default value from the option `[golang].external_linker_binary_name` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "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": "str | None" + "type_hint": "Iterable[str] | None" }, { "alias": "golang_cgo_gxx_binary_name", @@ -89979,73 +89977,81 @@ "type_hint": "str | None" }, { - "alias": "nodejs_corepack_env_vars", + "alias": "jvm_global_options", "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 `[jvm].global_options` when this environment target is active.", + "provider": "pants.backend.experimental.java", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_tool_search_paths", + "alias": "python_native_code_cpp_flags", "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 `[python-native-code].cpp_flags` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "docker_executable_search_paths", + "alias": "pex_executable_search_paths", "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 `[pex].executable_search_paths` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "go_generate_env_vars", + "alias": "shell_setup_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[go-generate].env_vars` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "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" }, { - "alias": "golang_cgo_fortran_flags", + "alias": "python_bootstrap_search_path", "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 `[python-bootstrap].search_path` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "pyenv_python_provider_installation_extra_env_vars", + "alias": "test_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", + "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": "subprocess_environment_env_vars", + "alias": "golang_cgo_cxx_flags", "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 `[golang].cgo_cxx_flags` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_bootstrap_search_path", + "alias": "apache_thrift_thrift_search_paths", "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 `[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": "python_native_code_cpp_flags", + "alias": "golang_cgo_gcc_binary_name", "default": null, - "description": "Overrides the default value from the option `[python-native-code].cpp_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": "str | None" + }, + { + "alias": "system_binaries_system_binary_paths", + "default": null, + "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" @@ -90059,76 +90065,68 @@ "type_hint": "Iterable[str] | None" }, { - "alias": "docker_env_vars", + "alias": "nodejs_search_path", "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].search_path` when this environment target is active.", + "provider": "pants.backend.experimental.javascript", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "apache_thrift_thrift_search_paths", + "alias": "golang_cgo_fortran_binary_name", "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 `[golang].cgo_fortran_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": "python_native_code_ld_flags", + "alias": "docker_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[python-native-code].ld_flags` when this environment target is active.", - "provider": "pants.core", + "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": "system_binaries_system_binary_paths", + "alias": "golang_subprocess_env_vars", "default": null, - "description": "Overrides the default value from the option `[system-binaries].system_binary_paths` when this environment target is active.", - "provider": "pants.core", + "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": "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": "jvm_global_options", + "alias": "docker_env_vars", "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 `[docker].env_vars` when this environment target is active.", + "provider": "pants.backend.docker", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "nodejs_executable_search_paths", + "alias": "subprocess_environment_env_vars", "default": null, - "description": "Overrides the default value from the option `[nodejs].executable_search_paths` when this environment target is active.", - "provider": "pants.backend.experimental.javascript", + "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" }, { - "alias": "golang_cgo_fortran_binary_name", - "default": null, - "description": "Overrides the default value from the option `[golang].cgo_fortran_binary_name` when this environment target is active.", - "provider": "pants.backend.experimental.go", - "required": false, - "type_hint": "str | None" - }, - { - "alias": "golang_cgo_gcc_binary_name", + "alias": "golang_go_search_paths", "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].go_search_paths` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, - "type_hint": "str | None" + "type_hint": "Iterable[str] | None" } ], "provider": "pants.core", @@ -91075,18 +91073,18 @@ "type_hint": "bool" }, { - "alias": "skip_gofmt", + "alias": "skip_golangci_lint", "default": "False", - "description": "If true, don't run gofmt on this package.", - "provider": "pants.backend.experimental.go", + "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_golangci_lint", + "alias": "skip_gofmt", "default": "False", - "description": "If true, don't run `golangci-lint` on this target's code.", - "provider": "pants.backend.experimental.go.lint.golangci_lint", + "description": "If true, don't run gofmt on this package.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "bool" }, @@ -91315,52 +91313,52 @@ "type_hint": "bool" }, { - "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": "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_kubernetes_version", + "alias": "kubeconform_ignore_missing_schemas", "default": null, - "description": "Kubernetes version to use for the validation.", + "description": "Whether to fail if there are missing schemas for custom resources.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, - "type_hint": "str | None" + "type_hint": "bool | None" }, { - "alias": "kubeconform_ignore_missing_schemas", + "alias": "kubeconform_ignore_sources", "default": null, - "description": "Whether to fail if there are missing schemas for custom resources.", + "description": "Regular expression patterns specifying paths to ignore.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, - "type_hint": "bool | None" + "type_hint": "Iterable[str] | None" }, { - "alias": "kubeconform_reject_kinds", + "alias": "kubeconform_skip_kinds", "default": null, - "description": "List of kinds or GVKs to reject.", + "description": "List of kinds or GVKs to ignore.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "kubeconform_ignore_sources", + "alias": "kubeconform_strict", "default": null, - "description": "Regular expression patterns specifying paths to ignore.", + "description": "Run Kubeconform in strict mode.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, - "type_hint": "Iterable[str] | None" + "type_hint": "bool | None" } ], "provider": "pants.backend.experimental.helm", @@ -91483,52 +91481,52 @@ "type_hint": "bool" }, { - "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": "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_kubernetes_version", + "alias": "kubeconform_ignore_missing_schemas", "default": null, - "description": "Kubernetes version to use for the validation.", + "description": "Whether to fail if there are missing schemas for custom resources.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, - "type_hint": "str | None" + "type_hint": "bool | None" }, { - "alias": "kubeconform_ignore_missing_schemas", + "alias": "kubeconform_ignore_sources", "default": null, - "description": "Whether to fail if there are missing schemas for custom resources.", + "description": "Regular expression patterns specifying paths to ignore.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, - "type_hint": "bool | None" + "type_hint": "Iterable[str] | None" }, { - "alias": "kubeconform_reject_kinds", + "alias": "kubeconform_skip_kinds", "default": null, - "description": "List of kinds or GVKs to reject.", + "description": "List of kinds or GVKs to ignore.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "kubeconform_ignore_sources", + "alias": "kubeconform_strict", "default": null, - "description": "Regular expression patterns specifying paths to ignore.", + "description": "Run Kubeconform in strict mode.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, - "type_hint": "Iterable[str] | None" + "type_hint": "bool | None" } ], "provider": "pants.backend.experimental.helm", @@ -92261,7 +92259,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.21.2rc0/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.21.2rc1/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" @@ -92883,76 +92881,76 @@ "type_hint": "str | None" }, { - "alias": "test_extra_env_vars", + "alias": "go_generate_env_vars", "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 `[go-generate].env_vars` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_linker_flags", + "alias": "golang_cgo_fortran_flags", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_linker_flags` when this environment target is active.", + "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": "nodejs_search_path", + "alias": "golang_cgo_linker_flags", "default": null, - "description": "Overrides the default value from the option `[nodejs].search_path` when this environment target is active.", - "provider": "pants.backend.experimental.javascript", + "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": "golang_go_search_paths", + "alias": "pyenv_python_provider_installation_extra_env_vars", "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 `[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_cxx_flags", + "alias": "golang_cgo_tool_search_paths", "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_tool_search_paths` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_bootstrap_names", + "alias": "nodejs_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[python-bootstrap].names` 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": "pex_executable_search_paths", + "alias": "python_bootstrap_names", "default": null, - "description": "Overrides the default value from the option `[pex].executable_search_paths` when this environment target is active.", + "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_subprocess_env_vars", + "alias": "golang_external_linker_binary_name", "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].external_linker_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", + "alias": "nodejs_corepack_env_vars", "default": null, - "description": "Overrides the default value from the option `[golang].external_linker_binary_name` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "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": "str | None" + "type_hint": "Iterable[str] | None" }, { "alias": "golang_cgo_gxx_binary_name", @@ -92963,73 +92961,81 @@ "type_hint": "str | None" }, { - "alias": "nodejs_corepack_env_vars", + "alias": "jvm_global_options", "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 `[jvm].global_options` when this environment target is active.", + "provider": "pants.backend.experimental.java", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_tool_search_paths", + "alias": "python_native_code_cpp_flags", "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 `[python-native-code].cpp_flags` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "docker_executable_search_paths", + "alias": "pex_executable_search_paths", "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 `[pex].executable_search_paths` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "go_generate_env_vars", + "alias": "shell_setup_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[go-generate].env_vars` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "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" }, { - "alias": "golang_cgo_fortran_flags", + "alias": "python_bootstrap_search_path", "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 `[python-bootstrap].search_path` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "pyenv_python_provider_installation_extra_env_vars", + "alias": "test_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", + "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": "subprocess_environment_env_vars", + "alias": "golang_cgo_cxx_flags", "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 `[golang].cgo_cxx_flags` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_bootstrap_search_path", + "alias": "apache_thrift_thrift_search_paths", "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 `[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": "python_native_code_cpp_flags", + "alias": "golang_cgo_gcc_binary_name", "default": null, - "description": "Overrides the default value from the option `[python-native-code].cpp_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": "str | None" + }, + { + "alias": "system_binaries_system_binary_paths", + "default": null, + "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" @@ -93043,76 +93049,68 @@ "type_hint": "Iterable[str] | None" }, { - "alias": "docker_env_vars", + "alias": "nodejs_search_path", "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].search_path` when this environment target is active.", + "provider": "pants.backend.experimental.javascript", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "apache_thrift_thrift_search_paths", + "alias": "golang_cgo_fortran_binary_name", "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 `[golang].cgo_fortran_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": "python_native_code_ld_flags", + "alias": "docker_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[python-native-code].ld_flags` when this environment target is active.", - "provider": "pants.core", + "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": "system_binaries_system_binary_paths", + "alias": "golang_subprocess_env_vars", "default": null, - "description": "Overrides the default value from the option `[system-binaries].system_binary_paths` when this environment target is active.", - "provider": "pants.core", + "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": "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": "jvm_global_options", + "alias": "docker_env_vars", "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 `[docker].env_vars` when this environment target is active.", + "provider": "pants.backend.docker", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "nodejs_executable_search_paths", + "alias": "subprocess_environment_env_vars", "default": null, - "description": "Overrides the default value from the option `[nodejs].executable_search_paths` when this environment target is active.", - "provider": "pants.backend.experimental.javascript", + "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" }, { - "alias": "golang_cgo_fortran_binary_name", - "default": null, - "description": "Overrides the default value from the option `[golang].cgo_fortran_binary_name` when this environment target is active.", - "provider": "pants.backend.experimental.go", - "required": false, - "type_hint": "str | None" - }, - { - "alias": "golang_cgo_gcc_binary_name", + "alias": "golang_go_search_paths", "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].go_search_paths` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, - "type_hint": "str | None" + "type_hint": "Iterable[str] | None" } ], "provider": "pants.core", @@ -93267,36 +93265,28 @@ "type_hint": "str | None" }, { - "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": "bool" - }, - { - "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": "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" }, { - "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": "skip_spectral", @@ -93305,6 +93295,14 @@ "provider": "pants.backend.experimental.openapi.lint.spectral", "required": false, "type_hint": "bool" + }, + { + "alias": "java_api_package", + "default": null, + "description": "Root package for generated API code", + "provider": "pants.backend.experimental.openapi.codegen.java", + "required": false, + "type_hint": "str | None" } ], "provider": "pants.backend.experimental.openapi", @@ -93347,36 +93345,28 @@ "type_hint": "str | None" }, { - "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": "bool" - }, - { - "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": "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" }, { - "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": "skip_spectral", @@ -93386,6 +93376,14 @@ "required": false, "type_hint": "bool" }, + { + "alias": "java_api_package", + "default": null, + "description": "Root package for generated API code", + "provider": "pants.backend.experimental.openapi.codegen.java", + "required": false, + "type_hint": "str | None" + }, { "alias": "dependencies", "default": null, @@ -93564,7 +93562,7 @@ }, { "alias": "version_spec", - "default": "'== 2.21.2rc0'", + "default": "'== 2.21.2rc1'", "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, @@ -94218,14 +94216,6 @@ "required": false, "type_hint": "bool" }, - { - "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": "bool" - }, { "alias": "jvm_resolve", "default": null, @@ -94234,14 +94224,6 @@ "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", - "required": false, - "type_hint": "bool" - }, { "alias": "jvm_jdk", "default": null, @@ -94259,12 +94241,12 @@ "type_hint": "str | None" }, { - "alias": "python_interpreter_constraints", - "default": null, - "description": "The Python interpreters this code is compatible with.\n\nEach element should be written in pip-style format, e.g. `CPython==2.7.*` or `CPython>=3.6,<4`. You can leave off `CPython` as a shorthand, e.g. `>=2.7` will be expanded to `CPython>=2.7`.\n\nSpecify more than one element to OR the constraints, e.g. `['PyPy==3.7.*', 'CPython==3.7.*']` means either PyPy 3.7 _or_ CPython 3.7.\n\nIf the field is not set, it will default to the option `[python].interpreter_constraints`.\n\nSee https://www.pantsbuild.org/2.21/docs/python/overview/interpreter-compatibility for how these interpreter constraints are merged with the constraints of dependencies.", - "provider": "pants.backend.codegen.protobuf.python", + "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": "Iterable[str] | None" + "type_hint": "bool" }, { "alias": "python_resolve", @@ -94274,6 +94256,22 @@ "required": false, "type_hint": "str | None" }, + { + "alias": "python_interpreter_constraints", + "default": null, + "description": "The Python interpreters this code is compatible with.\n\nEach element should be written in pip-style format, e.g. `CPython==2.7.*` or `CPython>=3.6,<4`. You can leave off `CPython` as a shorthand, e.g. `>=2.7` will be expanded to `CPython>=2.7`.\n\nSpecify more than one element to OR the constraints, e.g. `['PyPy==3.7.*', 'CPython==3.7.*']` means either PyPy 3.7 _or_ CPython 3.7.\n\nIf the field is not set, it will default to the option `[python].interpreter_constraints`.\n\nSee https://www.pantsbuild.org/2.21/docs/python/overview/interpreter-compatibility for how these interpreter constraints are merged with the constraints of dependencies.", + "provider": "pants.backend.codegen.protobuf.python", + "required": false, + "type_hint": "Iterable[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", + "required": false, + "type_hint": "bool" + }, { "alias": "go_mod_address", "default": null, @@ -94323,36 +94321,36 @@ "type_hint": "Dict[Union[str, Tuple[str, ...]], Dict[str, Any]] | None" }, { - "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", + "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": "bool" + "type_hint": "str | None" }, { - "alias": "jvm_resolve", + "alias": "jvm_jdk", "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": "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", + "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_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", + "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", "required": false, - "type_hint": "str | None" + "type_hint": "bool" }, { "alias": "go_mod_address", @@ -94371,17 +94369,17 @@ "type_hint": "Iterable[str] | None" }, { - "alias": "python_resolve", + "alias": "python_source_root", "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.", + "description": "The source root to generate Python sources under.\n\nIf unspecified, the source root the `protobuf_sources` is under will be used.", "provider": "", "required": false, "type_hint": "str | None" }, { - "alias": "python_source_root", + "alias": "python_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.", + "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": "", "required": false, "type_hint": "str | None" @@ -94795,12 +94793,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", @@ -94811,12 +94809,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", @@ -94957,7 +94955,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.21.2rc0/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.21.2rc1/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" @@ -94965,7 +94963,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.21.2rc0/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.21.2rc1/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" @@ -95123,66 +95121,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_ruff", + "alias": "skip_autoflake", "default": "False", - "description": "If True, do not run any Ruff tools on this target's code.", - "provider": "pants.backend.experimental.python.lint.ruff", + "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_format", + "alias": "skip_isort", "default": "False", - "description": "If true, don't run the ruff formatter on this target's code.", - "provider": "pants.backend.experimental.python.lint.ruff.format", + "description": "If true, don't run isort on this target's code.", + "provider": "pants.backend.python.lint.isort", "required": false, "type_hint": "bool" }, { - "alias": "skip_black", + "alias": "skip_yapf", "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 yapf on this target's code.", + "provider": "pants.backend.python.lint.yapf", "required": false, "type_hint": "bool" }, { - "alias": "skip_flake8", + "alias": "skip_ruff", "default": "False", - "description": "If true, don't run Flake8 on this target's code.", - "provider": "pants.backend.python.lint.flake8", + "description": "If True, do not run any Ruff tools on this target's code.", + "provider": "pants.backend.experimental.python.lint.ruff", "required": false, "type_hint": "bool" }, { - "alias": "skip_bandit", + "alias": "skip_ruff_check", "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 the ruff checker on this target's code.", + "provider": "pants.backend.experimental.python.lint.ruff", "required": false, "type_hint": "bool" }, { - "alias": "skip_autoflake", + "alias": "skip_ruff_format", "default": "False", - "description": "If true, don't run Autoflake on this target's code.", - "provider": "pants.backend.python.lint.autoflake", + "description": "If true, don't run the ruff formatter on this target's code.", + "provider": "pants.backend.experimental.python.lint.ruff.format", "required": false, "type_hint": "bool" }, { - "alias": "skip_mypy", + "alias": "skip_pyright", "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 Pyright on this target's code.", + "provider": "pants.backend.experimental.python.typecheck.pyright", "required": false, "type_hint": "bool" }, @@ -95195,10 +95185,10 @@ "type_hint": "bool" }, { - "alias": "skip_isort", + "alias": "skip_flake8", "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 Flake8 on this target's code.", + "provider": "pants.backend.python.lint.flake8", "required": false, "type_hint": "bool" }, @@ -95210,6 +95200,14 @@ "required": false, "type_hint": "bool" }, + { + "alias": "skip_docformatter", + "default": "False", + "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_pytype", "default": "False", @@ -95219,42 +95217,42 @@ "type_hint": "bool" }, { - "alias": "skip_pydocstyle", + "alias": "skip_mypy", "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 MyPy on this target's code.", + "provider": "pants.backend.python.typecheck.mypy", "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_ruff_check", + "alias": "skip_pydocstyle", "default": "False", - "description": "If true, don't run the ruff checker on this target's code.", - "provider": "pants.backend.experimental.python.lint.ruff", + "description": "If true, don't run pydocstyle on this target's code.", + "provider": "pants.backend.python.lint.pydocstyle", "required": false, "type_hint": "bool" }, { - "alias": "skip_pyupgrade", + "alias": "skip_black", "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 Black on this target's code.", + "provider": "pants.backend.python.lint.black", "required": false, "type_hint": "bool" }, { - "alias": "skip_docformatter", + "alias": "skip_pyupgrade", "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 pyupgrade on this target's code.", + "provider": "pants.backend.python.lint.pyupgrade", "required": false, "type_hint": "bool" } @@ -95299,66 +95297,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_ruff", + "alias": "skip_autoflake", "default": "False", - "description": "If True, do not run any Ruff tools on this target's code.", - "provider": "pants.backend.experimental.python.lint.ruff", + "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_format", + "alias": "skip_isort", "default": "False", - "description": "If true, don't run the ruff formatter on this target's code.", - "provider": "pants.backend.experimental.python.lint.ruff.format", + "description": "If true, don't run isort on this target's code.", + "provider": "pants.backend.python.lint.isort", "required": false, "type_hint": "bool" }, { - "alias": "skip_black", + "alias": "skip_yapf", "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 yapf on this target's code.", + "provider": "pants.backend.python.lint.yapf", "required": false, "type_hint": "bool" }, { - "alias": "skip_flake8", + "alias": "skip_ruff", "default": "False", - "description": "If true, don't run Flake8 on this target's code.", - "provider": "pants.backend.python.lint.flake8", + "description": "If True, do not run any Ruff tools on this target's code.", + "provider": "pants.backend.experimental.python.lint.ruff", "required": false, "type_hint": "bool" }, { - "alias": "skip_bandit", + "alias": "skip_ruff_check", "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 the ruff checker on this target's code.", + "provider": "pants.backend.experimental.python.lint.ruff", "required": false, "type_hint": "bool" }, { - "alias": "skip_autoflake", + "alias": "skip_ruff_format", "default": "False", - "description": "If true, don't run Autoflake on this target's code.", - "provider": "pants.backend.python.lint.autoflake", + "description": "If true, don't run the ruff formatter on this target's code.", + "provider": "pants.backend.experimental.python.lint.ruff.format", "required": false, "type_hint": "bool" }, { - "alias": "skip_mypy", + "alias": "skip_pyright", "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 Pyright on this target's code.", + "provider": "pants.backend.experimental.python.typecheck.pyright", "required": false, "type_hint": "bool" }, @@ -95371,10 +95361,10 @@ "type_hint": "bool" }, { - "alias": "skip_isort", + "alias": "skip_flake8", "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 Flake8 on this target's code.", + "provider": "pants.backend.python.lint.flake8", "required": false, "type_hint": "bool" }, @@ -95386,6 +95376,14 @@ "required": false, "type_hint": "bool" }, + { + "alias": "skip_docformatter", + "default": "False", + "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_pytype", "default": "False", @@ -95395,42 +95393,42 @@ "type_hint": "bool" }, { - "alias": "skip_pydocstyle", + "alias": "skip_mypy", "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 MyPy on this target's code.", + "provider": "pants.backend.python.typecheck.mypy", "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_ruff_check", + "alias": "skip_pydocstyle", "default": "False", - "description": "If true, don't run the ruff checker on this target's code.", - "provider": "pants.backend.experimental.python.lint.ruff", + "description": "If true, don't run pydocstyle on this target's code.", + "provider": "pants.backend.python.lint.pydocstyle", "required": false, "type_hint": "bool" }, { - "alias": "skip_pyupgrade", + "alias": "skip_black", "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 Black on this target's code.", + "provider": "pants.backend.python.lint.black", "required": false, "type_hint": "bool" }, { - "alias": "skip_docformatter", + "alias": "skip_pyupgrade", "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 pyupgrade on this target's code.", + "provider": "pants.backend.python.lint.pyupgrade", "required": false, "type_hint": "bool" }, @@ -95594,6 +95592,22 @@ "required": true, "type_hint": "str" }, + { + "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_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" + }, { "alias": "skip_yapf", "default": "False", @@ -95610,6 +95624,14 @@ "required": false, "type_hint": "bool" }, + { + "alias": "skip_ruff_check", + "default": "False", + "description": "If true, don't run the ruff checker on this target's code.", + "provider": "pants.backend.experimental.python.lint.ruff", + "required": false, + "type_hint": "bool" + }, { "alias": "skip_ruff_format", "default": "False", @@ -95619,18 +95641,18 @@ "type_hint": "bool" }, { - "alias": "skip_black", + "alias": "skip_pyright", "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 Pyright on this target's code.", + "provider": "pants.backend.experimental.python.typecheck.pyright", "required": false, "type_hint": "bool" }, { - "alias": "skip_flake8", + "alias": "skip_add_trailing_comma", "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 add-trailing-comma on this target's code.", + "provider": "pants.backend.experimental.python.lint.add_trailing_comma", "required": false, "type_hint": "bool" }, @@ -95643,60 +95665,52 @@ "type_hint": "bool" }, { - "alias": "skip_autoflake", + "alias": "skip_flake8", "default": "False", - "description": "If true, don't run Autoflake on this target's code.", - "provider": "pants.backend.python.lint.autoflake", + "description": "If true, don't run Flake8 on this target's code.", + "provider": "pants.backend.python.lint.flake8", "required": false, "type_hint": "bool" }, { - "alias": "stevedore_namespaces", - "default": null, - "description": "List the stevedore namespaces required by this target.\n\nCode for all `entry_points` on `python_distribution` targets with these namespaces will be added as dependencies so that they are available on PYTHONPATH during tests. Note that this is only a subset of the `python_distribution`s dependencies, so the `entry_points` only need to be defined on one `python_distribution` even if the test only needs some of the `entry_points` namespaces on it.\n\nPlus, an `entry_points.txt` file will be generated in the sandbox so that each of the `python_distribution`s appear to be \"installed\". The `entry_points.txt` file will only include the namespaces requested on this field. Without this, stevedore would not be able to look up plugins in the setuptools `entry_points` metadata.\n\nNOTE: Each `python_distribution` must opt-in to being included in this repo-wide inference by tagging the namespaces with `stevedore_namespace(\"my.stevedore.extension\")`.\n\nThe stevedore namespace format (`my.stevedore.extension`) is similar to a Python namespace.", - "provider": "pants.backend.experimental.python.framework.stevedore", - "required": false, - "type_hint": "Iterable[str] | None" - }, - { - "alias": "skip_mypy", + "alias": "skip_pylint", "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 Pylint on this target's code.", + "provider": "pants.backend.python.lint.pylint", "required": false, "type_hint": "bool" }, { - "alias": "skip_add_trailing_comma", + "alias": "skip_docformatter", "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 Docformatter on this target's code.", + "provider": "pants.backend.python.lint.docformatter", "required": false, "type_hint": "bool" }, { - "alias": "skip_isort", + "alias": "skip_pytype", "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 pytype on this target's code.", + "provider": "pants.backend.experimental.python.typecheck.pytype", "required": false, "type_hint": "bool" }, { - "alias": "skip_pylint", + "alias": "skip_mypy", "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 MyPy on this target's code.", + "provider": "pants.backend.python.typecheck.mypy", "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", + "alias": "stevedore_namespaces", + "default": null, + "description": "List the stevedore namespaces required by this target.\n\nCode for all `entry_points` on `python_distribution` targets with these namespaces will be added as dependencies so that they are available on PYTHONPATH during tests. Note that this is only a subset of the `python_distribution`s dependencies, so the `entry_points` only need to be defined on one `python_distribution` even if the test only needs some of the `entry_points` namespaces on it.\n\nPlus, an `entry_points.txt` file will be generated in the sandbox so that each of the `python_distribution`s appear to be \"installed\". The `entry_points.txt` file will only include the namespaces requested on this field. Without this, stevedore would not be able to look up plugins in the setuptools `entry_points` metadata.\n\nNOTE: Each `python_distribution` must opt-in to being included in this repo-wide inference by tagging the namespaces with `stevedore_namespace(\"my.stevedore.extension\")`.\n\nThe stevedore namespace format (`my.stevedore.extension`) is similar to a Python namespace.", + "provider": "pants.backend.experimental.python.framework.stevedore", "required": false, - "type_hint": "bool" + "type_hint": "Iterable[str] | None" }, { "alias": "skip_pydocstyle", @@ -95707,18 +95721,10 @@ "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_ruff_check", + "alias": "skip_black", "default": "False", - "description": "If true, don't run the ruff checker on this target's code.", - "provider": "pants.backend.experimental.python.lint.ruff", + "description": "If true, don't run Black on this target's code.", + "provider": "pants.backend.python.lint.black", "required": false, "type_hint": "bool" }, @@ -95729,14 +95735,6 @@ "provider": "pants.backend.python.lint.pyupgrade", "required": false, "type_hint": "bool" - }, - { - "alias": "skip_docformatter", - "default": "False", - "description": "If true, don't run Docformatter on this target's code.", - "provider": "pants.backend.python.lint.docformatter", - "required": false, - "type_hint": "bool" } ], "provider": "pants.backend.python", @@ -95779,66 +95777,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_ruff", + "alias": "skip_autoflake", "default": "False", - "description": "If True, do not run any Ruff tools on this target's code.", - "provider": "pants.backend.experimental.python.lint.ruff", + "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_format", + "alias": "skip_isort", "default": "False", - "description": "If true, don't run the ruff formatter on this target's code.", - "provider": "pants.backend.experimental.python.lint.ruff.format", + "description": "If true, don't run isort on this target's code.", + "provider": "pants.backend.python.lint.isort", "required": false, "type_hint": "bool" }, { - "alias": "skip_black", + "alias": "skip_yapf", "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 yapf on this target's code.", + "provider": "pants.backend.python.lint.yapf", "required": false, "type_hint": "bool" }, { - "alias": "skip_flake8", + "alias": "skip_ruff", "default": "False", - "description": "If true, don't run Flake8 on this target's code.", - "provider": "pants.backend.python.lint.flake8", + "description": "If True, do not run any Ruff tools on this target's code.", + "provider": "pants.backend.experimental.python.lint.ruff", "required": false, "type_hint": "bool" }, { - "alias": "skip_bandit", + "alias": "skip_ruff_check", "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 the ruff checker on this target's code.", + "provider": "pants.backend.experimental.python.lint.ruff", "required": false, "type_hint": "bool" }, { - "alias": "skip_autoflake", + "alias": "skip_ruff_format", "default": "False", - "description": "If true, don't run Autoflake on this target's code.", - "provider": "pants.backend.python.lint.autoflake", + "description": "If true, don't run the ruff formatter on this target's code.", + "provider": "pants.backend.experimental.python.lint.ruff.format", "required": false, "type_hint": "bool" }, { - "alias": "skip_mypy", + "alias": "skip_pyright", "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 Pyright on this target's code.", + "provider": "pants.backend.experimental.python.typecheck.pyright", "required": false, "type_hint": "bool" }, @@ -95851,10 +95841,10 @@ "type_hint": "bool" }, { - "alias": "skip_isort", + "alias": "skip_flake8", "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 Flake8 on this target's code.", + "provider": "pants.backend.python.lint.flake8", "required": false, "type_hint": "bool" }, @@ -95866,6 +95856,14 @@ "required": false, "type_hint": "bool" }, + { + "alias": "skip_docformatter", + "default": "False", + "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_pytype", "default": "False", @@ -95875,42 +95873,42 @@ "type_hint": "bool" }, { - "alias": "skip_pydocstyle", + "alias": "skip_mypy", "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 MyPy on this target's code.", + "provider": "pants.backend.python.typecheck.mypy", "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_ruff_check", + "alias": "skip_pydocstyle", "default": "False", - "description": "If true, don't run the ruff checker on this target's code.", - "provider": "pants.backend.experimental.python.lint.ruff", + "description": "If true, don't run pydocstyle on this target's code.", + "provider": "pants.backend.python.lint.pydocstyle", "required": false, "type_hint": "bool" }, { - "alias": "skip_pyupgrade", + "alias": "skip_black", "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 Black on this target's code.", + "provider": "pants.backend.python.lint.black", "required": false, "type_hint": "bool" }, { - "alias": "skip_docformatter", + "alias": "skip_pyupgrade", "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 pyupgrade on this target's code.", + "provider": "pants.backend.python.lint.pyupgrade", "required": false, "type_hint": "bool" }, @@ -95986,6 +95984,22 @@ "required": false, "type_hint": "Dict[Union[str, Tuple[str, ...]], Dict[str, Any]] | 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_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" + }, { "alias": "skip_yapf", "default": "False", @@ -96002,6 +96016,14 @@ "required": false, "type_hint": "bool" }, + { + "alias": "skip_ruff_check", + "default": "False", + "description": "If true, don't run the ruff checker on this target's code.", + "provider": "pants.backend.experimental.python.lint.ruff", + "required": false, + "type_hint": "bool" + }, { "alias": "skip_ruff_format", "default": "False", @@ -96011,18 +96033,18 @@ "type_hint": "bool" }, { - "alias": "skip_black", + "alias": "skip_pyright", "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 Pyright on this target's code.", + "provider": "pants.backend.experimental.python.typecheck.pyright", "required": false, "type_hint": "bool" }, { - "alias": "skip_flake8", + "alias": "skip_add_trailing_comma", "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 add-trailing-comma on this target's code.", + "provider": "pants.backend.experimental.python.lint.add_trailing_comma", "required": false, "type_hint": "bool" }, @@ -96035,60 +96057,52 @@ "type_hint": "bool" }, { - "alias": "skip_autoflake", + "alias": "skip_flake8", "default": "False", - "description": "If true, don't run Autoflake on this target's code.", - "provider": "pants.backend.python.lint.autoflake", + "description": "If true, don't run Flake8 on this target's code.", + "provider": "pants.backend.python.lint.flake8", "required": false, "type_hint": "bool" }, { - "alias": "stevedore_namespaces", - "default": null, - "description": "List the stevedore namespaces required by this target.\n\nCode for all `entry_points` on `python_distribution` targets with these namespaces will be added as dependencies so that they are available on PYTHONPATH during tests. Note that this is only a subset of the `python_distribution`s dependencies, so the `entry_points` only need to be defined on one `python_distribution` even if the test only needs some of the `entry_points` namespaces on it.\n\nPlus, an `entry_points.txt` file will be generated in the sandbox so that each of the `python_distribution`s appear to be \"installed\". The `entry_points.txt` file will only include the namespaces requested on this field. Without this, stevedore would not be able to look up plugins in the setuptools `entry_points` metadata.\n\nNOTE: Each `python_distribution` must opt-in to being included in this repo-wide inference by tagging the namespaces with `stevedore_namespace(\"my.stevedore.extension\")`.\n\nThe stevedore namespace format (`my.stevedore.extension`) is similar to a Python namespace.", - "provider": "pants.backend.experimental.python.framework.stevedore", - "required": false, - "type_hint": "Iterable[str] | None" - }, - { - "alias": "skip_mypy", + "alias": "skip_pylint", "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 Pylint on this target's code.", + "provider": "pants.backend.python.lint.pylint", "required": false, "type_hint": "bool" }, { - "alias": "skip_add_trailing_comma", + "alias": "skip_docformatter", "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 Docformatter on this target's code.", + "provider": "pants.backend.python.lint.docformatter", "required": false, "type_hint": "bool" }, { - "alias": "skip_isort", + "alias": "skip_pytype", "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 pytype on this target's code.", + "provider": "pants.backend.experimental.python.typecheck.pytype", "required": false, "type_hint": "bool" }, { - "alias": "skip_pylint", + "alias": "skip_mypy", "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 MyPy on this target's code.", + "provider": "pants.backend.python.typecheck.mypy", "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", + "alias": "stevedore_namespaces", + "default": null, + "description": "List the stevedore namespaces required by this target.\n\nCode for all `entry_points` on `python_distribution` targets with these namespaces will be added as dependencies so that they are available on PYTHONPATH during tests. Note that this is only a subset of the `python_distribution`s dependencies, so the `entry_points` only need to be defined on one `python_distribution` even if the test only needs some of the `entry_points` namespaces on it.\n\nPlus, an `entry_points.txt` file will be generated in the sandbox so that each of the `python_distribution`s appear to be \"installed\". The `entry_points.txt` file will only include the namespaces requested on this field. Without this, stevedore would not be able to look up plugins in the setuptools `entry_points` metadata.\n\nNOTE: Each `python_distribution` must opt-in to being included in this repo-wide inference by tagging the namespaces with `stevedore_namespace(\"my.stevedore.extension\")`.\n\nThe stevedore namespace format (`my.stevedore.extension`) is similar to a Python namespace.", + "provider": "pants.backend.experimental.python.framework.stevedore", "required": false, - "type_hint": "bool" + "type_hint": "Iterable[str] | None" }, { "alias": "skip_pydocstyle", @@ -96099,18 +96113,10 @@ "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_ruff_check", + "alias": "skip_black", "default": "False", - "description": "If true, don't run the ruff checker on this target's code.", - "provider": "pants.backend.experimental.python.lint.ruff", + "description": "If true, don't run Black on this target's code.", + "provider": "pants.backend.python.lint.black", "required": false, "type_hint": "bool" }, @@ -96122,14 +96128,6 @@ "required": false, "type_hint": "bool" }, - { - "alias": "skip_docformatter", - "default": "False", - "description": "If true, don't run Docformatter on this target's code.", - "provider": "pants.backend.python.lint.docformatter", - "required": false, - "type_hint": "bool" - }, { "alias": "dependencies", "default": null, @@ -96323,76 +96321,76 @@ "type_hint": "bool" }, { - "alias": "test_extra_env_vars", + "alias": "go_generate_env_vars", "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 `[go-generate].env_vars` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_linker_flags", + "alias": "golang_cgo_fortran_flags", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_linker_flags` when this environment target is active.", + "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": "nodejs_search_path", + "alias": "golang_cgo_linker_flags", "default": null, - "description": "Overrides the default value from the option `[nodejs].search_path` when this environment target is active.", - "provider": "pants.backend.experimental.javascript", + "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": "golang_go_search_paths", + "alias": "pyenv_python_provider_installation_extra_env_vars", "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 `[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_cxx_flags", + "alias": "golang_cgo_tool_search_paths", "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_tool_search_paths` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_bootstrap_names", + "alias": "nodejs_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[python-bootstrap].names` 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": "pex_executable_search_paths", + "alias": "python_bootstrap_names", "default": null, - "description": "Overrides the default value from the option `[pex].executable_search_paths` when this environment target is active.", + "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_subprocess_env_vars", + "alias": "golang_external_linker_binary_name", "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].external_linker_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", + "alias": "nodejs_corepack_env_vars", "default": null, - "description": "Overrides the default value from the option `[golang].external_linker_binary_name` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "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": "str | None" + "type_hint": "Iterable[str] | None" }, { "alias": "golang_cgo_gxx_binary_name", @@ -96403,73 +96401,81 @@ "type_hint": "str | None" }, { - "alias": "nodejs_corepack_env_vars", + "alias": "jvm_global_options", "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 `[jvm].global_options` when this environment target is active.", + "provider": "pants.backend.experimental.java", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_tool_search_paths", + "alias": "python_native_code_cpp_flags", "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 `[python-native-code].cpp_flags` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "docker_executable_search_paths", + "alias": "pex_executable_search_paths", "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 `[pex].executable_search_paths` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "go_generate_env_vars", + "alias": "shell_setup_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[go-generate].env_vars` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "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" }, { - "alias": "golang_cgo_fortran_flags", + "alias": "python_bootstrap_search_path", "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 `[python-bootstrap].search_path` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "pyenv_python_provider_installation_extra_env_vars", + "alias": "test_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", + "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": "subprocess_environment_env_vars", + "alias": "golang_cgo_cxx_flags", "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 `[golang].cgo_cxx_flags` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_bootstrap_search_path", + "alias": "apache_thrift_thrift_search_paths", "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 `[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": "python_native_code_cpp_flags", + "alias": "golang_cgo_gcc_binary_name", "default": null, - "description": "Overrides the default value from the option `[python-native-code].cpp_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": "str | None" + }, + { + "alias": "system_binaries_system_binary_paths", + "default": null, + "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" @@ -96483,76 +96489,68 @@ "type_hint": "Iterable[str] | None" }, { - "alias": "docker_env_vars", + "alias": "nodejs_search_path", "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].search_path` when this environment target is active.", + "provider": "pants.backend.experimental.javascript", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "apache_thrift_thrift_search_paths", + "alias": "golang_cgo_fortran_binary_name", "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 `[golang].cgo_fortran_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": "python_native_code_ld_flags", + "alias": "docker_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[python-native-code].ld_flags` when this environment target is active.", - "provider": "pants.core", + "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": "system_binaries_system_binary_paths", + "alias": "golang_subprocess_env_vars", "default": null, - "description": "Overrides the default value from the option `[system-binaries].system_binary_paths` when this environment target is active.", - "provider": "pants.core", + "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": "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": "jvm_global_options", + "alias": "docker_env_vars", "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 `[docker].env_vars` when this environment target is active.", + "provider": "pants.backend.docker", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "nodejs_executable_search_paths", + "alias": "subprocess_environment_env_vars", "default": null, - "description": "Overrides the default value from the option `[nodejs].executable_search_paths` when this environment target is active.", - "provider": "pants.backend.experimental.javascript", + "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" }, { - "alias": "golang_cgo_fortran_binary_name", - "default": null, - "description": "Overrides the default value from the option `[golang].cgo_fortran_binary_name` when this environment target is active.", - "provider": "pants.backend.experimental.go", - "required": false, - "type_hint": "str | None" - }, - { - "alias": "golang_cgo_gcc_binary_name", + "alias": "golang_go_search_paths", "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].go_search_paths` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, - "type_hint": "str | None" + "type_hint": "Iterable[str] | None" } ], "provider": "pants.core", @@ -96789,7 +96787,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.21.2rc0/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.21.2rc1/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" @@ -97707,18 +97705,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" } @@ -97763,18 +97761,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" }, @@ -97859,18 +97857,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" } @@ -97915,18 +97913,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" }, @@ -98355,12 +98353,12 @@ "type_hint": "str" }, { - "alias": "python_resolve", - "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.thrift.apache.python", + "alias": "finagle", + "default": "False", + "description": "If True, then also generate Finagle classes for services when using Scrooge as the Thrift generator.", + "provider": "pants.backend.experimental.codegen.thrift.scrooge.java", "required": false, - "type_hint": "str | None" + "type_hint": "bool" }, { "alias": "jvm_resolve", @@ -98370,14 +98368,6 @@ "required": false, "type_hint": "str | None" }, - { - "alias": "finagle", - "default": "False", - "description": "If True, then also generate Finagle classes for services when using Scrooge as the Thrift generator.", - "provider": "pants.backend.experimental.codegen.thrift.scrooge.java", - "required": false, - "type_hint": "bool" - }, { "alias": "jvm_jdk", "default": null, @@ -98385,6 +98375,14 @@ "provider": "pants.backend.experimental.codegen.thrift.apache.java", "required": false, "type_hint": "str | None" + }, + { + "alias": "python_resolve", + "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.thrift.apache.python", + "required": false, + "type_hint": "str | None" } ], "provider": "pants.backend.codegen.thrift.apache.python", @@ -98427,12 +98425,12 @@ "type_hint": "Dict[Union[str, Tuple[str, ...]], Dict[str, Any]] | None" }, { - "alias": "python_resolve", - "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.thrift.apache.python", + "alias": "finagle", + "default": "False", + "description": "If True, then also generate Finagle classes for services when using Scrooge as the Thrift generator.", + "provider": "pants.backend.experimental.codegen.thrift.scrooge.java", "required": false, - "type_hint": "str | None" + "type_hint": "bool" }, { "alias": "jvm_resolve", @@ -98442,14 +98440,6 @@ "required": false, "type_hint": "str | None" }, - { - "alias": "finagle", - "default": "False", - "description": "If True, then also generate Finagle classes for services when using Scrooge as the Thrift generator.", - "provider": "pants.backend.experimental.codegen.thrift.scrooge.java", - "required": false, - "type_hint": "bool" - }, { "alias": "jvm_jdk", "default": null, @@ -98458,6 +98448,14 @@ "required": false, "type_hint": "str | None" }, + { + "alias": "python_resolve", + "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.thrift.apache.python", + "required": false, + "type_hint": "str | None" + }, { "alias": "dependencies", "default": null, @@ -99181,12 +99179,12 @@ { "details": null, "rank": "HARDCODED", - "value": "2.21.2rc0" + "value": "2.21.2rc1" }, { "details": "from env var PANTS_VERSION", "rank": "ENVIRONMENT", - "value": "2.21.2rc0" + "value": "2.21.2rc1" } ] } @@ -100924,7 +100922,7 @@ "details": "", "rank": "HARDCODED", "value": { - "user-agent": "pants/2.21.2rc0" + "user-agent": "pants/2.21.2rc1" } } ] @@ -101316,7 +101314,7 @@ "details": "", "rank": "HARDCODED", "value": { - "user-agent": "pants/2.21.2rc0" + "user-agent": "pants/2.21.2rc1" } } ] @@ -114284,7 +114282,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.21.2rc0/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.21.2rc1/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": [ @@ -116968,7 +116966,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.21.2rc0/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.21.2rc1/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": [ @@ -117220,7 +117218,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.21.2rc0/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.21.2rc1/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": [ @@ -117679,7 +117677,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.21.2rc0/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.21.2rc1/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": [ @@ -118556,7 +118554,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.21.2rc0/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.21.2rc1/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": [ @@ -120950,7 +120948,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.21.2rc0/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.21.2rc1/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": [ @@ -122157,7 +122155,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.21.2rc0/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.21.2rc1/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": [ @@ -128967,7 +128965,7 @@ ], "env_var": "PANTS_SCALAFIX_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.21.2rc0/src/python/pants/backend/scala/lint/scalafix/scalafix.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=scalafix`.", + "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.21.2rc1/src/python/pants/backend/scala/lint/scalafix/scalafix.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=scalafix`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -129342,7 +129340,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.21.2rc0/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.21.2rc1/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": [ @@ -129637,7 +129635,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.21.2rc0/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.21.2rc1/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": [ @@ -129848,7 +129846,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.21.2rc0/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.21.2rc1/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": [ @@ -130371,7 +130369,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.21.2rc0/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.21.2rc1/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.21/reference/subsystems/google-java-format.mdx b/versioned_docs/version-2.21/reference/subsystems/google-java-format.mdx index ec75c6cc..06c8a335 100644 --- a/versioned_docs/version-2.21/reference/subsystems/google-java-format.mdx +++ b/versioned_docs/version-2.21/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.21.2rc0/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.21.2rc1/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.21/reference/subsystems/jarjar.mdx b/versioned_docs/version-2.21/reference/subsystems/jarjar.mdx index 2aa5fefb..1fe4ceeb 100644 --- a/versioned_docs/version-2.21/reference/subsystems/jarjar.mdx +++ b/versioned_docs/version-2.21/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.21.2rc0/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.21.2rc1/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.21/reference/subsystems/java-avro.mdx b/versioned_docs/version-2.21/reference/subsystems/java-avro.mdx index fcd5af8f..7083eb0e 100644 --- a/versioned_docs/version-2.21/reference/subsystems/java-avro.mdx +++ b/versioned_docs/version-2.21/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.21.2rc0/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.21.2rc1/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.21/reference/subsystems/junit.mdx b/versioned_docs/version-2.21/reference/subsystems/junit.mdx index 4f2871c8..0fe2d74a 100644 --- a/versioned_docs/version-2.21/reference/subsystems/junit.mdx +++ b/versioned_docs/version-2.21/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.21.2rc0/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.21.2rc1/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.21/reference/subsystems/ktlint.mdx b/versioned_docs/version-2.21/reference/subsystems/ktlint.mdx index 31c5ac31..ff4e6c42 100644 --- a/versioned_docs/version-2.21/reference/subsystems/ktlint.mdx +++ b/versioned_docs/version-2.21/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.21.2rc0/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.21.2rc1/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.21/reference/subsystems/openapi-generator.mdx b/versioned_docs/version-2.21/reference/subsystems/openapi-generator.mdx index a99f95bd..ff6276ea 100644 --- a/versioned_docs/version-2.21/reference/subsystems/openapi-generator.mdx +++ b/versioned_docs/version-2.21/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.21.2rc0/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.21.2rc1/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.21/reference/subsystems/protobuf-java-grpc.mdx b/versioned_docs/version-2.21/reference/subsystems/protobuf-java-grpc.mdx index 2ec66428..c4c7d5a9 100644 --- a/versioned_docs/version-2.21/reference/subsystems/protobuf-java-grpc.mdx +++ b/versioned_docs/version-2.21/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.21.2rc0/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.21.2rc1/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.21/reference/subsystems/scalafix.mdx b/versioned_docs/version-2.21/reference/subsystems/scalafix.mdx index d72a999d..e7e0619f 100644 --- a/versioned_docs/version-2.21/reference/subsystems/scalafix.mdx +++ b/versioned_docs/version-2.21/reference/subsystems/scalafix.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.21.2rc0/src/python/pants/backend/scala/lint/scalafix/scalafix.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.21.2rc1/src/python/pants/backend/scala/lint/scalafix/scalafix.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=scalafix`. diff --git a/versioned_docs/version-2.21/reference/subsystems/scalafmt.mdx b/versioned_docs/version-2.21/reference/subsystems/scalafmt.mdx index 718c9ad8..463d55a3 100644 --- a/versioned_docs/version-2.21/reference/subsystems/scalafmt.mdx +++ b/versioned_docs/version-2.21/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.21.2rc0/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.21.2rc1/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.21/reference/subsystems/scalapb.mdx b/versioned_docs/version-2.21/reference/subsystems/scalapb.mdx index 5234c043..c9a4cd26 100644 --- a/versioned_docs/version-2.21/reference/subsystems/scalapb.mdx +++ b/versioned_docs/version-2.21/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.21.2rc0/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.21.2rc1/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.21/reference/subsystems/scalatest.mdx b/versioned_docs/version-2.21/reference/subsystems/scalatest.mdx index 89d63d73..8dcdf1a9 100644 --- a/versioned_docs/version-2.21/reference/subsystems/scalatest.mdx +++ b/versioned_docs/version-2.21/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.21.2rc0/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.21.2rc1/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.21/reference/subsystems/scrooge.mdx b/versioned_docs/version-2.21/reference/subsystems/scrooge.mdx index 0c24713e..6a48990f 100644 --- a/versioned_docs/version-2.21/reference/subsystems/scrooge.mdx +++ b/versioned_docs/version-2.21/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.21.2rc0/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.21.2rc1/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.21/reference/targets/jvm_artifact.mdx b/versioned_docs/version-2.21/reference/targets/jvm_artifact.mdx index 0ec3c75a..3b4315b3 100644 --- a/versioned_docs/version-2.21/reference/targets/jvm_artifact.mdx +++ b/versioned_docs/version-2.21/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.21.2rc0/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.21.2rc1/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.21/reference/targets/pants_requirements.mdx b/versioned_docs/version-2.21/reference/targets/pants_requirements.mdx index 103f0669..819454d1 100644 --- a/versioned_docs/version-2.21/reference/targets/pants_requirements.mdx +++ b/versioned_docs/version-2.21/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.21/reference/targets/python_requirement.mdx b/versioned_docs/version-2.21/reference/targets/python_requirement.mdx index 92fc4c47..8d0c8103 100644 --- a/versioned_docs/version-2.21/reference/targets/python_requirement.mdx +++ b/versioned_docs/version-2.21/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.21.2rc0/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.21.2rc1/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.21.2rc0/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.21.2rc1/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.21/reference/targets/scala_artifact.mdx b/versioned_docs/version-2.21/reference/targets/scala_artifact.mdx index f10c2ab1..85fa8606 100644 --- a/versioned_docs/version-2.21/reference/targets/scala_artifact.mdx +++ b/versioned_docs/version-2.21/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.21.2rc0/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.21.2rc1/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.