feat: add igniter installer (#71)

Author: frankdugan3

README.md

@@ -35,7 +35,25 @@ word lists `feat(Something Special, Something Else Special): message`. Keep in
 mind that you are very limited on space in these messages, and if you find
 yourself using multiple scopes your commit is probably too big.
 
-## Installation
+## Installation with Igniter
+
+If `Igniter` is not already in your project, add it to your deps:
+
+```elixir
+def deps do
+  [
+    {:igniter, "~> 0.5", only: [:dev, :test]}
+  ]
+end
+```
+
+Then, run the installer:
+
+```sh
+mix igniter.install git_ops
+```
+
+## Manual Installation
 
 ```elixir
 def deps do

lib/git_ops/changelog.ex

@@ -73,7 +73,7 @@ defmodule GitOps.Changelog do
         rest
       ])
 
-    unless opts[:dry_run] do
+    if !opts[:dry_run] do
       File.write!(path, new_contents)
     end
 
@@ -95,7 +95,7 @@ defmodule GitOps.Changelog do
       raise "\nFile already exists: #{path}. Please remove it to initialize."
     end
 
-    unless opts[:dry_run] do
+    if !opts[:dry_run] do
       File.write!(path, String.trim_leading(contents))
     end
 

lib/git_ops/commit.ex

@@ -119,7 +119,7 @@ defmodule GitOps.Commit do
               message: Enum.at(result[:message], 0),
               body: body,
               footer: footer,
-              breaking?: is_breaking?(result[:breaking?], body, footer)
+              breaking?: breaking?(result[:breaking?], body, footer)
             }
           end)
 
@@ -143,8 +143,8 @@ defmodule GitOps.Commit do
   defp scopes([value]) when is_bitstring(value), do: String.split(value, ",")
   defp scopes(_), do: nil
 
-  defp is_breaking?(breaking, _, _) when not is_nil(breaking), do: true
-  defp is_breaking?(_, "BREAKING CHANGE:" <> _, _), do: true
-  defp is_breaking?(_, _, "BREAKING CHANGE:" <> _), do: true
-  defp is_breaking?(_, _, _), do: false
+  defp breaking?(breaking, _, _) when not is_nil(breaking), do: true
+  defp breaking?(_, "BREAKING CHANGE:" <> _, _), do: true
+  defp breaking?(_, _, "BREAKING CHANGE:" <> _), do: true
+  defp breaking?(_, _, _), do: false
 end

lib/git_ops/config.ex

@@ -44,13 +44,13 @@ defmodule GitOps.Config do
   ]
 
   def mix_project_check(opts \\ []) do
-    unless mix_project().project()[:version] do
+    if !mix_project().project()[:version] do
       raise "mix_project must be configured in order to use git_ops. Please see the configuration in the README.md for an example."
     end
 
     changelog_path = Path.expand(changelog_file())
 
-    unless opts[:initial] || File.exists?(changelog_path) do
+    if !(opts[:initial] || File.exists?(changelog_path)) do
       raise "\nFile: #{changelog_path} did not exist. Please use the `--initial` command to initialize."
     end
   end

lib/git_ops/version_replace.ex

@@ -35,7 +35,7 @@ defmodule GitOps.VersionReplace do
     if new_contents == contents do
       {:error, :bad_replace}
     else
-      unless opts[:dry_run] do
+      if !opts[:dry_run] do
         File.write!(file, new_contents)
       end
 

lib/mix/tasks/git_ops.install.ex

@@ -0,0 +1,147 @@
+defmodule Mix.Tasks.GitOps.Install.Docs do
+  @moduledoc false
+
+  def short_doc do
+    "Installs GitOps into a project."
+  end
+
+  def example do
+    "mix igniter.install git_ops"
+  end
+
+  def long_doc do
+    """
+    #{short_doc()}
+
+    ## Example
+
+    ```bash
+    #{example()}
+    ```
+
+    ## Switches
+
+    - `--no-manage-readme` - Disables mangaging the package version in the README file.
+    - `--no-manage-mix` - Disables mangaging the package version in the `mix.exs` file.
+    """
+  end
+end
+
+if Code.ensure_loaded?(Igniter) do
+  defmodule Mix.Tasks.GitOps.Install do
+    @shortdoc "#{__MODULE__.Docs.short_doc()}"
+
+    @moduledoc __MODULE__.Docs.long_doc()
+
+    use Igniter.Mix.Task
+
+    @impl Igniter.Mix.Task
+    def info(_argv, _composing_task) do
+      %Igniter.Mix.Task.Info{
+        group: :git_ops,
+        adds_deps: [],
+        installs: [],
+        example: __MODULE__.Docs.example(),
+        only: [:dev],
+        positional: [],
+        composes: [],
+        schema: [
+          manage_readme: :boolean,
+          manage_mix: :boolean
+        ],
+        defaults: [manage_readme: true, manage_mix: true],
+        aliases: [],
+        required: []
+      }
+    end
+
+    @impl Igniter.Mix.Task
+    def igniter(igniter) do
+      opts = igniter.args.options
+
+      manage_mix? = opts[:manage_mix]
+      manage_readme? = opts[:manage_readme]
+
+      igniter
+      |> Igniter.Project.Config.configure_new(
+        "dev.exs",
+        :git_ops,
+        [:mix_project],
+        {:code, Sourceror.parse_string!("Mix.Project.get!()")}
+      )
+      |> Igniter.Project.Config.configure_new("dev.exs", :git_ops, [:types],
+        types: [tidbit: [hidden?: true], important: [header: "Important Changes"]]
+      )
+      |> Igniter.Project.Config.configure_new("dev.exs", :git_ops, [:version_tag_prefix], "v")
+      |> then(fn igniter ->
+        igniter =
+          if manage_mix? do
+            Igniter.Project.MixProject.update(igniter, :project, [:version], fn zipper ->
+              version = zipper.node
+
+              zipper
+              |> Igniter.Code.Common.replace_code("@version")
+              |> Sourceror.Zipper.top()
+              |> Sourceror.Zipper.move_to_cursor("""
+              defmodule __ do
+                use __
+                __cursor__()
+              end
+              """)
+              |> Igniter.Code.Common.add_code("@version \"#{version}\"", placement: :before)
+            end)
+          else
+            igniter
+          end
+
+        igniter
+        |> Igniter.Project.Config.configure(
+          "dev.exs",
+          :git_ops,
+          [:manage_mix_verions?],
+          manage_mix?
+        )
+      end)
+      |> Igniter.Project.Config.configure(
+        "dev.exs",
+        :git_ops,
+        [:manage_readme_version],
+        manage_readme?
+      )
+      |> Igniter.Project.Config.configure_new(
+        "dev.exs",
+        :git_ops,
+        [:mix_project],
+        Sourceror.parse_string!("Mix.Project.get!()")
+      )
+      |> Igniter.add_notice("""
+      GitOps has been installed. To create the first release:
+
+        mix git_ops.release --initial
+
+      On subsequent releases, use:
+
+        mix git_ops.release
+
+      """)
+    end
+  end
+else
+  defmodule Mix.Tasks.GitOps.Install do
+    @shortdoc "#{__MODULE__.Docs.short_doc()} | Install `igniter` to use"
+
+    @moduledoc __MODULE__.Docs.long_doc()
+
+    use Mix.Task
+
+    def run(_argv) do
+      Mix.shell().error("""
+      The task 'git_ops.install' requires igniter. Please install igniter and try again.
+
+      For more information, see: https://hexdocs.pm/igniter/readme.html#installation
+      """)
+
+      exit({:shutdown, 1})
+    end
+  end
+end

mix.exs

@@ -70,6 +70,7 @@ defmodule GitOps.MixProject do
       {:ex_doc, "~> 0.19", only: :dev, runtime: false},
       {:excoveralls, "~> 0.6", only: :test},
       {:git_cli, "~> 0.2"},
+      {:igniter, "~> 0.5", optional: true},
       {:nimble_parsec, "~> 1.0"}
     ]
   end