Skip to main content

Validation Settings

The validate section of the atmos.yaml configures EditorConfig validation settings. EditorConfig helps maintain consistent coding styles across different editors and IDEs.

Configuration​

atmos.yaml

validate:
  editorconfig:
    # Skip default EditorConfig rules
    ignore_defaults: false

    # Preview mode - show what would be checked without failing
    dry_run: false

    # Output format for validation results
    format: default

    # Custom EditorConfig file paths to use
    config_file_paths: []

    # Patterns to exclude from validation
    exclude:
      - "vendor/**"
      - "node_modules/**"

    # Initialize EditorConfig in the project
    init: false

    # Disable specific checks
    disable_end_of_line: false
    disable_insert_final_newline: false
    disable_indentation: false
    disable_indent_size: false
    disable_max_line_length: false
    disable_trim_trailing_whitespace: false

Fields​

editorconfig.ignore_defaults
Skip the default EditorConfig rules. Default: false.
editorconfig.dry_run
Preview mode - show what would be checked without failing. Default: false.
editorconfig.format
Output format for validation results. Default: default.
editorconfig.config_file_paths
List of custom EditorConfig file paths to use for validation.
editorconfig.exclude
Glob patterns for files/directories to exclude from validation.
editorconfig.init
Initialize EditorConfig in the project if not present. Default: false.
editorconfig.disable_end_of_line
Disable end-of-line character validation. Default: false.
editorconfig.disable_insert_final_newline
Disable final newline validation. Default: false.
editorconfig.disable_indentation
Disable indentation style validation. Default: false.
editorconfig.disable_indent_size
Disable indent size validation. Default: false.
editorconfig.disable_max_line_length
Disable maximum line length validation. Default: false.
editorconfig.disable_trim_trailing_whitespace
Disable trailing whitespace validation. Default: false.

Examples​

Basic Validation​

Enable EditorConfig validation with default settings:

atmos.yaml

validate:
  editorconfig: {}

Exclude Vendor Directories​

Skip validation for third-party code:

atmos.yaml

validate:
  editorconfig:
    exclude:
      - "vendor/**"
      - "node_modules/**"
      - ".terraform/**"

Disable Specific Checks​

Disable checks that may cause issues with certain file types:

atmos.yaml

validate:
  editorconfig:
    disable_max_line_length: true
    disable_trim_trailing_whitespace: true

Run Validation

Use the validate command to check your project files against EditorConfig rules.