DSL refactor and Flags (options) parsing (#21)

* bump versions

* wip
- new DSL
- accurate parser (combinators)
- flags

* remove dead code

* refactor: simplified parser, need to fix tests

* simplify

* feat: add extensive cli spec definition validation

* feat: implement dispatcher

* fix: tests

* make credo happy

Author: zoedsoupe

.formatter.exs

@@ -1,5 +1,15 @@
+local_without_parens = [
+  defcommand: 2,
+  subcommand: 2,
+  value: 2,
+  flag: 2,
+  short: 1,
+  description: 1
+]
+
 [
+  import_deps: [:nimble_parsec],
   inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"],
-  export: [locals_without_parens: [defcommand: 2]],
-  locals_without_parens: [defcommand: 2]
+  export: [locals_without_parens: local_without_parens],
+  locals_without_parens: local_without_parens
 ]

.github/pull_request_template.md

@@ -0,0 +1,11 @@
+## Problem
+
+<!-- what problem is the PR is trying to solve? -->
+
+## Solution
+
+<!-- how is the PR solving the problem? -->
+
+## Rationale
+
+<!-- why was it implemented the way it was? -->

.github/workflows/ci.yml

@@ -0,0 +1,43 @@
+name: ci
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        elixir: [1.17.0]
+        otp: [27.0]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Elixir
+        uses: erlef/setup-beam@v1
+        with:
+          elixir-version: ${{ matrix.elixir }}
+          otp-version: ${{ matrix.otp }}
+
+      - name: Install dependencies
+        run: mix deps.get
+
+      - name: Clean build
+        run: mix clean
+
+      - name: Check code formatting
+        run: mix format --check-formatted
+
+      - name: Run Credo
+        run: mix credo --strict
+
+      - name: Run tests
+        run: mix test

.github/workflows/lint.yml

@@ -17,38 +17,26 @@ An `Elixir` library to write command line apps in a cleaner and elegant way!
 [![Hex.pm](https://img.shields.io/hexpm/v/nexus_cli.svg)](https://hex.pm/packages/nexus_cli)
 [![Downloads](https://img.shields.io/hexpm/dt/nexus_cli.svg)](https://hex.pm/packages/nexus_cli)
 [![Documentation](https://img.shields.io/badge/documentation-gray)](https://hexdocs.pm/nexus_cli)
-[![lint](https://github.com/zoedsoupe/nexus/actions/workflows/lint.yml/badge.svg)](https://github.com/zoedsoupe/nexus/actions/workflows/lint.yml)
-[![test](https://github.com/zoedsoupe/nexus/actions/workflows/test.yml/badge.svg)](https://github.com/zoedsoupe/nexus/actions/workflows/test.yml)
+[![ci](https://github.com/zoedsoupe/nexus/actions/workflows/ci.yml/badge.svg)](https://github.com/zoedsoupe/nexus/actions/workflows/ci.yml)
 
 ## Example
 
-```elixir dark
+```elixir
 defmodule MyCLI do
-  use Nexus
+  @moduledoc "This will be used into as help"
 
-  defcommand :ping, type: :null, doc: "Answers 'pong'"
-  defcommand :fizzbuzz, type: :integer, required: true, doc: "Plays fizzbuzz"
-  defcommand :mode, type: {:enum, ~w[fast slow]a}, required: true, doc: "Defines the command mode"
+  use Nexus.CLI
 
-  @impl Nexus.CLI
-  # no input as type == :null
-  def handle_input(:ping), do: IO.puts("pong")
+  defcommand :fizzbuzz do
+    description "Plays fizzbuzz - this will also be used as help"
 
-  @impl Nexus.CLI
-  # input can be named to anything
-  @spec handle_input(atom, input) :: :ok
-        when input: Nexus.Command.Input.t()
-  def handle_input(:fizzbuzz, %{value: value}) do
-    cond do
-      rem(value, 3) == 0 -> IO.puts("fizz")
-      rem(value, 5) == 0 -> IO.puts("buzz")
-      rem(value, 3) == 0 and rem(value, 5) == 0 -> IO.puts("fizzbuzz")
-      true -> IO.puts value
-    end
+    value :integer, required: true
   end
 
-  def handle_input(:mode, %{value: :fast), do: IO.puts "Hare"
-  def handle_input(:mode, %{value: :slow), do: IO.puts "Tortoise"
+  @impl Nexus.CLI
+  def handle_input(:fizzbuzz, %{args: [input]}) do
+    # plays fizzbuzz
+  end
 end
 ```
 

.github/workflows/test.yml

@@ -13,14 +13,34 @@ defmodule Escript.Example do
   from the `main/1` escript funciton, as can seen below.
   """
 
-  use Nexus
+  use Nexus.CLI
 
-  defcommand :foo, required: true, type: :string, doc: "Command that receives a string as argument and prints it."
-  defcommand :fizzbuzz, type: {:enum, ~w(fizz buzz)a}, doc: "Fizz bUZZ", required: true
+  defcommand :foo do
+    description "Command that receives a string as argument and prints it."
 
-  defcommand :foo_bar, type: :null, doc: "Teste" do
-    defcommand :foo, default: "hello", doc: "Hello"
-    defcommand :bar, default: "hello", doc: "Hello"
+    value :string, required: true
+  end
+
+  defcommand :fizzbuzz do
+    description "Fizz bUZZ"
+
+    value {:enum, ~w(fizz buzz)a}, required: true
+  end
+
+  defcommand :foo_bar do
+    description "Teste"
+
+    subcommand :foo do
+      description "hello"
+
+      value :string, required: false, default: "hello"
+    end
+
+    subcommand :bar do
+      description "hello"
+
+      value :string, required: false, default: "hello"
+    end
   end
 
   @impl true
@@ -49,8 +69,5 @@ defmodule Escript.Example do
     :ok
   end
 
-  Nexus.help()
-  Nexus.parse()
-
-  defdelegate main(args), to: __MODULE__, as: :run
+  # defdelegate main(args), to: __MODULE__, as: :run
 end

README.md

@@ -0,0 +1,127 @@
+defmodule MyCLI do
+  @moduledoc """
+  MyCLI provides file operations such as copy, move, and delete using the Nexus.CLI DSL.
+  """
+
+  use Nexus.CLI, otp_app: :nexus_cli
+
+  defcommand :file do
+    description "Performs file operations such as copy, move, and delete."
+
+    subcommand :copy do
+      description "Copies files from source to destination."
+
+      value :string, required: true, as: :source
+      value :string, required: true, as: :dest
+
+      flag :level do
+        value :integer, required: false
+      end
+
+      flag :verbose do
+        short :v
+        description "Enables verbose output."
+      end
+
+      flag :recursive do
+        short :rc
+        description "Copies directories recursively."
+      end
+    end
+
+    subcommand :move do
+      description "Moves files from source to destination."
+
+      value :string, required: true, as: :source
+      value :string, required: true, as: :dest
+
+      flag :force do
+        short :f
+        description "Forces the move without confirmation."
+      end
+
+      flag :verbose do
+        short :v
+        description "Enables verbose output."
+      end
+    end
+
+    subcommand :delete do
+      description "Deletes specified files or directories."
+
+      value {:list, :string}, required: true, as: :targets
+
+      flag :force do
+        short :f
+        description "Forces deletion without confirmation."
+      end
+
+      flag :recursive do
+        short :rc
+        description "Deletes directories recursively."
+      end
+
+      flag :verbose do
+        short :v
+        description "Enables verbose output."
+      end
+    end
+  end
+
+  @impl Nexus.CLI
+  def handle_input([:file, :copy], %{args: args, flags: flags}) do
+    if flags.verbose do
+      IO.puts("Copying from #{args.source} to #{args.dest}")
+    end
+
+    if flags.recursive do
+      IO.puts("Recursive copy enabled")
+    end
+
+    # Implement actual copy logic here
+    IO.puts("Copied #{args.source} to #{args.dest}")
+    :ok
+  end
+
+  def handle_input([:file, :move], %{args: args, flags: flags}) do
+    if flags.verbose do
+      IO.puts("Moving from #{args.source} to #{args.dest}")
+    end
+
+    if flags.force do
+      IO.puts("Force move enabled")
+    end
+
+    # Implement actual move logic here
+    IO.puts("Moved #{args.source} to #{args.dest}")
+    :ok
+  end
+
+  def handle_input([:file, :delete], %{args: args, flags: flags}) do
+    if flags.verbose do
+      IO.puts("Deleting targets: #{Enum.join(args.targets, ", ")}")
+    end
+
+    if flags.recursive do
+      IO.puts("Recursive delete enabled")
+    end
+
+    if flags.force do
+      IO.puts("Force delete enabled")
+    end
+
+    # Implement actual delete logic here
+    Enum.each(args.targets, fn target ->
+      IO.puts("Deleted #{target}")
+    end)
+
+    :ok
+  end
+
+  def handle_input(command, input) do
+    IO.puts("Unknown command or invalid parameters")
+    IO.inspect(command, label: "CMD")
+    IO.inspect(input, label: "INPUT")
+    :error
+  end
+end