Balancing Code Formatting Automation with Developer Flexibility

---
title: Balancing Code Formatting Automation with Developer Flexibility
description: Automate code formatting to ensure consistency while allowing developers the discretion to override formatting in specific cases where necessary.
category: Code Formatting
category_context: Ensures consistent style in code by handling indentation, spacing, line breaks, and overall structure to keep code clean and readable.
---

# Rule: Automated Code Formatting with Developer Overrides

## Context
- **When to Apply**: During code editing and before committing changes to the repository.
- **Prerequisites**: Ensure that the project is configured with a code formatter (e.g., Prettier for JavaScript, Black for Python) and that developers are aware of how to use override comments.

## Requirements
- **Automated Formatting**: Implement a code formatter that enforces consistent code style across the project.
- **Override Mechanism**: Allow developers to disable formatting for specific code blocks using standardized comments (e.g., `// prettier-ignore` for Prettier).
- **Documentation**: Provide clear guidelines on when and how to use formatting overrides appropriately.

## Examples

// Example of a function with automated formatting
function add(a, b) {
  return a + b;
}

// Example of a function with a formatting override
// prettier-ignore
function complexFunction() { return { key: 'value' }; }
# Example of a function with automated formatting
def add(a, b):
    return a + b

# Example of a function with a formatting override
# fmt: off
def complex_function(): return {'key': 'value'}
# fmt: on
## Notes
- **Consistency**: Automated formatting ensures a uniform codebase, improving readability and maintainability.
- **Flexibility**: Overrides should be used sparingly and only when automated formatting would hinder code clarity or functionality.
- **Review**: Code reviews should include checks for appropriate use of formatting overrides to prevent misuse.