# fix - rewrite file content in changesets and working copy

#

# Copyright 2018 Google LLC.

#

# This software may be used and distributed according to the terms of the

# GNU General Public License version 2 or any later version.

"""rewrite file content in changesets or working copy (EXPERIMENTAL)

Provides a command that runs configured tools on the contents of modified files,

writing back any fixes to the working copy or replacing changesets.

Here is an example configuration that causes :hg:`fix` to apply automatic

formatting fixes to modified lines in C++ code::

  [fix]

  clang-format:command=clang-format --assume-filename={rootpath}

  clang-format:linerange=--lines={first}:{last}

  clang-format:pattern=set:**.cpp or **.hpp

The :command suboption forms the first part of the shell command that will be

used to fix a file. The content of the file is passed on standard input, and the

fixed file content is expected on standard output. Any output on standard error

will be displayed as a warning. If the exit status is not zero, the file will

not be affected. A placeholder warning is displayed if there is a non-zero exit

status but no standard error output. Some values may be substituted into the

command::

  {rootpath}  The path of the file being fixed, relative to the repo root

  {basename}  The name of the file being fixed, without the directory path

If the :linerange suboption is set, the tool will only be run if there are

changed lines in a file. The value of this suboption is appended to the shell

command once for every range of changed lines in the file. Some values may be

substituted into the command::

  {first}   The 1-based line number of the first line in the modified range

  {last}    The 1-based line number of the last line in the modified range

Deleted sections of a file will be ignored by :linerange, because there is no

corresponding line range in the version being fixed.

By default, tools that set :linerange will only be executed if there is at least

one changed line range. This is meant to prevent accidents like running a code

formatter in such a way that it unexpectedly reformats the whole file. If such a

tool needs to operate on unchanged files, it should set the :skipclean suboption

to false.

The :pattern suboption determines which files will be passed through each

configured tool. See :hg:`help patterns` for possible values. However, all

patterns are relative to the repo root, even if that text says they are relative

to the current working directory. If there are file arguments to :hg:`fix`, the

intersection of these patterns is used.

There is also a configurable limit for the maximum size of file that will be

processed by :hg:`fix`::

  [fix]

  maxfilesize = 2MB

Normally, execution of configured tools will continue after a failure (indicated

by a non-zero exit status). It can also be configured to abort after the first

such failure, so that no files will be affected if any tool fails. This abort

will also cause :hg:`fix` to exit with a non-zero status::

  [fix]

  failure = abort

When multiple tools are configured to affect a file, they execute in an order