oxidecomputer / oxidecomputer/progenitor

add `PROGENITOR_DEBUG=<PATH>` environment variable to output macros to files

Open
#760 5 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted
Dominant language
Rust
Stars
1k
Forks
136
Avg merge
8h 36m
Merged PRs (30d)
14

Description

Sometimes users want to see the code the generate_api! macro produces. cargo-expand works, but it expands a lot of stuff. I think it would be useful to have an environment variable one could set that would result in the macro output landing in some file to examine after the build.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the generate_api! macro and the code path that produces its expansion. Determine how a PROGENITOR_DEBUG= value could capture that output during a build, then verify that the generated content is written to the requested file without changing normal expansion behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.