Restylers

Built from 715cfdecadad1cdd42a3e6b46ff6980278336ea7.

Restyler	Language(s)	Version	Runs automatically?
astyle	C, C++, C#, Java*, Objective-C	`v3.6.2`	Yes
autopep8	Python	`v2.3.1`	Yes
black	Python	`v24.10.0`	Yes
brittany	Haskell	`v0.14.0.2`	No
cabal-fmt	Haskell	`v0.1.12`	No
clang-format	C, C++, Java, JavaScript, Objective-C, Protobuf, C#	`v18.1.8`	Yes
cmake-format	CMake	`0.6.13-1`	Yes
dart-format	Dart	`v2.3.4`	Yes
dfmt	D	`v0.14.2`	Yes
dhall-format	Dhall	`1.42.1`	Yes
dotnet-format	C#, VB.NET	`v5.1.250801`	No
elm-format	Elm	`v0.6.1-alpha-3`	Yes
fantomas	F#	`v3.3.0`	Yes
fourmolu	Haskell	`v0.16.2.0`	No
gn	GN	`v2`	Yes
gofmt	Go	`go1.23.0`	Yes
google-java-format	Java	`v1.9`	No
hindent	Haskell	`v6.1.1`	No
hlint	Haskell	`v3.5`	No
isort	Python	`v5.13.2`	Yes
jdt	Java, JavaScript*, CSS, HTML, JSON, XML	`v2.13.0`	No
jq	JSON	`v1.6-3`	No
luaformatter	Lua	`v1.3.6`	Yes
nixfmt	Nix	`v0.6.0`	Yes
nixpkgs-fmt	Nix	`v1.3.0`	No
npm-groovy-lint	Groovy	`v15.0.2`	Yes
ocamlformat	OCaml	`v0.26.2`	Yes
ormolu	Haskell	`v0.5.3.0`	No
perltidy	Perl	`v20230701`	Yes
pg_format	PSQL	`v5.3`	Yes
php-cs-fixer	PHP	`v3.67.1`	Yes
prettier	JavaScript	`v3.4.2-3`	Yes
prettier-json	JSON	`v3.4.2-3`	Yes
prettier-markdown	Markdown	`v3.4.2-3`	Yes
prettier-yaml	Yaml	`v3.4.2-3`	Yes
prettier-ruby	Ruby	`v3.2.2-1`	No
purty	PureScript	`v7.0.0`	Yes
pyment	Python	`v0.3.3`	Yes
refmt	Reason	`v3.3.3`	Yes
reorder-python-imports	Python	`v3.14.0`	Yes
rubocop	Ruby	`v1.70.0`	No
rustfmt	Rust	`v1.7.1-stable`	Yes
scalafmt	Scala	`v3.7.10`	No
shellcheck	POSIX sh, Bash	`v0.9.0`	Yes
shellharden	POSIX sh, Bash	`v4.1.1-3`	Yes
shfmt	POSIX sh, Bash	`v3.4.3`	Yes
sqlformat	SQL, PSQL	`0.5.3`	No
standardrb	Ruby	`v1.43.0`	Yes
stylish-haskell	Haskell	`v0.14.3.0`	Yes
taplo	TOML	`0.9.3`	Yes
terraform	Terraform	`v0.12.24-2`	Yes
verible	System Verilog	`v0.0-1318-gf6b4485`	Yes
whitespace	*	`v0.2.0.0`	Yes
yapf	Python	`v0.43.0-1`	Yes

astyle

Restyles C, C++, C#, Java*, Objective-C, runs automatically.

Documentation

http://astyle.sourceforge.net/astyle.html

Configuration

restylers:
- astyle:
    arguments: []
    command:
    - astyle
    image: restyled/restyler-astyle:v3.6.2
    include:
    - '**/*.c'
    - '**/*.cc'
    - '**/*.cpp'
    - '**/*.cxx'
    - '**/*.c++'
    - '**/*.C'
    - '**/*.cs'
    - '**/*.h'
    - '**/*.hh'
    - '**/*.hpp'
    - '**/*.hxx'
    - '**/*.h++'
    - '**/*.H'
    - '**/*.m'
    - '**/*.mm'
    interpreters: []

Examples

Before

int Foo(bool isBar)
    {
    if (isBar) {
        bar();
        return 1; }
    else
        return 0;
}

After

int Foo(bool isBar)
{
    if (isBar) {
        bar();
        return 1;
    }
    else
        return 0;
}

Before

/* FEOF example */
#include <stdio.h>
int main()
{
   FILE * pFile;
   char buffer [100];
   pFile = fopen ("myfile.txt" , "r");
   if (pFile == NULL) perror ("Error opening file");
   else {
     while ( ! feof (pFile) ) {
       if ( fgets (buffer , 100 , pFile) == NULL ) break;
       fputs (buffer , stdout);
     }
     fclose (pFile);
   }
   return 0;
}

After

/* FEOF example */
#include <stdio.h>
int main()
{
    FILE * pFile;
    char buffer [100];
    pFile = fopen ("myfile.txt", "r");
    if (pFile == NULL) perror ("Error opening file");
    else {
        while (! feof (pFile) ) {
            if ( fgets (buffer, 100, pFile) == NULL ) break;
            fputs (buffer, stdout);
        }
        fclose (pFile);
    }
    return 0;
}

See all available images

autopep8

Restyles Python, runs automatically.

Documentation

https://github.com/hhatto/autopep8

Configuration

restylers:
- autopep8:
    arguments: []
    command:
    - autopep8
    - --in-place
    image: restyled/restyler-autopep8:v2.3.1
    include:
    - '**/*.py'
    interpreters:
    - python

Examples

Before

import math, sys;
def example1():
    ####This is a long comment. This should be wrapped to fit within 72 characters.
    some_tuple=(   1,2, 3,'a'  );
    some_variable={'long':'Long code lines should be wrapped within 79 characters.',
    'other':[math.pi, 100,200,300,9876543210,'This is a long string that goes on'],
    'more':{'inner':'This whole logical line should be wrapped.',some_tuple:[1,
    20,300,40000,500000000,60000000000000000]}}
    return (some_tuple, some_variable)

After

import math
import sys


def example1():
    # This is a long comment. This should be wrapped to fit within 72 characters.
    some_tuple = (1, 2, 3, 'a')
    some_variable = {'long': 'Long code lines should be wrapped within 79 characters.',
                     'other': [math.pi, 100, 200, 300, 9876543210, 'This is a long string that goes on'],
                     'more': {'inner': 'This whole logical line should be wrapped.', some_tuple: [1,
                                                                                                  20, 300, 40000, 500000000, 60000000000000000]}}
    return (some_tuple, some_variable)

See all available images

black

Restyles Python, runs automatically.

Documentation

https://github.com/python/black

Configuration

restylers:
- black:
    arguments: []
    command:
    - black
    image: public.ecr.aws/restyled-io/restyler-black:v24.10.0
    include:
    - '**/*.py'
    interpreters:
    - python

Examples

Before

import math, sys;
def example1():
    ####This is a long comment. This should be wrapped to fit within 72 characters.
    some_tuple=(   1,2, 3,'a'  );
    some_variable={'long':'Long code lines should be wrapped within 79 characters.',
    'other':[math.pi, 100,200,300,9876543210,'This is a long string that goes on'],
    'more':{'inner':'This whole logical line should be wrapped.',some_tuple:[1,
    20,300,40000,500000000,60000000000000000]}}
    return (some_tuple, some_variable)

After

import math, sys


def example1():
    ####This is a long comment. This should be wrapped to fit within 72 characters.
    some_tuple = (1, 2, 3, "a")
    some_variable = {
        "long": "Long code lines should be wrapped within 79 characters.",
        "other": [
            math.pi,
            100,
            200,
            300,
            9876543210,
            "This is a long string that goes on",
        ],
        "more": {
            "inner": "This whole logical line should be wrapped.",
            some_tuple: [1, 20, 300, 40000, 500000000, 60000000000000000],
        },
    }
    return (some_tuple, some_variable)

See all available images

brittany

Restyles Haskell, must be explicitly enabled.

Documentation

https://github.com/lspitzner/brittany
https://github.com/restyled-io/restyler/wiki/Errors#brittany

Configuration

restylers:
- brittany:
    arguments: []
    command:
    - brittany
    - --write-mode=inplace
    image: public.ecr.aws/restyled-io/restyler-brittany:v0.14.0.2
    include:
    - '**/*.hs'
    interpreters: []

Examples

Before

func (MyLongFoo abc def) = 1
func (Bar a d) = 2
func _ = 3

After

func (MyLongFoo abc def) = 1
func (Bar       a   d  ) = 2
func _                   = 3

See all available images

cabal-fmt

Restyles Haskell, must be explicitly enabled.

Documentation

https://github.com/phadej/cabal-fmt

Configuration

restylers:
- cabal-fmt:
    arguments: []
    command:
    - cabal-fmt
    - --inplace
    image: public.ecr.aws/restyled-io/restyler-cabal-fmt:v0.1.12
    include:
    - '**/*.cabal'
    interpreters: []

Examples

Before

cabal-version: 2.4
name: cabal-fmt
version: 0

-- An example formatter
executable cabal-fmt
    default-language: Haskell2010
    hs-source-dirs: src
    main-is: CabalFmt.hs
    -- build depends will be in
    -- a nice tabular format
    build-depends: base >=4.11 && <4.13, pretty >=1.1.3.6 && <1.2, bytestring, Cabal ^>=2.5, containers ^>=0.5.11.0 || ^>=0.6.0.1
    -- extensions will be sorted
    other-extensions:
      DeriveFunctor FlexibleContexts ExistentialQuantification OverloadedStrings
      RankNTypes

After

cabal-version: 2.4
name:          cabal-fmt
version:       0

-- An example formatter
executable cabal-fmt
  default-language: Haskell2010
  hs-source-dirs:   src
  main-is:          CabalFmt.hs

  -- build depends will be in
  -- a nice tabular format
  build-depends:
    , base        >=4.11      && <4.13
    , bytestring
    , Cabal       ^>=2.5
    , containers  ^>=0.5.11.0 || ^>=0.6.0.1
    , pretty      >=1.1.3.6   && <1.2

  -- extensions will be sorted
  other-extensions:
    DeriveFunctor
    ExistentialQuantification
    FlexibleContexts
    OverloadedStrings
    RankNTypes

See all available images

clang-format

Restyles C, C++, Java, JavaScript, Objective-C, Protobuf, C#, runs automatically.

Documentation

https://clang.llvm.org/docs/ClangFormat.html

Configuration

restylers:
- clang-format:
    arguments: []
    command:
    - clang-format
    - -i
    image: restyled/restyler-clang-format:v18.1.8
    include:
    - '**/*.c'
    - '**/*.cc'
    - '**/*.cpp'
    - '**/*.cxx'
    - '**/*.c++'
    - '**/*.C'
    - '**/*.cs'
    - '**/*.h'
    - '**/*.hh'
    - '**/*.hpp'
    - '**/*.hxx'
    - '**/*.h++'
    - '**/*.H'
    - '**/*.java'
    - '**/*.js'
    - '**/*.m'
    interpreters: []

Examples

Before

int formatted_code;
    void    unformatted_code  ;
void formatted_code_again;

After

int formatted_code;
void unformatted_code;
void formatted_code_again;

See all available images

cmake-format

Restyles CMake, runs automatically.

Documentation

https://github.com/cheshirekow/cmake_format

Configuration

