====== How to format code ======

We use the following code formatters to maintain consistent coding styles across different programming languages. These tools automatically format source code without changing its behavior.

===== Python: Black =====

[[https://black.readthedocs.io/|Black]] is an opinionated Python code formatter with minimal configuration.

**Install:**
<code bash>
pip install black
</code>

**Format:**
<code bash>
black script.py
</code>

**Check without modifying:**
<code bash>
black --check script.py
</code>

===== R: Air =====

[[https://posit-dev.github.io/air/|Air]] is a fast R code formatter written in Rust and developed by Posit.

**Install:**
<code bash>
pip install air-formatter
</code>

**Format:**
<code bash>
air format script.R
</code>

**Check without modifying:**
<code bash>
air format --check script.R
</code>

===== Shell: shfmt =====

[[https://github.com/mvdan/sh|shfmt]] formats POSIX shell, Bash, and other supported shell scripts.

**Install:**
<code bash>
go install mvdan.cc/sh/v3/cmd/shfmt@latest
</code>

**Format:**
<code bash>
shfmt -w script.sh
</code>

**Check without modifying (list files needing formatting):**
<code bash>
shfmt -l script.sh
</code>

===== C/C++: clang-format =====

[[https://clang.llvm.org/docs/ClangFormat.html|clang-format]] automatically formats C, C++, and related languages. Formatting rules can be configured using a ''.clang-format'' file.

**Install:**
<code bash>
pip install clang-format
</code>

**Format:**
<code bash>
clang-format -i source.c
</code>

**Check without modifying:**
<code bash>
clang-format --dry-run --Werror source.c
</code>

===== JavaScript: Prettier =====

[[https://prettier.io/|Prettier]] is an opinionated formatter for JavaScript, TypeScript, JSON, HTML, CSS, and other web languages.

**Install:**
<code bash>
npm config set prefix ~/.local
npm install -g prettier
</code>

**Format:**
<code bash>
prettier --write script.js
</code>

**Check without modifying:**
<code bash>
prettier --check script.js
</code>

===== Notes =====

  * Formatters should be run before committing changes.
  * Use the default formatting rules unless project-specific requirements justify configuration.
  * Ensure that user-installed executable directories, such as ''~/.local/bin'', are included in ''PATH''.
  * Formatting checks can also be integrated into CI workflows.