feat: describegpt migrate prompt file from JSON to more easier to edit TOML format
#2954
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
also updated other indirect dependencies
as TOML is easier to edit, as linebreaks in JSON are escaped, and unescaping them will make the JSON invalid
… of JSON for the prompt file
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR migrates the describegpt command's prompt file format from JSON to TOML for improved readability and easier editing of multi-line prompt templates.
- Converts the default prompt file from JSON to TOML format with better visual formatting for multi-line strings
- Updates the code to parse TOML instead of JSON format
- Updates documentation and package configuration to reference the new TOML file
Reviewed Changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/cmd/describegpt.rs | Updates parser from JSON to TOML, adds toml dependency import, and updates documentation strings |
| resources/describegpt_defaults.toml | New TOML format prompt file with improved multi-line string formatting |
| resources/describegpt_defaults.json | Removes the old JSON format prompt file |
| docs/Describegpt.md | Updates documentation to reference the new TOML file |
| Cargo.toml | Adds toml dependency and updates package includes |
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.
As the prompt templates span multiple lines which need to be escaped in JSON, making for harder to edit prompts.
With TOML, the linebreaks are visually preserved and far more human-readable.