NeoFaker.App (neo_faker v0.15.0)

Copy Markdown View Source

Functions for generating app metadata.

Provides utilities to generate random app-related information, including author names, app names, descriptions, versions, licenses, bundle identifiers, and package names with support for multiple locales and formatting options.

Summary

Functions

Generates a random app author name.

Generates a random app bundle identifier.

Generates a random short app description.

Generates a random open-source license name.

Generates a random app name.

Generates a random app package name.

Generates a random semantic version number.

Generates a simplified MAJOR.MINOR version number.

Functions

author(opts \\ [])

(since 0.4.0)
@spec author(keyword()) :: String.t()

Generates a random app author name.

Delegates to NeoFaker.Person.full_name/1, with :middle_name defaulting to false for cleaner attribution strings. Accepts the same options as full_name/1.

Options

  • :middle_name (boolean) - whether to include a middle name. Defaults to false.
  • :sex (:unisex, :female, or :male) - the sex of the generated name. Defaults to :unisex.
  • :locale (atom) - the locale to use. Defaults to the application's configured locale.

Examples

iex> NeoFaker.App.author()
"José Valim"

iex> NeoFaker.App.author(middle_name: true)
"Joshua Peter Bennet"

iex> NeoFaker.App.author(sex: :female)
"Juliana Silva"

bundle_id(opts \\ [])

(since 0.4.0)
@spec bundle_id(keyword()) :: String.t()

Generates a random app bundle identifier.

Returns a bundle ID in reverse-domain notation, commonly used for iOS and Android apps. The app name portion is generated via name/1.

Options

  • :domain (string) - the base domain. Defaults to "example.com".
  • :style (:underscore or :dashed) - the name style for the app segment. Defaults to :underscore.

Examples

iex> NeoFaker.App.bundle_id()
"com.example.neo_faker"

iex> NeoFaker.App.bundle_id(style: :dashed)
"com.example.neo-faker"

iex> NeoFaker.App.bundle_id(domain: "mycompany.io")
"io.mycompany.neo_faker"

description(opts \\ [])

(since 0.4.0)
@spec description(keyword()) :: String.t()

Generates a random short app description.

Returns a one-line description string selected from locale-specific data.

Options

  • :locale (atom) - the locale to use. Defaults to the application's configured locale.

Examples

iex> NeoFaker.App.description()
"Elixir library for generating fake data in tests and development."

iex> NeoFaker.App.description(locale: :id_id)
"Pustaka Elixir untuk menghasilkan data palsu dalam pengujian dan pengembangan."

license()

(since 0.4.0)
@spec license() :: String.t()

Generates a random open-source license name.

Returns a name from a curated list sourced from ChooseALicense, such as "MIT License", "Apache License 2.0", or "GNU General Public License v3.0".

Examples

iex> NeoFaker.App.license()
"MIT License"

name(opts \\ [])

(since 0.4.0)
@spec name(keyword()) :: String.t()

Generates a random app name.

Combines a random first word and last word from locale-specific data, then formats the result according to the requested style.

Options

  • :style (nil, :camel_case, :pascal_case, :dashed, :underscore, or :single) - the case style for the name. nil produces a title-spaced format (e.g. "Neo Faker"); :single returns the first word only (e.g. "Faker"). Defaults to nil.
  • :locale (atom) - the locale to use. Defaults to the application's configured locale.

Examples

iex> NeoFaker.App.name()
"Neo Faker"

iex> NeoFaker.App.name(style: :camel_case)
"neoFaker"

iex> NeoFaker.App.name(style: :dashed)
"neo-faker"

iex> NeoFaker.App.name(locale: :id_id)
"Garuda Web"

package_name(opts \\ [])

(since 0.4.0)
@spec package_name(keyword()) :: String.t()

Generates a random app package name.

Returns a package name in Java reverse-domain notation (e.g. for Android apps). The app name segment is lowercased and stripped of all non-alphanumeric characters.

Options

  • :domain (string) - the base domain. Defaults to "example.com".

Examples

iex> NeoFaker.App.package_name()
"com.example.neofaker"

iex> NeoFaker.App.package_name(domain: "mycompany.id")
"id.mycompany.neofaker"

semver(opts \\ [])

(since 0.4.0)
@spec semver(keyword()) :: String.t()

Generates a random semantic version number.

Returns a version string following the Semantic Versioning (MAJOR.MINOR.PATCH) standard.

Options

  • :type (nil, :pre_release, :build, or :pre_release_build) - which metadata to append. nil returns the core version only (e.g. "1.2.3"); :pre_release appends a pre-release label (e.g. "1.2.3-beta.1"); :build appends build metadata (e.g. "1.2.3+20250325"); :pre_release_build appends both (e.g. "1.2.3-rc.1+20250325"). Defaults to nil.

Examples

iex> NeoFaker.App.semver()
"1.2.3"

iex> NeoFaker.App.semver(type: :pre_release)
"1.2.3-beta.1"

iex> NeoFaker.App.semver(type: :build)
"1.2.3+20250325"

iex> NeoFaker.App.semver(type: :pre_release_build)
"1.2.3-rc.1+20250325"

version()

(since 0.4.0)
@spec version() :: String.t()

Generates a simplified MAJOR.MINOR version number.

Derives the version by taking the first two components of a semver/1 result.

Examples

iex> NeoFaker.App.version()
"1.2"