christopheradams/elixir_style_guide

Features

• Elixir Linters - Functions as a utility for identifying naming, formatting, and layout errors in Elixir files.
• Static Source Analysis - Analyzes source code without execution to detect structural inconsistencies and style violations.
• Code Formatting and Linting - Identifies style violations and formatting errors in source files to enforce a unified visual structure.
• Static Code Analysis - Scans Elixir files without execution to identify style violations and structural inconsistencies.
• Elixir Code Formatting Specifications - Defines rules for whitespace, indentation, and module layout to create a uniform visual structure.
• Elixir Code Standardization - Provides a standardized system for casing, prefixes, and formatting to ensure consistency across Elixir codebases.
• Elixir Naming Conventions - Enforces a standardized system for casing and prefixes used in files, functions, and variables.
• Elixir Static Analyzers - Scans Elixir source code without execution to detect structural inconsistencies and style violations.
• Module Organization - Arranges attributes, directives, and macros in a logical order to clarify the relationship between modules and files.
• Internal Definition Ordering - Organizes code by limiting each file to one module and prescribing the internal order of definitions.
• Lexical Layout Validations - Checks the specific ordering of module directives and attributes to ensure a consistent internal file structure.
• Code Documentation Standards - Sets requirements for module descriptions and punctuation to ensure functions are documented consistently.
• Documentation Standards - Establishes requirements for module and function descriptions using specific attributes and formatted text blocks.
• Naming Conventions - Applies consistent casing rules to files, functions, and variables to maintain clarity.
• Identifier Casing Enforcement - Validates that variable and function names adhere to specific casing rules through static analysis.
• Source Code Formatting - Applies rules for whitespace, indentation, and line length to create a consistent visual structure.
• Variable Naming Conventions - Dictates casing and prefix patterns for variables and booleans to ensure semantic consistency.
• Metadata Scanning - Scans module and function attributes to ensure required documentation blocks and type definitions are present.
• Comment Formatting Utilities - Formats comments and technical debt annotations using a consistent set of uppercase keywords and markers.
• Idiomatic Elixir Development - Guides the use of best practices for control-flow structures and collection syntax to improve readability.
• Documentation Governance Frameworks - Establishes requirements for module and function descriptions to maintain professional and uniform technical documentation.
• Idiomatic Coding Standards - Applies best practices for control-flow structures and collection syntax to improve code readability.
• Rule-Based Pattern Matching - Identifies naming and formatting violations by comparing source code patterns against regular expression rules.
• Regular Expression Validations - Uses regular expression validations to identify naming and formatting violations in source code.
• Type Specifications - Creates guidelines for declaring custom types to assist static analysis tools and developers.

Star history