ReqLLM.Migration (ReqLLM v1.19.0)

View Source

Read-only V2 migration inventory for ReqLLM applications.

ledger/0 exposes the versioned, JSON-compatible deprecation ledger shipped with ReqLLM. audit/2 scans Elixir source without evaluating it and reports only the precise patterns represented in that ledger.

The audit never rewrites source, starts ReqLLM, resolves credentials, or makes provider requests. Its result is safe to encode directly as JSON.

Summary

Types

report()

Functions

audit(paths \\ ["."], opts \\ [])

Audits Elixir source paths for mechanical V2 migration work.

deprecations()

Returns the active deprecation records in ledger order.

exit_status(arg1)

Returns 0 for clean or advisory-only reports, 1 for migration work, and 2 for errors.

format_human(report)

Formats an audit report for terminal output.

ledger()

Returns the complete machine-readable deprecation and migration ledger.

migration_checks()

Returns the precise V2-readiness checks in ledger order.

Types

report()

@type report() :: %{required(String.t()) => term()}

Functions

audit(paths \\ ["."], opts \\ [])

@spec audit(
  Path.t() | [Path.t()],
  keyword()
) :: report()

Audits Elixir source paths for mechanical V2 migration work.

A path may be a file or directory. Directories are scanned recursively for .ex and .exs files. Dependency, build, VCS, coverage, and generated-doc directories are ignored by default.

Options

  • :exclude - a path or list of paths to omit

deprecations()

@spec deprecations() :: [map()]

Returns the active deprecation records in ledger order.

exit_status(arg1)

@spec exit_status(report()) :: 0 | 1 | 2

Returns 0 for clean or advisory-only reports, 1 for migration work, and 2 for errors.

format_human(report)

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

Formats an audit report for terminal output.

ledger()

@spec ledger() :: map()

Returns the complete machine-readable deprecation and migration ledger.

migration_checks()

@spec migration_checks() :: [map()]

Returns the precise V2-readiness checks in ledger order.