Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.aspect.build/llms.txt

Use this file to discover all available pages before exploring further.

Aspect Workflows manages code formatting through Aspect’s rules_lint. This architecture allows you to establish and enforce specific formatting rules across your workspace. This document explains the core concepts of how the format task operates and the available methods for customization and integration.

rules_lint integration

Aspect Workflows abstracts the complexity of running multiple formatters by integrating with rules_lint. The minimal configuration for the format task uses the default settings provided by rules_lint:
config.yaml
tasks:
    - format:
This default setup includes formatters for various languages, such as Python, Go, and JavaScript.

Format task execution

With the minimal configuration, the format task automatically checks and fixes formatting issues in your codebase.
  • Validation: The task verifies that there are no pending changes in the source files, executing the check by running the underlying command bazel run //:format.
  • Failure State: If the task detects any changes, it fails.
  • Remediation: Developers can apply the suggested formatting fixes by manually running bazel run //:format.