rubocop/rubocop
Rubocop
RuboCop is a static code analyzer, linter, and formatter for the Ruby language. It identifies style violations, smells, and errors in source code to ensure consistency and maintainability based on community guidelines.
The project provides automatic source code formatting to rewrite files according to defined stylistic standards. It also functions as a language server protocol implementation, surfacing violations and suggested fixes directly within code editors.
The tool covers code complexity monitoring to track the size of classes and methods and employs non-inclusive language detection to suggest alternative phrasing. It includes a configuration system for managing rule activation, file exclusions, and the generation of todo lists to track existing offenses for incremental cleanup.
Features
- Ruby Linters - Functions as a comprehensive Ruby linter that identifies smells and errors to ensure maintainability.
- Automated Linting Integrations - Provides automated style and syntax checks integrated into the development workflow to ensure code quality.
- Source Code Rewriting - Automatically rewrites Ruby source files to correct stylistic violations based on precise AST node coordinates.
- Automatic Code Formatters - Automatically rewrites Ruby source code to adhere to defined stylistic and syntactic formatting standards.
- Static Code Analyzers - Scans Ruby source code for style violations and complexity issues using automated linting.
- Ruby Code Standardization - Automatically rewrites Ruby source code to ensure consistent indentation, spacing, and stylistic standards.
- Code Style Guides - Allows defining specific linting rules and naming conventions to ensure adherence to project or community style guides.
- Style Guide Enforcers - Automatically enforces a strict community standard of Ruby code style to eliminate manual debates.
- Static Code Analysis - Provides automated scanning of Ruby source code to detect style and maintainability issues without executing the program.
- Rule Activation Controls - Offers mechanisms to toggle whether specific linting rules are enabled or disabled by default.
- Compliance Registries - Generates configuration files that record existing violations to facilitate incremental codebase cleanup.
- Language Server Protocols - Implements the Language Server Protocol to communicate analysis results and suggested fixes to editors in real-time.
- Language Servers - Implements a language server that surfaces style violations and suggested fixes directly within supported code editors.
- Code Complexity Metrics - Monitors the length of blocks, classes, and modules to prevent the creation of overly complex code structures.
- Rule Configuration Engines - Implements a system for managing and customizing the activation and parameters of diagnostic and stylistic rules via YAML.
- Technical Debt Registries - Generates a registry of existing offenses to track and ignore legacy debt while enforcing rules on new code.
