1*61c4878aSAndroid Build Coastguard Worker.. _module-pw_presubmit-format: 2*61c4878aSAndroid Build Coastguard Worker 3*61c4878aSAndroid Build Coastguard Worker=============== 4*61c4878aSAndroid Build Coastguard WorkerCode formatting 5*61c4878aSAndroid Build Coastguard Worker=============== 6*61c4878aSAndroid Build Coastguard Worker.. pigweed-module-subpage:: 7*61c4878aSAndroid Build Coastguard Worker :name: pw_presubmit 8*61c4878aSAndroid Build Coastguard Worker 9*61c4878aSAndroid Build Coastguard Worker.. admonition:: Note 10*61c4878aSAndroid Build Coastguard Worker :class: warning 11*61c4878aSAndroid Build Coastguard Worker 12*61c4878aSAndroid Build Coastguard Worker :bug:`326309165`: While the ``pw format`` command interface is very stable, 13*61c4878aSAndroid Build Coastguard Worker the ``pw_presubmit.format`` library is a work-in-progress effort to detach 14*61c4878aSAndroid Build Coastguard Worker the implementation of ``pw format`` from the :ref:`module-pw_presubmit` 15*61c4878aSAndroid Build Coastguard Worker module. Not all formatters are migrated, and the library API is unstable. 16*61c4878aSAndroid Build Coastguard Worker After some of the core pieces land, this library will be moved to 17*61c4878aSAndroid Build Coastguard Worker ``pw_code_format``. 18*61c4878aSAndroid Build Coastguard Worker 19*61c4878aSAndroid Build Coastguard Worker.. _module-pw_presubmit-format-api: 20*61c4878aSAndroid Build Coastguard Worker 21*61c4878aSAndroid Build Coastguard Worker------------- 22*61c4878aSAndroid Build Coastguard WorkerAPI reference 23*61c4878aSAndroid Build Coastguard Worker------------- 24*61c4878aSAndroid Build Coastguard Worker 25*61c4878aSAndroid Build Coastguard WorkerCore 26*61c4878aSAndroid Build Coastguard Worker==== 27*61c4878aSAndroid Build Coastguard Worker.. automodule:: pw_presubmit.format.core 28*61c4878aSAndroid Build Coastguard Worker :members: 29*61c4878aSAndroid Build Coastguard Worker :special-members: DiffCallback 30*61c4878aSAndroid Build Coastguard Worker :noindex: 31*61c4878aSAndroid Build Coastguard Worker 32*61c4878aSAndroid Build Coastguard WorkerFormatters 33*61c4878aSAndroid Build Coastguard Worker========== 34*61c4878aSAndroid Build Coastguard Worker.. autoclass:: pw_presubmit.format.bazel.BuildifierFormatter 35*61c4878aSAndroid Build Coastguard Worker :members: 36*61c4878aSAndroid Build Coastguard Worker :noindex: 37*61c4878aSAndroid Build Coastguard Worker 38*61c4878aSAndroid Build Coastguard Worker.. autoclass:: pw_presubmit.format.cpp.ClangFormatFormatter 39*61c4878aSAndroid Build Coastguard Worker :members: 40*61c4878aSAndroid Build Coastguard Worker :noindex: 41*61c4878aSAndroid Build Coastguard Worker 42*61c4878aSAndroid Build Coastguard Worker.. autoclass:: pw_presubmit.format.gn.GnFormatter 43*61c4878aSAndroid Build Coastguard Worker :members: 44*61c4878aSAndroid Build Coastguard Worker :noindex: 45*61c4878aSAndroid Build Coastguard Worker 46*61c4878aSAndroid Build Coastguard Worker.. autoclass:: pw_presubmit.format.python.BlackFormatter 47*61c4878aSAndroid Build Coastguard Worker :members: 48*61c4878aSAndroid Build Coastguard Worker :noindex: 49