carthage-software/mago
Mago
Mago is a PHP static analysis tool, linter, and code formatter. It detects type errors, dead code, and logic bugs through advanced type inference and flow analysis, while providing a deterministic engine to rewrite source files according to style guides.
The project distinguishes itself with a WebAssembly runtime that enables PHP analysis to execute entirely within a web browser, allowing results to be shared via URL. It also provides a minimal Dockerized toolchain distributed as a scratch image for consistent execution across different processor architectures.
The toolset covers architecture rule enforcement to prevent structural decay, automated violation fixes, and static type analysis involving generics and conditional types. It includes a rule-based linter and utilities for abstract syntax tree traversal and visualization.
Installation is supported via a Composer wrapper, shell scripts, system package managers, or manual binary downloads, with cryptographic attestation verification to ensure release authenticity.
Features
- Static Code Analysis - Provides advanced static analysis for PHP code to detect type errors, dead code, and logic bugs.
- Code Formatting and Linting - Enforces consistent coding standards and automatically fixes stylistic violations in PHP source files.
- Automated Lint Fixes - Automatically corrects detected lint violations in PHP source code to reduce manual cleanup effort.
- Code Formatting Tools - Enforces consistent indentation, spacing, and brace placement through automated source code formatting.
- Static Analysis Rules - Validates dependency rules and structural conventions defined in configuration to guard the project structure.
- Deterministic Formatters - Provides a deterministic formatting engine that rewrites source files to a consistent style guide.
- PHP Formatters - Provides a deterministic engine that rewrites PHP source files to follow standard style guides.
- PHP Linters - Scans PHP code against configurable rules to identify coding standard violations and apply automatic fixes.
- Browser-Based Runtimes - Executes PHP static analysis in the browser via WebAssembly and enables sharing results via URL.
- Static Code Linting - Scans PHP source files against configurable rules to detect coding standard violations and potential bugs.
- WebAssembly - Compiles the static analyzer to WebAssembly to enable serverless execution entirely within the browser.
- Architecture Rule Enforcement - Validates project structure and dependency rules to prevent architectural decay in large PHP codebases.
- Recursive AST Traversal - Implements recursive traversal of the abstract syntax tree to detect coding violations and apply automated fixes.
- Static Analysis Engines - Detects bugs, dead code, and type mismatches by evaluating generics, conditional types, and flow narrowing.
- Static Code Analysis Tools - Detects type errors, dead code, and logic bugs in PHP code using advanced type inference and flow analysis.
- Containerized Toolchains - Provides a minimal Docker image that packages the static analysis, linting, and formatting toolset for consistent execution.
- Docker Container Execution - Enables the execution of static analysis tools within minimal Docker containers across different architectures.
- Toolchain Images - Ships a minimal 26 MB Docker image packaging static analysis, linting, and formatting for PHP projects.
- Scratch-Based Images - Provides a minimal Docker image built from scratch for lightweight, multi-architecture deployment.
- Scratch Docker Images - Distributes the toolchain as a minimal scratch-based Docker image for multi-architecture compatibility.
- Browser-Based Runtimes - Runs PHP static analysis entirely in the web browser via WebAssembly to enable results sharing by URL.
- Signals & Reactivity - Utilizes a signals-based reactive system to propagate changes and enable efficient incremental analysis updates.
- Compile-Time Code Generation - Generates optimized PHP code and fixers during the build process to enhance runtime performance.
- Linting Rule Configurations - Supports project-specific linting and formatting rules loaded from external configuration files.
- Static Analysis - Improves developer experience through static analysis.
