id       = "psysh"
name     = "PsySH"
homepage = "https://psysh.org"
# The project's own repository description.
description = "A REPL for PHP"
executables   = ["psysh"]

[dotfiles]

# The project's own wiki page on configuration
# (https://github.com/bobthecow/psysh/wiki/Configuration) says the global
# config file is `~/.config/psysh/config.php` on Unix-like systems and
# `C:\Users\{USER}\AppData\Roaming\PsySH\config.php` on Windows, and the
# companion Config-options page states that PsySH follows the XDG Base
# Directory specification with `~/.config/psysh` as the config directory and
# `~/.local/share/psysh` as the data directory.
#
# That is $XDG_CONFIG_HOME on Unix — macOS included, since PsySH is XDG
# everywhere rather than platform-native — and %APPDATA% on Windows, which is
# what [configHome] names. The Windows spelling the wiki gives capitalises the
# directory as `PsySH`; that is the same case-insensitive path this resolves to.
#
# The per-project `.psysh.php` the same page describes lives in the working
# directory, not the home directory, so it is not here. History and other
# persistent data go to the separate data directory, so nothing below needs
# carving out.
paths = ["[configHome]/psysh/config.php"]

exclude = []

# The config file is PHP returning an array of options — the prompt, the pager,
# the startup message, `commands`, `casters`. No account, no credential.
secret = []

# Read once when the shell starts, so a rewrite between sessions is harmless.
side_effect = false

# No machine_lines: the file is PHP, which neither `prefix` nor `key_path` can
# read meaningfully, and its settings are preferences rather than machine
# facts. A `pager` or `editor` option can name an absolute path, but PsySH's
# own examples use bare command names resolved from $PATH.