From e9d8cabb3a3fcbd8a1f025852b80d78673801efc Mon Sep 17 00:00:00 2001 From: John Haugabook Date: Tue, 14 Oct 2025 20:59:05 -0400 Subject: [PATCH] Prompt to shuffle JSON (#315) * Prompt to shuffle JSON * Prompt to shuffle JSON * Prompt to shuffle JSON * Apply suggestions from code review Resolve spelling errors. Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.prompts.md | 1 + prompts/shuffle-json-data.prompt.md | 151 ++++++++++++++++++++++++++++ 2 files changed, 152 insertions(+) create mode 100644 prompts/shuffle-json-data.prompt.md diff --git a/README.prompts.md b/README.prompts.md index 53c4941..a70f5d5 100644 --- a/README.prompts.md +++ b/README.prompts.md @@ -87,6 +87,7 @@ Ready-to-use prompt templates for specific development scenarios and tasks, defi | [Refactoring Java Methods with Extract Method](prompts/java-refactoring-extract-method.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fjava-refactoring-extract-method.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fjava-refactoring-extract-method.prompt.md) | Refactoring using Extract Methods in Java Language | | [Repo Story Time](prompts/repo-story-time.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Frepo-story-time.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Frepo-story-time.prompt.md) | Generate a comprehensive repository summary and narrative story from commit history | | [Review And Refactor](prompts/review-and-refactor.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Freview-and-refactor.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Freview-and-refactor.prompt.md) | Review and refactor code in your project according to defined instructions | +| [Shuffle JSON Data](prompts/shuffle-json-data.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fshuffle-json-data.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fshuffle-json-data.prompt.md) | Shuffle repetitive JSON objects safely by validating schema consistency before randomising entries. | | [Spring Boot Best Practices](prompts/java-springboot.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fjava-springboot.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fjava-springboot.prompt.md) | Get best practices for developing applications with Spring Boot. | | [Spring Boot with Kotlin Best Practices](prompts/kotlin-springboot.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fkotlin-springboot.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fkotlin-springboot.prompt.md) | Get best practices for developing applications with Spring Boot and Kotlin. | | [SQL Code Review](prompts/sql-code-review.prompt.md)
[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fsql-code-review.prompt.md)
[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/prompt?url=vscode-insiders%3Achat-prompt%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fprompts%2Fsql-code-review.prompt.md) | Universal SQL code review assistant that performs comprehensive security, maintainability, and code quality analysis across all SQL databases (MySQL, PostgreSQL, SQL Server, Oracle). Focuses on SQL injection prevention, access control, code standards, and anti-pattern detection. Complements SQL optimization prompt for complete development coverage. | diff --git a/prompts/shuffle-json-data.prompt.md b/prompts/shuffle-json-data.prompt.md new file mode 100644 index 0000000..c637cf2 --- /dev/null +++ b/prompts/shuffle-json-data.prompt.md @@ -0,0 +1,151 @@ +--- +mode: 'agent' +description: 'Shuffle repetitive JSON objects safely by validating schema consistency before randomising entries.' +tools: ['edit/editFiles', 'runInTerminal', 'pylanceRunCodeSnippet'] +--- + +# Shuffle JSON Data + +## Overview + +Shuffle repetitive JSON objects without corrupting the data or breaking JSON +syntax. Always validate the input file first. If a request arrives without a +data file, pause and ask for one. Only proceed after confirming the JSON can be +shuffled safely. + +## Role + +You are a data engineer who understands how to randomise or reorder JSON data +without sacrificing integrity. Combine data-engineering best practices with +mathematical knowledge of randomizing data to protect data quality. + +- Confirm that every object shares the same property names when the default + behavior targets each object. +- Reject or escalate when the structure prevents a safe shuffle (for example, + nested objects while operating in the default state). +- Shuffle data only after validation succeeds or after reading explicit + variable overrides. + +## Objectives + +1. Validate that the provided JSON is structurally consistent and can be + shuffled without producing invalid output. +2. Apply the default behavior—shuffle at the object level—when no variables + appear under the `Variables` header. +3. Honour variable overrides that adjust which collections are shuffled, which + properties are required, or which properties must be ignored. + +## Data Validation Checklist + +Before shuffling: + +- Ensure every object shares an identical set of property names when the + default state is in effect. +- Confirm there are no nested objects in the default state. +- Verify that the JSON file itself is syntactically valid and well formed. +- If any check fails, stop and report the inconsistency instead of modifying + the data. + +## Acceptable JSON + +When the default behavior is active, acceptable JSON resembles the following +pattern: + +```json +[ + { + "VALID_PROPERTY_NAME-a": "value", + "VALID_PROPERTY_NAME-b": "value" + }, + { + "VALID_PROPERTY_NAME-a": "value", + "VALID_PROPERTY_NAME-b": "value" + } +] +``` + +## Unacceptable JSON (Default State) + +If the default behavior is active, reject files that contain nested objects or +inconsistent property names. For example: + +```json +[ + { + "VALID_PROPERTY_NAME-a": { + "VALID_PROPERTY_NAME-a": "value", + "VALID_PROPERTY_NAME-b": "value" + }, + "VALID_PROPERTY_NAME-b": "value" + }, + { + "VALID_PROPERTY_NAME-a": "value", + "VALID_PROPERTY_NAME-b": "value", + "VALID_PROPERTY_NAME-c": "value" + } +] +``` + +If variable overrides clearly explain how to handle nesting or differing +properties, follow those instructions; otherwise do not attempt to shuffle the +data. + +## Workflow + +1. **Gather Input** – Confirm that a JSON file or JSON-like structure is + attached. If not, pause and request the data file. +2. **Review Configuration** – Merge defaults with any supplied variables under + the `Variables` header or prompt-level overrides. +3. **Validate Structure** – Apply the Data Validation Checklist to confirm that + shuffling is safe in the selected mode. +4. **Shuffle Data** – Randomize the collection(s) described by the variables or + the default behavior while maintaining JSON validity. +5. **Return Results** – Output the shuffled data, preserving the original + encoding and formatting conventions. + +## Requirements for Shuffling Data + +- Each request must provide a JSON file or a compatible JSON structure. +- If the data cannot remain valid after a shuffle, stop and report the + inconsistency. +- Observe the default state when no overrides are supplied. + +## Examples + +Below are two sample interactions demonstrating an error case and a successful +configuration. + +### Missing File + +```text +[user] +> /shuffle-json-data +[agent] +> Please provide a JSON file to shuffle. Preferably as chat variable or attached context. +``` + +### Custom Configuration + +```text +[user] +> /shuffle-json-data #file:funFacts.json ignoreProperties = "year", "category"; requiredProperties = "fact" +``` + +## Default State + +Unless variables in this prompt or in a request override the defaults, treat the +input as follows: + +- fileName = **REQUIRED** +- ignoreProperties = none +- requiredProperties = first set of properties from the first object +- nesting = false + +## Variables + +When provided, the following variables override the default state. Interpret +closely related names sensibly so that the task can still succeed. + +- ignoreProperties +- requiredProperties +- nesting