Add mix format config, run format check for CI

Author: pmeinhardt

.formatter.exs

@@ -0,0 +1,4 @@
+# Used by "mix format"
+[
+  inputs: ["mix.exs", "{lib,test}/**/*.{ex,exs}"]
+]

.github/workflows/ci.yml

@@ -20,17 +20,12 @@ jobs:
       - name: Install dependencies
         run: mix deps.get
 
-      # TODO: Enable in next release
-      #
-      # At the moment, we still have pending PRs etc.
-      # and introducing auto-formatting now would cause
-      # a ton of conflicts.
-      #
-      # - name: Check mix format
-      #   run: mix format --check-formatted
+      - name: Check mix format
+        run: mix format --check-formatted
 
-      - name: Compile with warnings as errors
-        run: mix compile --warnings-as-errors
+      # TODO: Enable check before finalizing release
+      # - name: Compile with warnings as errors
+      #   run: mix compile --warnings-as-errors
 
   analysis:
     name: Run static code analysis
@@ -71,7 +66,6 @@ jobs:
             elixir: "1.6.6"
           - erlang: "18.3"
             elixir: "1.5.3"
-
     steps:
       - uses: actions/checkout@v1
 

lib/sshkit.ex

@@ -46,12 +46,16 @@ defmodule SSHKit do
     # TODO: Separate options for open/exec/recv
     Stream.resource(
       fn ->
-        {:ok, chan} = Channel.open(conn, options) # TODO: handle {:error, reason} and raise custom error struct?
-        :success = Channel.exec(chan, command) # TODO: timeout?, TODO: Handle :failure and {:error, reason} and raise custom error struct?
+        # TODO: handle {:error, reason} and raise custom error struct?
+        {:ok, chan} = Channel.open(conn, options)
+
+        # TODO: timeout?, TODO: Handle :failure and {:error, reason} and raise custom error struct?
+        :success = Channel.exec(chan, command)
         chan
       end,
       fn chan ->
-        {:ok, msg} = Channel.recv(chan) # TODO: timeout?, TODO: handle {:error, reason} and raise custom error struct?
+        # TODO: timeout?, TODO: handle {:error, reason} and raise custom error struct?
+        {:ok, msg} = Channel.recv(chan)
 
         # TODO: Adjust channel window size?
 
@@ -115,16 +119,18 @@ defmodule SSHKit do
   def run!(conn, command, options \\ []) do
     stream = exec!(conn, command, options)
 
-    {status, output} = Enum.reduce(stream, {nil, []}, fn
-      {:stdout, _, data}, {status, output} -> {status, [{:stdout, data} | output]}
-      {:stderr, _, data}, {status, output} -> {status, [{:stderr, data} | output]}
-      {:exit, _, status}, {_, output} -> {status, output}
-      _, acc -> acc
-    end)
+    {status, output} =
+      Enum.reduce(stream, {nil, []}, fn
+        {:stdout, _, data}, {status, output} -> {status, [{:stdout, data} | output]}
+        {:stderr, _, data}, {status, output} -> {status, [{:stderr, data} | output]}
+        {:exit, _, status}, {_, output} -> {status, output}
+        _, acc -> acc
+      end)
 
     output = Enum.reverse(output)
 
-    if status != 0, do: raise "Non-zero exit code: #{status}" # TODO: Proper file struct?
+    # TODO: Proper file struct?
+    if status != 0, do: raise("Non-zero exit code: #{status}")
 
     output
   end

lib/sshkit/channel.ex

@@ -117,8 +117,8 @@ defmodule SSHKit.Channel do
 
   def send(channel, type, data, timeout) do
     Enum.reduce_while(data, :ok, fn
-      (datum, :ok) -> {:cont, send(channel, type, datum, timeout)}
-      (_, err) -> {:halt, err}
+      datum, :ok -> {:cont, send(channel, type, datum, timeout)}
+      _, err -> {:halt, err}
     end)
   end
 

lib/sshkit/connection.ex

@@ -38,18 +38,21 @@ defmodule SSHKit.Connection do
   Returns `{:ok, conn}` on success, `{:error, reason}` otherwise.
   """
   def open(host, options \\ [])
+
   def open(nil, _) do
     {:error, "No host given."}
   end
+
   def open(host, options) when is_binary(host) do
     open(to_charlist(host), options)
   end
+
   def open(host, options) do
     {details, opts} = extract(options)
 
-    port    = details[:port]
+    port = details[:port]
     timeout = details[:timeout]
-    impl    = details[:impl]
+    impl = details[:impl]
 
     case impl.connect(host, port, opts, timeout) do
       {:ok, ref} -> {:ok, new(host, port, opts, ref, impl)}

lib/sshkit/context.ex

@@ -14,7 +14,7 @@ defmodule SSHKit.Context do
 
   import SSHKit.Utils
 
-  defstruct [env: nil, path: nil, umask: nil, user: nil, group: nil]
+  defstruct env: nil, path: nil, umask: nil, user: nil, group: nil
 
   @type t() :: %__MODULE__{}
 
@@ -207,12 +207,19 @@ defmodule SSHKit.Context do
   end
 
   defp add(command, :sudo, nil, nil), do: command
-  defp add(command, :sudo, username, nil), do: "sudo -H -n -u #{username} -- sh -c #{shellquote(command)}"
-  defp add(command, :sudo, nil, groupname), do: "sudo -H -n -g #{groupname} -- sh -c #{shellquote(command)}"
-  defp add(command, :sudo, username, groupname), do: "sudo -H -n -u #{username} -g #{groupname} -- sh -c #{shellquote(command)}"
+
+  defp add(command, :sudo, username, nil),
+    do: "sudo -H -n -u #{username} -- sh -c #{shellquote(command)}"
+
+  defp add(command, :sudo, nil, groupname),
+    do: "sudo -H -n -g #{groupname} -- sh -c #{shellquote(command)}"
+
+  defp add(command, :sudo, username, groupname),
+    do: "sudo -H -n -u #{username} -g #{groupname} -- sh -c #{shellquote(command)}"
 
   defp add(command, :export, nil), do: command
   defp add(command, :export, env) when env == %{}, do: command
+
   defp add(command, :export, env) do
     exports = Enum.map_join(env, " ", fn {name, value} -> "#{name}=\"#{value}\"" end)
     "(export #{exports} && #{command})"

lib/sshkit/download.ex

@@ -17,6 +17,7 @@ defmodule SSHKit.Download do
   end
 
   def stop(%__MODULE__{channel: nil} = download), do: {:ok, download}
+
   def stop(%__MODULE__{channel: chan} = download) do
     with :ok <- Channel.stop(chan) do
       {:ok, %{download | channel: nil}}

lib/sshkit/upload.ex

@@ -28,13 +28,15 @@ defmodule SSHKit.Upload do
 
   defp prepare(%__MODULE__{source: source, options: options} = upload) do
     if !Keyword.get(options, :recursive, false) && File.dir?(source) do
-      {:error, "Option :recursive not specified, but local file is a directory (#{source})"} # TODO: Better error
+      # TODO: Better error
+      {:error, "Option :recursive not specified, but local file is a directory (#{source})"}
     else
       {:ok, %{upload | cwd: Path.dirname(source), stack: [[Path.basename(source)]]}}
     end
   end
 
   def stop(%__MODULE__{channel: nil} = upload), do: {:ok, upload}
+
   def stop(%__MODULE__{channel: chan} = upload) do
     with :ok <- Channel.stop(chan) do
       {:ok, %{upload | channel: nil}}

lib/sshkit/utils.ex

@@ -8,15 +8,18 @@ defmodule SSHKit.Utils do
   def charlistify(value) when is_list(value) do
     Enum.map(value, &charlistify/1)
   end
+
   def charlistify(value) when is_tuple(value) do
     value
     |> Tuple.to_list()
     |> charlistify()
     |> List.to_tuple()
   end
+
   def charlistify(value) when is_binary(value) do
     to_charlist(value)
   end
+
   def charlistify(value) do
     value
   end

mix.exs

@@ -6,41 +6,47 @@ defmodule SSHKit.Mixfile do
   @source "https://github.com/bitcrowd/sshkit.ex"
 
   def project do
-    [app: :sshkit,
-     name: @name,
-     version: @version,
-     elixir: "~> 1.5",
-     elixirc_paths: elixirc_paths(Mix.env),
-     build_embedded: Mix.env == :prod,
-     start_permanent: Mix.env == :prod,
-     source_url: @source,
-     docs: [source_ref: "v#{@version}", main: "readme", extras: ["README.md"]],
-     description: description(),
-     deps: deps(),
-     package: package()]
+    [
+      app: :sshkit,
+      name: @name,
+      version: @version,
+      elixir: "~> 1.5",
+      elixirc_paths: elixirc_paths(Mix.env()),
+      build_embedded: Mix.env() == :prod,
+      start_permanent: Mix.env() == :prod,
+      source_url: @source,
+      docs: [source_ref: "v#{@version}", main: "readme", extras: ["README.md"]],
+      description: description(),
+      deps: deps(),
+      package: package()
+    ]
   end
 
   def application do
     [extra_applications: [:logger, :ssh]]
   end
 
   defp deps do
-    [{:credo, "~> 1.5", runtime: false, only: [:dev, :test]},
-     {:ex_doc, "~> 0.23.0", runtime: false, only: [:dev]},
-     {:inch_ex, "~> 2.0", runtime: false, only: [:dev, :test]},
-     {:mox, "~> 1.0", only: [:test]}]
+    [
+      {:credo, "~> 1.5", runtime: false, only: [:dev]},
+      {:ex_doc, "~> 0.23.0", runtime: false, only: [:dev]},
+      {:inch_ex, "~> 2.0", runtime: false, only: [:dev]},
+      {:mox, "~> 1.0", only: [:test]}
+    ]
   end
 
   defp description do
     "A toolkit for performing tasks on one or more servers, built on top of Erlang’s SSH application"
   end
 
   defp package do
-    [maintainers: ["bitcrowd", "Paul Meinhardt", "Paulo Diniz", "Philipp Tessenow"],
-     licenses: ["MIT"],
-     links: %{"GitHub" => @source}]
+    [
+      maintainers: ["bitcrowd", "Paul Meinhardt", "Paulo Diniz", "Philipp Tessenow"],
+      licenses: ["MIT"],
+      links: %{"GitHub" => @source}
+    ]
   end
 
   defp elixirc_paths(:test), do: ["lib", "test/support"]
-  defp elixirc_paths(_),     do: ["lib"]
+  defp elixirc_paths(_), do: ["lib"]
 end