Add options to list and get a detailed explanation of options #293
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bugadani
force-pushed
the
accessibility
branch
3 times, most recently
from
e9b35a4 to
bc1764b
Compare
bugadani
commented
Jan 15, 2026
| ## Available Options | ||
| - `unstable-hal`: Enables esp-hal features that may not be ready for general use yet. |
Contributor
Author
There was a problem hiding this comment.
I think we lost track of some of the options, and the list commands makes this list redundant also.
There was a problem hiding this comment.
Pull request overview
This PR introduces new subcommands to list and explain template options, addressing issue #287. It also embeds the generator parameters used in the generated code for future reference.
Changes:
- Added
esp-generate list-optionscommand to display all available template options grouped by category - Added
esp-generate explain <option>command to provide detailed information about a specific option - Embedded generator parameters as a comment in generated template files
- Updated README to reference new commands instead of maintaining a static list of options
- Removed unused
populate_toolchain_categoryfunction from toolchain module
Reviewed changes
Copilot reviewed 5 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| template/src/bin/main.rs | Added comment placeholder for generator parameters in main entry point |
| template/src/bin/async_main.rs | Added comment placeholder for generator parameters in async entry point |
| src/toolchain.rs | Removed unused populate_toolchain_category function |
| src/main.rs | Implemented new subcommands, improved headless mode error messages, and added logic to embed parameters in generated code |
| README.md | Updated documentation to reference new subcommands instead of listing all options |
| Cargo.toml | Added indexmap dependency for ordered map operations |
| Cargo.lock | Updated with indexmap dependency |
| CHANGELOG.md | Documented new features |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
bugadani
force-pushed
the
accessibility
branch
3 times, most recently
from
e7d32b6 to
781c1ce
Compare
SergioGasquez
approved these changes
Jan 19, 2026
Member
SergioGasquez
left a comment
SergioGasquez
left a comment
There was a problem hiding this comment.
LGTM! Just gave it a try and it looks like a good improvement to me! I would still wait for some more useful feedback before merging it
bugadani
force-pushed
the
accessibility
branch
from
781c1ce to
de6c475
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #287 by introducing
esp-generate list-optionsandesp-generate explain <option>. These commands describe each option and their dependencies. The module and toolchain options are not included in this yet.