Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

mix igniter.new doesn't support --help directly. #195

Open
jimsynz opened this issue Jan 15, 2025 · 4 comments
Open

mix igniter.new doesn't support --help directly. #195

jimsynz opened this issue Jan 15, 2025 · 4 comments
Labels
bug Something isn't working

Comments

@jimsynz
Copy link

jimsynz commented Jan 15, 2025

Describe the bug
I keep typing mix igniter.new --help looking for a list of available options, except I get the following error:

Required positional argument missing: project_name.

Usage:

    mix igniter.new project_name [options]

To Reproduce

$ mix igniter.new --help

Expected behavior

It should output the same output as mix help igniter.new.

** Runtime

  • Elixir version 1.18.1
  • Erlang version 27.2
  • OS macOS Sequoia 15.2 (24C101)
  • Igniter version 0.5.6
  • any related extension versions
@jimsynz jimsynz added the bug Something isn't working label Jan 15, 2025
@zachdaniel
Copy link
Contributor

Closing as mostly a duplicate of #182

We want --help to be handled by igniter, not the individual task, and display the task docs etc.

@zachdaniel
Copy link
Contributor

nvm, igniter.new is a special case and it needs its own --help handling. Not a duplicate.

@zachdaniel
Copy link
Contributor

The main thing is that mix tasks get help with mix help task_name, and we would just look for --help for any igniter task and run and output mix help this.task.

@jimsynz
Copy link
Author

jimsynz commented Jan 20, 2025

The main thing is that mix tasks get help with mix help task_name, and we would just look for --help for any igniter task and run and output mix help this.task.

That seems like the correct behaviour, yes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Development

No branches or pull requests

2 participants