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

Running mix help in project does not list available atom tasks/descriptions #40

Open
joustava opened this issue Feb 2, 2025 · 1 comment

Comments

@joustava
Copy link

joustava commented Feb 2, 2025

When running mix help, I'd expect atomvm tasks to be listed.
Now the output is

$ mix help
mix                   # Runs the default task (current: "mix run")
mix app.config        # Configures all registered apps
mix app.start         # Starts all registered apps
mix app.tree          # Prints the application tree
mix archive           # Lists installed archives
mix archive.build     # Archives this project into a .ez file
mix archive.install   # Installs an archive locally
mix archive.uninstall # Uninstalls archives
mix clean             # Deletes generated application files
mix cmd               # Executes the given command
mix compile           # Compiles source files
mix deps              # Lists dependencies and their status
mix deps.clean        # Deletes the given dependencies' files
mix deps.compile      # Compiles dependencies
...

I made a quick change locally and:
When adding use Mix.Task a @moduledoc entry and a @shortdoc entry to a task module implemenation it will present the available atomvm tasks:

$ mix help
mix                   # Runs the default task (current: "mix run")
mix app.config        # Configures all registered apps
mix app.start         # Starts all registered apps
mix app.tree          # Prints the application tree
mix archive           # Lists installed archives
mix archive.build     # Archives this project into a .ez file
mix archive.install   # Installs an archive locally
mix archive.uninstall # Uninstalls archives
mix atomvm.check      # Does a check <---
mix clean             # Deletes generated application files
mix cmd               # Executes the given command
mix compile           # Compiles source files
mix deps              # Lists dependencies and their status
mix deps.clean        # Deletes the given dependencies' files
mix deps.compile      # Compiles dependencies
mix deps.get          # Gets all out of date dependencies
...

Maybe there is a reason why it won't/can't work as I expected? Otherwise I could make a PR.

@UncleGrumpy
Copy link
Contributor

UncleGrumpy commented Feb 3, 2025

The only reason that help for AtomVM tasks is not included is just that none of us have taken the time to add it. I think a PR adding help for the AtomVM tasks would be a very welcome contribution. This has crossed my mind before, but my todo list is already long and growing ;-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants