Name: code-analysis
Author: fadwen

Prompt file imported from fadwen/TechbyJeff (.github/prompts/code-analysis.prompt.md). Fill in {{selection}} before use. Copyright stays with the author.

Perform thorough analysis of this PowerShell code against modern best practices:

Selected Code:

{{selection}}

Analysis Framework:

1. Modern PowerShell Patterns ✅

Error handling: Verify $_ usage in catch blocks (not $Error[0])
Credential creation: Check for [PSCredential]::new() vs New-Object
Parameter validation: Ensure appropriate validation without redundancy
String operations: Context-appropriate concatenation vs StringBuilder

2. Comment-Based Help Quality ✅

Proper block comment syntax with opening markers
Complete parameter documentation
Meaningful examples with descriptions
Appropriate .INPUTS and .OUTPUTS sections
Avoid maintenance-heavy versioning in .NOTES

3. Performance Patterns ✅

Context-aware string operations (simple vs complex)
Collection handling: flag += only where the declared target is below 7.5, in which it is still O(n²), or where the loop is unbounded. PowerShell 7.5 optimised it. Never suggest ArrayList
Appropriate use of pipeline vs loops
Memory-conscious patterns for large datasets

4. Output Type Design ✅

Descriptive type names instead of misleading [PSCustomObject]
Custom classes for complex objects
Meaningful IntelliSense support
Proper type declarations

5. Enterprise Standards ✅

Correlation ID implementation
Structured logging patterns
Configuration-driven behavior
Environment-appropriate error handling

6. Security & Compliance ✅

Modern security patterns
Input validation best practices
Audit trail requirements
Compliance framework alignment

7. Code Quality Metrics ✅

Approved PowerShell verb usage
Consistent style and formatting
Appropriate function complexity
Clear separation of concerns

Analysis Output: Provide prioritized recommendations with:

❌ Issues found with severity rating
✅ Best practices already implemented
🔧 Specific code corrections
💡 Optimization opportunities
📋 Compliance gaps

Include corrected code examples demonstrating proper modern PowerShell patterns.

Perform thorough analysis of this PowerShell code against modern best practices: **Selected Code:** ```powershell {{selection}} ``` **Analysis Framework:** **1. Modern PowerShell Patterns ✅** - Error handling: Verify $_ usage in catch blocks (not $Error[0]) - Credential creation: Check for [PSCredential]::new() vs New-Object - Parameter validation: Ensure appropriate validation without redundancy - String operations: Context-appropriate concatenation vs StringBuilder **2. Comment-Based Help Quality ✅** - Proper block comment syntax with opening markers - Complete parameter documentation - Meaningful examples with descriptions - Appropriate .INPUTS and .OUTPUTS sections - Avoid maintenance-heavy versioning in .NOTES **3. Performance Patterns ✅** - Context-aware string operations (simple vs complex) - Collection handling: flag `+=` only where the declared target is below 7.5, in which it is still O(n²), or where the loop is unbounded. PowerShell 7.5 optimised it. Never suggest `ArrayList` - Appropriate use of pipeline vs loops - Memory-conscious patterns for large datasets **4. Output Type Design ✅** - Descriptive type names instead of misleading [PSCustomObject] - Custom classes for complex objects - Meaningful IntelliSense support - Proper type declarations **5. Enterprise Standards ✅** - Correlation ID implementation - Structured logging patterns - Configuration-driven behavior - Environment-appropriate error handling **6. Security & Compliance ✅** - Modern security patterns - Input validation best practices - Audit trail requirements - Compliance framework alignment **7. Code Quality Metrics ✅** - Approved PowerShell verb usage - Consistent style and formatting - Appropriate function complexity - Clear separation of concerns **Analysis Output:** Provide prioritized recommendations with: - ❌ Issues found with severity rating - ✅ Best practices already implemented - 🔧 Specific code corrections - 💡 Optimization opportunities - 📋 Compliance gaps Include corrected code examples demonstrating proper modern PowerShell patterns.

{ "prompt": "Perform thorough analysis of this PowerShell code against modern best practices:\n\n**Selected Code:**\n\n```powershell\n{{selection}}\n```\n\n**Analysis Framework:**\n\n**1. Modern PowerShell Patterns ✅**\n\n- Error handling: Verify $_ usage in catch blocks (not $Error[0])\n- Credential creation: Check for [PSCredential]::new() vs New-Object\n- Parameter validation: Ensure appropriate validation without redundancy\n- String operations: Context-appropriate concatenation vs StringBuilder\n\n**2. Comment-Based Help Quality ✅**\n\n- Proper block comment syntax with opening markers\n- Complete parameter documentation\n- Meaningful examples with descriptions\n- Appropriate .INPUTS and .OUTPUTS sections\n- Avoid maintenance-heavy versioning in .NOTES\n\n**3. Performance Patterns ✅**\n\n- Context-aware string operations (simple vs complex)\n- Collection handling: flag `+=` only where the declared target is below 7.5, in which it is still\n O(n²), or where the loop is unbounded. PowerShell 7.5 optimised it. Never suggest `ArrayList`\n- Appropriate use of pipeline vs loops\n- Memory-conscious patterns for large datasets\n\n**4. Output Type Design ✅**\n\n- Descriptive type names instead of misleading [PSCustomObject]\n- Custom classes for complex objects\n- Meaningful IntelliSense support\n- Proper type declarations\n\n**5. Enterprise Standards ✅**\n\n- Correlation ID implementation\n- Structured logging patterns\n- Configuration-driven behavior\n- Environment-appropriate error handling\n\n**6. Security & Compliance ✅**\n\n- Modern security patterns\n- Input validation best practices\n- Audit trail requirements\n- Compliance framework alignment\n\n**7. Code Quality Metrics ✅**\n\n- Approved PowerShell verb usage\n- Consistent style and formatting\n- Appropriate function complexity\n- Clear separation of concerns\n\n**Analysis Output:**\nProvide prioritized recommendations with:\n\n- ❌ Issues found with severity rating\n- ✅ Best practices already implemented\n- 🔧 Specific code corrections\n- 💡 Optimization opportunities\n- 📋 Compliance gaps\n\nInclude corrected code examples demonstrating proper modern PowerShell patterns.", "variables": [ "selection" ], "notes": "Comprehensive code quality analysis with expert-reviewed standards Mode: agent. Tools: codebase.", "metadata": { "source": { "provider": "github-prompts", "repository": "https://github.com/fadwen/TechbyJeff", "path": ".github/prompts/code-analysis.prompt.md", "ref": "7fd44a5d0858f119afec00e152e5dbdabd48b18b", "url": "https://github.com/fadwen/TechbyJeff/blob/7fd44a5d0858f119afec00e152e5dbdabd48b18b/.github/prompts/code-analysis.prompt.md", "key": "fadwen/TechbyJeff/.github/prompts/code-analysis.prompt.md" } } }

code-analysis

About

Use it

Manifest

Reviews