1. restyled.yaml(5)
2. Restyler v0.0.0.0
3. restyled.yaml(5)

NAME

restyled.yaml - restyled configuration file

SYNOPSIS

Restyled configuration, loaded from the first of:

• .restyled.yaml
• .restyled.yml
• .github/restyled.yaml
• .github/restyled.yml

DESCRIPTION

enabled

Do anything at all

Schema:

<boolean>

Default: True

dry_run

Do everything except pull and run restylers

Schema:

<boolean>

Default: False

fail_on_differences

Exit non-zero if differences were found

Schema:

<boolean>

Default: False

restylers_version

Version of Restylers manifest to use

Ignored if manifest is given

Schema:

<string>

Default: "stable"

restylers_manifest

Restylers manifest to use

Schema:

<string>

restylers

Restylers to run, and how

Schema:

- # any of
  [ # Restyler
    name: # required
      <string>
    enabled: # optional
      <boolean>
    image: # optional
      # any of
      [ # [<registry>/]<name>:<tag>
        <string>
      , # Image
        registry: # optional
          <string>
        name: # optional
          <string>
        tag: # optional
          <string>
      ]
    command: # optional
      - <string>
    arguments: # optional
      - <string>
    include: # optional
      - # <pattern>|!<pattern>
        <string>
    interpreters: # optional
      - # sh|bash|python|ruby|...
        <string>
    delimiters: # optional
      # Delimiters
      start: # required
        <string>
      end: # required
        <string>
  , # {name: Restyler}
    <any>
  , # !<name>|<name>
    <string>
  ]

Default: ["*"]

Examples:

# Elements in this list can be specified in one of three forms:
# A string, which means to run that Restyler with all defaults
restylers:
  - prettier
    
# A single key, that is a name, a Restyler (see Schema) as the
# value:
restylers:
  - prettier:
      include:
        - "**/*.js"
    
# Or a Restyler including a name key:
restylers:
  - name: prettier
    include:
      - "**/*.js"
    
# All three of the above are equivalent. The latter two are useful
# if you want to run the same Restyler multiple ways:
restylers:
  - name: prettier
    arguments: ["--one-thing"]
    include: ["needs-one-thing/**/*.js"]
    
  - name: prettier
    arguments: ["--another"]
    include: ["needs-another/**/*.js"]
    
# Omitted keys inherit defaults for the Restyler of that name.
#
# Except the enabled key. Adding an item to this list without
# specifying {enabled:false}, automatically enables that Restyler.
#
# In string form, prefixing the name with ! is short-hand for
# disabling. The following two configurations are equivalent:
restylers:
  - "!astyle" # quoting is required for this
  - astyle:
      enabled: false
    
# The special value * (wildcard) means all Restylers not
# configured. One wildcard may be placed anywhere in the
# restylers list and remaining Restylers will be run, with their
# default values at that point.
#
# Note that the Restylers added by the * entry will not run if
# they're default configuration includes {enabled:false}. You must
# explicitly add such Restylers for them to run.
#
# Just run all Restylers with default values, i.e. the default
# configuration value:
restylers:
  - "*"
    
# Enable jdt, and run all others after
restylers:
  - jdt
  - "*"
    
# Enable jdt, and run it after all others
restylers:
  - "*"
  - jdt
    
# Ensure stylish-haskell runs before brittany, and before all others
restylers:
  - stylish-haskell
  - brittany
  - "*"
    
# Run only clang-format
restylers:
  - clang-format
    
# Run clang-format, astyle, everything else, then clang-format again with different options
restylers:
  - clang-format
  - astyle
  - "*"
  - clang-format:
      arguments: ["--special"]
      include:
        - "special/**/*.cs"
    
# Disable the astyle Restyler, maintaining all other defaults
restylers:
  - "!astyle"
  - "*"

exclude

Exclude paths matching the given globs (instead of defaults)

By default, we ignore directories that are often checked-in but rarely represent project code. Some globs are slightly complicated match paths within directories of names appearing at any depth.

Schema:

- <string>

Default: ["**/*.patch","**/.git/**/*","**/node_modules/**/*","**/vendor/**/*",".github/workflows/**/*"]

Examples:

exclude: []

also_exclude

Exclude paths matching the given globs (in addition to defaults)

Schema:

- <string>

Default: []

ignore.authors

Ignore authors that match globs

Schema:

- <string>

Default: ["*[bot]"]

ignore.branches

Ignore branches that match globs

Schema:

- <string>

Default: ["renovate/*"]

ignore.labels

Ignore labels that match globs

Schema:

- <string>

Default: ["restyled-ignore"]

remote_files

Download remote file before restyling

Schema:

- # any of
  [ # RemoteFile
    url: # required
      # URL to download
      <string>
    path: # optional
      # Path to download to
      <string>
  , # URL with path
    <string>
  ]

Default: []

Examples:

remote_files:
  # URL downloaded to a particular path
  - url: https://raw.github.com/.../hlint.yaml
    path: .hlint.yaml
    
remote_files:
  # URL downloaded to its basename
  - https://raw.github.com/.../prettier.json

docker.host_directory

Working directory on host, if dockerized

Schema:

<string>

Default: "."

docker.image_cleanup

Remove images after running them

Schema:

<boolean>

Default: False

docker.pull

Explicitly pull images before running them

Schema:

<boolean>

Default: True

docker.restyler.net_none

Run restylers with --net=none

Schema:

<boolean>

Default: True

docker.restyler.cpu_shares

Run restylers with --cpu-shares

Schema:

<integer>0 or more

Default: 512

docker.restyler.memory

Run restylers with --memory

Schema:

# NUMBER<b|k|m|g>
<string>

Default: 128m

docker.restyler.restricted

Restrict restylers resources

Schema:

<boolean>

Default: True

commit_template

Template for restyling commit messages

Schema:

<string>

Default: "Restyled by ${restyler.name}\n"

git.commit

Commit each restyling change

Schema:

<boolean>

Default: True

git.clean

Run git-clean after restyling

Schema:

<boolean>

Default: True

logging.debug

Enable debug logging

Schema:

<boolean>

Default: False

logging.trace

Enable trace logging

Schema:

<boolean>

Default: False

logging.color

Enable color WHEN

Schema:

# one of
[ auto
, always
, never
]

Default: auto

1. Restyled
2. March 2025
3. restyled.yaml(5)