update-build-files

Suggest Edits

pants update-build-files [args]

Format and fix safe deprecations in BUILD files.

This does not handle the full Pants upgrade. You must still manually change pants_version in pants.toml and you may need to manually address some deprecations. See Upgrade tips for upgrade tips.

This goal is run without arguments. It will run over all BUILD files in your project.

Backend: pants.core
Config section: [update-build-files]

Basic options

`check`

--[no-]update-build-files-check

PANTS_UPDATE_BUILD_FILES_CHECK

default: False

Do not write changes to disk, only write back what would change. Return code 0 means there would be no changes, and 1 means that there would be.

`fmt`

--[no-]update-build-files-fmt

PANTS_UPDATE_BUILD_FILES_FMT

default: True

Format BUILD files using Black or Yapf.

Set [black].args / [yapf].args, [black].config / [yapf].config , and [black].config_discovery / [yapf].config_discovery to change Black's or Yapf's behavior. Set [black].interpreter_constraints / [yapf].interpreter_constraints and [python].interpreter_search_path to change which interpreter is used to run the formatter.

`formatter`

--update-build-files-formatter=<Formatter>

PANTS_UPDATE_BUILD_FILES_FORMATTER

one of: yapf, black
default: black

Which formatter Pants should use to format BUILD files.

`fix_safe_deprecations`

--[no-]update-build-files-fix-safe-deprecations

PANTS_UPDATE_BUILD_FILES_FIX_SAFE_DEPRECATIONS

default: True

Automatically fix deprecations, such as target type renames, that are safe because they do not change semantics.

Advanced options

None

Deprecated options

None

Related subsystems

environments-preview, filter

Updated about 1 month ago