Ruby Style Guide

This project is a community-driven Ruby coding style guide and static analysis standard. It provides a collection of agreed-upon rules for syntax, naming conventions, and structural guidelines to ensure uniform code appearance and maintainability across Ruby projects.

The project serves as both a human-readable documentation resource for developers and a machine-readable RuboCop configuration specification. This allows natural language style guidelines to be mapped directly to automated linting rules.

The system covers Ruby code standardization, style enforcement, and project governance through the use of rule-based static analysis. It leverages RuboCop to programmatically identify and fix stylistic inconsistencies based on the established community standards.

Features

Coding Standards - Provides a curated collection of Ruby language conventions and formatting rules.
Static Analysis Standards - Defines agreed-upon naming and syntax conventions for identifying stylistic deviations in Ruby.
Static Analysis Rules - Evaluates source code against predefined patterns to identify stylistic deviations.
RuboCop Integration - Leverages RuboCop to programmatically enforce defined style rules.
Ruby Style Enforcement - Applies uniform guidelines to Ruby files to eliminate stylistic inconsistencies.
Linting Configuration Specifications - Provides a machine-readable RuboCop configuration specification mapped from natural language guidelines.
Community-Driven Specifications - Provides a community-driven specification for Ruby coding style and formatting.
Language-Specific Quality Standards - Establishes a community-consensual set of quality standards for Ruby code.
Ruby Code Standardization - Establishes a consistent set of formatting and structural rules for Ruby source code.
Coding Standards - Provides a collection of agreed-upon rules for Ruby syntax and naming conventions.
Linter Configuration Management - Defines machine-readable rules for RuboCop to automatically enforce coding styles.
Configuration-Driven Rules - Maps natural language style guidelines to a machine-readable RuboCop configuration file.
Static Code Analysis - Uses automated tools to evaluate source code against predefined patterns.
Ruby Programming Resources - Serves as a human-readable reference guide for Ruby best practices.
Documentation-Driven Standards - Uses human-readable guides as the primary reference for the linting configuration.
Project Governance Standards - Defines community-accepted standards for clean and maintainable Ruby code.
Coding Standards - Community-driven Ruby coding style guide.
Programming Language Guides - Comprehensive guide for writing idiomatic Ruby code.
Programming Languages - Community-driven style guide for Ruby coding.
Coding Style Guides - Standardized community coding style and conventions.

Star 历史

bbatsovruby-style-guide

Name: bbatsov/ruby-style-guide
Author: bbatsov

View on GitHub

16,546 星标3,351 分支11 次浏览rubystyle.guide

Ruby Style Guide

Features

Coding Standards - Provides a curated collection of Ruby language conventions and formatting rules.
Static Analysis Standards - Defines agreed-upon naming and syntax conventions for identifying stylistic deviations in Ruby.
Static Analysis Rules - Evaluates source code against predefined patterns to identify stylistic deviations.
RuboCop Integration - Leverages RuboCop to programmatically enforce defined style rules.
Ruby Style Enforcement - Applies uniform guidelines to Ruby files to eliminate stylistic inconsistencies.
Linting Configuration Specifications - Provides a machine-readable RuboCop configuration specification mapped from natural language guidelines.
Community-Driven Specifications - Provides a community-driven specification for Ruby coding style and formatting.
Language-Specific Quality Standards - Establishes a community-consensual set of quality standards for Ruby code.
Ruby Code Standardization - Establishes a consistent set of formatting and structural rules for Ruby source code.
Coding Standards - Provides a collection of agreed-upon rules for Ruby syntax and naming conventions.
Linter Configuration Management - Defines machine-readable rules for RuboCop to automatically enforce coding styles.
Configuration-Driven Rules - Maps natural language style guidelines to a machine-readable RuboCop configuration file.
Static Code Analysis - Uses automated tools to evaluate source code against predefined patterns.
Ruby Programming Resources - Serves as a human-readable reference guide for Ruby best practices.
Documentation-Driven Standards - Uses human-readable guides as the primary reference for the linting configuration.
Project Governance Standards - Defines community-accepted standards for clean and maintainable Ruby code.
Coding Standards - Community-driven Ruby coding style guide.
Programming Language Guides - Comprehensive guide for writing idiomatic Ruby code.
Programming Languages - Community-driven style guide for Ruby coding.
Coding Style Guides - Standardized community coding style and conventions.

