squizlabs/PHP_CodeSniffer

Features

• Pattern Violation Scanning - Scans source code for structures that violate predefined coding standards and formatting rules.
• Static Code Analysis - Performs static scanning of PHP files to identify syntax violations and style errors without execution.
• Automated Lint Fixes - Corrects detected style and formatting errors automatically to bring code into compliance.
• CLI Coding Standard Validators - Provides a command-line interface for auditing PHP source code against defined sets of rules.
• PHP Formatters - Automatically corrects coding standard violations to bring PHP source code into compliance.
• PHP Linters - Tokenizes PHP code to detect and report violations of defined coding style guides.
• Lexical Tokenizers - Converts raw PHP source code into a stream of atomic tokens for structural inspection.
• Token Manipulation - Implements token manipulation to automatically correct formatting violations and rewrite source files.
• Coding Standards Enforcement - Enforces adherence to specific style guides and organizational standards across a PHP codebase.
• Coding Standards - Validates PHP code against one or more standards to ensure consistency and adherence to style guides.
• Rule-Based Token Analysis - Uses token-based lexical analysis to identify where PHP code deviates from defined formatting rules.
• Analysis File Extension Filters - Restricts analysis to specific file types by matching extensions to ensure only relevant files are scanned.
• File Exclusion Patterns - Skips specific directories or files using regular expression patterns to avoid scanning irrelevant code.
• Project Configuration - Supports loading analysis settings and coding standards from project-specific configuration files.
• Build Exit Code Controls - Allows configuring the return code for automated builds to prevent failures when only warnings are detected.
• Configuration File Loading - Loads rule definitions from external configuration files to define the analysis profile.
• Continuous Integration Checks - Integrates as a check within CI pipelines to catch style and syntax errors before deployment.
• Language Version Targeting - Allows the analyzer to apply rules compatible with the specific version of PHP used in a project.
• Recursive Directory Traversers - Recursively scans nested directory structures to identify files for analysis based on extensions.
• Rule Subset Selections - Enables running a selected subset of rules or excluding specific checks to isolate particular types of violations.
• Violation Reporters - Processes detected coding violations into various visual formats for human reading or machine automation.
• Violation Severity Management - Evaluates violation priority levels to determine which errors trigger build failures or are reported.
• Rule Suppression Comments - Provides inline source code comments to disable specific linting rules for targeted lines or blocks.
• Analysis Result Filtering - Adjusts which errors and warnings are displayed by filtering based on severity levels or hiding warnings.
• Detector Severity Thresholds - Filters analysis detectors based on a minimum severity level to hide low-priority findings.

Star history