Raxol.Core.Standards.ConsistencyChecker (Raxol v2.0.1)

View Source

Automated code consistency checker for the Raxol codebase.

This module analyzes code files and reports inconsistencies with established coding standards.

Summary

Functions

Checks all Elixir files in a directory recursively.

Checks a single file for consistency issues.

Generates a detailed consistency report.

Types

issue()

@type issue() :: %{
  file: String.t(),
  line: non_neg_integer(),
  type: atom(),
  message: String.t(),
  severity: :error | :warning | :info
}

report()

@type report() :: %{total_files: non_neg_integer(), issues: [issue()], summary: map()}

Functions

check_directory(dir_path)

@spec check_directory(String.t()) :: {:ok, report()} | {:error, term()}

Checks all Elixir files in a directory recursively.

check_file(file_path)

@spec check_file(String.t()) :: {:ok, [issue()]} | {:error, term()}

Checks a single file for consistency issues.

generate_report(map)

@spec generate_report(report()) :: String.t()

Generates a detailed consistency report.