Name: Alphabetically Ordered Aliases
Author: blockscout

Overview

Elixir code style conventions prefer that module aliases are alphabetically ordered within their groups. This improves code readability, maintainability, and consistency. Credo checks for this ordering and warns when aliases are not properly alphabetized.

When to Use

When addressing Credo warning: "The alias is not alphabetically ordered among its group"
When organizing module aliases at the top of a file
When multiple aliases from related modules are defined together
When refactoring code to improve consistency and readability

Anti-Patterns (Avoid These)

defmodule Explorer.Migrator.HeavyDbIndexOperation.RenameTransactions do
  # ❌ BAD: Aliases not alphabetically ordered
  alias Explorer.Chain.Cache.BackgroundMigrations
  alias Explorer.Migrator.{HeavyDbIndexOperation, MigrationStatus}
  alias Explorer.Migrator.HeavyDbIndexOperation.Helper
  alias Explorer.Migrator.HeavyDbIndexOperation.DropTransactionsIndex
  alias Explorer.Repo
end

# In the above, "Helper" comes after "DropTransactionsIndex" 
# alphabetically, but it's listed before it. Correct order should be:
# - DropTransactionsIndex (D < H)
# - Helper (H)

Overview

When to Use

When addressing Credo warning: "The alias is not alphabetically ordered among its group"
When organizing module aliases at the top of a file
When multiple aliases from related modules are defined together
When refactoring code to improve consistency and readability

Anti-Patterns (Avoid These)

defmodule Explorer.Migrator.HeavyDbIndexOperation.RenameTransactions do
  # ❌ BAD: Aliases not alphabetically ordered
  alias Explorer.Chain.Cache.BackgroundMigrations
  alias Explorer.Migrator.{HeavyDbIndexOperation, MigrationStatus}
  alias Explorer.Migrator.HeavyDbIndexOperation.Helper
  alias Explorer.Migrator.HeavyDbIndexOperation.DropTransactionsIndex
  alias Explorer.Repo
end

# In the above, "Helper" comes after "DropTransactionsIndex" 
# alphabetically, but it's listed before it. Correct order should be:
# - DropTransactionsIndex (D < H)
# - Helper (H)

Alphabetically Ordered Aliases

Overview

When to Use

Anti-Patterns (Avoid These)

Alphabetically Ordered Aliases

Overview

When to Use

Anti-Patterns (Avoid These)

Best Practices (Use These)

How to Implement

Step 1: Identify alias groups

Step 2: Sort alphabetically within each group

Step 3: Reorder in code

Step 4: Verify with Credo

Example Violations and Fixes

Violation 1: Helper before DropTransactions

Violation 2: Mixed ordering in group

References

Openclaw Release Maintainer

Verify

Flow

Fix

Hygiene

Add Policy

Alphabetically Ordered Aliases

Overview

When to Use

Anti-Patterns (Avoid These)

Alphabetically Ordered Aliases

Overview

When to Use

Anti-Patterns (Avoid These)

Best Practices (Use These)

How to Implement

Step 1: Identify alias groups

Step 2: Sort alphabetically within each group

Step 3: Reorder in code

Step 4: Verify with Credo

Example Violations and Fixes

Violation 1: Helper before DropTransactions

Violation 2: Mixed ordering in group

Related Skills

References

Openclaw Release Maintainer

Verify

Flow

Fix

Hygiene

Add Policy