GettextOps.Config (gettext_ops v0.1.1)

View Source

Configuration and path resolution for gettext_ops.

This module provides functions to read configuration from the Application environment and resolve paths to .po and .pot files in Phoenix's gettext directory structure.

Configuration

Configure gettext_ops in your config/config.exs:

config :gettext_ops,
  gettext_path: "priv/gettext",
  default_domain: "default"

Path Structure

gettext_ops follows Phoenix Gettext conventions:

  • .po files: priv/gettext/{locale}/LC_MESSAGES/{domain}.po
  • .pot template: priv/gettext/{domain}.pot

Examples

iex> GettextOps.Config.po_file_path("sv")
"priv/gettext/sv/LC_MESSAGES/default.po"

iex> GettextOps.Config.pot_file_path()
"priv/gettext/default.pot"

Summary

Functions

default_domain()

Get the default domain name.

gettext_path()

Get the configured gettext path.

list_locales()

List all available locales.

list_po_files()

List all available .po files.

locale_exists?(locale)

Check if a .po file exists for the given locale.

po_file_path(locale, domain \\ nil)

Resolve the path to a locale's .po file.

pot_file_path(domain \\ nil)

Find the path to a .pot template file.

Functions

default_domain()

@spec default_domain() :: String.t()

Get the default domain name.

Returns the default domain for .po files. Defaults to "default" if not configured.

Examples

iex> GettextOps.Config.default_domain()
"default"

gettext_path()

@spec gettext_path() :: String.t()

Get the configured gettext path.

Returns the path to the gettext directory. Defaults to "priv/gettext" if not configured.

Examples

iex> GettextOps.Config.gettext_path()
"priv/gettext"

list_locales()

@spec list_locales() :: [String.t()]

List all available locales.

Scans the gettext directory structure and returns a list of all locale codes found (directory names directly under the gettext path). Returns an empty list if the gettext directory doesn't exist.

list_po_files()

@spec list_po_files() :: [String.t()]

List all available .po files.

Recursively scans the gettext directory and returns paths to all .po files found. Returns an empty list if the gettext directory doesn't exist.

locale_exists?(locale)

@spec locale_exists?(locale :: String.t()) :: boolean()

Check if a .po file exists for the given locale.

Returns true if the locale directory exists under the configured gettext path, false otherwise.

po_file_path(locale, domain \\ nil)

@spec po_file_path(locale :: String.t(), domain :: String.t() | nil) :: String.t()

Resolve the path to a locale's .po file.

Returns the full path to a .po file for the given locale and domain. If domain is not provided, uses the configured default domain.

Examples

iex> GettextOps.Config.po_file_path("sv")
"priv/gettext/sv/LC_MESSAGES/default.po"

iex> GettextOps.Config.po_file_path("sv", "errors")
"priv/gettext/sv/LC_MESSAGES/errors.po"

pot_file_path(domain \\ nil)

@spec pot_file_path(domain :: String.t() | nil) :: String.t()

Find the path to a .pot template file.

Returns the path to the .pot template file for the given domain. If domain is not provided, uses the configured default domain.

Note: This returns the path regardless of whether the file exists. Use File.exists?/1 to check if the template file is present.

Examples

iex> GettextOps.Config.pot_file_path()
"priv/gettext/default.pot"

iex> GettextOps.Config.pot_file_path("errors")
"priv/gettext/errors.pot"