restylers:
- cmake-format:
    arguments: []
    command:
    - cmake-format
    - --in-place
    image: restyled/restyler-cmake-format:0.6.13-1
    include:
    - '**/CMakeLists.txt'
    - '**/*.cmake-format-test'
    interpreters: []

Examples

Before

# The following multiple newlines should be collapsed into a single newline




cmake_minimum_required(VERSION 2.8.11)
project(cmakelang_test)

# This multiline-comment should be reflowed
# into a single comment
# on one line

# This comment should remain right before the command call.
# Furthermore, the command call should be formatted
# to a single line.
add_subdirectories(foo bar baz
  foo2 bar2 baz2)

# This very long command should be wrapped
set(HEADERS very_long_header_name_a.h very_long_header_name_b.h very_long_header_name_c.h)

# This command should be split into one line per entry because it has a long argument list.
set(SOURCES source_a.cc source_b.cc source_d.cc source_e.cc source_f.cc source_g.cc source_h.cc)

# The string in this command should not be split
set_target_properties(foo bar baz PROPERTIES COMPILE_FLAGS "-std=c++11 -Wall -Wextra")

# This command has a very long argument and can't be aligned with the command
# end, so it should be moved to a new line with block indent + 1.
some_long_command_name("Some very long argument that really needs to be on the next line.")

# This situation is similar but the argument to a KWARG needs to be on a
# newline instead.
set(CMAKE_CXX_FLAGS "-std=c++11 -Wall -Wno-sign-compare -Wno-unused-parameter -xx")

set(HEADERS header_a.h header_b.h # This comment should
                                  # be preserved, moreover it should be split
                                  # across two lines.
    header_c.h header_d.h)


# This part of the comment should
# be formatted
# but...
# cmake-format: off
# This bunny should remain untouched:
# . 　 ＿　∩
# 　　ﾚﾍヽ| |
# 　　　 (・ｘ・)
# 　　 c( uu}
# cmake-format: on
#          while this part should
#          be formatted again

# This is a paragraph
#
# This is a second paragraph
#
# This is a third paragraph

# This is a comment
# that should be joined but
# TODO(josh): This todo should not be joined with the previous line.
# NOTE(josh): Also this should not be joined with the todo.

if(foo)
if(sbar)
# This comment is in-scope.
add_library(foo_bar_baz foo.cc bar.cc # this is a comment for arg2
                                      # this is more comment for arg2, it should be joined with the first.
    baz.cc) # This comment is part of add_library

other_command(some_long_argument some_long_argument) # this comment is very long and gets split across some lines

other_command(some_long_argument some_long_argument some_long_argument) # this comment is even longer and wouldn't make sense to pack at the end of the command so it gets it's own lines
endif()
endif()


# This very long command should be broken up along keyword arguments
foo(nonkwarg_a nonkwarg_b HEADERS a.h b.h c.h d.h e.h f.h SOURCES a.cc b.cc d.cc DEPENDS foo bar baz)

# This command uses a string with escaped quote chars
foo(some_arg some_arg "This is a \"string\" within a string")

# This command uses an empty string
foo(some_arg some_arg "")

