feat: add --git option to igniter.new (#296)

albinkc · web-flow · commit 97028269a34e · 2025-07-15T08:27:21.000-04:00
* add --git option to igniter.new

* add integration test

* add 🔥 to initial commit
diff --git a/installer/lib/mix/tasks/igniter.new.ex b/installer/lib/mix/tasks/igniter.new.ex
@@ -15,6 +15,7 @@ defmodule Mix.Tasks.Igniter.New do
     to the `--with` command, as it may or may not support it. Use `--with-args`
     to provide arguments to that command.
   * `--no-installer-version-check` - skip the version check for the latest igniter_new version
+  * `--git` - Initialize a git repository in the project directory and commit the initial state.
 
   ## Options for `mix.new`
 
@@ -71,7 +72,8 @@ defmodule Mix.Tasks.Igniter.New do
           module: :string,
           sup: :boolean,
           umbrella: :boolean,
-          installer_version_check: :boolean
+          installer_version_check: :boolean,
+          git: :boolean
         ],
         aliases: [i: :install, l: :local, e: :example, w: :with]
       )
@@ -241,6 +243,10 @@ defmodule Mix.Tasks.Igniter.New do
       )
     end
 
+    if options[:git] do
+      initialize_git_repo()
+    end
+
     :ok
   end
 
@@ -312,7 +318,7 @@ defmodule Mix.Tasks.Igniter.New do
     end
   end
 
-  @flags ~w(example sup umbrella installer-version-check no-installer-version-check)
+  @flags ~w(example sup umbrella installer-version-check no-installer-version-check git)
   @flags_with_values ~w(install local with with-args module)
   @switches ~w(e)
   @switches_with_values ~w(i l)
@@ -383,6 +389,33 @@ defmodule Mix.Tasks.Igniter.New do
   @doc false
   def igniter_version, do: @igniter_version
 
+  defp initialize_git_repo do
+    Igniter.Installer.Loading.with_spinner(
+      "Initializing local git repository, staging all files, and committing",
+      fn ->
+        case System.cmd("git", ["init"]) do
+          {_, 0} ->
+            case System.cmd("git", ["add", "."]) do
+              {_, 0} ->
+                case System.cmd("git", ["commit", "-m", "🔥 initial commit 🔥"]) do
+                  {_, 0} ->
+                    Mix.shell().info("Git repository initialized and initial commit created.")
+
+                  {output, _} ->
+                    Mix.shell().error("Failed to create initial commit: #{output}")
+                end
+
+              {output, _} ->
+                Mix.shell().error("Failed to add files to git: #{output}")
+            end
+
+          {output, _} ->
+            Mix.shell().error("Failed to initialize git repository: #{output}")
+        end
+      end
+    )
+  end
+
   defp maybe_warn_outdated(latest_version, opts) do
     if Version.compare(@installer_version, latest_version) == :lt do
       if opts[:yes] do
