exatomvm
exatomvm copied to clipboard
Running mix help in project does not list available atom tasks/descriptions
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.
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 ;-)