Adding `sqeel_config` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add sqeel-config

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

sqeel-config = "0.2.8"

The sqeel_config library will be automatically available globally. Read the sqeel_config library documentation.

Back to the crate overview.

Readme

sqeel-config

Config and connection storage for sqeel — the vim-native SQL client.

Wraps hjkl-config's AppConfig trait to provide deep-merge TOML loading for ~/.config/sqeel/config.toml, XDG path resolution, and the connection-file store (~/.config/sqeel/conns/<name>.toml).

Library crate, consumed by sqeel-core. Part of the sqeel workspace.

Public API

Config loading

use sqeel_config::{load_main_config, MainConfig, EditorConfig};

// Loads ~/.config/sqeel/config.toml merged over bundled defaults.
// Missing file → bundled defaults. Never writes to disk.
let cfg: MainConfig = load_main_config()?;

println!("lsp: {}", cfg.editor.lsp_binary);
println!("leader: {:?}", cfg.editor.leader_key);

Connection storage

use sqeel_config::{load_connections, save_connection, delete_connection};

// List all saved connections.
for conn in load_connections()? {
    println!("{}: {}", conn.name, conn.url);
}

// Add or update a connection (file: ~/.config/sqeel/conns/<name>.toml).
save_connection("local", "postgres://localhost/mydb")?;

// Remove a connection.
delete_connection("local")?;

Path resolution

use sqeel_config::{config_dir, set_config_dir_override};

// Override config dir (used by --sandbox mode).
set_config_dir_override("/tmp/sqeel-sandbox-abc".into());

// Resolves to the override or ~/.config/sqeel/.
let dir = config_dir();

Key types

Type / fn	Purpose
`MainConfig`	Top-level config struct (`[editor]` section).
`EditorConfig`	Editor settings: LSP binary, leader key, scroll, etc.
`ConnectionConfig`	A single saved connection: `name` + `url`.
`load_main_config()`	Load and merge config from disk.
`load_connections()`	List all saved connections.
`save_connection()`	Write/update a connection file.
`delete_connection()`	Remove a connection file.
`config_dir()`	Resolve the active config directory.
`DEFAULTS_TOML`	Bundled default config string.

License

MIT

Adding sqeel_config library as a dependency

Adding `sqeel_config` library as a dependency