From eadbcd4268d38d4d619dc9da4010b85a5bcb96e1 Mon Sep 17 00:00:00 2001 From: "Worker Pants (Pantsbuild GitHub Automation Bot)" Date: Thu, 8 Aug 2024 17:57:41 +0000 Subject: [PATCH] Update docs site for version 2.20.4rc0 --- .../version-2.20/reference/help-all.json | 1351 +++++++++-------- .../subsystems/google-java-format.mdx | 2 +- .../reference/subsystems/jarjar.mdx | 2 +- .../reference/subsystems/java-avro.mdx | 2 +- .../reference/subsystems/junit.mdx | 2 +- .../reference/subsystems/ktlint.mdx | 2 +- .../subsystems/openapi-generator.mdx | 2 +- .../subsystems/protobuf-java-grpc.mdx | 2 +- .../reference/subsystems/scalafmt.mdx | 2 +- .../reference/subsystems/scalapb.mdx | 2 +- .../reference/subsystems/scalatest.mdx | 2 +- .../reference/subsystems/scrooge.mdx | 2 +- .../reference/targets/jvm_artifact.mdx | 2 +- .../reference/targets/pants_requirements.mdx | 2 +- .../reference/targets/python_requirement.mdx | 4 +- .../reference/targets/scala_artifact.mdx | 2 +- 16 files changed, 692 insertions(+), 691 deletions(-) diff --git a/versioned_docs/version-2.20/reference/help-all.json b/versioned_docs/version-2.20/reference/help-all.json index 32cd6a10..fe810220 100644 --- a/versioned_docs/version-2.20/reference/help-all.json +++ b/versioned_docs/version-2.20/reference/help-all.json @@ -10882,7 +10882,7 @@ ], "env_var": "PANTS_GOOGLE_JAVA_FORMAT_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/java/lint/google_java_format/google_java_format.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=google-java-format`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/src/python/pants/backend/java/lint/google_java_format/google_java_format.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=google-java-format`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -14208,7 +14208,7 @@ ], "env_var": "PANTS_JARJAR_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/jvm/shading/jarjar.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=jarjar`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/src/python/pants/jvm/shading/jarjar.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=jarjar`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -14528,7 +14528,7 @@ ], "env_var": "PANTS_JAVA_AVRO_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/codegen/avro/java/avro-tools.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=java-avro`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/src/python/pants/backend/codegen/avro/java/avro-tools.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=java-avro`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -14892,7 +14892,7 @@ ], "env_var": "PANTS_JUNIT_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/jvm/test/junit.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=junit`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/src/python/pants/jvm/test/junit.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=junit`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -15694,7 +15694,7 @@ ], "env_var": "PANTS_KTLINT_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/kotlin/lint/ktlint/ktlint.lock for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=ktlint`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/src/python/pants/backend/kotlin/lint/ktlint/ktlint.lock for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=ktlint`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -18423,7 +18423,7 @@ ], "env_var": "PANTS_OPENAPI_GENERATOR_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/openapi/subsystems/openapi_generator.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=openapi-generator`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/src/python/pants/backend/openapi/subsystems/openapi_generator.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=openapi-generator`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -20276,7 +20276,7 @@ ], "env_var": "PANTS_PROTOBUF_JAVA_GRPC_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/codegen/protobuf/java/grpc-java.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=protobuf-java-grpc`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/src/python/pants/backend/codegen/protobuf/java/grpc-java.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=protobuf-java-grpc`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -26093,7 +26093,7 @@ "details": "", "rank": "HARDCODED", "value": { - "user-agent": "pants/2.20.3" + "user-agent": "pants/2.20.4rc0" } } ] @@ -26469,7 +26469,7 @@ "details": "", "rank": "HARDCODED", "value": { - "user-agent": "pants/2.20.3" + "user-agent": "pants/2.20.4rc0" } } ] @@ -27613,7 +27613,7 @@ ], "env_var": "PANTS_SCALAFMT_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/scala/lint/scalafmt/scalafmt.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalafmt`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/src/python/pants/backend/scala/lint/scalafmt/scalafmt.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalafmt`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -27896,7 +27896,7 @@ ], "env_var": "PANTS_SCALAPB_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/codegen/protobuf/scala/scalapbc.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalapb`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/src/python/pants/backend/codegen/protobuf/scala/scalapbc.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalapb`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -28096,7 +28096,7 @@ ], "env_var": "PANTS_SCALATEST_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/scala/subsystems/scalatest.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalatest`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/src/python/pants/backend/scala/subsystems/scalatest.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalatest`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -28799,7 +28799,7 @@ ], "env_var": "PANTS_SCROOGE_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/codegen/thrift/scrooge/scrooge.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scrooge`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/src/python/pants/backend/codegen/thrift/scrooge/scrooge.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scrooge`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ @@ -34009,12 +34009,12 @@ { "details": null, "rank": "HARDCODED", - "value": "2.20.3" + "value": "2.20.4rc0" }, { "details": "from env var PANTS_VERSION", "rank": "ENVIRONMENT", - "value": "2.20.3" + "value": "2.20.4rc0" } ] } @@ -35044,22 +35044,22 @@ "name_to_api_type_info": { "abc.EnvironmentAware": { "consumed_by_rules": [ - "pants.jvm.jdk_rules.prepare_jdk_environment" + "pants.backend.codegen.thrift.apache.rules.setup_thrift_tool" ], "dependencies": [ "pants.backend.experimental.javascript", "pants.core" ], "dependents": [ - "pants.backend.experimental.java" + "pants.backend.codegen.thrift.apache.python" ], "documentation": null, "is_union": false, "module": "abc", "name": "EnvironmentAware", - "provider": "pants.backend.experimental.java", + "provider": "pants.backend.codegen.thrift.apache.python", "returned_by_rules": [ - "construct_env_aware_scope_jvm" + "construct_env_aware_scope_apache_thrift" ], "union_members": [], "union_type": null, @@ -58530,19 +58530,19 @@ }, "pants.core.goals.fix.Batch": { "consumed_by_rules": [ - "pants.backend.openapi.lint.openapi_format.rules.run_openapi_format" + "pants.backend.build_files.fix.deprecations.renamed_fields_rules.fix" ], "dependencies": [ "pants.core" ], "dependents": [ - "pants.backend.experimental.openapi.lint.openapi_format" + "pants.core" ], "documentation": "Batch(tool_name: 'str', elements: 'tuple[PartitionElementT, ...]', partition_metadata: 'PartitionMetadataT', snapshot: 'Snapshot')", "is_union": true, "module": "pants.core.goals.fix", "name": "Batch", - "provider": "pants.backend.experimental.openapi.lint.openapi_format", + "provider": "pants.backend.build_files.fix.deprecations", "returned_by_rules": [], "union_members": [], "union_type": "Batch", @@ -59433,19 +59433,19 @@ }, "pants.core.goals.lint.Batch": { "consumed_by_rules": [ - "pants.backend.tools.yamllint.rules.run_yamllint" + "pants.backend.python.lint.bandit.rules.bandit_lint" ], "dependencies": [ "pants.core" ], "dependents": [ - "pants.backend.experimental.tools.yamllint" + "pants.backend.python.lint.bandit" ], "documentation": null, "is_union": true, "module": "pants.core.goals.lint", "name": "Batch", - "provider": "pants.backend.experimental.tools.yamllint", + "provider": "pants.backend.python.lint.bandit", "returned_by_rules": [], "union_members": [], "union_type": "Batch", @@ -59622,19 +59622,19 @@ }, "pants.core.goals.lint.PartitionRequest": { "consumed_by_rules": [ - "pants.core.util_rules.partitions._single_partition_field_set_rules.partitioner_HadolintRequest" + "pants.backend.build_files.utils._get_build_file_partitioner_rules.partition_build_files_RenameFieldsInFilesRequest" ], "dependencies": [ "pants.core" ], "dependents": [ - "pants.backend.docker.lint.hadolint" + "pants.backend.build_files.fix.deprecations" ], "documentation": null, "is_union": true, "module": "pants.core.goals.lint", "name": "PartitionRequest", - "provider": "pants.backend.docker.lint.hadolint", + "provider": "pants.backend.build_files.fix.deprecations", "returned_by_rules": [], "union_members": [], "union_type": "PartitionRequest", @@ -60745,26 +60745,37 @@ ] }, "pants.core.goals.test.Batch": { - "consumed_by_rules": [ - "pants.backend.shell.goals.test.test_shell_command", - "pants.core.goals.test._unsupported_debug_adapter_rules.get_test_debug_adapter_request_ShellTestRequest", - "pants.core.goals.test._unsupported_debug_rules.get_test_debug_request_ShellTestRequest" - ], - "dependencies": [ - "pants.core" - ], + "consumed_by_rules": [], + "dependencies": [], "dependents": [ + "pants.backend.experimental.go", + "pants.backend.experimental.helm", + "pants.backend.experimental.java", + "pants.backend.experimental.javascript", + "pants.backend.experimental.scala", + "pants.backend.python", "pants.backend.shell" ], "documentation": null, "is_union": true, "module": "pants.core.goals.test", "name": "Batch", - "provider": "pants.backend.shell", + "provider": "pants.core", "returned_by_rules": [], - "union_members": [], - "union_type": "Batch", - "used_in_rules": [] + "union_members": [ + "Batch", + "Batch", + "Batch", + "Batch", + "Batch", + "Batch", + "Batch", + "Batch" + ], + "union_type": null, + "used_in_rules": [ + "pants.core.goals.test.run_tests" + ] }, "pants.core.goals.test.BuildPackageDependenciesRequest": { "consumed_by_rules": [ @@ -60876,37 +60887,24 @@ ] }, "pants.core.goals.test.PartitionRequest": { - "consumed_by_rules": [], - "dependencies": [], + "consumed_by_rules": [ + "pants.core.util_rules.partitions._partition_per_input_field_set_rules.partitioner_JunitTestRequest" + ], + "dependencies": [ + "pants.core" + ], "dependents": [ - "pants.backend.experimental.go", - "pants.backend.experimental.helm", - "pants.backend.experimental.java", - "pants.backend.experimental.javascript", - "pants.backend.experimental.scala", - "pants.backend.python", - "pants.backend.shell" + "pants.backend.experimental.java" ], "documentation": null, "is_union": true, "module": "pants.core.goals.test", "name": "PartitionRequest", - "provider": "pants.core", + "provider": "pants.backend.experimental.java", "returned_by_rules": [], - "union_members": [ - "PartitionRequest", - "PartitionRequest", - "PartitionRequest", - "PartitionRequest", - "PartitionRequest", - "PartitionRequest", - "PartitionRequest", - "PartitionRequest" - ], - "union_type": null, - "used_in_rules": [ - "pants.core.goals.test.run_tests" - ] + "union_members": [], + "union_type": "PartitionRequest", + "used_in_rules": [] }, "pants.core.goals.test.Test": { "consumed_by_rules": [], @@ -62516,7 +62514,7 @@ "is_union": false, "module": "pants.core.util_rules.environments", "name": "OptionField", - "provider": "pants.backend.experimental.go", + "provider": "pants.backend.python.providers.experimental.pyenv", "returned_by_rules": [], "union_members": [], "union_type": "PluginField", @@ -63851,19 +63849,19 @@ }, "pants.core.util_rules.wrap_source.GenerateWrapSourceSourcesRequest": { "consumed_by_rules": [ - "pants.core.util_rules.wrap_source.wrap_source_rule_and_target.wrap_source_KotlinSourceField" + "pants.core.util_rules.wrap_source.wrap_source_rule_and_target.wrap_source_ScalaSourceField" ], "dependencies": [ "pants.engine.target" ], "dependents": [ - "pants.backend.experimental.kotlin" + "pants.backend.experimental.scala" ], "documentation": null, "is_union": false, "module": "pants.core.util_rules.wrap_source", "name": "GenerateWrapSourceSourcesRequest", - "provider": "pants.backend.experimental.kotlin", + "provider": "pants.backend.experimental.scala", "returned_by_rules": [], "union_members": [], "union_type": "GenerateSourcesRequest", @@ -66807,7 +66805,7 @@ "consumed_by_rules": [], "dependencies": [], "dependents": [ - "pants.backend.experimental.kotlin.lint.ktlint" + "pants.backend.experimental.codegen.avro.java" ], "documentation": null, "is_union": true, @@ -66816,7 +66814,8 @@ "provider": "pants.engine.target", "returned_by_rules": [], "union_members": [ - "SkipKtlintField" + "PrefixedJvmJdkField", + "PrefixedJvmResolveField" ], "union_type": null, "used_in_rules": [] @@ -69405,7 +69404,8 @@ "used_in_rules": [ "pants.backend.java.compile.javac.compile_java_source", "pants.backend.scala.compile.scalac.compile_scala_source", - "pants.jvm.package.deploy_jar.package_deploy_jar" + "pants.jvm.package.deploy_jar.package_deploy_jar", + "pants.jvm.resources.assemble_resources_jar" ] }, "pants.jvm.strip_jar.strip_jar.StripJarToolLockfileSentinel": { @@ -87541,6 +87541,7 @@ "Get(FallibleClasspathEntries, ClasspathDependenciesRequest, ..)", "Get(StrippedSourceFiles, SourceFilesRequest, ..)", "Get(ProcessResult, Process, ..)", + "Get(Digest, StripJarRequest, ..)", "Get(Digest, MergeDigests, ..)" ], "description": "Assemble resources", @@ -88760,186 +88761,178 @@ "type_hint": "str | None" }, { - "alias": "jvm_global_options", + "alias": "golang_cgo_gcc_binary_name", "default": null, - "description": "Overrides the default value from the option `[jvm].global_options` when this environment target is active.", - "provider": "pants.backend.experimental.java", + "description": "Overrides the default value from the option `[golang].cgo_gcc_binary_name` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, - "type_hint": "Iterable[str] | None" + "type_hint": "str | None" }, { - "alias": "python_bootstrap_names", + "alias": "python_native_code_cpp_flags", "default": null, - "description": "Overrides the default value from the option `[python-bootstrap].names` when this environment target is active.", + "description": "Overrides the default value from the option `[python-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": "nodejs_search_path", "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 `[nodejs].search_path` when this environment target is active.", + "provider": "pants.backend.experimental.javascript", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_native_code_cpp_flags", + "alias": "python_bootstrap_names", "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 `[python-bootstrap].names` when this environment target is active.", "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "nodejs_corepack_env_vars", - "default": null, - "description": "Overrides the default value from the option `[nodejs].corepack_env_vars` when this environment target is active.", - "provider": "pants.backend.experimental.javascript", - "required": false, - "type_hint": "Iterable[str] | None" - }, - { - "alias": "pex_executable_search_paths", + "alias": "golang_cgo_fortran_binary_name", "default": null, - "description": "Overrides the default value from the option `[pex].executable_search_paths` when this environment target is active.", - "provider": "pants.core", + "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": "test_extra_env_vars", + "alias": "golang_go_search_paths", "default": null, - "description": "Overrides the default value from the option `[test].extra_env_vars` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[golang].go_search_paths` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_bootstrap_search_path", + "alias": "golang_cgo_tool_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 `[golang].cgo_tool_search_paths` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_fortran_binary_name", + "alias": "golang_cgo_fortran_flags", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_fortran_binary_name` 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": "str | None" + "type_hint": "Iterable[str] | None" }, { - "alias": "nodejs_executable_search_paths", + "alias": "pex_executable_search_paths", "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 `[pex].executable_search_paths` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_cxx_flags", + "alias": "golang_cgo_linker_flags", "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_linker_flags` when this environment target is active.", "provider": "pants.backend.experimental.go", "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_gcc_binary_name", + "alias": "test_extra_env_vars", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_gcc_binary_name` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[test].extra_env_vars` when this environment target is active.", + "provider": "pants.core", "required": false, - "type_hint": "str | None" + "type_hint": "Iterable[str] | None" }, { - "alias": "golang_external_linker_binary_name", + "alias": "golang_cgo_c_flags", "default": null, - "description": "Overrides the default value from the option `[golang].external_linker_binary_name` when this environment target is active.", + "description": "Overrides the default value from the option `[golang].cgo_c_flags` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, - "type_hint": "str | None" + "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_tool_search_paths", + "alias": "golang_subprocess_env_vars", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_tool_search_paths` when this environment target is active.", + "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": "system_binaries_system_binary_paths", + "alias": "python_native_code_ld_flags", "default": null, - "description": "Overrides the default value from the option `[system-binaries].system_binary_paths` when this environment target is active.", + "description": "Overrides the default value from the option `[python-native-code].ld_flags` when this environment target is active.", "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_go_search_paths", + "alias": "subprocess_environment_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 `[subprocess-environment].env_vars` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "nodejs_search_path", + "alias": "apache_thrift_thrift_search_paths", "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 `[apache-thrift].thrift_search_paths` when this environment target is active.", + "provider": "pants.backend.codegen.thrift.apache.python", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_subprocess_env_vars", + "alias": "jvm_global_options", "default": null, - "description": "Overrides the default value from the option `[golang].subprocess_env_vars` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "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_fortran_flags", + "alias": "docker_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_fortran_flags` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[docker].executable_search_paths` when this environment target is active.", + "provider": "pants.backend.docker", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_native_code_ld_flags", + "alias": "docker_env_vars", "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].env_vars` when this environment target is active.", + "provider": "pants.backend.docker", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_linker_flags", + "alias": "system_binaries_system_binary_paths", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_linker_flags` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[system-binaries].system_binary_paths` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "shell_setup_executable_search_paths", + "alias": "nodejs_corepack_env_vars", "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 `[nodejs].corepack_env_vars` when this environment target is active.", + "provider": "pants.backend.experimental.javascript", "required": false, "type_hint": "Iterable[str] | None" }, @@ -88952,41 +88945,49 @@ "type_hint": "str | None" }, { - "alias": "pyenv_python_provider_installation_extra_env_vars", + "alias": "golang_cgo_cxx_flags", "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 `[golang].cgo_cxx_flags` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_c_flags", + "alias": "nodejs_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_c_flags` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[nodejs].executable_search_paths` when this environment target is active.", + "provider": "pants.backend.experimental.javascript", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "docker_env_vars", + "alias": "pyenv_python_provider_installation_extra_env_vars", "default": null, - "description": "Overrides the default value from the option `[docker].env_vars` when this environment target is active.", - "provider": "pants.backend.docker", + "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": "apache_thrift_thrift_search_paths", + "alias": "golang_external_linker_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].external_linker_binary_name` when this environment target is active.", + "provider": "pants.backend.experimental.go", + "required": false, + "type_hint": "str | None" + }, + { + "alias": "go_generate_env_vars", + "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", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "subprocess_environment_env_vars", + "alias": "python_bootstrap_search_path", "default": null, - "description": "Overrides the default value from the option `[subprocess-environment].env_vars` when this environment target is active.", + "description": "Overrides the default value from the option `[python-bootstrap].search_path` when this environment target is active.", "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" @@ -89927,6 +89928,14 @@ "required": false, "type_hint": "bool" }, + { + "alias": "skip_go_vet", + "default": "False", + "description": "If true, don't run `go vet` on this target's code.", + "provider": "pants.backend.experimental.go.lint.vet", + "required": false, + "type_hint": "bool" + }, { "alias": "skip_golangci_lint", "default": "False", @@ -89942,14 +89951,6 @@ "provider": "pants.backend.experimental.go", "required": false, "type_hint": "bool" - }, - { - "alias": "skip_go_vet", - "default": "False", - "description": "If true, don't run `go vet` on this target's code.", - "provider": "pants.backend.experimental.go.lint.vet", - "required": false, - "type_hint": "bool" } ], "provider": "pants.backend.experimental.go", @@ -90160,12 +90161,12 @@ "type_hint": "bool" }, { - "alias": "kubeconform_reject_kinds", + "alias": "kubeconform_ignore_missing_schemas", "default": null, - "description": "List of kinds or GVKs to reject.", + "description": "Whether to fail if there are missing schemas for custom resources.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, - "type_hint": "Iterable[str] | None" + "type_hint": "bool | None" }, { "alias": "kubeconform_skip_kinds", @@ -90176,44 +90177,44 @@ "type_hint": "Iterable[str] | None" }, { - "alias": "skip_kubeconform", - "default": "False", - "description": "If set to true, do not run any kubeconform checking in this Helm target when running `pants check`.", + "alias": "kubeconform_kubernetes_version", + "default": null, + "description": "Kubernetes version to use for the validation.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, - "type_hint": "bool" + "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_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_kubernetes_version", + "alias": "kubeconform_strict", "default": null, - "description": "Kubernetes version to use for the validation.", + "description": "Run Kubeconform in strict mode.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, - "type_hint": "str | None" + "type_hint": "bool | None" }, { - "alias": "kubeconform_ignore_sources", - "default": null, - "description": "Regular expression patterns specifying paths to ignore.", + "alias": "skip_kubeconform", + "default": "False", + "description": "If set to true, do not run any kubeconform checking in this Helm target when running `pants check`.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, - "type_hint": "Iterable[str] | None" + "type_hint": "bool" } ], "provider": "pants.backend.experimental.helm", @@ -90328,12 +90329,12 @@ "type_hint": "bool" }, { - "alias": "kubeconform_reject_kinds", + "alias": "kubeconform_ignore_missing_schemas", "default": null, - "description": "List of kinds or GVKs to reject.", + "description": "Whether to fail if there are missing schemas for custom resources.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, - "type_hint": "Iterable[str] | None" + "type_hint": "bool | None" }, { "alias": "kubeconform_skip_kinds", @@ -90344,44 +90345,44 @@ "type_hint": "Iterable[str] | None" }, { - "alias": "skip_kubeconform", - "default": "False", - "description": "If set to true, do not run any kubeconform checking in this Helm target when running `pants check`.", + "alias": "kubeconform_kubernetes_version", + "default": null, + "description": "Kubernetes version to use for the validation.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, - "type_hint": "bool" + "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_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_kubernetes_version", + "alias": "kubeconform_strict", "default": null, - "description": "Kubernetes version to use for the validation.", + "description": "Run Kubeconform in strict mode.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, - "type_hint": "str | None" + "type_hint": "bool | None" }, { - "alias": "kubeconform_ignore_sources", - "default": null, - "description": "Regular expression patterns specifying paths to ignore.", + "alias": "skip_kubeconform", + "default": "False", + "description": "If set to true, do not run any kubeconform checking in this Helm target when running `pants check`.", "provider": "pants.backend.experimental.helm.check.kubeconform", "required": false, - "type_hint": "Iterable[str] | None" + "type_hint": "bool" } ], "provider": "pants.backend.experimental.helm", @@ -91114,7 +91115,7 @@ { "alias": "packages", "default": null, - "description": "The JVM packages this artifact provides for the purposes of dependency inference.\n\nFor example, the JVM artifact `junit:junit` might provide `[\"org.junit.**\"]`.\n\nUsually you can leave this field off. If unspecified, Pants will fall back to the `[java-infer].third_party_import_mapping`, then to a built in mapping (https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/jvm/dependency_inference/jvm_artifact_mappings.py), and then finally it will default to the normalized `group` of the artifact. For example, in the absence of any other mapping the artifact `io.confluent:common-config` would default to providing `[\"io.confluent.**\"]`.\n\nThe package path may be made recursive to match symbols in subpackages by adding `.**` to the end of the package path. For example, specify `[\"org.junit.**\"]` to infer a dependency on the artifact for any file importing a symbol from `org.junit` or its subpackages.", + "description": "The JVM packages this artifact provides for the purposes of dependency inference.\n\nFor example, the JVM artifact `junit:junit` might provide `[\"org.junit.**\"]`.\n\nUsually you can leave this field off. If unspecified, Pants will fall back to the `[java-infer].third_party_import_mapping`, then to a built in mapping (https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/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" @@ -91736,186 +91737,178 @@ "type_hint": "str | None" }, { - "alias": "jvm_global_options", + "alias": "golang_cgo_gcc_binary_name", "default": null, - "description": "Overrides the default value from the option `[jvm].global_options` when this environment target is active.", - "provider": "pants.backend.experimental.java", + "description": "Overrides the default value from the option `[golang].cgo_gcc_binary_name` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, - "type_hint": "Iterable[str] | None" + "type_hint": "str | None" }, { - "alias": "python_bootstrap_names", + "alias": "python_native_code_cpp_flags", "default": null, - "description": "Overrides the default value from the option `[python-bootstrap].names` when this environment target is active.", + "description": "Overrides the default value from the option `[python-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": "nodejs_search_path", "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 `[nodejs].search_path` when this environment target is active.", + "provider": "pants.backend.experimental.javascript", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_native_code_cpp_flags", + "alias": "python_bootstrap_names", "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 `[python-bootstrap].names` when this environment target is active.", "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "nodejs_corepack_env_vars", - "default": null, - "description": "Overrides the default value from the option `[nodejs].corepack_env_vars` when this environment target is active.", - "provider": "pants.backend.experimental.javascript", - "required": false, - "type_hint": "Iterable[str] | None" - }, - { - "alias": "pex_executable_search_paths", + "alias": "golang_cgo_fortran_binary_name", "default": null, - "description": "Overrides the default value from the option `[pex].executable_search_paths` when this environment target is active.", - "provider": "pants.core", + "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": "test_extra_env_vars", + "alias": "golang_go_search_paths", "default": null, - "description": "Overrides the default value from the option `[test].extra_env_vars` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[golang].go_search_paths` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_bootstrap_search_path", + "alias": "golang_cgo_tool_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 `[golang].cgo_tool_search_paths` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_fortran_binary_name", + "alias": "golang_cgo_fortran_flags", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_fortran_binary_name` 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": "str | None" + "type_hint": "Iterable[str] | None" }, { - "alias": "nodejs_executable_search_paths", + "alias": "pex_executable_search_paths", "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 `[pex].executable_search_paths` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_cxx_flags", + "alias": "golang_cgo_linker_flags", "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_linker_flags` when this environment target is active.", "provider": "pants.backend.experimental.go", "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_gcc_binary_name", + "alias": "test_extra_env_vars", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_gcc_binary_name` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[test].extra_env_vars` when this environment target is active.", + "provider": "pants.core", "required": false, - "type_hint": "str | None" + "type_hint": "Iterable[str] | None" }, { - "alias": "golang_external_linker_binary_name", + "alias": "golang_cgo_c_flags", "default": null, - "description": "Overrides the default value from the option `[golang].external_linker_binary_name` when this environment target is active.", + "description": "Overrides the default value from the option `[golang].cgo_c_flags` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, - "type_hint": "str | None" + "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_tool_search_paths", + "alias": "golang_subprocess_env_vars", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_tool_search_paths` when this environment target is active.", + "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": "system_binaries_system_binary_paths", + "alias": "python_native_code_ld_flags", "default": null, - "description": "Overrides the default value from the option `[system-binaries].system_binary_paths` when this environment target is active.", + "description": "Overrides the default value from the option `[python-native-code].ld_flags` when this environment target is active.", "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_go_search_paths", + "alias": "subprocess_environment_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 `[subprocess-environment].env_vars` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "nodejs_search_path", + "alias": "apache_thrift_thrift_search_paths", "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 `[apache-thrift].thrift_search_paths` when this environment target is active.", + "provider": "pants.backend.codegen.thrift.apache.python", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_subprocess_env_vars", + "alias": "jvm_global_options", "default": null, - "description": "Overrides the default value from the option `[golang].subprocess_env_vars` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "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_fortran_flags", + "alias": "docker_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_fortran_flags` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[docker].executable_search_paths` when this environment target is active.", + "provider": "pants.backend.docker", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_native_code_ld_flags", + "alias": "docker_env_vars", "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].env_vars` when this environment target is active.", + "provider": "pants.backend.docker", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_linker_flags", + "alias": "system_binaries_system_binary_paths", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_linker_flags` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[system-binaries].system_binary_paths` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "shell_setup_executable_search_paths", + "alias": "nodejs_corepack_env_vars", "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 `[nodejs].corepack_env_vars` when this environment target is active.", + "provider": "pants.backend.experimental.javascript", "required": false, "type_hint": "Iterable[str] | None" }, @@ -91928,41 +91921,49 @@ "type_hint": "str | None" }, { - "alias": "pyenv_python_provider_installation_extra_env_vars", + "alias": "golang_cgo_cxx_flags", "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 `[golang].cgo_cxx_flags` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_c_flags", + "alias": "nodejs_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_c_flags` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[nodejs].executable_search_paths` when this environment target is active.", + "provider": "pants.backend.experimental.javascript", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "docker_env_vars", + "alias": "pyenv_python_provider_installation_extra_env_vars", "default": null, - "description": "Overrides the default value from the option `[docker].env_vars` when this environment target is active.", - "provider": "pants.backend.docker", + "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": "apache_thrift_thrift_search_paths", + "alias": "golang_external_linker_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].external_linker_binary_name` when this environment target is active.", + "provider": "pants.backend.experimental.go", + "required": false, + "type_hint": "str | None" + }, + { + "alias": "go_generate_env_vars", + "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", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "subprocess_environment_env_vars", + "alias": "python_bootstrap_search_path", "default": null, - "description": "Overrides the default value from the option `[subprocess-environment].env_vars` when this environment target is active.", + "description": "Overrides the default value from the option `[python-bootstrap].search_path` when this environment target is active.", "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" @@ -92112,25 +92113,33 @@ "type_hint": "str" }, { - "alias": "java_model_package", + "alias": "jvm_jdk", "default": null, - "description": "Root package for generated model 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": "jvm_resolve", + "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": "java_api_package", "default": null, - "description": "The resolve from `[jvm].resolves` to use when compiling this target.\n\nIf not defined, will default to `[jvm].default_resolve`.", + "description": "Root package for generated API code", "provider": "pants.backend.experimental.openapi.codegen.java", "required": false, "type_hint": "str | None" }, { - "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" @@ -92144,17 +92153,9 @@ "type_hint": "bool" }, { - "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": "java_api_package", + "alias": "jvm_resolve", "default": null, - "description": "Root package for generated API code", + "description": "The resolve from `[jvm].resolves` to use when compiling this target.\n\nIf not defined, will default to `[jvm].default_resolve`.", "provider": "pants.backend.experimental.openapi.codegen.java", "required": false, "type_hint": "str | None" @@ -92192,25 +92193,33 @@ "type_hint": "Iterable[str] | None" }, { - "alias": "java_model_package", + "alias": "jvm_jdk", "default": null, - "description": "Root package for generated model 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": "jvm_resolve", + "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": "java_api_package", "default": null, - "description": "The resolve from `[jvm].resolves` to use when compiling this target.\n\nIf not defined, will default to `[jvm].default_resolve`.", + "description": "Root package for generated API code", "provider": "pants.backend.experimental.openapi.codegen.java", "required": false, "type_hint": "str | None" }, { - "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" @@ -92224,17 +92233,9 @@ "type_hint": "bool" }, { - "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": "java_api_package", + "alias": "jvm_resolve", "default": null, - "description": "Root package for generated API code", + "description": "The resolve from `[jvm].resolves` to use when compiling this target.\n\nIf not defined, will default to `[jvm].default_resolve`.", "provider": "pants.backend.experimental.openapi.codegen.java", "required": false, "type_hint": "str | None" @@ -92417,7 +92418,7 @@ }, { "alias": "version_spec", - "default": "'== 2.20.3'", + "default": "'== 2.20.4rc0'", "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, @@ -93064,50 +93065,34 @@ "type_hint": "bool" }, { - "alias": "python_source_root", + "alias": "go_mod_address", "default": null, - "description": "The source root to generate Python sources under.\n\nIf unspecified, the source root the `protobuf_sources` is under will be used.", - "provider": "pants.backend.codegen.protobuf.python", + "description": "Address of the `go_mod` target representing the Go module that this target is part of.\n\nThis field is similar to the `resolve` field used in the Python and JVM backends. If a codegen target such as `protobuf_sources` will be used in multiple Go modules, then you should use the `parametrize` built-in to parametrize that `protobuf_sources` target for each Go module.\n\nIf there is a single `go_mod` target in the repository, then this field defaults to the address for that single `go_mod` target.", + "provider": "pants.backend.experimental.codegen.protobuf.go", "required": false, "type_hint": "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", - "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": "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": "pants.backend.codegen.protobuf.python", "required": false, "type_hint": "str | None" }, { - "alias": "jvm_jdk", - "default": null, - "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", - "provider": "pants.backend.experimental.codegen.protobuf.java", - "required": false, - "type_hint": "str | None" - }, - { - "alias": "go_mod_address", + "alias": "python_resolve", "default": null, - "description": "Address of the `go_mod` target representing the Go module that this target is part of.\n\nThis field is similar to the `resolve` field used in the Python and JVM backends. If a codegen target such as `protobuf_sources` will be used in multiple Go modules, then you should use the `parametrize` built-in to parametrize that `protobuf_sources` target for each Go module.\n\nIf there is a single `go_mod` target in the repository, then this field defaults to the address for that single `go_mod` target.", - "provider": "pants.backend.experimental.codegen.protobuf.go", + "description": "The resolve from `[python].resolves` to use.\n\nIf not defined, will default to `[python].default_resolve`.\n\nAll dependencies must share the same value for their `resolve` field.", + "provider": "pants.backend.codegen.protobuf.python", "required": false, "type_hint": "str | None" }, @@ -93126,6 +93111,22 @@ "provider": "pants.backend.codegen.protobuf.lint.buf", "required": false, "type_hint": "bool" + }, + { + "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_resolve", + "default": null, + "description": "The resolve from `[jvm].resolves` to use when compiling this target.\n\nIf not defined, will default to `[jvm].default_resolve`.", + "provider": "pants.backend.experimental.codegen.protobuf.java", + "required": false, + "type_hint": "str | None" } ], "provider": "pants.backend.codegen.protobuf.python", @@ -93168,21 +93169,13 @@ "type_hint": "Dict[Union[str, Tuple[str, ...]], Dict[str, Any]] | None" }, { - "alias": "jvm_resolve", + "alias": "go_mod_address", "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", + "description": "Address of the `go_mod` target representing the Go module that this target is part of.\n\nThis field is similar to the `resolve` field used in the Python and JVM backends. If a codegen target such as `protobuf_sources` will be used in multiple Go modules, then you should use the `parametrize` built-in to parametrize that `protobuf_sources` target for each Go module.\n\nIf there is a single `go_mod` target in the repository, then this field defaults to the address for that single `go_mod` target.", + "provider": "pants.backend.experimental.codegen.protobuf.go", "required": false, "type_hint": "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, @@ -93192,26 +93185,26 @@ "type_hint": "str | None" }, { - "alias": "go_mod_address", - "default": null, - "description": "Address of the `go_mod` target representing the Go module that this target is part of.\n\nThis field is similar to the `resolve` field used in the Python and JVM backends. If a codegen target such as `protobuf_sources` will be used in multiple Go modules, then you should use the `parametrize` built-in to parametrize that `protobuf_sources` target for each Go module.\n\nIf there is a single `go_mod` target in the repository, then this field defaults to the address for that single `go_mod` target.", - "provider": "pants.backend.experimental.codegen.protobuf.go", + "alias": "skip_buf_lint", + "default": "False", + "description": "If true, don't run `buf lint` on this target's code.", + "provider": "pants.backend.codegen.protobuf.lint.buf", "required": false, - "type_hint": "str | None" + "type_hint": "bool" }, { - "alias": "skip_buf_lint", + "alias": "skip_buf_format", "default": "False", - "description": "If true, don't run `buf lint` on this target's code.", + "description": "If true, don't run `buf format` on this target's code.", "provider": "pants.backend.codegen.protobuf.lint.buf", "required": false, "type_hint": "bool" }, { - "alias": "python_resolve", + "alias": "jvm_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": "", + "description": "The resolve from `[jvm].resolves` to use when compiling this target.\n\nIf not defined, will default to `[jvm].default_resolve`.", + "provider": "pants.backend.experimental.codegen.protobuf.java", "required": false, "type_hint": "str | None" }, @@ -93231,6 +93224,14 @@ "required": false, "type_hint": "Iterable[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": "", + "required": false, + "type_hint": "str | None" + }, { "alias": "grpc", "default": "False", @@ -93639,14 +93640,6 @@ "required": false, "type_hint": "str | None" }, - { - "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": "bool" - }, { "alias": "uses_mypyc", "default": "False", @@ -93662,6 +93655,14 @@ "provider": "pants.backend.experimental.python", "required": false, "type_hint": "Iterable[str] | None" + }, + { + "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": "bool" } ], "provider": "pants.backend.python", @@ -93802,7 +93803,7 @@ { "alias": "modules", "default": null, - "description": "The modules this requirement provides (used for dependency inference).\n\nFor example, the requirement `setuptools` provides `[\"setuptools\", \"pkg_resources\", \"easy_install\"]`.\n\nUsually you can leave this field off. If unspecified, Pants will first look at the default module mapping (https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/python/dependency_inference/default_module_mapping.py), and then will default to the normalized project name. For example, the requirement `Django` would default to the module `django`.\n\nMutually exclusive with the `type_stub_modules` field.", + "description": "The modules this requirement provides (used for dependency inference).\n\nFor example, the requirement `setuptools` provides `[\"setuptools\", \"pkg_resources\", \"easy_install\"]`.\n\nUsually you can leave this field off. If unspecified, Pants will first look at the default module mapping (https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/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" @@ -93810,7 +93811,7 @@ { "alias": "type_stub_modules", "default": null, - "description": "The modules this requirement provides if the requirement is a type stub (used for dependency inference).\n\nFor example, the requirement `types-requests` provides `[\"requests\"]`.\n\nUsually you can leave this field off. If unspecified, Pants will first look at the default module mapping (https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/python/dependency_inference/default_module_mapping.py). If not found _and_ the requirement name starts with `types-` or `stubs-`, or ends with `-types` or `-stubs`, will default to that requirement name without the prefix/suffix. For example, `types-requests` would default to `requests`. Otherwise, will be treated like a normal requirement (see the `modules` field).\n\nMutually exclusive with the `modules` field.", + "description": "The modules this requirement provides if the requirement is a type stub (used for dependency inference).\n\nFor example, the requirement `types-requests` provides `[\"requests\"]`.\n\nUsually you can leave this field off. If unspecified, Pants will first look at the default module mapping (https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/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" @@ -93968,18 +93969,18 @@ "type_hint": "bool" }, { - "alias": "skip_add_trailing_comma", + "alias": "skip_pytype", "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 pytype on this target's code.", + "provider": "pants.backend.experimental.python.typecheck.pytype", "required": false, "type_hint": "bool" }, { - "alias": "skip_ruff", + "alias": "skip_autoflake", "default": "False", - "description": "If true, don't run ruff on this target's code.", - "provider": "pants.backend.experimental.python.lint.ruff", + "description": "If true, don't run Autoflake on this target's code.", + "provider": "pants.backend.python.lint.autoflake", "required": false, "type_hint": "bool" }, @@ -94008,26 +94009,26 @@ "type_hint": "bool" }, { - "alias": "skip_pytype", + "alias": "skip_ruff", "default": "False", - "description": "If true, don't run pytype on this target's code.", - "provider": "pants.backend.experimental.python.typecheck.pytype", + "description": "If true, don't run ruff on this target's code.", + "provider": "pants.backend.experimental.python.lint.ruff", "required": false, "type_hint": "bool" }, { - "alias": "skip_mypy", + "alias": "skip_bandit", "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 Bandit on this target's code.", + "provider": "pants.backend.python.lint.bandit", "required": false, "type_hint": "bool" }, { - "alias": "skip_pylint", + "alias": "skip_pydocstyle", "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 pydocstyle on this target's code.", + "provider": "pants.backend.python.lint.pydocstyle", "required": false, "type_hint": "bool" }, @@ -94040,50 +94041,50 @@ "type_hint": "bool" }, { - "alias": "skip_bandit", + "alias": "skip_mypy", "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 MyPy on this target's code.", + "provider": "pants.backend.python.typecheck.mypy", "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_pydocstyle", + "alias": "skip_black", "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 Black on this target's code.", + "provider": "pants.backend.python.lint.black", "required": false, "type_hint": "bool" }, { - "alias": "skip_autoflake", + "alias": "skip_add_trailing_comma", "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 add-trailing-comma on this target's code.", + "provider": "pants.backend.experimental.python.lint.add_trailing_comma", "required": false, "type_hint": "bool" }, { - "alias": "skip_yapf", + "alias": "skip_isort", "default": "False", - "description": "If true, don't run yapf on this target's code.", - "provider": "pants.backend.python.lint.yapf", + "description": "If true, don't run isort on this target's code.", + "provider": "pants.backend.python.lint.isort", "required": false, "type_hint": "bool" }, { - "alias": "skip_isort", + "alias": "skip_pylint", "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 Pylint on this target's code.", + "provider": "pants.backend.python.lint.pylint", "required": false, "type_hint": "bool" } @@ -94128,18 +94129,18 @@ "type_hint": "Dict[Union[str, Tuple[str, ...]], Dict[str, Any]] | None" }, { - "alias": "skip_add_trailing_comma", + "alias": "skip_pytype", "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 pytype on this target's code.", + "provider": "pants.backend.experimental.python.typecheck.pytype", "required": false, "type_hint": "bool" }, { - "alias": "skip_ruff", + "alias": "skip_autoflake", "default": "False", - "description": "If true, don't run ruff on this target's code.", - "provider": "pants.backend.experimental.python.lint.ruff", + "description": "If true, don't run Autoflake on this target's code.", + "provider": "pants.backend.python.lint.autoflake", "required": false, "type_hint": "bool" }, @@ -94168,26 +94169,26 @@ "type_hint": "bool" }, { - "alias": "skip_pytype", + "alias": "skip_ruff", "default": "False", - "description": "If true, don't run pytype on this target's code.", - "provider": "pants.backend.experimental.python.typecheck.pytype", + "description": "If true, don't run ruff on this target's code.", + "provider": "pants.backend.experimental.python.lint.ruff", "required": false, "type_hint": "bool" }, { - "alias": "skip_mypy", + "alias": "skip_bandit", "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 Bandit on this target's code.", + "provider": "pants.backend.python.lint.bandit", "required": false, "type_hint": "bool" }, { - "alias": "skip_pylint", + "alias": "skip_pydocstyle", "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 pydocstyle on this target's code.", + "provider": "pants.backend.python.lint.pydocstyle", "required": false, "type_hint": "bool" }, @@ -94200,50 +94201,50 @@ "type_hint": "bool" }, { - "alias": "skip_bandit", + "alias": "skip_mypy", "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 MyPy on this target's code.", + "provider": "pants.backend.python.typecheck.mypy", "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_pydocstyle", + "alias": "skip_black", "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 Black on this target's code.", + "provider": "pants.backend.python.lint.black", "required": false, "type_hint": "bool" }, { - "alias": "skip_autoflake", + "alias": "skip_add_trailing_comma", "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 add-trailing-comma on this target's code.", + "provider": "pants.backend.experimental.python.lint.add_trailing_comma", "required": false, "type_hint": "bool" }, { - "alias": "skip_yapf", + "alias": "skip_isort", "default": "False", - "description": "If true, don't run yapf on this target's code.", - "provider": "pants.backend.python.lint.yapf", + "description": "If true, don't run isort on this target's code.", + "provider": "pants.backend.python.lint.isort", "required": false, "type_hint": "bool" }, { - "alias": "skip_isort", + "alias": "skip_pylint", "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 Pylint on this target's code.", + "provider": "pants.backend.python.lint.pylint", "required": false, "type_hint": "bool" }, @@ -94408,18 +94409,26 @@ "type_hint": "str" }, { - "alias": "skip_add_trailing_comma", + "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_pytype", "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 pytype on this target's code.", + "provider": "pants.backend.experimental.python.typecheck.pytype", "required": false, "type_hint": "bool" }, { - "alias": "skip_ruff", + "alias": "skip_autoflake", "default": "False", - "description": "If true, don't run ruff on this target's code.", - "provider": "pants.backend.experimental.python.lint.ruff", + "description": "If true, don't run Autoflake on this target's code.", + "provider": "pants.backend.python.lint.autoflake", "required": false, "type_hint": "bool" }, @@ -94448,26 +94457,26 @@ "type_hint": "bool" }, { - "alias": "skip_pytype", + "alias": "skip_ruff", "default": "False", - "description": "If true, don't run pytype on this target's code.", - "provider": "pants.backend.experimental.python.typecheck.pytype", + "description": "If true, don't run ruff on this target's code.", + "provider": "pants.backend.experimental.python.lint.ruff", "required": false, "type_hint": "bool" }, { - "alias": "skip_mypy", + "alias": "skip_bandit", "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 Bandit on this target's code.", + "provider": "pants.backend.python.lint.bandit", "required": false, "type_hint": "bool" }, { - "alias": "skip_pylint", + "alias": "skip_pydocstyle", "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 pydocstyle on this target's code.", + "provider": "pants.backend.python.lint.pydocstyle", "required": false, "type_hint": "bool" }, @@ -94480,42 +94489,34 @@ "type_hint": "bool" }, { - "alias": "skip_bandit", - "default": "False", - "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_black", + "alias": "skip_mypy", "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 MyPy on this target's code.", + "provider": "pants.backend.python.typecheck.mypy", "required": false, "type_hint": "bool" }, { - "alias": "skip_pydocstyle", + "alias": "skip_yapf", "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 yapf on this target's code.", + "provider": "pants.backend.python.lint.yapf", "required": false, "type_hint": "bool" }, { - "alias": "skip_autoflake", + "alias": "skip_black", "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 Black on this target's code.", + "provider": "pants.backend.python.lint.black", "required": false, "type_hint": "bool" }, { - "alias": "skip_yapf", + "alias": "skip_add_trailing_comma", "default": "False", - "description": "If true, don't run yapf on this target's code.", - "provider": "pants.backend.python.lint.yapf", + "description": "If true, don't run add-trailing-comma on this target's code.", + "provider": "pants.backend.experimental.python.lint.add_trailing_comma", "required": false, "type_hint": "bool" }, @@ -94528,12 +94529,12 @@ "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", + "alias": "skip_pylint", + "default": "False", + "description": "If true, don't run Pylint on this target's code.", + "provider": "pants.backend.python.lint.pylint", "required": false, - "type_hint": "Iterable[str] | None" + "type_hint": "bool" } ], "provider": "pants.backend.python", @@ -94576,18 +94577,18 @@ "type_hint": "Dict[Union[str, Tuple[str, ...]], Dict[str, Any]] | None" }, { - "alias": "skip_add_trailing_comma", + "alias": "skip_pytype", "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 pytype on this target's code.", + "provider": "pants.backend.experimental.python.typecheck.pytype", "required": false, "type_hint": "bool" }, { - "alias": "skip_ruff", + "alias": "skip_autoflake", "default": "False", - "description": "If true, don't run ruff on this target's code.", - "provider": "pants.backend.experimental.python.lint.ruff", + "description": "If true, don't run Autoflake on this target's code.", + "provider": "pants.backend.python.lint.autoflake", "required": false, "type_hint": "bool" }, @@ -94616,26 +94617,26 @@ "type_hint": "bool" }, { - "alias": "skip_pytype", + "alias": "skip_ruff", "default": "False", - "description": "If true, don't run pytype on this target's code.", - "provider": "pants.backend.experimental.python.typecheck.pytype", + "description": "If true, don't run ruff on this target's code.", + "provider": "pants.backend.experimental.python.lint.ruff", "required": false, "type_hint": "bool" }, { - "alias": "skip_mypy", + "alias": "skip_bandit", "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 Bandit on this target's code.", + "provider": "pants.backend.python.lint.bandit", "required": false, "type_hint": "bool" }, { - "alias": "skip_pylint", + "alias": "skip_pydocstyle", "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 pydocstyle on this target's code.", + "provider": "pants.backend.python.lint.pydocstyle", "required": false, "type_hint": "bool" }, @@ -94648,50 +94649,50 @@ "type_hint": "bool" }, { - "alias": "skip_bandit", + "alias": "skip_mypy", "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 MyPy on this target's code.", + "provider": "pants.backend.python.typecheck.mypy", "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_pydocstyle", + "alias": "skip_black", "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 Black on this target's code.", + "provider": "pants.backend.python.lint.black", "required": false, "type_hint": "bool" }, { - "alias": "skip_autoflake", + "alias": "skip_add_trailing_comma", "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 add-trailing-comma on this target's code.", + "provider": "pants.backend.experimental.python.lint.add_trailing_comma", "required": false, "type_hint": "bool" }, { - "alias": "skip_yapf", + "alias": "skip_isort", "default": "False", - "description": "If true, don't run yapf on this target's code.", - "provider": "pants.backend.python.lint.yapf", + "description": "If true, don't run isort on this target's code.", + "provider": "pants.backend.python.lint.isort", "required": false, "type_hint": "bool" }, { - "alias": "skip_isort", + "alias": "skip_pylint", "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 Pylint on this target's code.", + "provider": "pants.backend.python.lint.pylint", "required": false, "type_hint": "bool" }, @@ -94768,18 +94769,26 @@ "type_hint": "Dict[Union[str, Tuple[str, ...]], Dict[str, Any]] | None" }, { - "alias": "skip_add_trailing_comma", + "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_pytype", "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 pytype on this target's code.", + "provider": "pants.backend.experimental.python.typecheck.pytype", "required": false, "type_hint": "bool" }, { - "alias": "skip_ruff", + "alias": "skip_autoflake", "default": "False", - "description": "If true, don't run ruff on this target's code.", - "provider": "pants.backend.experimental.python.lint.ruff", + "description": "If true, don't run Autoflake on this target's code.", + "provider": "pants.backend.python.lint.autoflake", "required": false, "type_hint": "bool" }, @@ -94808,26 +94817,26 @@ "type_hint": "bool" }, { - "alias": "skip_pytype", + "alias": "skip_ruff", "default": "False", - "description": "If true, don't run pytype on this target's code.", - "provider": "pants.backend.experimental.python.typecheck.pytype", + "description": "If true, don't run ruff on this target's code.", + "provider": "pants.backend.experimental.python.lint.ruff", "required": false, "type_hint": "bool" }, { - "alias": "skip_mypy", + "alias": "skip_bandit", "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 Bandit on this target's code.", + "provider": "pants.backend.python.lint.bandit", "required": false, "type_hint": "bool" }, { - "alias": "skip_pylint", + "alias": "skip_pydocstyle", "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 pydocstyle on this target's code.", + "provider": "pants.backend.python.lint.pydocstyle", "required": false, "type_hint": "bool" }, @@ -94840,42 +94849,34 @@ "type_hint": "bool" }, { - "alias": "skip_bandit", - "default": "False", - "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_black", + "alias": "skip_mypy", "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 MyPy on this target's code.", + "provider": "pants.backend.python.typecheck.mypy", "required": false, "type_hint": "bool" }, { - "alias": "skip_pydocstyle", + "alias": "skip_yapf", "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 yapf on this target's code.", + "provider": "pants.backend.python.lint.yapf", "required": false, "type_hint": "bool" }, { - "alias": "skip_autoflake", + "alias": "skip_black", "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 Black on this target's code.", + "provider": "pants.backend.python.lint.black", "required": false, "type_hint": "bool" }, { - "alias": "skip_yapf", + "alias": "skip_add_trailing_comma", "default": "False", - "description": "If true, don't run yapf on this target's code.", - "provider": "pants.backend.python.lint.yapf", + "description": "If true, don't run add-trailing-comma on this target's code.", + "provider": "pants.backend.experimental.python.lint.add_trailing_comma", "required": false, "type_hint": "bool" }, @@ -94888,12 +94889,12 @@ "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", + "alias": "skip_pylint", + "default": "False", + "description": "If true, don't run Pylint on this target's code.", + "provider": "pants.backend.python.lint.pylint", "required": false, - "type_hint": "Iterable[str] | None" + "type_hint": "bool" }, { "alias": "dependencies", @@ -95088,186 +95089,178 @@ "type_hint": "bool" }, { - "alias": "jvm_global_options", + "alias": "golang_cgo_gcc_binary_name", "default": null, - "description": "Overrides the default value from the option `[jvm].global_options` when this environment target is active.", - "provider": "pants.backend.experimental.java", + "description": "Overrides the default value from the option `[golang].cgo_gcc_binary_name` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, - "type_hint": "Iterable[str] | None" + "type_hint": "str | None" }, { - "alias": "python_bootstrap_names", + "alias": "python_native_code_cpp_flags", "default": null, - "description": "Overrides the default value from the option `[python-bootstrap].names` when this environment target is active.", + "description": "Overrides the default value from the option `[python-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": "nodejs_search_path", "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 `[nodejs].search_path` when this environment target is active.", + "provider": "pants.backend.experimental.javascript", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_native_code_cpp_flags", + "alias": "golang_cgo_fortran_binary_name", "default": null, - "description": "Overrides the default value from the option `[python-native-code].cpp_flags` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[golang].cgo_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": "nodejs_corepack_env_vars", + "alias": "golang_go_search_paths", "default": null, - "description": "Overrides the default value from the option `[nodejs].corepack_env_vars` when this environment target is active.", - "provider": "pants.backend.experimental.javascript", + "description": "Overrides the default value from the option `[golang].go_search_paths` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "pex_executable_search_paths", + "alias": "golang_cgo_tool_search_paths", "default": null, - "description": "Overrides the default value from the option `[pex].executable_search_paths` when this environment target is active.", - "provider": "pants.core", + "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": "test_extra_env_vars", + "alias": "golang_cgo_fortran_flags", "default": null, - "description": "Overrides the default value from the option `[test].extra_env_vars` when this environment target is active.", - "provider": "pants.core", + "description": "Overrides the default value from the option `[golang].cgo_fortran_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": "pex_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[python-bootstrap].search_path` when this environment target is active.", + "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": "golang_cgo_fortran_binary_name", + "alias": "golang_cgo_linker_flags", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_fortran_binary_name` when this environment target is active.", + "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": "str | None" - }, - { - "alias": "nodejs_executable_search_paths", - "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", - "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_cxx_flags", + "alias": "shell_setup_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_cxx_flags` 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": "go_generate_env_vars", + "alias": "test_extra_env_vars", "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 `[test].extra_env_vars` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_gcc_binary_name", + "alias": "python_bootstrap_search_path", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_gcc_binary_name` 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": "str | None" + "type_hint": "Iterable[str] | None" }, { - "alias": "golang_external_linker_binary_name", + "alias": "golang_cgo_c_flags", "default": null, - "description": "Overrides the default value from the option `[golang].external_linker_binary_name` when this environment target is active.", + "description": "Overrides the default value from the option `[golang].cgo_c_flags` when this environment target is active.", "provider": "pants.backend.experimental.go", "required": false, - "type_hint": "str | None" + "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_tool_search_paths", + "alias": "golang_subprocess_env_vars", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_tool_search_paths` when this environment target is active.", + "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": "system_binaries_system_binary_paths", + "alias": "python_native_code_ld_flags", "default": null, - "description": "Overrides the default value from the option `[system-binaries].system_binary_paths` when this environment target is active.", + "description": "Overrides the default value from the option `[python-native-code].ld_flags` when this environment target is active.", "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_go_search_paths", + "alias": "subprocess_environment_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 `[subprocess-environment].env_vars` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "nodejs_search_path", + "alias": "apache_thrift_thrift_search_paths", "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 `[apache-thrift].thrift_search_paths` when this environment target is active.", + "provider": "pants.backend.codegen.thrift.apache.python", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_subprocess_env_vars", + "alias": "jvm_global_options", "default": null, - "description": "Overrides the default value from the option `[golang].subprocess_env_vars` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "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_fortran_flags", + "alias": "docker_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_fortran_flags` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[docker].executable_search_paths` when this environment target is active.", + "provider": "pants.backend.docker", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "python_native_code_ld_flags", + "alias": "docker_env_vars", "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].env_vars` when this environment target is active.", + "provider": "pants.backend.docker", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_linker_flags", + "alias": "system_binaries_system_binary_paths", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_linker_flags` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[system-binaries].system_binary_paths` when this environment target is active.", + "provider": "pants.core", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "shell_setup_executable_search_paths", + "alias": "nodejs_corepack_env_vars", "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 `[nodejs].corepack_env_vars` when this environment target is active.", + "provider": "pants.backend.experimental.javascript", "required": false, "type_hint": "Iterable[str] | None" }, @@ -95280,41 +95273,49 @@ "type_hint": "str | None" }, { - "alias": "pyenv_python_provider_installation_extra_env_vars", + "alias": "golang_cgo_cxx_flags", "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 `[golang].cgo_cxx_flags` when this environment target is active.", + "provider": "pants.backend.experimental.go", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "golang_cgo_c_flags", + "alias": "nodejs_executable_search_paths", "default": null, - "description": "Overrides the default value from the option `[golang].cgo_c_flags` when this environment target is active.", - "provider": "pants.backend.experimental.go", + "description": "Overrides the default value from the option `[nodejs].executable_search_paths` when this environment target is active.", + "provider": "pants.backend.experimental.javascript", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "docker_env_vars", + "alias": "pyenv_python_provider_installation_extra_env_vars", "default": null, - "description": "Overrides the default value from the option `[docker].env_vars` when this environment target is active.", - "provider": "pants.backend.docker", + "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": "apache_thrift_thrift_search_paths", + "alias": "golang_external_linker_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].external_linker_binary_name` when this environment target is active.", + "provider": "pants.backend.experimental.go", + "required": false, + "type_hint": "str | None" + }, + { + "alias": "go_generate_env_vars", + "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", "required": false, "type_hint": "Iterable[str] | None" }, { - "alias": "subprocess_environment_env_vars", + "alias": "python_bootstrap_names", "default": null, - "description": "Overrides the default value from the option `[subprocess-environment].env_vars` 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" @@ -95554,7 +95555,7 @@ { "alias": "packages", "default": null, - "description": "The JVM packages this artifact provides for the purposes of dependency inference.\n\nFor example, the JVM artifact `junit:junit` might provide `[\"org.junit.**\"]`.\n\nUsually you can leave this field off. If unspecified, Pants will fall back to the `[java-infer].third_party_import_mapping`, then to a built in mapping (https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/jvm/dependency_inference/jvm_artifact_mappings.py), and then finally it will default to the normalized `group` of the artifact. For example, in the absence of any other mapping the artifact `io.confluent:common-config` would default to providing `[\"io.confluent.**\"]`.\n\nThe package path may be made recursive to match symbols in subpackages by adding `.**` to the end of the package path. For example, specify `[\"org.junit.**\"]` to infer a dependency on the artifact for any file importing a symbol from `org.junit` or its subpackages.", + "description": "The JVM packages this artifact provides for the purposes of dependency inference.\n\nFor example, the JVM artifact `junit:junit` might provide `[\"org.junit.**\"]`.\n\nUsually you can leave this field off. If unspecified, Pants will fall back to the `[java-infer].third_party_import_mapping`, then to a built in mapping (https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/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" @@ -97048,10 +97049,10 @@ "type_hint": "bool" }, { - "alias": "python_resolve", + "alias": "jvm_jdk", "default": null, - "description": "The resolve from `[python].resolves` to use.\n\nIf not defined, will default to `[python].default_resolve`.\n\nAll dependencies must share the same value for their `resolve` field.", - "provider": "pants.backend.codegen.thrift.apache.python", + "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", + "provider": "pants.backend.experimental.codegen.thrift.apache.java", "required": false, "type_hint": "str | None" }, @@ -97064,10 +97065,10 @@ "type_hint": "str | None" }, { - "alias": "jvm_jdk", + "alias": "python_resolve", "default": null, - "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", - "provider": "pants.backend.experimental.codegen.thrift.apache.java", + "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" } @@ -97120,10 +97121,10 @@ "type_hint": "bool" }, { - "alias": "python_resolve", + "alias": "jvm_jdk", "default": null, - "description": "The resolve from `[python].resolves` to use.\n\nIf not defined, will default to `[python].default_resolve`.\n\nAll dependencies must share the same value for their `resolve` field.", - "provider": "pants.backend.codegen.thrift.apache.python", + "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", + "provider": "pants.backend.experimental.codegen.thrift.apache.java", "required": false, "type_hint": "str | None" }, @@ -97136,10 +97137,10 @@ "type_hint": "str | None" }, { - "alias": "jvm_jdk", + "alias": "python_resolve", "default": null, - "description": "The major version of the JDK that this target should be built with. If not defined, will default to `[jvm].default_source_jdk`.", - "provider": "pants.backend.experimental.codegen.thrift.apache.java", + "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" }, @@ -97865,12 +97866,12 @@ { "details": null, "rank": "HARDCODED", - "value": "2.20.3" + "value": "2.20.4rc0" }, { "details": "from env var PANTS_VERSION", "rank": "ENVIRONMENT", - "value": "2.20.3" + "value": "2.20.4rc0" } ] } @@ -99608,7 +99609,7 @@ "details": "", "rank": "HARDCODED", "value": { - "user-agent": "pants/2.20.3" + "user-agent": "pants/2.20.4rc0" } } ] @@ -100000,7 +100001,7 @@ "details": "", "rank": "HARDCODED", "value": { - "user-agent": "pants/2.20.3" + "user-agent": "pants/2.20.4rc0" } } ] @@ -112832,7 +112833,7 @@ ], "env_var": "PANTS_GOOGLE_JAVA_FORMAT_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/java/lint/google_java_format/google_java_format.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=google-java-format`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/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": [ @@ -115500,7 +115501,7 @@ ], "env_var": "PANTS_JARJAR_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/jvm/shading/jarjar.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=jarjar`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/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": [ @@ -115752,7 +115753,7 @@ ], "env_var": "PANTS_JAVA_AVRO_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/codegen/avro/java/avro-tools.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=java-avro`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/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": [ @@ -116211,7 +116212,7 @@ ], "env_var": "PANTS_JUNIT_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/jvm/test/junit.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=junit`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/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": [ @@ -117088,7 +117089,7 @@ ], "env_var": "PANTS_KTLINT_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/kotlin/lint/ktlint/ktlint.lock for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=ktlint`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/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": [ @@ -119430,7 +119431,7 @@ ], "env_var": "PANTS_OPENAPI_GENERATOR_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/openapi/subsystems/openapi_generator.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=openapi-generator`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/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": [ @@ -120596,7 +120597,7 @@ ], "env_var": "PANTS_PROTOBUF_JAVA_GRPC_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/codegen/protobuf/java/grpc-java.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=protobuf-java-grpc`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/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": [ @@ -127406,7 +127407,7 @@ ], "env_var": "PANTS_SCALAFMT_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/scala/lint/scalafmt/scalafmt.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalafmt`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/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": [ @@ -127701,7 +127702,7 @@ ], "env_var": "PANTS_SCALAPB_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/codegen/protobuf/scala/scalapbc.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalapb`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/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": [ @@ -127912,7 +127913,7 @@ ], "env_var": "PANTS_SCALATEST_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/scala/subsystems/scalatest.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalatest`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/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": [ @@ -128435,7 +128436,7 @@ ], "env_var": "PANTS_SCROOGE_LOCKFILE", "fromfile": false, - "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/codegen/thrift/scrooge/scrooge.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scrooge`.", + "help": "Path to a lockfile used for installing the tool.\n\nSet to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/src/python/pants/backend/codegen/thrift/scrooge/scrooge.default.lockfile.txt for the default lockfile contents.\n\nTo use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scrooge`.", "removal_hint": null, "removal_version": null, "scoped_cmd_line_args": [ diff --git a/versioned_docs/version-2.20/reference/subsystems/google-java-format.mdx b/versioned_docs/version-2.20/reference/subsystems/google-java-format.mdx index 3393187d..a62c2acf 100644 --- a/versioned_docs/version-2.20/reference/subsystems/google-java-format.mdx +++ b/versioned_docs/version-2.20/reference/subsystems/google-java-format.mdx @@ -99,7 +99,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/java/lint/google_java_format/google_java_format.default.lockfile.txt for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/src/python/pants/backend/java/lint/google_java_format/google_java_format.default.lockfile.txt for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=google-java-format`. diff --git a/versioned_docs/version-2.20/reference/subsystems/jarjar.mdx b/versioned_docs/version-2.20/reference/subsystems/jarjar.mdx index 2339fc40..6b464341 100644 --- a/versioned_docs/version-2.20/reference/subsystems/jarjar.mdx +++ b/versioned_docs/version-2.20/reference/subsystems/jarjar.mdx @@ -100,7 +100,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/jvm/shading/jarjar.default.lockfile.txt for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/src/python/pants/jvm/shading/jarjar.default.lockfile.txt for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=jarjar`. diff --git a/versioned_docs/version-2.20/reference/subsystems/java-avro.mdx b/versioned_docs/version-2.20/reference/subsystems/java-avro.mdx index 5c687a49..f365393a 100644 --- a/versioned_docs/version-2.20/reference/subsystems/java-avro.mdx +++ b/versioned_docs/version-2.20/reference/subsystems/java-avro.mdx @@ -73,7 +73,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/codegen/avro/java/avro-tools.default.lockfile.txt for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/src/python/pants/backend/codegen/avro/java/avro-tools.default.lockfile.txt for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=java-avro`. diff --git a/versioned_docs/version-2.20/reference/subsystems/junit.mdx b/versioned_docs/version-2.20/reference/subsystems/junit.mdx index 4606299d..1caef7ab 100644 --- a/versioned_docs/version-2.20/reference/subsystems/junit.mdx +++ b/versioned_docs/version-2.20/reference/subsystems/junit.mdx @@ -103,7 +103,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/jvm/test/junit.default.lockfile.txt for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/src/python/pants/jvm/test/junit.default.lockfile.txt for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=junit`. diff --git a/versioned_docs/version-2.20/reference/subsystems/ktlint.mdx b/versioned_docs/version-2.20/reference/subsystems/ktlint.mdx index 9f13ec52..a24bfdab 100644 --- a/versioned_docs/version-2.20/reference/subsystems/ktlint.mdx +++ b/versioned_docs/version-2.20/reference/subsystems/ktlint.mdx @@ -85,7 +85,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/kotlin/lint/ktlint/ktlint.lock for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/src/python/pants/backend/kotlin/lint/ktlint/ktlint.lock for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=ktlint`. diff --git a/versioned_docs/version-2.20/reference/subsystems/openapi-generator.mdx b/versioned_docs/version-2.20/reference/subsystems/openapi-generator.mdx index a258de5e..122fa4d3 100644 --- a/versioned_docs/version-2.20/reference/subsystems/openapi-generator.mdx +++ b/versioned_docs/version-2.20/reference/subsystems/openapi-generator.mdx @@ -73,7 +73,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/openapi/subsystems/openapi_generator.default.lockfile.txt for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/src/python/pants/backend/openapi/subsystems/openapi_generator.default.lockfile.txt for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=openapi-generator`. diff --git a/versioned_docs/version-2.20/reference/subsystems/protobuf-java-grpc.mdx b/versioned_docs/version-2.20/reference/subsystems/protobuf-java-grpc.mdx index cb0929d5..ea5a5249 100644 --- a/versioned_docs/version-2.20/reference/subsystems/protobuf-java-grpc.mdx +++ b/versioned_docs/version-2.20/reference/subsystems/protobuf-java-grpc.mdx @@ -73,7 +73,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/codegen/protobuf/java/grpc-java.default.lockfile.txt for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/src/python/pants/backend/codegen/protobuf/java/grpc-java.default.lockfile.txt for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=protobuf-java-grpc`. diff --git a/versioned_docs/version-2.20/reference/subsystems/scalafmt.mdx b/versioned_docs/version-2.20/reference/subsystems/scalafmt.mdx index f568d6b6..ab43009f 100644 --- a/versioned_docs/version-2.20/reference/subsystems/scalafmt.mdx +++ b/versioned_docs/version-2.20/reference/subsystems/scalafmt.mdx @@ -99,7 +99,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/scala/lint/scalafmt/scalafmt.default.lockfile.txt for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/src/python/pants/backend/scala/lint/scalafmt/scalafmt.default.lockfile.txt for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalafmt`. diff --git a/versioned_docs/version-2.20/reference/subsystems/scalapb.mdx b/versioned_docs/version-2.20/reference/subsystems/scalapb.mdx index 69bf2975..e4f52634 100644 --- a/versioned_docs/version-2.20/reference/subsystems/scalapb.mdx +++ b/versioned_docs/version-2.20/reference/subsystems/scalapb.mdx @@ -91,7 +91,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/codegen/protobuf/scala/scalapbc.default.lockfile.txt for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/src/python/pants/backend/codegen/protobuf/scala/scalapbc.default.lockfile.txt for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalapb`. diff --git a/versioned_docs/version-2.20/reference/subsystems/scalatest.mdx b/versioned_docs/version-2.20/reference/subsystems/scalatest.mdx index 8cc9846c..9f077a5b 100644 --- a/versioned_docs/version-2.20/reference/subsystems/scalatest.mdx +++ b/versioned_docs/version-2.20/reference/subsystems/scalatest.mdx @@ -105,7 +105,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/scala/subsystems/scalatest.default.lockfile.txt for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/src/python/pants/backend/scala/subsystems/scalatest.default.lockfile.txt for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scalatest`. diff --git a/versioned_docs/version-2.20/reference/subsystems/scrooge.mdx b/versioned_docs/version-2.20/reference/subsystems/scrooge.mdx index 2829da25..ed3a3d23 100644 --- a/versioned_docs/version-2.20/reference/subsystems/scrooge.mdx +++ b/versioned_docs/version-2.20/reference/subsystems/scrooge.mdx @@ -73,7 +73,7 @@ lockfile = `} Path to a lockfile used for installing the tool. -Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/codegen/thrift/scrooge/scrooge.default.lockfile.txt for the default lockfile contents. +Set to the string `` to use a lockfile provided by Pants, so long as you have not changed the `--version` option. See https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/src/python/pants/backend/codegen/thrift/scrooge/scrooge.default.lockfile.txt for the default lockfile contents. To use a custom lockfile, set this option to a file path relative to the build root, then run `pants jvm-generate-lockfiles --resolve=scrooge`. diff --git a/versioned_docs/version-2.20/reference/targets/jvm_artifact.mdx b/versioned_docs/version-2.20/reference/targets/jvm_artifact.mdx index 300f6da7..4bff0a60 100644 --- a/versioned_docs/version-2.20/reference/targets/jvm_artifact.mdx +++ b/versioned_docs/version-2.20/reference/targets/jvm_artifact.mdx @@ -148,7 +148,7 @@ The JVM packages this artifact provides for the purposes of dependency inference For example, the JVM artifact `junit:junit` might provide `["org.junit.**"]`. -Usually you can leave this field off. If unspecified, Pants will fall back to the `[java-infer].third_party_import_mapping`, then to a built in mapping (https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/jvm/dependency_inference/jvm_artifact_mappings.py), and then finally it will default to the normalized `group` of the artifact. For example, in the absence of any other mapping the artifact `io.confluent:common-config` would default to providing `["io.confluent.**"]`. +Usually you can leave this field off. If unspecified, Pants will fall back to the `[java-infer].third_party_import_mapping`, then to a built in mapping (https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/src/python/pants/jvm/dependency_inference/jvm_artifact_mappings.py), and then finally it will default to the normalized `group` of the artifact. For example, in the absence of any other mapping the artifact `io.confluent:common-config` would default to providing `["io.confluent.**"]`. The package path may be made recursive to match symbols in subpackages by adding `.**` to the end of the package path. For example, specify `["org.junit.**"]` to infer a dependency on the artifact for any file importing a symbol from `org.junit` or its subpackages. diff --git a/versioned_docs/version-2.20/reference/targets/pants_requirements.mdx b/versioned_docs/version-2.20/reference/targets/pants_requirements.mdx index d3cbd860..5de94cff 100644 --- a/versioned_docs/version-2.20/reference/targets/pants_requirements.mdx +++ b/versioned_docs/version-2.20/reference/targets/pants_requirements.mdx @@ -79,7 +79,7 @@ If true, include `pantsbuild.pants.testutil` to write tests for your plugin. The PEP 440 version specifier version of Pants to target. E.g. `== 2.15.*`, or `>= 2.16.0, < 2.17.0` diff --git a/versioned_docs/version-2.20/reference/targets/python_requirement.mdx b/versioned_docs/version-2.20/reference/targets/python_requirement.mdx index 41977952..85570f04 100644 --- a/versioned_docs/version-2.20/reference/targets/python_requirement.mdx +++ b/versioned_docs/version-2.20/reference/targets/python_requirement.mdx @@ -96,7 +96,7 @@ The modules this requirement provides (used for dependency inference). For example, the requirement `setuptools` provides `["setuptools", "pkg_resources", "easy_install"]`. -Usually you can leave this field off. If unspecified, Pants will first look at the default module mapping (https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/python/dependency_inference/default_module_mapping.py), and then will default to the normalized project name. For example, the requirement `Django` would default to the module `django`. +Usually you can leave this field off. If unspecified, Pants will first look at the default module mapping (https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/src/python/pants/backend/python/dependency_inference/default_module_mapping.py), and then will default to the normalized project name. For example, the requirement `Django` would default to the module `django`. Mutually exclusive with the `type_stub_modules` field. @@ -141,7 +141,7 @@ The modules this requirement provides if the requirement is a type stub (used fo For example, the requirement `types-requests` provides `["requests"]`. -Usually you can leave this field off. If unspecified, Pants will first look at the default module mapping (https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/backend/python/dependency_inference/default_module_mapping.py). If not found _and_ the requirement name starts with `types-` or `stubs-`, or ends with `-types` or `-stubs`, will default to that requirement name without the prefix/suffix. For example, `types-requests` would default to `requests`. Otherwise, will be treated like a normal requirement (see the `modules` field). +Usually you can leave this field off. If unspecified, Pants will first look at the default module mapping (https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/src/python/pants/backend/python/dependency_inference/default_module_mapping.py). If not found _and_ the requirement name starts with `types-` or `stubs-`, or ends with `-types` or `-stubs`, will default to that requirement name without the prefix/suffix. For example, `types-requests` would default to `requests`. Otherwise, will be treated like a normal requirement (see the `modules` field). Mutually exclusive with the `modules` field. diff --git a/versioned_docs/version-2.20/reference/targets/scala_artifact.mdx b/versioned_docs/version-2.20/reference/targets/scala_artifact.mdx index 79259701..230373e0 100644 --- a/versioned_docs/version-2.20/reference/targets/scala_artifact.mdx +++ b/versioned_docs/version-2.20/reference/targets/scala_artifact.mdx @@ -151,7 +151,7 @@ The JVM packages this artifact provides for the purposes of dependency inference For example, the JVM artifact `junit:junit` might provide `["org.junit.**"]`. -Usually you can leave this field off. If unspecified, Pants will fall back to the `[java-infer].third_party_import_mapping`, then to a built in mapping (https://github.com/pantsbuild/pants/blob/release_2.20.3/src/python/pants/jvm/dependency_inference/jvm_artifact_mappings.py), and then finally it will default to the normalized `group` of the artifact. For example, in the absence of any other mapping the artifact `io.confluent:common-config` would default to providing `["io.confluent.**"]`. +Usually you can leave this field off. If unspecified, Pants will fall back to the `[java-infer].third_party_import_mapping`, then to a built in mapping (https://github.com/pantsbuild/pants/blob/release_2.20.4rc0/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.