# `NeoFaker.App`
[🔗](https://github.com/muzhawir/neo_faker/blob/main/lib/neo_faker/app.ex#L1)

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.

# `author`
*since 0.4.0* 

```elixir
@spec author(Keyword.t()) :: 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.

## Parameters

- `opts` - Keyword list of options:
  - `:middle_name` - Include a middle name. Defaults to `false`.
  - `:sex` - Sex of the generated name. One of `:unisex` (default), `:female`, `:male`.
  - `:locale` - Locale to use. Defaults to the application's configured locale.

## Examples

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

    iex> NeoFaker.App.author(middle_name: true)
    "José Carlos Valim"

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

# `bundle_id`
*since 0.4.0* 

```elixir
@spec bundle_id(Keyword.t()) :: 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` and formatted
with the given `:style`. Only `:underscore` and `:dashed` styles are supported.

## Parameters

- `opts` - Keyword list of options:
  - `:domain` - Base domain. Defaults to `"example.com"`.
  - `:style` - Name style for the app segment. Either `:underscore` (default) or `:dashed`.

## 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`
*since 0.4.0* 

```elixir
@spec description(Keyword.t()) :: String.t()
```

Generates a random short app description.

Returns a one-line description string selected from locale-specific data.
Pass `locale:` to override 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* 

```elixir
@spec license() :: String.t()
```

Generates a random open-source license name.

Returns a name from a curated list sourced from
[ChooseALicense](https://choosealicense.com/appendix), such as
`"MIT License"`, `"Apache License 2.0"`, or `"GNU General Public License v3.0"`.

## Examples

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

# `name`
*since 0.4.0* 

```elixir
@spec name(Keyword.t()) :: 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.

## Parameters

- `opts` - Keyword list of options:
  - `:style` - Case style for the name. Defaults to `nil` (title-spaced).
  - `:locale` - Locale to use. Defaults to the application's configured locale.

## Options

The values for `:style` can be:

- `nil` - Title-spaced format, e.g. `"Neo Faker"` (default).
- `:camel_case` - e.g. `"neoFaker"`.
- `:pascal_case` - e.g. `"NeoFaker"`.
- `:dashed` - e.g. `"neo-faker"`.
- `:underscore` - e.g. `"neo_faker"`.
- `:single` - First word only, e.g. `"Faker"`.

## 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`
*since 0.4.0* 

```elixir
@spec package_name(Keyword.t()) :: 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.

## Parameters

- `opts` - Keyword list of options:
  - `:domain` - 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`
*since 0.4.0* 

```elixir
@spec semver(Keyword.t()) :: String.t()
```

Generates a random semantic version number.

Returns a version string following the [Semantic Versioning](https://semver.org)
(`MAJOR.MINOR.PATCH`) standard. Use `:type` to append pre-release or build metadata.

## Parameters

- `opts` - Keyword list of options:
  - `:type` - Version format variant. Defaults to `nil` (core only).

## Options

The values for `:type` can be:

- `nil` - Core `MAJOR.MINOR.PATCH` format, e.g. `"1.2.3"` (default).
- `: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"`.

## 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* 

```elixir
@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"

---

*Consult [api-reference.md](api-reference.md) for complete listing*