diff --git a/installer/test/mix/tasks/igniter.new_test.exs b/installer/test/mix/tasks/igniter.new_test.exs
@@ -0,0 +1,222 @@
+defmodule Mix.Tasks.Igniter.NewTest do
+  use ExUnit.Case, async: true
+
+  @moduletag :tmp_dir
+
+  describe "igniter.new with --git flag" do
+    @tag :integration
+    test "initializes git repository and creates initial commit", %{tmp_dir: tmp_dir} do
+      unless git_available?() do
+        :ok
+      else
+        IO.inspect(tmp_dir)
+        project_name = "test_project"
+        project_path = Path.join(tmp_dir, project_name)
+
+        # Change to tmp directory to run the command
+        original_cwd = File.cwd!()
+
+        try do
+          File.cd!(tmp_dir)
+
+          # Run igniter.new with --git flag using System.cmd
+          {output, exit_code} =
+            System.cmd(
+              "mix",
+              ["igniter.new", project_name, "--git", "--yes", "--no-installer-version-check"],
+              stderr_to_stdout: true,
+              env: [{"MIX_ENV", "test"}]
+            )
+
+          if exit_code != 0 do
+            IO.puts("Command failed with output: #{output}")
+          end
+
+          assert exit_code == 0,
+                 "Expected igniter.new to succeed, but got exit code #{exit_code}. Output: #{output}"
+
+          # Verify project directory was created
+          assert File.exists?(project_path), "Project directory should exist at #{project_path}"
+
+          # Change to project directory to check git status
+          File.cd!(project_path)
+
+          # Verify .git directory exists
+          assert File.exists?(".git"), ".git directory should exist"
+          assert File.dir?(".git"), ".git should be a directory"
+
+          # Verify git repository was initialized by checking git status
+          {output, 0} = System.cmd("git", ["status", "--porcelain"])
+          # Empty output means all files are committed (working directory clean)
+          assert String.trim(output) == "",
+                 "Working directory should be clean after initial commit"
+
+          # Verify there is at least one commit
+          {output, 0} = System.cmd("git", ["log", "--oneline"])
+
+          assert String.contains?(output, "🔥 initial commit 🔥"),
+                 "Should have initial commit with fire emoji"
+
+          # Verify essential files are tracked
+          {output, 0} = System.cmd("git", ["ls-files"])
+          tracked_files = String.split(String.trim(output), "\n")
+
+          assert "mix.exs" in tracked_files, "mix.exs should be tracked"
+          assert ".gitignore" in tracked_files, ".gitignore should be tracked"
+          assert "README.md" in tracked_files, "README.md should be tracked"
+
+          # Verify igniter was added to mix.exs
+          mix_exs_content = File.read!("mix.exs")
+
+          assert String.contains?(mix_exs_content, "{:igniter"),
+                 "Igniter dependency should be added to mix.exs"
+        after
+          File.cd!(original_cwd)
+        end
+      end
+    end
+
+    @tag :integration
+    test "creates project without git when --git flag is not provided", %{tmp_dir: tmp_dir} do
+      unless git_available?() do
+        :ok
+      else
+        project_name = "test_project_no_git"
+        project_path = Path.join(tmp_dir, project_name)
+
+        original_cwd = File.cwd!()
+
+        try do
+          File.cd!(tmp_dir)
+
+          # Run igniter.new without --git flag
+          {output, exit_code} =
+            System.cmd(
+              "mix",
+              ["igniter.new", project_name, "--yes", "--no-installer-version-check"],
+              stderr_to_stdout: true,
+              env: [{"MIX_ENV", "test"}]
+            )
+
+          assert exit_code == 0,
+                 "Expected igniter.new to succeed, but got exit code #{exit_code}. Output: #{output}"
+
+          assert File.exists?(project_path), "Project directory should exist"
+          File.cd!(project_path)
+
+          # Verify .git directory does NOT exist
+          refute File.exists?(".git"),
+                 ".git directory should not exist when --git flag is not provided"
+        after
+          File.cd!(original_cwd)
+        end
+      end
+    end
+
+    @tag :integration
+    test "git functionality works with other flags", %{tmp_dir: tmp_dir} do
+      unless git_available?() do
+        :ok
+      else
+        project_name = "test_project_with_sup"
+        project_path = Path.join(tmp_dir, project_name)
+
+        original_cwd = File.cwd!()
+
+        try do
+          File.cd!(tmp_dir)
+
+          # Run igniter.new with --git and --sup flags
+          {output, exit_code} =
+            System.cmd(
+              "mix",
+              [
+                "igniter.new",
+                project_name,
+                "--git",
+                "--sup",
+                "--yes",
+                "--no-installer-version-check"
+              ],
+              stderr_to_stdout: true,
+              env: [{"MIX_ENV", "test"}]
+            )
+
+          assert exit_code == 0,
+                 "Expected igniter.new to succeed, but got exit code #{exit_code}. Output: #{output}"
+
+          assert File.exists?(project_path)
+          File.cd!(project_path)
+
+          # Verify git repository exists and is clean
+          assert File.exists?(".git")
+          {output, 0} = System.cmd("git", ["status", "--porcelain"])
+          assert String.trim(output) == ""
+
+          # Verify project has supervision tree (--sup flag worked)
+          mix_exs_content = File.read!("mix.exs")
+
+          assert String.contains?(mix_exs_content, "mod: {"),
+                 "Should have supervision tree when --sup is used"
+
+          # Verify commit exists
+          {output, 0} = System.cmd("git", ["rev-list", "--count", "HEAD"])
+          commit_count = String.trim(output) |> String.to_integer()
+          assert commit_count >= 1, "Should have at least one commit"
+        after
+          File.cd!(original_cwd)
+        end
+      end
+    end
+  end
+
+  describe "handle missing git" do
+    @tag :integration
+    test "handles missing git gracefully in development", %{tmp_dir: tmp_dir} do
+      # This test simulates what happens when git is not available
+      # but --git flag is used. In practice, the initialize_git_repo function
+      # will output error messages but not crash the entire task.
+
+      project_name = "test_project_no_git_binary"
+      project_path = Path.join(tmp_dir, project_name)
+
+      original_cwd = File.cwd!()
+
+      try do
+        File.cd!(tmp_dir)
+
+        # Create project first without git
+        {_output, exit_code} =
+          System.cmd(
+            "mix",
+            ["igniter.new", project_name, "--yes", "--no-installer-version-check"],
+            stderr_to_stdout: true,
+            env: [{"MIX_ENV", "test"}]
+          )
+
+        assert exit_code == 0
+        assert File.exists?(project_path)
+
+        File.cd!(project_path)
+
+        # Now test that the git repo functionality produces appropriate output
+        # when git commands fail (we can't easily simulate missing git binary in tests)
+        if git_available?() do
+          # At least verify that git operations would work in normal circumstances
+          {_output, exit_code} = System.cmd("git", ["init"])
+          assert exit_code == 0
+        end
+      after
+        File.cd!(original_cwd)
+      end
+    end
+  end
+
+  # Helper to ensure git is available for testing
+  defp git_available? do
+    case System.cmd("git", ["--version"]) do
+      {_, 0} -> true
+      _ -> false
+    end
+  end
+end
diff --git a/installer/test/test_helper.exs b/installer/test/test_helper.exs
@@ -0,0 +1 @@
+ExUnit.start()
