Reserves --help for each mix task and showing bad args error with its helper

[shahryarjb]

Hello,

As we discussed on Discord, I think it would be great if Igniter reserves the --helps option and provides a display similar to mix help task.
This approach can help prevent mistakes for users of the CLI, especially those coming from non-Elixir stacks.

---

Another improvement that I believe can enhance the task is displaying a helper specific to each argument. For instance, if an argument is entered incorrectly, the task could show an error like:

** (Mix) Could not invoke task "mishka.ui.gen.component": 1 error found!
--color : Missing argument of type string

However, in a library like Clap (built on Rust), the usage of that option is also displayed. For example:

curl [options / URLs]
or
--alt-svc <file name>
or
Usage: color [OPTIONS]

This approach provides users with clear guidance on how to correctly use the options, similar to how it's presented in Unix-style commands.

---

By the way, since Igniter's strength lies in generating initial templates and providing a very intuitive structure, I believe that, in addition to argument definitions, composing other tasks, and similar features, it would be beneficial to include the version in its map. This way, the --version option could also be reserved automatically.

Of course, this is more of a personal suggestion, but I think it could add a nice touch to the tool's usability.

Thank you in advance

[zachdaniel]

We’d go with —help as opposed to —helper as the first is more idiomatic.

as for individual options, I believe that sort of thing should already be handled, showing an error similar to the one you described.

so the main thing would be to derive the —help message automatically.

[zachdaniel]

And likely provide a callback to override it

[shahryarjb]

We’d go with —help as opposed to —helper as the first is more idiomatic.

as for individual options, I believe that sort of thing should already be handled, showing an error similar to the one you described.

so the main thing would be to derive the —help message automatically.

Sorry, meant --help