py-psscriptanalyzer

Contents

  • Installation
    • Prerequisites
      • Python
      • PowerShell
        • Windows
        • macOS
        • Linux
      • Verify PowerShell Installation
    • Install py-psscriptanalyzer
      • From PyPI (Recommended)
      • From Source
      • Verify Installation
    • Development Installation
    • Troubleshooting
      • PowerShell Not Found
      • PSScriptAnalyzer Module Missing
      • Permission Issues
      • Python Version Issues
    • Next Steps
  • Usage
    • Command Line Usage
      • Basic Commands
      • Command Line Options
      • Severity Levels
      • Environment Variables
      • Rule Filtering
        • By Category
        • By Specific Rules
      • Output Formats
        • Text Output (Default)
        • JSON Output
        • SARIF Output
      • Formatting
      • Recursive Processing
      • Exit Codes
      • Examples
        • Basic Analysis
        • Output to Files
        • Custom Rule Sets
    • Pre-commit Hook Usage
    • Integration with IDEs
      • VS Code
      • Other Editors
  • Configuration
    • Pre-commit Hook Configuration
      • Basic Setup
      • Severity Configuration
      • Environment Variables
      • Rule Category Filtering
      • Include/Exclude Rules
      • Output Formats
      • File Patterns and Exclusions
      • Advanced Examples
        • Environment-Specific Configuration
        • Multiple Output Formats
    • CI/CD Integration
      • GitHub Actions
      • Azure DevOps
      • GitLab CI
  • Development
    • Setting Up Development Environment
      • Prerequisites
      • Clone and Setup
      • Verify Installation
    • Project Structure
    • Development Workflow
      • 1. Create Feature Branch
      • 2. Make Changes
      • 3. Test Your Changes
      • 4. Test CLI Integration
      • 5. Update Documentation
      • 6. Submit Pull Request
    • Testing
      • Running Tests
      • Writing Tests
        • Unit Test Example
      • Integration Tests
    • Code Style and Quality
      • Code Formatting
      • Type Checking
      • Pre-commit Hooks
    • Documentation
      • Building Documentation
      • Writing Documentation
        • Docstring Style
    • Release Process
      • Version Management
      • Creating a Release
      • Publishing to PyPI
    • Contributing Guidelines
      • Pull Request Process
      • Commit Messages
      • Code Review
    • Debugging
      • Common Development Issues
        • PowerShell Not Found
        • PSScriptAnalyzer Module Issues
        • Test Failures
      • Logging and Debugging
  • Change Log
  • Change Log
    • [Unreleased]
    • [0.3.1] - 2025-08-14
      • Fixed
    • [0.3.0] - 2025-08-12
      • Added
    • [0.2.0] - 2025-08-11
      • Added
      • Changed
      • Fixed
    • [0.1.0] - 2025-08-11
      • Added
      • Technical Features
      • Documentation
      • Package Management
      • Command Line Interface
      • Quality Assurance
py-psscriptanalyzer
  • Search

© Copyright 2025, Chris McQuaid.

Built with Sphinx using a theme provided by Read the Docs.