Refactor module structure

Author: gaggle

lib/CLI.ex renamed to lib/command_line.ex

@@ -1,10 +1,20 @@
-defmodule ElixirScript.CLI do
+defmodule ElixirScript.CommandLine do
   alias ElixirScript.Context
   alias ElixirScript.Core
   alias ElixirScript.CustomLogger, as: Logger
 
-  def main(_args \\ []) do
+  def main(args \\ []) do
     Logger.debug("Running in debug mode")
+    {opts, _, _} = OptionParser.parse(args, strict: [help: :boolean])
+
+    if opts[:help] do
+      print_help()
+    else
+      run_script()
+    end
+  end
+
+  defp run_script do
     Logger.debug("All Environment Variables: #{inspect(System.get_env(), limit: :infinity, printable_limit: :infinity)}")
 
     script = Core.get_env_input("script", required: true)
@@ -15,7 +25,16 @@ defmodule ElixirScript.CLI do
     Logger.debug("Result output: #{inspect(value, limit: :infinity, printable_limit: :infinity)}")
   end
 
-  defp log_debug(message) do
-    if @debug_mode, do: Logger.debug(message)
+  defp print_help do
+    IO.puts("""
+    Usage:
+      script [OPTIONS]
+
+    Options:
+      --help          Show this help message and exit.
+
+    Example:
+      INPUT_SCRIPT="IO.puts('Hello, world!')" script
+    """)
   end
 end

lib/core.ex

@@ -1,7 +1,7 @@
 defmodule ElixirScript.Core do
-  alias ElixirScript.Command
-  alias ElixirScript.CommandUtils
-  alias ElixirScript.FileCommand
+  alias ElixirScript.GitHubActions.Command
+  alias ElixirScript.GitHubActions.CommandUtils
+  alias ElixirScript.GitHubActions.EnvironmentFileCommand
 
   def parse_args(args) do
     aliases = [script: :s, debug: :d]
@@ -34,9 +34,9 @@ defmodule ElixirScript.Core do
 
   def set_output(name, value) do
     if System.get_env("GITHUB_OUTPUT") do
-      FileCommand.issue_file_command(
+      EnvironmentFileCommand.issue_file_command(
         "OUTPUT",
-        FileCommand.prepare_key_value_message(name, CommandUtils.to_command_value(value))
+        EnvironmentFileCommand.prepare_key_value_message(name, CommandUtils.to_command_value(value))
       )
     else
       Command.issue_command('set-output', name, CommandUtils.to_command_value(value))

lib/file_command.ex renamed to lib/github_actions/environment_file_command.ex

@@ -1,5 +1,11 @@
-defmodule ElixirScript.FileCommand do
-  alias ElixirScript.CommandUtils
+defmodule ElixirScript.GitHubActions.EnvironmentFileCommand do
+  @moduledoc """
+  Handles GitHub Actions Workflow Commands Environment Files.
+
+  This module is designed to interact with GitHub Actions by issuing
+  workflow commands to environment files as specified in the GitHub Actions documentation:
+  [Workflow Commands for GitHub Actions](https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#environment-files).
+  """
 
   def issue_file_command(command, command_value) do
     file_path = System.get_env("GITHUB_#{command}", "")

lib/command.ex renamed to lib/github_actions/workflow_command.ex

@@ -1,6 +1,4 @@
-defmodule ElixirScript.Command do
-  alias ElixirScript.CommandUtils
-
+defmodule ElixirScript.GitHubActions.Command do
   def issue_command(command, name, command_value) do
     IO.puts("::#{command} name=#{name}::#{command_value}")
   end

lib/command_utils.ex renamed to lib/github_actions/workflow_command_utils.ex

@@ -1,4 +1,4 @@
-defmodule ElixirScript.CommandUtils do
+defmodule ElixirScript.GitHubActions.CommandUtils do
 
   def to_command_value(nil), do: ""
 

mix.exs

@@ -13,7 +13,7 @@ defmodule ElixirScript.MixProject do
 
   def escript do
     [
-      main_module: ElixirScript.CLI
+      main_module: ElixirScript.CommandLine
     ]
   end