feolius/hell2shape

Generate PHPStan type annotations from var_dump output

v0.1.3 2025-12-31 12:14 UTC

Requires

• php: ^8.4
• symfony/console: ^8.0
• symfony/polyfill: ^1.33

Requires (Dev)

• phpstan/phpstan: ^2.1
• phpunit/phpunit: ^12.4
• symplify/easy-coding-standard: ^13.0

MIT

• Ivan Strygin

• var_dump
• static-analysis
• PHPStan
• type-annotations

README

Generate PHPStan type annotations from var_dump output

A CLI tool that analyzes PHP var_dump() output and generates PHPStan-compatible type annotations, helping you add type hints to legacy code or complex data structures.

Installation

composer require feolius/hell2shape

Requirements:

• PHP 8.4 or higher

Quick Start

php -r 'var_dump($myArray);' | vendor/bin/hell2shape

Usage

Pipe any var_dump() output to hell2shape:

# From a PHP script
php script.php | vendor/bin/hell2shape

# From a one-liner
php -r 'var_dump(["name" => "John", "age" => 30]);' | vendor/bin/hell2shape

Output Example

Input (var_dump):

array(2) {
  ["name"]=>
  string(4) "John"
  ["age"]=>
  int(30)
}

Output (PHPStan type):

array{
    name: string,
    age: int
}

Options

--indent / -i

Control indentation for multi-line output (default: 4 spaces)

# Single-line output
hell2shape --indent=0

# 2-space indentation
hell2shape -i 2

# Default 4-space indentation
hell2shape

--quotes

Control key quoting style in array shapes

# No quotes (default)
hell2shape --quotes=none
# Output: array{name: string}

# Single quotes
hell2shape --quotes=single
# Output: array{'name': string}

# Double quotes
hell2shape --quotes=double
# Output: array{"name": string}

Features

• ✅ Scalar types (int, string, bool, float, null)
• ✅ Arrays and nested arrays
• ✅ Array shapes with optional keys
• ✅ Objects (class names)
• ✅ stdClass objects as object shapes
• ✅ Lists with union types
• ✅ Complex nested structures
• ✅ Configurable formatting
• ✅ Resource types

Examples

Simple Array

php -r 'var_dump(["id" => 1, "name" => "Alice"]);' | hell2shape

Output:

array{
    id: int,
    name: string
}

Nested Structure

php -r 'var_dump(["user" => ["name" => "Bob", "roles" => ["admin", "user"]]]);' | hell2shape

Output:

array{
    user: array{
        name: string,
        roles: list<string>
    }
}

Single-line Output

php -r 'var_dump(["id" => 1, "active" => true]);' | hell2shape --indent=0

Output:

array{id: int, active: bool}

Optional Keys

When arrays have different structures, hell2shape marks missing keys as optional:

array{
    id: int,
    name: string,
    email?: string
}

Limitations

⚠️ Important: This tool provides a starting point for type annotations, not a complete solution.

• var_dump doesn't show all possible values, only the current state
• Union types are inferred from visible data only
• You should review and refine the generated types based on your actual usage
• Empty arrays are typed as array (not list<mixed>)

Development

# Run tests
vendor/bin/phpunit

# Run PHPStan
vendor/bin/phpstan analyse

# Run code style checks
vendor/bin/ecs check

License

MIT License - see LICENSE file for details

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.