Ruby Style Guide 的开源替代方案

相似的开源项目，按与 Ruby Style Guide 的功能重合度排序。

airbnb/ruby
airbnb/ruby
3,890在 GitHub 上查看
This project provides a collection of coding standard specifications, style guides, and configuration assets used to define automated rules for static code analysis in Ruby. It serves as a centralized set of RuboCop configurations and static analysis rules to ensure consistent syntax and idiomatic usage across a codebase. The project establishes a comprehensive Ruby style guide that defines naming conventions, indentation, and structural requirements. It utilizes a pluggable linting engine to enforce these standards through a defined set of patterns and constraints. The capability surface co
Ruby
在 GitHub 上查看3,890
thoughtbot/guides
thoughtbot/guides
9,556在 GitHub 上查看
This project is a software engineering style guide and a curated collection of architectural patterns and coding standards. It provides a multi-language coding standard to ensure maintainable software across Ruby, Python, JavaScript, and Swift. The project establishes a development workflow specification for version control, continuous integration, and peer review to maintain a linear project history. It also includes a web accessibility framework based on ARIA and WCAG standards, using design tokens and semantic HTML patterns to build inclusive interfaces. The guides cover a broad range of
Ruby
在 GitHub 上查看9,556
rubocop/ruby-style-guide
rubocop/ruby-style-guide
16,546在 GitHub 上查看
This project is a community-driven style guide that defines standards for formatting and structuring Ruby code. It serves as a collection of language conventions and best practices intended to ensure that Ruby applications are written idiomatically and maintainably. The guide functions as a static analysis standard, providing a reference that automated linting tools use to enforce uniform coding patterns and structural rules. By mapping written guidelines to these automated configurations, it establishes a shared source of truth for code consistency. The scope of the project covers Ruby code
rubocoprubystyle-guide
在 GitHub 上查看16,546
bbatsov/rails-style-guide
bbatsov/rails-style-guide
6,509在 GitHub 上查看
This project is a collection of community-driven coding standards and best practices for developing maintainable Ruby on Rails applications. It serves as a style guide, architecture reference, and development guide to ensure consistency across a codebase. The guide provides technical recommendations for establishing naming conventions and architectural patterns. It specifically focuses on organizing models, controllers, and views to separate business logic from data persistence and user interface presentation. The documentation covers a broad range of capabilities, including RESTful API desi
在 GitHub 上查看6,509

查看 Ruby Style Guide 的所有 30 个替代方案

常见问题解答

bbatsov/ruby-style-guide 是做什么的？

bbatsov/ruby-style-guide 的主要功能有哪些？

bbatsov/ruby-style-guide 的主要功能包括：Coding Standards, Static Analysis Standards, Static Analysis Rules, RuboCop Integration, Ruby Style Enforcement, Linting Configuration Specifications, Community-Driven Specifications, Language-Specific Quality Standards。

bbatsov/ruby-style-guide 有哪些开源替代品？

bbatsov/ruby-style-guide 的开源替代品包括： airbnb/ruby — This project provides a collection of coding standard specifications, style guides, and configuration assets used to… thoughtbot/guides — This project is a software engineering style guide and a curated collection of architectural patterns and coding… rubocop/ruby-style-guide — This project is a community-driven style guide that defines standards for formatting and structuring Ruby code. It… bbatsov/rails-style-guide — This project is a collection of community-driven coding standards and best practices for developing maintainable Ruby… rwaldron/idiomatic.js — This project is a JavaScript style guide and a set of coding standards designed to ensure codebase consistency. It… bbatsov/rubocop — RuboCop is a static code analyzer and linter for Ruby. It functions as a static analysis tool designed to detect…