swiftlang/swift-format
Swift Format
swift-format is a set of developer utilities for the Swift ecosystem designed for automated style enforcement, static analysis, and project-wide configuration management. It functions as a code formatter that rewrites source code to adhere to consistent style rules and as a linter that identifies style violations.
The tool provides a system for defining and applying custom formatting rules through a configuration tool. This includes the ability to load settings from configuration files discovered in a directory hierarchy or to export default settings for user customization.
Its capabilities include source code formatting and linting, which allow for the detection of style violations and the automatic rewriting of files. The project also provides an API for embedding formatting and linting logic directly into other applications.
Features
- Source Code Formatters - Automatically rewrites Swift source files to adhere to a consistent and standardized style guide.
- Preservation-Aware Rewrites - Performs structural code modifications while preserving all original whitespace and comments to prevent metadata loss.
- Static Code Linting - Scans source code to detect style violations and report diagnostics via a linter.
- Swift Linters - Performs static analysis on Swift code to identify style violations and ensure adherence to coding standards.
- Swift Resources - Provides developer utilities built specifically to maintain code quality and consistency in Swift projects.
- Swift Code Formatters - Applies visual style and consistent formatting specifically to the Swift programming language.
- Swift Development Tooling - Provides a set of developer utilities to manage code style and quality within the Swift ecosystem.
- Abstract Syntax Tree Parsing - Parses Swift source code into a structured abstract syntax tree to identify and manipulate specific language constructs.
- Automated Linting Integrations - Enables the integration of style checks into development pipelines to treat formatting warnings as build errors.
- Style Rule Configurations - Supports loading formatting rules from configuration files discovered in the directory hierarchy or command line flags.
- Style Configuration Systems - Provides a system for defining and applying custom formatting rules for Swift projects via configuration files.
- Configuration-Driven Rule Engines - Implements a rule engine that parses user-defined settings to apply specific style transformations to source code.
- Configuration Path Resolution - Resolves the applicable style configuration by traversing up the directory tree from the current file to the root.