# This command uses a multiline string
foo(some_arg some_arg "
    This string is on multiple lines
")

# No, I really want this to look ugly
# cmake-format: off
add_library(a b.cc
  c.cc         d.cc
           e.cc)
# cmake-format: on

After

# The following multiple newlines should be collapsed into a single newline

cmake_minimum_required(VERSION 2.8.11)
project(cmakelang_test)

# This multiline-comment should be reflowed into a single comment on one line

# This comment should remain right before the command call. Furthermore, the
# command call should be formatted to a single line.
add_subdirectories(foo bar baz foo2 bar2 baz2)

# This very long command should be wrapped
set(HEADERS very_long_header_name_a.h very_long_header_name_b.h
            very_long_header_name_c.h)

# This command should be split into one line per entry because it has a long
# argument list.
set(SOURCES
    source_a.cc
    source_b.cc
    source_d.cc
    source_e.cc
    source_f.cc
    source_g.cc
    source_h.cc)

# The string in this command should not be split
set_target_properties(foo bar baz PROPERTIES COMPILE_FLAGS
                                             "-std=c++11 -Wall -Wextra")

# This command has a very long argument and can't be aligned with the command
# end, so it should be moved to a new line with block indent + 1.
some_long_command_name(
  "Some very long argument that really needs to be on the next line.")

# This situation is similar but the argument to a KWARG needs to be on a newline
# instead.
set(CMAKE_CXX_FLAGS
    "-std=c++11 -Wall -Wno-sign-compare -Wno-unused-parameter -xx")

set(HEADERS
    header_a.h header_b.h # This comment should be preserved, moreover it should
                          # be split across two lines.
    header_c.h header_d.h)

# This part of the comment should be formatted but...
# cmake-format: off
# This bunny should remain untouched:
# . 　 ＿　∩
# 　　ﾚﾍヽ| |
# 　　　 (・ｘ・)
# 　　 c( uu}
# cmake-format: on
# while this part should be formatted again

# This is a paragraph
#
# This is a second paragraph
#
# This is a third paragraph

# This is a comment that should be joined but
# TODO(josh): This todo should not be joined with the previous line.
# NOTE(josh): Also this should not be joined with the todo.

if(foo)
  if(sbar)
    # This comment is in-scope.
    add_library(
      foo_bar_baz
      foo.cc bar.cc # this is a comment for arg2 this is more comment for arg2,
                    # it should be joined with the first.
      baz.cc) # This comment is part of add_library

    other_command(
      some_long_argument some_long_argument) # this comment is very long and
                                             # gets split across some lines

    other_command(
      some_long_argument some_long_argument some_long_argument) # this comment
                                                                # is even longer
                                                                # and wouldn't
                                                                # make sense to
                                                                # pack at the
                                                                # end of the
                                                                # command so it
                                                                # gets it's own
                                                                # lines
  endif()
endif()

# This very long command should be broken up along keyword arguments
foo(nonkwarg_a nonkwarg_b
    HEADERS a.h b.h c.h d.h e.h f.h
    SOURCES a.cc b.cc d.cc
    DEPENDS foo
    bar baz)

# This command uses a string with escaped quote chars
foo(some_arg some_arg "This is a \"string\" within a string")

# This command uses an empty string
foo(some_arg some_arg "")

# This command uses a multiline string
foo(some_arg some_arg "
    This string is on multiple lines
")

# No, I really want this to look ugly
# cmake-format: off
add_library(a b.cc
  c.cc         d.cc
           e.cc)
# cmake-format: on

See all available images

dart-format

Restyles Dart, runs automatically.

Documentation

https://pub.dev/packages/dart_style

Configuration

restylers:
- dart-format:
    arguments: []
    command:
    - dart
    - format
    image: restyled/restyler-dart-format:v2.3.4
    include:
    - '**/*.dart'
    interpreters: []

Examples

Before

void example() {
  if (tag=='style'||tag=='script'&&(type==null||type == TYPE_JS
        ||type==TYPE_DART)||
    tag=='link'&&(rel=='stylesheet'||rel=='import')) {}
}

After

void example() {
  if (tag == 'style' ||
      tag == 'script' &&
          (type == null || type == TYPE_JS || type == TYPE_DART) ||
      tag == 'link' && (rel == 'stylesheet' || rel == 'import')) {}
}

See all available images

dfmt

Restyles D, runs automatically.

Documentation

https://github.com/dlang-community/dfmt#readme

Configuration

restylers:
- dfmt:
    arguments: []
    command:
    - dfmt
    - --inplace
    image: restyled/restyler-dfmt:v0.14.2
    include:
    - '**/*.d'
    interpreters: []

Examples

Before

void main(string[] args) {
    bool optionOne, optionTwo, optionThree;
    getopt(args,
        "optionOne", &optionOne,
        "optionTwo", &optionTwo,
        "optionThree", &optionThree);
}

After

void main(string[] args)
{
    bool optionOne, optionTwo, optionThree;
    getopt(args, "optionOne", &optionOne, "optionTwo", &optionTwo, "optionThree", &optionThree);
}

See all available images

dhall-format

Restyles Dhall, runs automatically.

Documentation

https://docs.dhall-lang.org

Configuration

restylers:
- dhall-format:
    arguments:
    - format
    - --inplace
    command:
    - dhall
    image: restyled/restyler-dhall-format:1.42.1
    include:
    - '**/*.dhall'
    interpreters: []

Examples

Before

let Fruit_ = < Apple : {} | Banana : {} | Orange : {} >
in let fruiteHandler_ =
            { Apple = \(_ : {}) -> "Apple"
            , Banana = \(_ : {}) -> "Banana"
            , Orange = \(_ : {}) -> "Orange"
            }
        in let f = { Fruit = Fruit_, fruitToText = \(f : Fruit_) -> merge fruiteHandler_ f }
        in let x = { fruit1 = f.fruitToText (f.Fruit.Apple {=}), fruit2 = f.fruitToText (f.Fruit.Banana {=}) }
        in x // { fruit1 = f.fruitToText (f.Fruit.Orange {=}) }

After

let Fruit_ = < Apple : {} | Banana : {} | Orange : {} >

in  let fruiteHandler_ =
          { Apple = \(_ : {}) -> "Apple"
          , Banana = \(_ : {}) -> "Banana"
          , Orange = \(_ : {}) -> "Orange"
          }

    in  let f =
              { Fruit = Fruit_
              , fruitToText = \(f : Fruit_) -> merge fruiteHandler_ f
              }

        in  let x =
                  { fruit1 = f.fruitToText (f.Fruit.Apple {=})
                  , fruit2 = f.fruitToText (f.Fruit.Banana {=})
                  }

            in  x // { fruit1 = f.fruitToText (f.Fruit.Orange {=}) }

See all available images

dotnet-format

Restyles C#, VB.NET, must be explicitly enabled.

Documentation

https://github.com/dotnet/format

Configuration

restylers:
- dotnet-format:
    arguments: []
    command:
    - dotnet-format-files
    image: restyled/restyler-dotnet-format:v5.1.250801
    include:
    - '**/*.cs'
    - '**/*.vb'
    interpreters: []

Examples

Before

int formatted_code;
    void    unformatted_code  ;
void formatted_code_again;

After

int formatted_code;
void unformatted_code;
void formatted_code_again;

Before

int formatted_code;
    void    unformatted_code  ;
void formatted_code_again;

After

int formatted_code;
void unformatted_code;
void formatted_code_again;

See all available images

elm-format

Restyles Elm, runs automatically.

Documentation

https://github.com/avh4/elm-format

Configuration

restylers:
- elm-format:
    arguments: []
    command:
    - elm-format
    - --yes
    image: public.ecr.aws/restyled-io/restyler-elm-format:v0.6.1-alpha-3
    include:
    - '**/*.elm'
    interpreters: []

Examples

Before

homeDirectory = "/root/files"
eval boolean = case boolean of
    Literal bool -> bool
    Not b        -> not (eval b)
    And b b_     -> eval b && eval b_
    Or b b_      -> eval b   || eval b_

After

module Main exposing (eval, homeDirectory)


homeDirectory =
    "/root/files"


eval boolean =
    case boolean of
        Literal bool ->
            bool

        Not b ->
            not (eval b)

        And b b_ ->
            eval b && eval b_

        Or b b_ ->
            eval b || eval b_

See all available images

fantomas

Restyles F#, runs automatically.

Documentation

https://github.com/fsprojects/fantomas

Configuration

restylers:
- fantomas:
    arguments: []
    command:
    - fantomas
    image: restyled/restyler-fantomas:v3.3.0
    include:
    - '**/*.fs'
    - '**/*.fsi'
    - '**/*.fsx'
    interpreters: []

Examples

Before

type Type
    = TyLam of Type * Type
    | TyVar of string
    | TyCon of string * Type list
    with override this.ToString () =
            match this with
            | TyLam (t1, t2) -> sprintf "(%s -> %s)" (t1.ToString()) (t2.ToString())
            | TyVar a -> a
            | TyCon (s, ts) -> s

After

type Type =
    | TyLam of Type * Type
    | TyVar of string
    | TyCon of string * Type list
    override this.ToString() =
        match this with
        | TyLam(t1, t2) -> sprintf "(%s -> %s)" (t1.ToString()) (t2.ToString())
        | TyVar a -> a
        | TyCon(s, ts) -> s

Before

let Multiple9x9 () =
    for i in 1 .. 9 do
        printf "\n";
        for j in 1 .. 9 do
            let k = i * j in
            printf "%d x %d = %2d " i j k;
        done;
    done;;
Multiple9x9 ();;

After

let Multiple9x9() =
    for i in 1 .. 9 do
        printf "\n"
        for j in 1 .. 9 do
            let k = i * j
            printf "%d x %d = %2d " i j k

Multiple9x9()

See all available images

fourmolu

Restyles Haskell, must be explicitly enabled.

Documentation

https://fourmolu.github.io/
https://github.com/fourmolu/fourmolu

Configuration

restylers:
- fourmolu:
    arguments: []
    command:
    - fourmolu
    - --mode
    - inplace
    image: restyled/restyler-fourmolu:v0.16.2.0
    include:
    - '**/*.hs'
    interpreters: []

Examples

Before

foo
 :: MonadIO m
 -> Text -> Text
 -> SqlPersistT m ()
 foo = undefined

After

foo ::
    MonadIO m ->
    Text ->
    Text ->
    SqlPersistT
        m
        ()
        foo = undefined

See all available images

gn

Restyles GN, runs automatically.

Documentation

https://gn.googlesource.com/gn/+/master/docs/reference.md#cmd_format

Configuration

restylers:
- gn:
    arguments: []
    command:
    - gn
    - format
    image: restyled/restyler-gn:v2
    include:
    - '**/*.gn'
    - '**/*.gni'
    interpreters: []

Examples

Before

sources = ["b", "a"]

After

sources = [
  "a",
  "b",
]

See all available images

gofmt

Restyles Go, runs automatically.

Documentation

https://golang.org/cmd/gofmt/

Configuration

restylers:
- gofmt:
    arguments: []
    command:
    - gofmt
    - -w
    image: restyled/restyler-gofmt:go1.23.0
    include:
    - '**/*.go'
    interpreters: []

Examples

Before

package main
          import "fmt"
// this is demo to format code
            // with gofmt command
 var a int=2;
              var b int=5;
                                  var c string= `hello world`;
       func print(){
                  fmt.Println("Value for a,b and c is : ");
                          fmt.Println(a);
                              fmt.Println((b));
                                 fmt.Println(c);
                        }

After

package main

import "fmt"

// this is demo to format code
// with gofmt command
var a int = 2
var b int = 5
var c string = `hello world`

func print() {
	fmt.Println("Value for a,b and c is : ")
	fmt.Println(a)
	fmt.Println((b))
	fmt.Println(c)
}

See all available images

google-java-format

Restyles Java, must be explicitly enabled.

Documentation

https://github.com/google/google-java-format#readme

Configuration

restylers:
- google-java-format:
    arguments: []
    command:
    - google-java-format
    - --replace
    image: public.ecr.aws/restyled-io/restyler-google-java-format:v1.9
    include:
    - '**/*.java'
    interpreters: []

Examples

Before

private enum Answer {
  YES { @Override public String toString() { return "yes";
    }
  }, NO,
  MAYBE
}

After

private enum Answer {
  YES {
    @Override
    public String toString() {
      return "yes";
    }
  },
  NO,
  MAYBE
}

See all available images

hindent

Restyles Haskell, must be explicitly enabled.

Documentation

https://github.com/commercialhaskell/hindent

Configuration

restylers:
- hindent:
    arguments: []
    command:
    - hindent
    image: restyled/restyler-hindent:v6.1.1
    include:
    - '**/*.hs'
    interpreters: []

Examples

Before

example = case x of Just p -> foo bar

After

example =
  case x of
    Just p -> foo bar

See all available images

hlint

Restyles Haskell, must be explicitly enabled.

Documentation

https://github.com/ndmitchell/hlint#readme
https://github.com/restyled-io/restyler/wiki/Errors#hlint

Configuration

restylers:
- hlint:
    arguments: []
    command:
    - hlint
    - --refactor
    - --refactor-options=-i
    image: public.ecr.aws/restyled-io/restyler-hlint:v3.5
    include:
    - '**/*.hs'
    interpreters: []

Examples

Before

main :: IO ()
main = putStrLn $ "hello hlint"

After

main :: IO ()
main = putStrLn "hello hlint"

See all available images

isort

Restyles Python, runs automatically.

Documentation

https://github.com/timothycrosley/isort/

Configuration

restylers:
- isort:
    arguments: []
    command:
    - isort
    image: restyled/restyler-isort:v5.13.2
    include:
    - '**/*.py'
    interpreters:
    - python

Examples

Before

from my_lib import Object

import os

from my_lib import Object3

from my_lib import Object2

import sys

from third_party import lib15, lib1, lib2, lib3, lib4, lib5, lib6, lib7, lib8, lib9, lib10, lib11, lib12, lib13, lib14

import sys

from __future__ import absolute_import

from third_party import lib3

print("Hey")
print("yo")

After

from __future__ import absolute_import

import os
import sys

from my_lib import Object, Object2, Object3
from third_party import (lib1, lib2, lib3, lib4, lib5, lib6, lib7, lib8, lib9,
                         lib10, lib11, lib12, lib13, lib14, lib15)

print("Hey")
print("yo")

See all available images

jdt

Restyles Java, JavaScript*, CSS, HTML, JSON, XML, must be explicitly enabled.

Documentation

https://code.revelc.net/formatter-maven-plugin/

Configuration

restylers:
- jdt:
    arguments: []
    command:
    - formatter
    image: restyled/restyler-jdt:v2.13.0
    include:
    - '**/*.java'
    - '**/*.css'
    - '**/*.html'
    - '**/*.json'
    - '**/*.xml'
    interpreters: []

Examples

Before

public class ShouldFormat1 {
int Foo(bool isBar) {
        if (isBar) {
            bar();
            return 1;
        } else
            return 0;
    }
}

After

public class ShouldFormat1 {
    int Foo(bool isBar) {
        if (isBar) {
            bar();
            return 1;
        } else
            return 0;
    }
}

Before

public class ShouldFormat2 {
    int Foo(bool isBar) {

        if (isBar) {

            bar();

            return 1;
   } else

            return 0;
    }}

After

public class ShouldFormat2 {
    int Foo(bool isBar) {

        if (isBar) {

            bar();

            return 1;
        } else

            return 0;
    }
}

See all available images

jq

Restyles JSON, must be explicitly enabled.

Documentation

https://stedolan.github.io/jq/

Configuration

restylers:
- jq:
    arguments: []
    command:
    - jq-write
    image: public.ecr.aws/restyled-io/restyler-jq:v1.6-3
    include:
    - '**/*.json'
    interpreters: []

Examples

Before

{
   "foo": "bar"
   , "baz":
 "bat" }

After

{
  "foo": "bar",
  "baz": "bat"
}

See all available images

luaformatter

Restyles Lua, runs automatically.

Documentation

https://github.com/Koihik/LuaFormatter

Configuration

restylers:
- luaformatter:
    arguments: []
    command:
    - lua-format
    - --in-place
    image: restyled/restyler-luaformatter:v1.3.6
    include:
    - '**/*.lua'
    interpreters:
    - lua

Examples

Before

matrix = { {1, 0, 0, 0},
   {1, 1, 0,   0},
   {1, 1,  1, 0},
   {1, 1, 1, 1} }

After

matrix = {{1, 0, 0, 0}, {1, 1, 0, 0}, {1, 1, 1, 0}, {1, 1, 1, 1}}

See all available images

nixfmt

Restyles Nix, runs automatically.

Documentation

https://github.com/NixOS/nixfmt#readme

Configuration

restylers:
- nixfmt:
    arguments: []
    command:
    - nixfmt
    image: restyled/restyler-nixfmt:v0.6.0
    include:
    - '**/*.nix'
    interpreters: []

Examples

Before

let
/*
* What you're seeing here is our nix formatter. It's quite opinionated:
*/
  sample-01 = { lib }:
{
  list = [
    elem1
    elem2
    elem3
  ] ++ lib.optionals stdenv.isDarwin [
    elem4
    elem5
  ]; # and not quite finished
}; # it will preserve your newlines

  sample-02 = { stdenv, lib }:
{
  list =
    [
      elem1
      elem2
      elem3
    ]
    ++ lib.optionals stdenv.isDarwin [ elem4 elem5 ]
    ++ lib.optionals stdenv.isLinux [ elem6 ]
    ;
};
# but it can handle all nix syntax,
# and, in fact, all of nixpkgs in <20s.
# The javascript build is quite a bit slower.
sample-03 = { stdenv, system }:
assert system == "i686-linux";
stdenv.mkDerivation { };
# these samples are all from https://github.com/nix-community/nix-fmt/tree/master/samples
sample-simple = # Some basic formatting
{
  empty_list = [ ];
  inline_list = [ 1 2 3 ];
  multiline_list = [
    1
    2
    3
    4
  ];
  inline_attrset = { x = "y"; };
  multiline_attrset = {
    a = 3;
    b = 5;
  };
  # some comment over here
  fn = x: x + x;
  relpath = ./hello;
  abspath = /hello;
  # URLs get converted from strings
  url = "https://foobar.com";
  atoms = [ true false null ];
  # Combined
  listOfAttrs = [
    {
      attr1 = 3;
      attr2 = "fff";
    }
    {
      attr1 = 5;
      attr2 = "ggg";
    }
  ];

  # long expression
  attrs = {
    attr1 = short_expr;
    attr2 =
      if true then big_expr else big_expr;
  };
}
;
in
[ sample-01 sample-02 sample-03 ]

After

let
  # * What you're seeing here is our nix formatter. It's quite opinionated:
  sample-01 =
    { lib }:
    {
      list =
        [
          elem1
          elem2
          elem3
        ]
        ++ lib.optionals stdenv.isDarwin [
          elem4
          elem5
        ]; # and not quite finished
    }; # it will preserve your newlines

  sample-02 =
    { stdenv, lib }:
    {
      list =
        [
          elem1
          elem2
          elem3
        ]
        ++ lib.optionals stdenv.isDarwin [
          elem4
          elem5
        ]
        ++ lib.optionals stdenv.isLinux [ elem6 ];
    };
  # but it can handle all nix syntax,
  # and, in fact, all of nixpkgs in <20s.
  # The javascript build is quite a bit slower.
  sample-03 =
    { stdenv, system }:
    assert system == "i686-linux";
    stdenv.mkDerivation { };
  # these samples are all from https://github.com/nix-community/nix-fmt/tree/master/samples
  sample-simple = # Some basic formatting
    {
      empty_list = [ ];
      inline_list = [
        1
        2
        3
      ];
      multiline_list = [
        1
        2
        3
        4
      ];
      inline_attrset = {
        x = "y";
      };
      multiline_attrset = {
        a = 3;
        b = 5;
      };
      # some comment over here
      fn = x: x + x;
      relpath = ./hello;
      abspath = /hello;
      # URLs get converted from strings
      url = "https://foobar.com";
      atoms = [
        true
        false
        null
      ];
      # Combined
      listOfAttrs = [
        {
          attr1 = 3;
          attr2 = "fff";
        }
        {
          attr1 = 5;
          attr2 = "ggg";
        }
      ];

      # long expression
      attrs = {
        attr1 = short_expr;
        attr2 = if true then big_expr else big_expr;
      };
    };
in
[
  sample-01
  sample-02
  sample-03
]

See all available images

nixpkgs-fmt

Restyles Nix, must be explicitly enabled.

Documentation

https://github.com/nix-community/nixpkgs-fmt#readme

Configuration

restylers:
- nixpkgs-fmt:
    arguments: []
    command:
    - nixpkgs-fmt
    image: restyled/restyler-nixpkgs-fmt:v1.3.0
    include:
    - '**/*.nix'
    interpreters: []

Examples

Before

{foo,bar}:
        foo+bar

After

{ foo, bar }:
foo + bar

See all available images

npm-groovy-lint

Restyles Groovy, runs automatically.

Documentation

https://github.com/nvuillam/npm-groovy-lint#readme

Configuration

restylers:
- npm-groovy-lint:
    arguments: []
    command:
    - npm-groovy-lint
    - --fix
    image: public.ecr.aws/restyled-io/restyler-npm-groovy-lint:v15.0.2
    include:
    - '**/*.groovy'
    interpreters: []

Examples

Before

def variable = 1;

pipeline {
    agent any
    options{ timestamps() }
    stages{ stage('') {
            steps {
                sh """
                """
            }
        }

        stage('Deploy')
        {
            steps {
                ansiColor('xterm') {
                    sh """
                    """
                }
            } } } }

After

def variable = 1

pipeline {
    agent any
    options { timestamps() }
    stages { stage('') {
            steps {
                sh '''
                '''
            }
    }

        stage('Deploy')
        {
            steps {
                ansiColor('xterm') {
                    sh '''
                    '''
                }
            } } } }

See all available images

ocamlformat

Restyles OCaml, runs automatically.

Documentation

https://github.com/ocaml-ppx/ocamlformat

Configuration

restylers:
- ocamlformat:
    arguments: []
    command:
    - ocamlformat
    - --inplace
    image: restyled/restyler-ocamlformat:v0.26.2
    include:
    - '**/*.ml'
    interpreters: []

Examples

Before

let sum_of_squares num =
  num + 1
  |> List.range 0 |> List.map ~f:square
  |> List.fold_left ~init:0 ~f:( + )

After

let sum_of_squares num =
  num + 1 |> List.range 0 |> List.map ~f:square
  |> List.fold_left ~init:0 ~f:( + )

See all available images

ormolu

Restyles Haskell, must be explicitly enabled.

Documentation

https://github.com/tweag/ormolu#readme

Configuration

restylers:
- ormolu:
    arguments: []
    command:
    - ormolu
    - --mode
    - inplace
    image: public.ecr.aws/restyled-io/restyler-ormolu:v0.5.3.0
    include:
    - '**/*.hs'
    interpreters: []

Examples

Before

foo
 :: MonadIO m
 -> Text -> Text
 -> SqlPersistT m ()
 foo = undefined

After

foo ::
  MonadIO m ->
  Text ->
  Text ->
  SqlPersistT
    m
    ()
    foo = undefined

See all available images

perltidy

Restyles Perl, runs automatically.

Documentation

https://perltidy.sourceforge.net/

Configuration

restylers:
- perltidy:
    arguments: []
    command:
    - perltidy
    - -st
    image: restyled/restyler-perltidy:v20230701
    include:
    - '**/*.pl'
    - '**/*.pm'
    interpreters: []

Examples

Before

my $lines  = 0; # checksum: #lines
my $bytes  = 0; # checksum: #bytes
my $sum  = 0; # checksum: system V sum
my $patchdata = 0; # saw patch data
my $pos  = 0; # start of patch data
my $endkit = 0; # saw end of kit
my $fail  = 0; # failed

After

my $lines     = 0;    # checksum: #lines
my $bytes     = 0;    # checksum: #bytes
my $sum       = 0;    # checksum: system V sum
my $patchdata = 0;    # saw patch data
my $pos       = 0;    # start of patch data
my $endkit    = 0;    # saw end of kit
my $fail      = 0;    # failed

Before

$_= <<'EOL';
   $url = new URI::URL "http://www/";   die if $url eq "xXx";
EOL
LOOP:{print(" digits"),redo LOOP if/\G\d+\b[,.;]?\s*/gc;print(" lowercase"),
redo LOOP if/\G[a-z]+\b[,.;]?\s*/gc;print(" UPPERCASE"),redo LOOP 
if/\G[A-Z]+\b[,.;]?\s*/gc;print(" Capitalized"),
redo LOOP if/\G[A-Z][a-z]+\b[,.;]?\s*/gc;
print(" MiXeD"),redo LOOP if/\G[A-Za-z]+\b[,.;]?\s*/gc;print(
" alphanumeric"),redo LOOP if/\G[A-Za-z0-9]+\b[,.;]?\s*/gc;print(" line-noise"
),redo LOOP if/\G[^A-Za-z0-9]+/gc;print". That's all!\n";}

After

$_ = <<'EOL';
   $url = new URI::URL "http://www/";   die if $url eq "xXx";
EOL
LOOP: {
    print(" digits"),    redo LOOP if /\G\d+\b[,.;]?\s*/gc;
    print(" lowercase"), redo LOOP if /\G[a-z]+\b[,.;]?\s*/gc;
    print(" UPPERCASE"), redo LOOP
      if /\G[A-Z]+\b[,.;]?\s*/gc;
    print(" Capitalized"),  redo LOOP if /\G[A-Z][a-z]+\b[,.;]?\s*/gc;
    print(" MiXeD"),        redo LOOP if /\G[A-Za-z]+\b[,.;]?\s*/gc;
    print(" alphanumeric"), redo LOOP if /\G[A-Za-z0-9]+\b[,.;]?\s*/gc;
    print(" line-noise"),   redo LOOP if /\G[^A-Za-z0-9]+/gc;
    print ". That's all!\n";
}

Before

%unitscale=("in",72,"pt",72.27/72,"pc",12,"mm",72/25.4,"cm",72/2.54,
"\\hsize",100,"\\vsize",100,"\\textwidth",100,"\\textheight",100,
"\\pagewidth",100,"\\linewidth",100);

After

%unitscale = (
    "in",           72,        "pt",          72.27 / 72,
    "pc",           12,        "mm",          72 / 25.4,
    "cm",           72 / 2.54, "\\hsize",     100,
    "\\vsize",      100,       "\\textwidth", 100,
    "\\textheight", 100,       "\\pagewidth", 100,
    "\\linewidth",  100
);

Before

my $a_box = [ [ $a11, $a12, $a13, $a14, $a15, $a16 ], 
[ $a21, $a22, $a23, $a24, $a25, $a26 ], [ $a31, $a32, $a33, $a34, $a35, $a36 ],
[ $a41, $a42, $a43, $a44, $a45, $a46 ], [ $a51, $a52, $a53, $a54, $a55, $a56 ],
	[ $a61, $a62, $a63, $a64, $a65, $a66 ], ];

After

my $a_box = [
    [ $a11, $a12, $a13, $a14, $a15, $a16 ],
    [ $a21, $a22, $a23, $a24, $a25, $a26 ],
    [ $a31, $a32, $a33, $a34, $a35, $a36 ],
    [ $a41, $a42, $a43, $a44, $a45, $a46 ],
    [ $a51, $a52, $a53, $a54, $a55, $a56 ],
    [ $a61, $a62, $a63, $a64, $a65, $a66 ],
];

Before

%TV=(flintstones=>{series=>"flintstones",nights=>[qw(monday thursday friday)],
members=>[{name=>"fred",role=>"lead",age=>36,},{name=>"wilma",role=>"wife",
age=>31,},{name=>"pebbles",role=>"kid",age=>4,},],},jetsons=>{series=>"jetsons",
nights=>[qw(wednesday saturday)],members=>[{name=>"george",role=>"lead",age=>41,
},{name=>"jane",role=>"wife",age=>39,},{name=>"elroy",role=>"kid",age=>9,},],},
simpsons=>{series=>"simpsons",nights=>[qw(monday)],members=>[{name=>"homer",
role=>"lead",age=>34,},{name=>"marge",role=>"wife",age=>37,},{name=>"bart",
role=>"kid",age=>11,},],},);

After

%TV = (
    flintstones => {
        series  => "flintstones",
        nights  => [qw(monday thursday friday)],
        members => [
            { name => "fred", role => "lead", age => 36, },
            {
                name => "wilma",
                role => "wife",
                age  => 31,
            },
            { name => "pebbles", role => "kid", age => 4, },
        ],
    },
    jetsons => {
        series  => "jetsons",
        nights  => [qw(wednesday saturday)],
        members => [
            {
                name => "george",
                role => "lead",
                age  => 41,
            },
            { name => "jane",  role => "wife", age => 39, },
            { name => "elroy", role => "kid",  age => 9, },
        ],
    },
    simpsons => {
        series  => "simpsons",
        nights  => [qw(monday)],
        members => [
            {
                name => "homer",
                role => "lead",
                age  => 34,
            },
            { name => "marge", role => "wife", age => 37, },
            {
                name => "bart",
                role => "kid",
                age  => 11,
            },
        ],
    },
);

Before

{
  L9140:
 if ($msccom::obj==$msccom::food) {
 goto L8142;
 }
 if ($msccom::obj==$msccom::bird||$msccom::obj==$msccom::snake||$msccom::obj==$msccom::clam||$msccom::obj==$msccom::oyster||$msccom::obj==$msccom::dwarf||$msccom::obj==$msccom::dragon||$msccom::obj==$msccom::troll||$msccom::obj==$msccom::bear) {
 $msccom::spk=71;
 }
 goto L2011;
 # 
  #  DRINK.  IF NO OBJECT, ASSUME WATER AND LOOK FOR IT HERE.  IF WATER IS 
  #  THE BOTTLE, DRINK THAT, ELSE MUST BE AT A WATER LOC, SO DRINK STREAM. 
  # 
  L9150:
 if ($msccom::obj==0&&$liqloc->($placom::loc)!=$msccom::water&&($liq->(0)!=$msccom::water||!$here->($msccom::bottle))) {
 goto L8000;
 }
 if ($msccom::obj!=0&&$msccom::obj!=$msccom::water) {
 $msccom::spk=110;
 }
 if ($msccom::spk==110||$liq->(0)!=$msccom::water||!$here->($msccom::bottle)) {
 goto L2011;
 }
 $placom::prop->($msccom::bottle)=1;
 $placom::place->($msccom::water)=0;
 $msccom::spk=74;
 goto L2011;
 # 
  #  RUB.  YIELDS VARIOUS SNIDE REMARKS. 
  # 
  L9160:
 if ($msccom::obj!=$placom::lamp) {
 $msccom::spk=76;
 }
 goto L2011;
 # 
  #  THROW.  SAME AS DISCARD UNLESS AXE.  THEN SAME AS ATTACK EXCEPT IGNOR 
  #  AND IF DWARF IS PRESENT THEN ONE MIGHT BE KILLED.  (ONLY WAY TO DO SO 
  #  AXE ALSO SPECIAL FOR DRAGON, BEAR, AND TROLL.  TREASURES SPECIAL FOR 
  # 
  L9170:
 if ($toting->($msccom::rod2)&&$msccom::obj==$msccom::rod&&!$toting->($msccom::rod)) {
 $msccom::obj=$msccom::rod2;
 }
 }

After

{
  L9140:
    if ( $msccom::obj == $msccom::food ) {
        goto L8142;
    }
    if (   $msccom::obj == $msccom::bird
        || $msccom::obj == $msccom::snake
        || $msccom::obj == $msccom::clam
        || $msccom::obj == $msccom::oyster
        || $msccom::obj == $msccom::dwarf
        || $msccom::obj == $msccom::dragon
        || $msccom::obj == $msccom::troll
        || $msccom::obj == $msccom::bear )
    {
        $msccom::spk = 71;
    }
    goto L2011;
    #
    #  DRINK.  IF NO OBJECT, ASSUME WATER AND LOOK FOR IT HERE.  IF WATER IS
    #  THE BOTTLE, DRINK THAT, ELSE MUST BE AT A WATER LOC, SO DRINK STREAM.
    #
  L9150:
    if (   $msccom::obj == 0
        && $liqloc->($placom::loc) != $msccom::water
        && ( $liq->(0) != $msccom::water || !$here->($msccom::bottle) ) )
    {
        goto L8000;
    }
    if ( $msccom::obj != 0 && $msccom::obj != $msccom::water ) {
        $msccom::spk = 110;
    }
    if (   $msccom::spk == 110
        || $liq->(0) != $msccom::water
        || !$here->($msccom::bottle) )
    {
        goto L2011;
    }
    $placom::prop->($msccom::bottle) = 1;
    $placom::place->($msccom::water) = 0;
    $msccom::spk                     = 74;
    goto L2011;
    #
    #  RUB.  YIELDS VARIOUS SNIDE REMARKS.
    #
  L9160:
    if ( $msccom::obj != $placom::lamp ) {
        $msccom::spk = 76;
    }
    goto L2011;
    #
    #  THROW.  SAME AS DISCARD UNLESS AXE.  THEN SAME AS ATTACK EXCEPT IGNOR
    #  AND IF DWARF IS PRESENT THEN ONE MIGHT BE KILLED.  (ONLY WAY TO DO SO
    #  AXE ALSO SPECIAL FOR DRAGON, BEAR, AND TROLL.  TREASURES SPECIAL FOR
    #
  L9170:
    if (   $toting->($msccom::rod2)
        && $msccom::obj == $msccom::rod
        && !$toting->($msccom::rod) )
    {
        $msccom::obj = $msccom::rod2;
    }
}

See all available images

pg_format

Restyles PSQL, runs automatically.

Documentation

https://github.com/darold/pgFormatter#readme

Configuration

restylers:
- pg_format:
    arguments: []
    command:
    - pg_format
    - --inplace
    image: public.ecr.aws/restyled-io/restyler-pg_format:v5.3
    include:
    - '**/*.sql'
    interpreters: []

Examples

Before

SELECT * from
students
WHERE students.age > 10;

After

SELECT
    *
FROM
    students
WHERE
    students.age > 10;

See all available images

php-cs-fixer

Restyles PHP, runs automatically.

Documentation

https://github.com/FriendsOfPHP/PHP-CS-Fixer

Configuration

restylers:
- php-cs-fixer:
    arguments: []
    command:
    - php-cs-fixer
    - fix
    image: public.ecr.aws/restyled-io/restyler-php-cs-fixer:v3.67.1
    include:
    - '**/*.php'
    interpreters: []

Examples

Before

<?PHP
$this->foo();

After

<?php

$this->foo();

See all available images

prettier

Restyles JavaScript, runs automatically.

Documentation

https://github.com/restyled-io/restyler/wiki/Errors#prettier
https://prettier.io/docs/en/

Configuration

restylers:
- prettier:
    arguments: []
    command:
    - prettier
    - --write
    image: public.ecr.aws/restyled-io/restyler-prettier:v3.4.2-3
    include:
    - '**/*.js'
    - '**/*.jsx'
    interpreters: []

Examples

Before

matrix(
  1, 0, 0,
  0, 1, 0,
  0, 0, 1
)

After

matrix(1, 0, 0, 0, 1, 0, 0, 0, 1);

Before

matrix(
  1, 0, 0,
  0, 1, 0,
  0, 0, 1
)

After

matrix(1, 0, 0, 0, 1, 0, 0, 0, 1);

Before

import c from 'moduleC';
import a from 'moduleA';
import b from 'moduleB';

After

import a from "moduleA";
import b from "moduleB";
import c from "moduleC";

See all available images

prettier-json

Restyles JSON, runs automatically.

Documentation

https://prettier.io/docs/en/options.html#parser

Configuration

restylers:
- prettier-json:
    arguments: []
    command:
    - prettier
    - --write
    image: public.ecr.aws/restyled-io/restyler-prettier:v3.4.2-3
    include:
    - '**/*.json'
    interpreters: []

Examples

Before

{
   "foo": "bar"
   , "baz":
 "bat" }

After

{
  "foo": "bar",
  "baz": "bat"
}

See all available images

prettier-markdown

Restyles Markdown, runs automatically.

Documentation

https://prettier.io/blog/2017/11/07/1.8.0.html
https://prettier.io/docs/en/index.html

Configuration

restylers:
- prettier-markdown:
    arguments: []
    command:
    - prettier
    - --write
    image: public.ecr.aws/restyled-io/restyler-prettier:v3.4.2-3
    include:
    - '**/*.md'
    - '**/*.markdown'
    interpreters: []

Examples

Before

Voilà! In view, a humble vaudevillian veteran cast vicariously as both victim and villain by the vicissitudes of Fate. This visage, no mere veneer of vanity, is a vestige of the vox populi, now vacant, vanished. However, this valourous visitation of a bygone vexation stands vivified and has vowed to vanquish these venal and virulent vermin vanguarding vice and vouchsafing the violently vicious and voracious violation of volition! The only verdict is vengeance; a vendetta held as a votive, not in vain, for the value and veracity of such shall one day vindicate the vigilant and the virtuous. Verily, this vichyssoise of verbiage veers most verbose, so let me simply add that it's my very good honour to meet you and you may call me V.

After

Voilà! In view, a humble vaudevillian veteran cast vicariously as both victim
and villain by the vicissitudes of Fate. This visage, no mere veneer of vanity,
is a vestige of the vox populi, now vacant, vanished. However, this valourous
visitation of a bygone vexation stands vivified and has vowed to vanquish these
venal and virulent vermin vanguarding vice and vouchsafing the violently vicious
and voracious violation of volition! The only verdict is vengeance; a vendetta
held as a votive, not in vain, for the value and veracity of such shall one day
vindicate the vigilant and the virtuous. Verily, this vichyssoise of verbiage
veers most verbose, so let me simply add that it's my very good honour to meet
you and you may call me V.

See all available images

prettier-yaml

Restyles Yaml, runs automatically.

Documentation

https://prettier.io/docs/en/
https://prettier.io/blog/2018/07/29/1.14.0.html

Configuration

restylers:
- prettier-yaml:
    arguments: []
    command:
    - prettier
    - --write
    image: public.ecr.aws/restyled-io/restyler-prettier:v3.4.2-3
    include:
    - '**/*.yml'
    - '**/*.yaml'
    interpreters: []

Examples

Before

foo: bar
baz:   bat

After

foo: bar
baz: bat

See all available images

prettier-ruby

Restyles Ruby, must be explicitly enabled.

Documentation

https://prettier.io/docs/en/
https://github.com/prettier/plugin-ruby

Configuration

restylers:
- prettier-ruby:
    arguments: []
    command:
    - rbprettier
    - --write
    image: restyled/restyler-prettier-ruby:v3.2.2-1
    include:
    - '**/*.rb'
    interpreters:
    - ruby

Examples

Before

       d=[30644250780,9003106878,
   30636278846,66641217692,4501790980,
671_24_603036,131_61973916,66_606629_920,
  30642677916,30643069058];a,s=[],$*[0]
     s.each_byte{|b|a<<("%036b"%d[b.
        chr.to_i]).scan(/\d{6}/)}
         a.transpose.each{ |a|
           a.join.each_byte{\
            |i|print i==49?\
              ($*[1]||"#")\
                :32.chr}
                  puts
                   }

After

d = [
  30_644_250_780,
  9_003_106_878,
  30_636_278_846,
  66_641_217_692,
  4_501_790_980,
  671_24_603036,
  131_61973916,
  66_606629_920,
  30_642_677_916,
  30_643_069_058
]
a, s = [], $*[0]
s.each_byte { |b| a << ("%036b" % d[b.chr.to_i]).scan(/\d{6}/) }
a.transpose.each do |a|
  a.join.each_byte { |i| print i == 49 ? ($*[1] || "#") : 32.chr }
  puts
end

See all available images

purty

Restyles PureScript, runs automatically.

Documentation

https://github.com/joneshf/purty#readme

Configuration

restylers:
- purty:
    arguments: []
    command:
    - purty
    - --write
    image: public.ecr.aws/restyled-io/restyler-purty:v7.0.0
    include:
    - '**/*.purs'
    interpreters: []

Examples

Before

module Ado where

foo = ado
  let w = 0
  x <- pure 1
  y <- do
    pure 2
    pure 2
  z <- do pure 3
  in w + x + y + z

bar = ado in 12

After

module Ado where

foo = ado
  let
    w = 0
  x <- pure 1
  y <- do
    pure 2
    pure 2
  z <- do pure 3
  in w + x + y + z

bar = ado in 12

See all available images

pyment

Restyles Python, runs automatically.

Documentation

https://github.com/dadadel/pyment

Configuration

restylers:
- pyment:
    arguments: []
    command:
    - pyment
    - -w
    image: restyled/restyler-pyment:v0.3.3
    include:
    - '**/*.py'
    interpreters:
    - python

Examples

Before

def func(param1=True, param2: str = 'default val'):
  '''Description of func with docstring groups style.

  Params:
      param1 - descr of param1 that has True for default value.
      param2 - descr of param2

  Returns:
      some value

  Raises:
      keyError: raises key exception
      TypeError: raises type exception

  '''
  pass

class A:
    def method(self, param1, param2=None) -> int:
        pass

After

def func(param1=True, param2: str = 'default val'):
    """Description of func with docstring groups style.

    :param param1: descr of param1 that has True for default value
    :param param2: descr of param2
    :param param2: str:  (Default value = 'default val')
    :returns: some value
    :raises keyError: raises key exception
    :raises TypeError: raises type exception

    """
  pass

class A:
    """ """
    def method(self, param1, param2=None) -> int:
        """

        :param param1: 
        :param param2:  (Default value = None)

        """
        pass

Before

def func(param1=True, param2: str = 'default val'):
  '''Description of func with docstring groups style.

  Params:
      param1 - descr of param1 that has True for default value.
      param2 - descr of param2

  Returns:
      some value

  Raises:
      keyError: raises key exception
      TypeError: raises type exception

  '''
  pass

class A:
    def method(self, param1, param2=None) -> int:
        pass

After

def func(param1=True, param2: str = 'default val'):
    """Description of func with docstring groups style.

    :param param1: descr of param1 that has True for default value
    :param param2: descr of param2
    :param param2: str:  (Default value = 'default val')
    :returns: some value
    :raises keyError: raises key exception
    :raises TypeError: raises type exception

    """
  pass

class A:
    """ """
    def method(self, param1, param2=None) -> int:
        """

        :param param1: 
        :param param2:  (Default value = None)

        """
        pass

See all available images

refmt

Restyles Reason, runs automatically.

Documentation

https://github.com/reasonml/reason-cli#reason-cli

Configuration

restylers:
- refmt:
    arguments: []
    command:
    - refmt
    - --in-place
    image: public.ecr.aws/restyled-io/restyler-refmt:v3.3.3
    include:
    - '**/*.re'
    interpreters: []

Examples

Before

type schoolPerson = Teacher
        | Director | Student(string);

let greeting = person =>
  switch (person){
      | Teacher => "Hey Professor!"
      | Director => "Hello Director."
      | Student("Richard") => "Still here Ricky?"
      | Student(anyOtherName) => "Hey, " ++ anyOtherName
          ++ "."
  };

After

type schoolPerson =
  | Teacher
  | Director
  | Student(string);

let greeting = person =>
  switch (person) {
  | Teacher => "Hey Professor!"
  | Director => "Hello Director."
  | Student("Richard") => "Still here Ricky?"
  | Student(anyOtherName) => "Hey, " ++ anyOtherName ++ "."
  };

See all available images

reorder-python-imports

Restyles Python, runs automatically.

Documentation

https://github.com/asottile/reorder_python_imports

Configuration

restylers:
- reorder-python-imports:
    arguments: []
    command:
    - reorder-python-imports
    - --exit-zero-even-if-changed
    image: restyled/restyler-reorder-python-imports:v3.14.0
    include:
    - '**/*.py'
    interpreters:
    - python

Examples

Before

import os, sys
from argparse import ArgumentParser

from foo import bar
from baz import womp

from crazy import example1

After

import os
import sys
from argparse import ArgumentParser

from baz import womp
from crazy import example1
from foo import bar

See all available images

rubocop

Restyles Ruby, must be explicitly enabled.

Documentation

https://rubocop.readthedocs.io/en/latest/

Configuration

restylers:
- rubocop:
    arguments: []
    command:
    - rubocop
    - --auto-correct
    - --fail-level
    - fatal
    image: public.ecr.aws/restyled-io/restyler-rubocop:v1.70.0
    include:
    - '**/*.rb'
    interpreters:
    - ruby

Examples

Before

def some_method
    do_something
end

After

def some_method
  do_something
end

Before

case foo
when *[1, 2, 3, 4]
  bar
when 5
  baz
end

After

case foo
when 1, 2, 3, 4
  bar
when 5
  baz
end

Before

class User < ApplicationRecord
  MissingAdminAccount = Class.new(RuntimeError)

  include Wisper::Publisher

  # Include default devise modules. Others available are:
  # :confirmable, :lockable, :timeoutable and :omniauthable
  devise :database_authenticatable, :registerable, :confirmable,
         :recoverable, :rememberable, :trackable, :validatable
  has_many :radars, foreign_key: "owner_id", dependent: :destroy
  has_many :created_topics, foreign_key: "creator_id", class_name: "Topic", dependent: :nullify
  has_many :blips, through: :radars

  attr_accessor :login

  validates :name, presence: true
  validates :username,
            presence: true,
            uniqueness: {
              case_sensitive: false
            }

  # For Devise
  def self.find_for_database_authentication(warden_conditions)
    conditions = warden_conditions.dup
    if (login = conditions.delete(:login))
      where(conditions).find_by(["lower(username) = :value OR lower(email) = :value", { value: login.downcase }])
    else
      # :nocov:
      find_by(conditions)
      # :nocov:
    end
  end

  # Override Devise to use ActiveJob
  # https://github.com/plataformatec/devise#activejob-integration
  def send_devise_notification(notification, *args)
    devise_mailer.send(notification, self, *args).deliver_later
  end

  def find_radar(uuid:)
    radars.find_by!(uuid: uuid)
  end

  def new_radar(params)
    radars.new(params)
  end

  def add_radar(params)
    new_radar(params).tap(&:save!)
  end

  def first_sign_in?
    sign_in_count == 1
  end

  after_create do |user|
    publish(:user_created, user)
  end

  def self.admin
    admin = find_by(admin: true)
    admin || raise(MissingAdminAccount)
  end
end

After

class User < ApplicationRecord
  MissingAdminAccount = Class.new(RuntimeError)

  include Wisper::Publisher

  # Include default devise modules. Others available are:
  # :confirmable, :lockable, :timeoutable and :omniauthable
  devise :database_authenticatable, :registerable, :confirmable,
         :recoverable, :rememberable, :trackable, :validatable
  has_many :radars, foreign_key: 'owner_id', dependent: :destroy
  has_many :created_topics, foreign_key: 'creator_id', class_name: 'Topic', dependent: :nullify
  has_many :blips, through: :radars

  attr_accessor :login

  validates :name, presence: true
  validates :username,
            presence: true,
            uniqueness: {
              case_sensitive: false
            }

  # For Devise
  def self.find_for_database_authentication(warden_conditions)
    conditions = warden_conditions.dup
    if (login = conditions.delete(:login))
      where(conditions).find_by(['lower(username) = :value OR lower(email) = :value', { value: login.downcase }])
    else
      # :nocov:
      find_by(conditions)
      # :nocov:
    end
  end

  # Override Devise to use ActiveJob
  # https://github.com/plataformatec/devise#activejob-integration
  def send_devise_notification(notification, *args)
    devise_mailer.send(notification, self, *args).deliver_later
  end

  def find_radar(uuid:)
    radars.find_by!(uuid: uuid)
  end

  def new_radar(params)
    radars.new(params)
  end

  def add_radar(params)
    new_radar(params).tap(&:save!)
  end

  def first_sign_in?
    sign_in_count == 1
  end

  after_create do |user|
    publish(:user_created, user)
  end

  def self.admin
    admin = find_by(admin: true)
    admin || raise(MissingAdminAccount)
  end
end

See all available images

rustfmt

Restyles Rust, runs automatically.

Documentation

https://github.com/rust-lang-nursery/rustfmt#readme
https://github.com/restyled-io/restyler/wiki/Errors#prettier

Configuration

restylers:
- rustfmt:
    arguments: []
    command:
    - rustfmt
    image: restyled/restyler-rustfmt:v1.7.1-stable
    include:
    - '**/*.rs'
    interpreters: []

Examples

Before

// Attributes should be on their own lines
struct CRepr {
    x: f32,y: f32,
}

After

// Attributes should be on their own lines
struct CRepr {
    x: f32,
    y: f32,
}

See all available images

scalafmt

Restyles Scala, must be explicitly enabled.

Documentation

https://scalameta.org/scalafmt/
https://github.com/restyled-io/restyler/wiki/Errors#scalafmt

Configuration

restylers:
- scalafmt:
    arguments: []
    command:
    - scalafmt
    - --non-interactive
    image: restyled/restyler-scalafmt:v3.7.10
    include:
    - '**/*.scala'
    interpreters: []

Examples

Before

object a {
  def c(b: List[Int]): List[Int] =
    for {
      a <- b
      if ((a))
    } yield a
}

After

object a {
  def c(b: List[Int]): List[Int] =
    for {
      a <- b
      if a
    } yield a
}

See all available images

shellcheck

Restyles POSIX sh, Bash, runs automatically.

Documentation

https://github.com/koalaman/shellcheck/wiki

Configuration

restylers:
- shellcheck:
    arguments: []
    command:
    - shellcheck-fix
    image: restyled/restyler-shellcheck:v0.9.0
    include:
    - '**/*.sh'
    - '**/*.bash'
    interpreters:
    - sh
    - bash

Examples

Before

echo $foo

After

echo "$foo"

Before

## Example of a broken script.
for f in $(ls *.m3u)
do
  grep -qi hq.*mp3 $f \
    && echo -e 'Playlist $f contains a HQ file in mp3 format'
done

After

## Example of a broken script.
for f in $(ls *.m3u)
do
  grep -qi hq.*mp3 "$f" \
    && echo -e 'Playlist $f contains a HQ file in mp3 format'
done

Before

if (( $n > 1 )); then
  echo yeah
fi

After

if (( $n > 1 )); then
  echo yeah
fi

Before

echo "$foo"

After

echo "$foo"

See all available images

shellharden

Restyles POSIX sh, Bash, runs automatically.

Documentation

https://github.com/anordal/shellharden#readme

Configuration

restylers:
- shellharden:
    arguments: []
    command:
    - shellharden
    - --replace
    image: restyled/restyler-shellharden:v4.1.1-3
    include:
    - '**/*.sh'
    - '**/*.bash'
    interpreters:
    - sh
    - bash

Examples

Before

#!/bin/sh
x=x
var=`echo $x`

After

#!/bin/sh
x=x
var=`echo "$x"`

See all available images

shfmt

Restyles POSIX sh, Bash, runs automatically.

Documentation

https://github.com/mvdan/sh#shfmt

Configuration

restylers:
- shfmt:
    arguments:
    - -i
    - '2'
    - -ci
    command:
    - shfmt
    - -w
    image: public.ecr.aws/restyled-io/restyler-shfmt:v3.4.3
    include:
    - '**/*.sh'
    - '**/*.bash'
    interpreters:
    - sh
    - bash

Examples

Before

#!/bin/sh
if [ 2 -eq 2 ]
    then
        echo "yup"
    fi

After

#!/bin/sh
if [ 2 -eq 2 ]; then
  echo "yup"
fi

See all available images

sqlformat

Restyles SQL, PSQL, must be explicitly enabled.

Documentation

https://github.com/andialbrecht/sqlparse#readme

Configuration

restylers:
- sqlformat:
    arguments: []
    command:
    - sqlformat
    - --reindent
    - --keywords=upper
    image: public.ecr.aws/restyled-io/restyler-sqlformat:0.5.3
    include:
    - '**/*.sql'
    interpreters: []

Examples

Before

-- hi there
select * from students WHERE students.age > 10;

After

-- hi there

SELECT *
FROM students
WHERE students.age > 10;

Before

INSERT
  INTO x VALUES ()

After

INSERT INTO x
VALUES ()

See all available images

standardrb

Restyles Ruby, runs automatically.

Documentation

https://github.com/testdouble/standard

Configuration

restylers:
- standardrb:
    arguments: []
    command:
    - standardrb
    - --fix
    image: public.ecr.aws/restyled-io/restyler-standardrb:v1.43.0
    include:
    - '**/*.rb'
    interpreters:
    - ruby

Examples

Before

def some_method
    do_something
end

After

def some_method
  do_something
end

See all available images

stylish-haskell

Restyles Haskell, runs automatically.

Documentation

https://github.com/jaspervdj/stylish-haskell
https://github.com/restyled-io/restyler/wiki/Errors#stylish-haskell

Configuration

restylers:
- stylish-haskell:
    arguments: []
    command:
    - stylish-haskell
    - --inplace
    image: public.ecr.aws/restyled-io/restyler-stylish-haskell:v0.14.3.0
    include:
    - '**/*.hs'
    interpreters: []

Examples

Before

{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}

After

{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards   #-}

Before

{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE GADTs #-}
{-# LANGUAGE GeneralizedNewtypeDeriving #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}

module Restyler.App
    (
    -- * Application environment
      App(..)
    , AppT
    , runAppT

    -- * Application errors
    , AppError(..)
    , mapAppError
    )
where

import Restyler.Prelude

import Conduit (runResourceT, sinkFile)
import qualified Data.Text as T
import qualified Data.Text.IO as T
import qualified Data.Vector as V
import GitHub.Endpoints.Issues.Comments
import GitHub.Endpoints.PullRequests
import GitHub.Endpoints.Repos.Statuses
import GitHub.Request
import Network.HTTP.Client.TLS
import Network.HTTP.Simple hiding (Request)
import Restyler.Capabilities.Docker
import Restyler.Capabilities.Git
import Restyler.Capabilities.GitHub
import Restyler.Capabilities.RemoteFile
import Restyler.Capabilities.System
import Restyler.Model.Config
import Restyler.Model.RemoteFile
import qualified System.Directory as Directory
import qualified System.Exit as Exit
import System.Process

-- | Application environment
data App = App
    { appLogLevel :: LogLevel
    , appLogColor :: Bool
    , appAccessToken :: Text
    , appPullRequest :: PullRequest
    -- ^ The @'PullRequest'@ we are restyling
    , appConfig :: Config
    -- ^ Configuration loaded from @.restyled.yaml@
    , appRestyledPullRequest :: Maybe SimplePullRequest
    -- ^ Existing restyled @'PullRequest'@ if it exists
    }

-- | All possible application error conditions
data AppError
    = PullRequestFetchError Error
    -- ^ We couldn't fetch the @'PullRequest'@ to restyle
    | PullRequestCloneError IOException
    -- ^ We couldn't clone or checkout the PR's branch
    | ConfigurationError String
    -- ^ We couldn't load a @.restyled.yaml@
    | DockerError IOException
    -- ^ Error running a @docker@ operation
    | GitError IOException
    -- ^ Error running a @git@ operation
    | GitHubError Error
    -- ^ We encountered a GitHub API error during restyling
    | SystemError IOException
    -- ^ Trouble reading a file or etc
    | RemoteFileError IOException
    -- ^ Trouble performing some HTTP request
    | OtherError IOException
    -- ^ A minor escape hatch for @'IOException'@s
    deriving Show

-- | Run a computation, and modify any thrown @'AppError'@s
mapAppError :: MonadError AppError m => (AppError -> AppError) -> m a -> m a
mapAppError f = (`catchError` throwError . f)

newtype AppT m a = AppT
    { runAppT :: ReaderT App (LoggingT (ExceptT AppError m)) a
    }
    deriving
        ( Functor
        , Applicative
        , Monad
        , MonadError AppError
        , MonadReader App
        , MonadLogger
        )

-- | Run an @'IO'@ computation and capture @'IOException'@s to the given type
appIO :: MonadIO m => (IOException -> AppError) -> IO a -> AppT m a
appIO err f = AppT $ do
    result <- liftIO $ tryIO f
    either (throwError . err) pure result

instance MonadIO m => MonadGit (AppT m) where
    cloneRepository url dir = do
        logDebugN $ "git clone " <> tshow [masked, dir]
        appIO GitError $ callProcess "git" ["clone", unpack url, dir]
      where
        masked = T.unpack $ scheme <> "://<creds>" <> T.dropWhile (/= '@') rest
        (scheme, rest) = T.breakOn "://" url

    checkoutBranch b branch = do
        logDebugN $ "git checkout " <> branch
        appIO GitError $ callProcess "git" $ ["checkout"] ++ [ "-b" | b ] ++ [unpack branch]

    changedPaths branch = do
        logDebugN $ "git diff --name-only " <> branch
        appIO GitError $ lines <$> readProcess "git" ["diff", "--name-only", unpack branch] ""

    commitAll msg = do
        logDebugN "git commit"
        appIO GitError $ callProcess "git" ["commit", "-am", unpack msg]

    fetchOrigin remoteRef localRef = do
        logDebugN $ "git fetch origin " <> remoteRef <> ":" <> localRef
        appIO GitError $ callProcess "git" ["fetch", "origin", unpack $ remoteRef <> ":" <> localRef]

    pushOrigin branch = do
        logDebugN $ "git push origin " <> branch
        appIO GitError $ callProcess "git" ["push", "origin", unpack branch]

    forcePushOrigin branch = do
        logDebugN $ "git push origin " <> branch
        appIO GitError $ callProcess "git" ["push", "--force-with-lease", "origin", unpack branch]

instance MonadIO m => MonadGitHub (AppT m) where
    getPullRequest owner name num = runGitHub $ pullRequestR owner name num

    findPullRequest owner name base head = do
        results <- runGitHub $ pullRequestsForR owner name
            (optionsBase base <> optionsHead head) FetchAll
        pure $ results V.!? 0

    createPullRequest owner name create =
        runGitHub $ createPullRequestR owner name create

    updatePullRequest owner name id' edit =
        runGitHub $ updatePullRequestR owner name id' edit

    getComments owner name id' = runGitHub $ commentsR owner name id' FetchAll

    createComment owner name id' body = runGitHub_ $ createCommentR
        owner
        name
        id'
        body

    deleteComment owner name id' = runGitHub_ $ deleteCommentR owner name id'

    createStatus owner name sha status = runGitHub_ $ createStatusR owner name sha status

instance MonadIO m => MonadSystem (AppT m) where
    getCurrentDirectory = do
        logDebugN "getCurrentDirectory"
        appIO SystemError Directory.getCurrentDirectory

    doesFileExist path = do
        logDebugN $ "doesFileExist: " <> tshow path
        appIO SystemError $ Directory.doesFileExist path

    setCurrentDirectory path = do
        logDebugN $ "setCurrentDirectory: " <> tshow path
        appIO SystemError $ Directory.setCurrentDirectory path

    readFile path = do
        logDebugN $ "readFile: " <> tshow path
        appIO SystemError $ T.readFile path

    exitSuccess = appIO SystemError Exit.exitSuccess

instance MonadIO m => MonadDocker (AppT m) where
    dockerRun args = do
        logDebugN $ "docker run " <> tshow args
        appIO DockerError $ callProcess "docker" $ "run" : args

instance MonadIO m => MonadRemoteFile (AppT m) where
    fetchRemoteFile RemoteFile{..} = do
        let url = getUrl rfUrl
        logInfoN $ "Fetching " <> tshow rfPath <> " from " <> tshow url
        appIO RemoteFileError $ do
            request <- parseRequest $ unpack url
            runResourceT $ httpSink request $ \_ -> sinkFile rfPath

-- | Run a GitHub @'Request'@
runGitHub :: MonadIO m => Request k a -> AppT m a
runGitHub req = do
    logDebugN $ "GitHub request: " <> showGitHubRequest req
    auth <- asks $ OAuth . encodeUtf8 . appAccessToken
    result <- appIO OtherError $ do
        mgr <- getGlobalManager
        executeRequestWithMgr mgr auth req

    either (throwError . GitHubError) pure result

-- | @'runGitHub'@ but discard the result
runGitHub_ :: MonadIO m => Request k a -> AppT m ()
runGitHub_ = void . runGitHub

-- | Show a GitHub @'Request'@, useful for debugging
-- brittany-disable-next-binding
showGitHubRequest :: Request k a -> Text
showGitHubRequest (SimpleQuery (Query ps qs)) = mconcat
    [ "[GET] "
    , "/" <> T.intercalate "/" ps
    , "?" <> T.intercalate "&" (queryParts qs)
    ]
showGitHubRequest (SimpleQuery (PagedQuery ps qs fc)) = mconcat
    [ "[GET] "
    , "/" <> T.intercalate "/" ps
    , "?" <> T.intercalate "&" (queryParts qs)
    , " (" <> tshow fc <> ")"
    ]
showGitHubRequest (SimpleQuery (Command m ps _body)) = mconcat
    [ "[" <> T.toUpper (tshow m) <> "] "
    , "/" <> T.intercalate "/" ps
    ]
showGitHubRequest (StatusQuery _ _) = "<status query>"
showGitHubRequest (HeaderQuery _ _) = "<header query>"
showGitHubRequest (RedirectQuery _) = "<redirect query>"

queryParts :: QueryString -> [Text]
queryParts = map $ \(k, mv) -> decodeUtf8 k <> "=" <> maybe "" decodeUtf8 mv

After

{-# LANGUAGE FlexibleContexts           #-}
{-# LANGUAGE FlexibleInstances          #-}
{-# LANGUAGE GADTs                      #-}
{-# LANGUAGE GeneralizedNewtypeDeriving #-}
{-# LANGUAGE OverloadedStrings          #-}
{-# LANGUAGE RecordWildCards            #-}

module Restyler.App
    (
    -- * Application environment
      App(..)
    , AppT
    , runAppT

    -- * Application errors
    , AppError(..)
    , mapAppError
    )
where

import           Restyler.Prelude

import           Conduit                          (runResourceT, sinkFile)
import qualified Data.Text                        as T
import qualified Data.Text.IO                     as T
import qualified Data.Vector                      as V
import           GitHub.Endpoints.Issues.Comments
import           GitHub.Endpoints.PullRequests
import           GitHub.Endpoints.Repos.Statuses
import           GitHub.Request
import           Network.HTTP.Client.TLS
import           Network.HTTP.Simple              hiding (Request)
import           Restyler.Capabilities.Docker
import           Restyler.Capabilities.Git
import           Restyler.Capabilities.GitHub
import           Restyler.Capabilities.RemoteFile
import           Restyler.Capabilities.System
import           Restyler.Model.Config
import           Restyler.Model.RemoteFile
import qualified System.Directory                 as Directory
import qualified System.Exit                      as Exit
import           System.Process

-- | Application environment
data App = App
    { appLogLevel            :: LogLevel
    , appLogColor            :: Bool
    , appAccessToken         :: Text
    , appPullRequest         :: PullRequest
    -- ^ The @'PullRequest'@ we are restyling
    , appConfig              :: Config
    -- ^ Configuration loaded from @.restyled.yaml@
    , appRestyledPullRequest :: Maybe SimplePullRequest
    -- ^ Existing restyled @'PullRequest'@ if it exists
    }

-- | All possible application error conditions
data AppError
    = PullRequestFetchError Error
    -- ^ We couldn't fetch the @'PullRequest'@ to restyle
    | PullRequestCloneError IOException
    -- ^ We couldn't clone or checkout the PR's branch
    | ConfigurationError String
    -- ^ We couldn't load a @.restyled.yaml@
    | DockerError IOException
    -- ^ Error running a @docker@ operation
    | GitError IOException
    -- ^ Error running a @git@ operation
    | GitHubError Error
    -- ^ We encountered a GitHub API error during restyling
    | SystemError IOException
    -- ^ Trouble reading a file or etc
    | RemoteFileError IOException
    -- ^ Trouble performing some HTTP request
    | OtherError IOException
    -- ^ A minor escape hatch for @'IOException'@s
    deriving Show

-- | Run a computation, and modify any thrown @'AppError'@s
mapAppError :: MonadError AppError m => (AppError -> AppError) -> m a -> m a
mapAppError f = (`catchError` throwError . f)

newtype AppT m a = AppT
    { runAppT :: ReaderT App (LoggingT (ExceptT AppError m)) a
    }
    deriving
        ( Functor
        , Applicative
        , Monad
        , MonadError AppError
        , MonadReader App
        , MonadLogger
        )

-- | Run an @'IO'@ computation and capture @'IOException'@s to the given type
appIO :: MonadIO m => (IOException -> AppError) -> IO a -> AppT m a
appIO err f = AppT $ do
    result <- liftIO $ tryIO f
    either (throwError . err) pure result

instance MonadIO m => MonadGit (AppT m) where
    cloneRepository url dir = do
        logDebugN $ "git clone " <> tshow [masked, dir]
        appIO GitError $ callProcess "git" ["clone", unpack url, dir]
      where
        masked = T.unpack $ scheme <> "://<creds>" <> T.dropWhile (/= '@') rest
        (scheme, rest) = T.breakOn "://" url

    checkoutBranch b branch = do
        logDebugN $ "git checkout " <> branch
        appIO GitError $ callProcess "git" $ ["checkout"] ++ [ "-b" | b ] ++ [unpack branch]

    changedPaths branch = do
        logDebugN $ "git diff --name-only " <> branch
        appIO GitError $ lines <$> readProcess "git" ["diff", "--name-only", unpack branch] ""

    commitAll msg = do
        logDebugN "git commit"
        appIO GitError $ callProcess "git" ["commit", "-am", unpack msg]

    fetchOrigin remoteRef localRef = do
        logDebugN $ "git fetch origin " <> remoteRef <> ":" <> localRef
        appIO GitError $ callProcess "git" ["fetch", "origin", unpack $ remoteRef <> ":" <> localRef]

    pushOrigin branch = do
        logDebugN $ "git push origin " <> branch
        appIO GitError $ callProcess "git" ["push", "origin", unpack branch]

    forcePushOrigin branch = do
        logDebugN $ "git push origin " <> branch
        appIO GitError $ callProcess "git" ["push", "--force-with-lease", "origin", unpack branch]

instance MonadIO m => MonadGitHub (AppT m) where
    getPullRequest owner name num = runGitHub $ pullRequestR owner name num

    findPullRequest owner name base head = do
        results <- runGitHub $ pullRequestsForR owner name
            (optionsBase base <> optionsHead head) FetchAll
        pure $ results V.!? 0

    createPullRequest owner name create =
        runGitHub $ createPullRequestR owner name create

    updatePullRequest owner name id' edit =
        runGitHub $ updatePullRequestR owner name id' edit

    getComments owner name id' = runGitHub $ commentsR owner name id' FetchAll

    createComment owner name id' body = runGitHub_ $ createCommentR
        owner
        name
        id'
        body

    deleteComment owner name id' = runGitHub_ $ deleteCommentR owner name id'

    createStatus owner name sha status = runGitHub_ $ createStatusR owner name sha status

instance MonadIO m => MonadSystem (AppT m) where
    getCurrentDirectory = do
        logDebugN "getCurrentDirectory"
        appIO SystemError Directory.getCurrentDirectory

    doesFileExist path = do
        logDebugN $ "doesFileExist: " <> tshow path
        appIO SystemError $ Directory.doesFileExist path

    setCurrentDirectory path = do
        logDebugN $ "setCurrentDirectory: " <> tshow path
        appIO SystemError $ Directory.setCurrentDirectory path

    readFile path = do
        logDebugN $ "readFile: " <> tshow path
        appIO SystemError $ T.readFile path

    exitSuccess = appIO SystemError Exit.exitSuccess

instance MonadIO m => MonadDocker (AppT m) where
    dockerRun args = do
        logDebugN $ "docker run " <> tshow args
        appIO DockerError $ callProcess "docker" $ "run" : args

instance MonadIO m => MonadRemoteFile (AppT m) where
    fetchRemoteFile RemoteFile{..} = do
        let url = getUrl rfUrl
        logInfoN $ "Fetching " <> tshow rfPath <> " from " <> tshow url
        appIO RemoteFileError $ do
            request <- parseRequest $ unpack url
            runResourceT $ httpSink request $ \_ -> sinkFile rfPath

-- | Run a GitHub @'Request'@
runGitHub :: MonadIO m => Request k a -> AppT m a
runGitHub req = do
    logDebugN $ "GitHub request: " <> showGitHubRequest req
    auth <- asks $ OAuth . encodeUtf8 . appAccessToken
    result <- appIO OtherError $ do
        mgr <- getGlobalManager
        executeRequestWithMgr mgr auth req

    either (throwError . GitHubError) pure result

-- | @'runGitHub'@ but discard the result
runGitHub_ :: MonadIO m => Request k a -> AppT m ()
runGitHub_ = void . runGitHub

-- | Show a GitHub @'Request'@, useful for debugging
-- brittany-disable-next-binding
showGitHubRequest :: Request k a -> Text
showGitHubRequest (SimpleQuery (Query ps qs)) = mconcat
    [ "[GET] "
    , "/" <> T.intercalate "/" ps
    , "?" <> T.intercalate "&" (queryParts qs)
    ]
showGitHubRequest (SimpleQuery (PagedQuery ps qs fc)) = mconcat
    [ "[GET] "
    , "/" <> T.intercalate "/" ps
    , "?" <> T.intercalate "&" (queryParts qs)
    , " (" <> tshow fc <> ")"
    ]
showGitHubRequest (SimpleQuery (Command m ps _body)) = mconcat
    [ "[" <> T.toUpper (tshow m) <> "] "
    , "/" <> T.intercalate "/" ps
    ]
showGitHubRequest (StatusQuery _ _) = "<status query>"
showGitHubRequest (HeaderQuery _ _) = "<header query>"
showGitHubRequest (RedirectQuery _) = "<redirect query>"

queryParts :: QueryString -> [Text]
queryParts = map $ \(k, mv) -> decodeUtf8 k <> "=" <> maybe "" decodeUtf8 mv

Before

module Foo where
import FrontRow.Renaissance.RenaissancePlatform
import FrontRow.Renaissance.RPID
import FrontRow.Renaissance.RPIdentifier

After

module Foo where
import           FrontRow.Renaissance.RenaissancePlatform
import           FrontRow.Renaissance.RPID
import           FrontRow.Renaissance.RPIdentifier

See all available images

taplo

Restyles TOML, runs automatically.

Documentation

https://taplo.tamasfe.dev/cli/usage/formatting.html

Configuration

restylers:
- taplo:
    arguments: []
    command:
    - taplo
    - fmt
    image: restyled/restyler-taplo:0.9.3
    include:
    - '**/*.toml'
    interpreters: []

Examples

Before

var   = true
list = [
  'hi',
    'there'
  , 'now'
 ]

After

var = true
list = ['hi', 'there', 'now']

Before

long_list = [ 'hi', 'there' , 'now' , 'now' , 'now' , 'now' , 'now'
  , 'now'
  , 'now'
  , 'now'
  , 'now'
  , 'now'
  , 'now'
  , 'now'
 ]

After

long_list = [
  'hi',
  'there',
  'now',
  'now',
  'now',
  'now',
  'now',
  'now',
  'now',
  'now',
  'now',
  'now',
  'now',
  'now',
]

See all available images

terraform

Restyles Terraform, runs automatically.

Documentation

https://www.terraform.io/docs/commands/fmt.html

Configuration

restylers:
- terraform:
    arguments: []
    command:
    - terraform
    - fmt
    image: public.ecr.aws/restyled-io/restyler-terraform:v0.12.24-2
    include:
    - '**/*.tf'
    interpreters: []

Examples

Before

locals = {
  short = 1
  this_is_longer = true
  this_is_really_longer_than_it_needs_to_be = "bazzle"
}

After

locals = {
  short                                     = 1
  this_is_longer                            = true
  this_is_really_longer_than_it_needs_to_be = "bazzle"
}

Before

variable "policy_definition_name" {
    description  = "Policy definition name must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and is limited between 2 and 60 characters in length."
    default    = "demoPolicy"
}

After

variable "policy_definition_name" {
  description = "Policy definition name must only contain lowercase letters, digits or dashes, cannot use dash as the first two or last one characters, cannot contain consecutive dashes, and is limited between 2 and 60 characters in length."
  default     = "demoPolicy"
}

See all available images

verible

Restyles System Verilog, runs automatically.

Documentation

https://google.github.io/verible/verilog_format.html

Configuration

restylers:
- verible:
    arguments: []
    command:
    - verible-verilog-format
    - --inplace
    image: restyled/restyler-verible:v0.0-1318-gf6b4485
    include:
    - '**/*.sv'
    interpreters: []

Examples

Before

module debounce(
  input wire logic clk, output logic debounced
   );
stateType ns;

  always_comb
            begin
             ns = ERR;
       end

  logic timerDone;
     logic clrTimer;
   endmodule

After

module debounce (
    input wire logic clk,
    output logic debounced
);
  stateType ns;

  always_comb begin
    ns = ERR;
  end

  logic timerDone;
  logic clrTimer;
endmodule

See all available images

whitespace

Restyles *, runs automatically.

Documentation

https://github.com/restyled-io/restyler-whitespace/blob/master/README.md

Configuration

restylers:
- whitespace:
    arguments: []
    command:
    - whitespace
    image: restyled/restyler-whitespace:v0.2.0.0
    include:
    - '**/*'
    - '!**/*.gif'
    - '!**/*.ico'
    - '!**/*.jpeg'
    - '!**/*.jpg'
    - '!**/*.pdf'
    - '!**/*.png'
    - '!**/fonts/**/*'
    interpreters: []

Examples

Before

line one  
line two 
  
line three \
line four

After

line one
line two

line three \
line four

Before

line one
line two

line three

After

line one
line two

line three

Before

line one
line two

line three

After

line one
line two

line three

Before

line one
line two
line three

After

line one
line two
line three

See all available images

yapf

Restyles Python, runs automatically.

Documentation

https://github.com/google/yapf

Configuration

restylers:
- yapf:
    arguments: []
    command:
    - yapf
    - --in-place
    image: restyled/restyler-yapf:v0.43.0-1
    include:
    - '**/*.py'
    interpreters:
    - python

Examples

Before

import math, sys;
def example1():
    ####This is a long comment. This should be wrapped to fit within 72 characters.
    some_tuple=(   1,2, 3,'a'  );
    some_variable={'long':'Long code lines should be wrapped within 79 characters.',
    'other':[math.pi, 100,200,300,9876543210,'This is a long string that goes on'],
    'more':{'inner':'This whole logical line should be wrapped.',some_tuple:[1,
    20,300,40000,500000000,60000000000000000]}}
    return (some_tuple, some_variable)

After

import math, sys


def example1():
    ####This is a long comment. This should be wrapped to fit within 72 characters.
    some_tuple = (1, 2, 3, 'a')
    some_variable = {
        'long':
        'Long code lines should be wrapped within 79 characters.',
        'other': [
            math.pi, 100, 200, 300, 9876543210,
            'This is a long string that goes on'
        ],
        'more': {
            'inner': 'This whole logical line should be wrapped.',
            some_tuple: [1, 20, 300, 40000, 500000000, 60000000000000000]
        }
    }
    return (some_tuple, some_variable)

See all available images

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

restylers.md

restylers.md

Restylers

astyle

autopep8

black

brittany

cabal-fmt

clang-format

cmake-format

dart-format

dfmt

dhall-format

dotnet-format

elm-format

fantomas

fourmolu

gn

gofmt

google-java-format

Files

restylers.md

Latest commit

History

restylers.md

File metadata and controls

Restylers

astyle

autopep8

black

brittany

cabal-fmt

clang-format

cmake-format

dart-format

dfmt

dhall-format

dotnet-format

elm-format

fantomas

fourmolu

gn

gofmt

google-java-format