Documentation
¶
Overview ¶
Package config lee las preferencias de fast-folder-cli: un archivo TOML opcional (por defecto %APPDATA%\fast-folder-cli\config.toml) que cambia los valores de siempre. Sin archivo, todo funciona como si no existiera.
Index ¶
Constants ¶
const DefaultRecent = 5
DefaultRecent es cuántas carpetas recientes se ofrecen si el archivo no dice otra cosa.
const EnvVar = "FFC_CONFIG"
EnvVar es la variable de entorno que indica otro archivo de configuración (por ejemplo, en las pruebas).
Variables ¶
var Template string
Template es la plantilla comentada que crea fast --config: con todas las claves desactivadas, equivale a no tener archivo.
Functions ¶
func AddRecent ¶
AddRecent pone dir la primera de las carpetas recientes, sin repetirla, y guarda el archivo. Un archivo dañado se reemplaza.
func Create ¶
Create escribe la plantilla en path, creando su carpeta, si el archivo no existe. Devuelve true si lo creó; un archivo que ya existe no se toca.
func LoadRecent ¶
LoadRecent devuelve hasta limit carpetas recientes que aún existen, de la más reciente a la más antigua. Si el archivo no existe o está dañado devuelve nil: perder las recientes no impide usar el programa.
func Path ¶
Path devuelve la ruta del archivo de configuración: la de FFC_CONFIG o, si no está definida, config.toml en la carpeta de configuración del usuario (%APPDATA%\fast-folder-cli en Windows).
func RecentPath ¶
RecentPath devuelve la ruta del archivo de carpetas recientes.
Types ¶
type Config ¶
type Config struct {
Root string `toml:"ubicacion"` // carpeta por defecto, como -p
Exclude []string `toml:"excluir"` // carpetas que no se muestran ni se recorren
Editor string `toml:"editor"` // orden de la tecla v; vacía: VS Code
Terminal string `toml:"terminal"` // terminal de la tecla t; vacía: pwsh o powershell
Hidden bool `toml:"ocultas"` // incluir las carpetas ocultas y de sistema
Recent *int `toml:"recientes"` // carpetas recientes del formulario; nil: DefaultRecent
Locations []Location `toml:"ubicaciones"` // ubicaciones propias del formulario
}
Config son las preferencias del usuario. El valor cero de cada campo deja el comportamiento de siempre.
func LoadFile ¶
LoadFile lee y valida el archivo path. Si no existe, devuelve una Config vacía sin error. Si no se puede leer o tiene errores, devuelve una Config vacía junto con el error: quien llama avisa y sigue con los valores de siempre, porque un archivo mal escrito no debe dejar el programa inservible.
func (Config) RecentLimit ¶
RecentLimit devuelve cuántas carpetas recientes se ofrecen (0: ninguna).
Source Files