Open
Description
Feature/behavior summary
It would be desirable for new and more experienced users alike to have a CLI command that will provide a reference analysis TOML configuration, either directly to a file or to stdout
, instead of having to refer to the documentation or copy an older configuration file for every new project.
Request attributes
- Would this be a refactor of existing code?
- Does this proposal require new package dependencies?
- Would this change break backwards compatibility?
Related issues
Solution description
My proposal potentially encapsulates two use cases:
- A "quickstart" configuration that yields the minimum working specification, and a user will make minor modifications to it to suit their current use case. This provides a simple onboarding ramp for new users, and as a way to quickly configure a project from scratch.
- A holistic schema dump, that provides the schema/structure with or without specialization (i.e. either keep it abstract, or user provides a target compiler, etc.). This would provide the most up-to-date schema (a la Add compiler definitions #168), and would make it easier for users to find the right key/value for what they might be interested in configuring for, and never have to leave the terminal.
I think we could potentially split this up into two separate commands, or one or the other.
Additional notes
No response