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

Consider adding options for scaffolding - "verbose" vs. "minimal" #43

Open
austinvalle opened this issue Sep 14, 2023 · 1 comment
Open

Comments

@austinvalle
Copy link
Member

austinvalle commented Sep 14, 2023

References

Context

There seems to be an appetite for the scaffold function to provide different levels of information in the skeleton that is created:

  • Minimal, no deleting of code needed, resource/datasource/provider code file
  • Verbose, comments explaining pieces of code, showing different data handling function, like mentioned here

No proposal right now, maybe the scaffold command isn't the right place for this, but wanted to document this before I forget 😃

@bflad
Copy link
Contributor

bflad commented Sep 15, 2023

Yeah there's certainly been asks in both directions for this verbosity. I'm not sure we'll ever satisfy everyone. Maybe we can point folks at (and potentially a code comment in the scaffolding repo) https://github.com/hashicorp/terraform-provider-corner/blob/main/internal/framework6provider/schema_resource.go although I'm honestly really not sure the benefit without also showing real data handling. Maybe we should just make a terraform-provider-examplecloud or something with its own fake "API SDK" package with types, client, and "API" operations.

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