Question 1

How to configure uncrustify for a C++ project?

Accepted Answer

Start with a base config from the etc/ directory, use uncrustify --update-config to see all options, and test on sample files. Adjust rules like indent_switch_case and align_func_params incrementally, using diff tools to verify changes.

Question 2

Uncrustify vs clang-format for C++ formatting?

Accepted Answer

Uncrustify offers more customization with 857 options, ideal for strict style guides, while clang-format is better integrated with LLVM and IDEs for ease of use. Choose based on whether you need fine-grained control or out-of-the-box functionality.

Question 3

Can uncrustify format Java code correctly?

Accepted Answer

Yes, it supports Java, but the README notes that Java support needs testing and feedback, so verify output carefully. It might have limitations compared to Java-specific tools like google-java-format.

Question 4

How to debug uncrustify formatting errors?

Accepted Answer

Use the -p and -L flags to generate parsing and step dumps, as described in the debugging section. This creates files like myExample.p for detailed insights into transformation steps.

Question 5

Is there a GUI for configuring uncrustify?

Accepted Answer

Yes, third-party tools like Universal Indent GUI TQt or uncrustify_config web tool can help, but they are external and may not cover all 857 options, often requiring manual config file edits for advanced settings.

Question 6

How to integrate uncrustify with CI/CD pipelines?

Accepted Answer

Run uncrustify with your config file on source code in scripts, use diff tools to check for changes, and set up flags like --no-backup to avoid file duplication. Ensure testing on sample code first due to potential bugs.

Uncrustify

What is Uncrustify?

Overview

Use Cases

Best For

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions