ZealDocsets.CLI (zeal_docsets v0.1.7)

Shared argument parsing and report rendering helpers used by mix zeal.docs.

This module is not the primary public entrypoint of the package. The recommended interface is the Mix task made available when zeal_docsets is added as a development dependency to a project.

Summary

Functions

default_zeal_path()

Returns the default Zeal docsets path for the current platform.

exit_code(arg1)

Returns the process exit code for a run result.

parse_args(argv)

Parses CLI arguments into the project path, Zeal path, and options.

print_report(result)

Prints a human-readable execution report.

run(project_path, zeal_path, opts)

Runs the docset generation pipeline and returns a structured result.

Functions

default_zeal_path()

@spec default_zeal_path() :: Path.t()

Returns the default Zeal docsets path for the current platform.

exit_code(arg1)

@spec exit_code(ZealDocsets.Runner.run_result()) :: 0 | 1

Returns the process exit code for a run result.

parse_args(argv)

@spec parse_args([String.t()]) ::
  {:ok, Path.t(), Path.t(), keyword()} | {:error, String.t()}

Parses CLI arguments into the project path, Zeal path, and options.

print_report(result)

@spec print_report(ZealDocsets.Runner.run_result()) :: :ok

Prints a human-readable execution report.

The report includes the execution settings, the build summary, an optional note about docsets without custom icons, and any package-level failures.

run(project_path, zeal_path, opts)

@spec run(Path.t(), Path.t(), keyword()) :: ZealDocsets.Runner.run_result()

Runs the docset generation pipeline and returns a structured result.