id       = "valet"
name     = "Laravel Valet"
homepage = "https://laravel.com/docs/valet"
description = "Laravel Valet is a development environment for macOS minimalists."
icon     = "SimpleIcons:laravel"
executables   = ["valet"]
platforms = ["macos"]

[dotfiles]

# https://laravel.com/docs/valet#valet-directories-and-files — "~/.config/valet
# contains all of Valet's configuration. You may wish to maintain a backup of
# this directory", "~/.config/valet/config.json … is Valet's master
# configuration file" and "~/.config/valet/Drivers/ … contains Valet's drivers.
# Drivers determine how a particular framework / CMS is served". The same
# directory is where cli/includes/helpers.php points VALET_HOME_PATH:
# define('VALET_HOME_PATH', $_SERVER['HOME'].'/.config/valet').
#
# Only those two are listed. The rest of the tree is generated or local state:
# Nginx/ ("rebuilt when running the install and secure commands"), Sites/ (one
# symlink per linked project), dnsmasq.d/, Log/ and the valet.sock PHP-FPM
# socket. Valet requires macOS, hence platforms.
paths = [
  "~/.config/valet/config.json",
  "~/.config/valet/Drivers/",
]

# cli/Valet/Configuration.php createCertificatesDirectory():
# VALET_HOME_PATH.'/Certificates'. `valet secure` writes the site key, CSR and
# certificate there, so the directory holds private keys. It is outside the two
# paths above, so nothing has to resolve a conflict.
secret = ["~/.config/valet/Certificates/"]

# config.json's "paths" is the list of parked directories — absolute paths on
# this Mac (Configuration.php addPath/prune store $PWD verbatim) — and
# "default" is "the path to the site that should serve as your default site",
# also absolute. tld and loopback are preferences and travel.
# Both are the user's own sites on this Mac, and the first thing they would
# want back when rebuilding it, so they are kept for this device alone.
[[dotfiles.machine_lines]]
file  = "~/.config/valet/config.json"
match = { key_path = ["paths", "default"] }
scope = "backup"

[commands]
format = 1
label = "Laravel Valet"
description = "Local Laravel development environment (macOS). Forms cover link, park and secure."
quality = "ai-draft"
base = "fig:valet"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false }

[[commands.source]]
id = "fig"
kind = "completion"
url = "https://github.com/withfig/autocomplete/blob/master/src/valet.ts"
license = "MIT"

[[commands.subcommand]]
path = ["link"]
label = "Link site"
description = "Link the current directory as a site."

[[commands.subcommand.source]]
id = "fig"
kind = "completion"
url = "https://github.com/withfig/autocomplete/blob/master/src/valet.ts"
license = "MIT"

[[commands.subcommand.field]]
id = "name"
label = "Site name"
description = "Defaults to the directory name."
type = "string"
position = 0
sources = ["fig"]

[[commands.subcommand.field]]
id = "secure"
label = "Secure (TLS)"
type = "boolean"
option = ["--secure"]
sources = ["fig"]

[[commands.subcommand.field]]
id = "isolate"
label = "Isolate PHP version"
type = "boolean"
option = ["--isolate"]
sources = ["fig"]

[[commands.subcommand.task]]
id = "link"
label = "Link"
fields = ["name", "secure"]
required = []

[[commands.subcommand.task]]
id = "link-secure"
label = "Link with TLS"
set = { secure = [true] }
fields = ["name", "secure"]
required = []

[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["name", "secure", "isolate"]

[[commands.subcommand]]
path = ["park"]
label = "Park directory"
description = "Register a directory whose subfolders become sites."

[[commands.subcommand.source]]
id = "fig"
kind = "completion"
url = "https://github.com/withfig/autocomplete/blob/master/src/valet.ts"
license = "MIT"

[[commands.subcommand.field]]
id = "path"
label = "Directory"
type = "path"
position = 0
path = { kind = "directory", role = "input" }
sources = ["fig"]

[[commands.subcommand.task]]
id = "park"
label = "Park"
fields = ["path"]
required = []

[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["path"]

[[commands.subcommand]]
path = ["secure"]
label = "Secure domain"
description = "Issue a trusted TLS certificate for a site."

[[commands.subcommand.source]]
id = "fig"
kind = "completion"
url = "https://github.com/withfig/autocomplete/blob/master/src/valet.ts"
license = "MIT"

[[commands.subcommand.field]]
id = "domain"
label = "Domain"
type = "string"
position = 0
sources = ["fig"]

[[commands.subcommand.task]]
id = "secure"
label = "Secure"
fields = ["domain"]
required = []

[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["domain"]