diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 0a7e4cabe9..444963dc57 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -124,6 +124,14 @@ jobs: run: | ${{ steps.build-devenv.outputs.path }}/bin/devenv --system ${{ inputs.system }} shell -- cargo nextest run -j 4 --features devenv/test-all --retries 3 + # devenv-tasks is outside Cargo's default workspace members. Run its + # process scheduling regressions explicitly on Linux and macOS. + - name: Check concurrent process scheduling + run: | + ${{ steps.build-devenv.outputs.path }}/bin/devenv --system ${{ inputs.system }} shell -- \ + cargo nextest run -p devenv-tasks -j 2 --retries 0 \ + -E 'test(concurrent_dynamic_starts_share_never_started_process_prerequisite) | test(concurrent_start_stop_keeps_explicitly_stopped_dependencies_off)' + # Exercise the actual terminal boundary on every platform: PTY resize, # crossterm key decoding, rendering, and reactive process commands. - name: Run deterministic TUI replay regression diff --git a/CHANGELOG.md b/CHANGELOG.md index 895d383c25..5d7e522cce 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,11 +2,19 @@ ## 2.4.1 (unreleased) +### Improvements + +- Added the `tui.emoji` user setting. Set it to `false` to replace the emoji in the interactive shell status line, such as the eye in `devenv watching 11 files`, with non-emoji Unicode glyphs. It defaults to `true`, and the status line stays visible with file watching and automatic reload unchanged. + ### Bug Fixes +- Task cancellation now stops status checks and waits for nested commands to stop before the scheduler exits ([#3251](https://github.com/cachix/devenv/issues/3251)). +- Fixed rapid process restarts failing because a stopped process still held its ownership claim. +- Starting a process on demand now starts never-started, enabled process dependencies. Explicitly stopped and disabled dependencies stay off ([#3229](https://github.com/cachix/devenv/issues/3229)). +- Fixed `devenv machines install` hanging while uploading store paths when no SSH connection was already open ([#3254](https://github.com/cachix/devenv/issues/3254)). - Nushell hot reload no longer breaks commands that use structured environment variables and now removes variables that disappeared after a reload ([#3230](https://github.com/cachix/devenv/issues/3230)). - MySQL now creates configured databases and users when started with `devenv up`, including `devenv up mysql` ([#2843](https://github.com/cachix/devenv/issues/2843)). -- fish auto-activation no longer hangs when `env` is a fish function, such as grc's wrapper ([#3222](https://github.com/cachix/devenv/issues/3222)). +- fish auto-activation no longer hangs when `env` is a fish function, such as grc's wrapper; `cat`, `rm` and `devenv` functions are bypassed too ([#3222](https://github.com/cachix/devenv/issues/3222)). - Task names containing `::`, such as `foo::bar`, are now rejected with an invalid task name error. Previously they were accepted but could not be run by name ([#3227](https://github.com/cachix/devenv/issues/3227)). - Detached process startup now publishes the manager as soon as processes are scheduled, without waiting for service readiness, and keeps HTTPS proxy routes during a slow startup ([#3216](https://github.com/cachix/devenv/issues/3216)). - `devenv test` with the native process manager now reports a process dependency on `start.enable = false` before starting services, instead of waiting indefinitely for the disabled process ([#3215](https://github.com/cachix/devenv/issues/3215)). diff --git a/devenv-processes/src/manager.rs b/devenv-processes/src/manager.rs index e2c1794579..a8af2ff909 100644 --- a/devenv-processes/src/manager.rs +++ b/devenv-processes/src/manager.rs @@ -233,6 +233,8 @@ pub struct JobHandle { pub status_rx: tokio::sync::watch::Receiver, /// Supervisor task handling restarts pub supervisor_task: JoinHandle<()>, + /// Job controller task, joined before publishing a completed stop. + pub job_task: JoinHandle<()>, /// Channel to send lifecycle commands (restart/stop) into the supervisor loop. pub cmd_tx: mpsc::Sender, /// Output reader tasks (stdout, stderr) @@ -344,6 +346,7 @@ fn lifecycle_phase(terminal_phase: Option) -> ProcessPhase { /// Resources consumed by [`ProcessRunner::finish_stop`]. struct StopParts { job: Arc, + job_task: JoinHandle<()>, cmd_tx: mpsc::Sender, supervisor_task: JoinHandle<()>, notify_forwarder: JoinHandle<()>, @@ -371,6 +374,7 @@ fn take_active_for_stop( resources, cmd_tx, supervisor_task, + job_task, notify_forwarder, output_readers, .. @@ -398,6 +402,7 @@ fn take_active_for_stop( StopParts { job, + job_task, cmd_tx, supervisor_task, notify_forwarder, @@ -780,6 +785,7 @@ async fn wait_for_port_conflicts_to_settle(ports: &[u16], timeout: Duration) -> /// Everything a launch produces before the entry settles to Active. struct LaunchSetup { job: Arc, + job_task: JoinHandle<()>, status_tx: tokio::sync::watch::Sender, status_rx: tokio::sync::watch::Receiver, notify_socket: Option>, @@ -798,6 +804,9 @@ impl LaunchSetup { self.stdout_tailer.abort(); self.stderr_tailer.abort(); crate::process_guardian::stop_job(&self.job, &self.scopes, &self.shutdown).await; + self.job.unset_spawn_child_fn().await; + self.job.delete().await; + let _ = self.job_task.await; } } @@ -1395,6 +1404,7 @@ impl ProcessRunner { status_rx: setup.status_rx, cmd_tx, supervisor_task, + job_task: setup.job_task, output_readers: Some((setup.stdout_tailer, setup.stderr_tailer)), notify_forwarder, }), @@ -1479,7 +1489,7 @@ impl ProcessRunner { let _ = std::fs::write(&proc_cmd.stdout_log, ""); let _ = std::fs::write(&proc_cmd.stderr_log, ""); - let (job, _task) = start_job(proc_cmd.command); + let (job, job_task) = start_job(proc_cmd.command); let job = Arc::new(job); let scopes = Arc::new(crate::process_guardian::ProcessScopeRegistry::default()); @@ -1597,7 +1607,9 @@ impl ProcessRunner { job.start().await; if let Ok(error) = start_error_rx.try_recv() { + job.unset_spawn_child_fn().await; job.delete().await; + let _ = job_task.await; bail!("Failed to spawn process '{}': {}", config.name, error); } // Spawn file tailers to emit output to activity @@ -1618,6 +1630,7 @@ impl ProcessRunner { Ok(LaunchSetup { job, + job_task, status_tx, status_rx, notify_socket, @@ -1637,6 +1650,7 @@ impl ProcessRunner { async fn finish_stop(&self, name: &str, parts: StopParts) { let StopParts { job, + job_task, cmd_tx, supervisor_task, notify_forwarder, @@ -1655,6 +1669,12 @@ impl ProcessRunner { } crate::process_guardian::stop_job(&job, &scopes, &shutdown).await; + // The controller's spawn hook owns the process claim. Dropping the + // last job handle only queues its exit, so a rapid restart can race + // that release. Join the controller before making Stopped visible. + job.unset_spawn_child_fn().await; + job.delete().await; + let _ = job_task.await; if !ports.is_empty() { let release_status = @@ -3124,8 +3144,19 @@ mod tests { let manager = ProcessRunner::new(temp_dir.path().to_path_buf()).unwrap(); let config = long_running_config("restartable"); - manager.start_command(&config, None).await.unwrap(); + // A caller may still hold its launch result when stop finishes. + let original_job = manager.start_command(&config, None).await.unwrap().unwrap(); assert!(manager.list().await.contains(&"restartable".to_string())); + // A custom spawner can hold ownership too, and is shared with the + // retained job handle independently of the controller task. + let custom_owner = Arc::new(()); + let owner = Arc::downgrade(&custom_owner); + original_job + .set_spawn_child_fn(move |_| { + let _owner = &custom_owner; + Err(std::io::Error::other("stopped job must not spawn")) + }) + .await; manager.stop_and_keep("restartable").await.unwrap(); assert_eq!( @@ -3133,12 +3164,20 @@ mod tests { Some(ProcessPhase::Stopped) ); + assert!( + owner.upgrade().is_none(), + "stopped job retained its custom spawner" + ); manager.start_not_started("restartable").await.unwrap(); assert!( manager.list().await.contains(&"restartable".to_string()), "process should be active again after restart" ); + assert!( + original_job.is_dead(), + "stopped job must release its ownership claim" + ); let _ = manager.stop_all().await; } diff --git a/devenv-run-tests/src/main.rs b/devenv-run-tests/src/main.rs index 3b16519abc..c49bc0a40b 100644 --- a/devenv-run-tests/src/main.rs +++ b/devenv-run-tests/src/main.rs @@ -555,18 +555,30 @@ async fn run_tests_in_directory(args: &RunArgs) -> Result> { // Run .patch.sh if it exists (must run before loading config) let patch_script = PathBuf::from(".patch.sh"); - if patch_script.exists() { + let patch_result = if patch_script.exists() { devenv_activity::message(ActivityLevel::Info, "Running .patch.sh"); let mut command = tokio::process::Command::new("bash"); command.arg(&patch_script); with_test_env_path(&mut command); - let _ = command.status().await.into_diagnostic()?; - } + let status = command.status().await.into_diagnostic()?; + if status.success() { + Ok(()) + } else { + Err(miette::miette!( + "Patch script failed. Status code: {}", + status.code().unwrap_or(1) + )) + } + } else { + Ok(()) + }; // A script to run inside the shell before the test. let setup_script = ".setup.sh"; - let status: miette::Result<()> = if test_config.use_shell { + let status: miette::Result<()> = if let Err(error) = patch_result { + Err(error) + } else if test_config.use_shell { // Now load config from the current directory (which might be temp dir) let mut config = Config::load_from(&devenv_root)?; for input in args.override_inputs.chunks_exact(2) { diff --git a/devenv-shell/src/indicators.rs b/devenv-shell/src/indicators.rs new file mode 100644 index 0000000000..f2ba373344 --- /dev/null +++ b/devenv-shell/src/indicators.rs @@ -0,0 +1,127 @@ +//! Display indicators that have an emoji and a non-emoji form. +//! +//! Renderers ask [`Indicators`] for a glyph instead of hard-coding one, so the +//! `tui.emoji` user setting is applied in exactly one place. +//! +//! Emoji glyphs are not width-stable: terminals disagree on whether they occupy +//! one or two cells, and Unicode width tables report one. The non-emoji glyphs +//! are plain symbols that occupy a single cell, like the checkmark and spinner +//! already used by the status line, so the label that follows lines up with +//! every other status. + +use crate::status_line::{DOT_RING, DOT_RUNNING}; + +/// A display indicator with an emoji and a non-emoji form. +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub enum Indicator { + /// File watching is paused. + Paused, + /// Files are being watched for changes. + Watching, +} + +impl Indicator { + /// Every indicator. + pub const ALL: [Indicator; 2] = [Indicator::Paused, Indicator::Watching]; +} + +/// A glyph and the space that separates it from the label that follows. +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub struct Glyph { + /// The text to draw. + pub text: &'static str, + /// Columns between the glyph and its label. + pub gap: u32, +} + +/// Selects the glyph used for each [`Indicator`]. +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub struct Indicators { + emoji: bool, +} + +impl Indicators { + /// Select emoji glyphs when `emoji` is true and non-emoji glyphs otherwise. + pub const fn new(emoji: bool) -> Self { + Self { emoji } + } + + /// Whether emoji glyphs are selected. + pub const fn emoji(self) -> bool { + self.emoji + } + + /// The glyph for `indicator`. + pub const fn glyph(self, indicator: Indicator) -> Glyph { + match (self.emoji, indicator) { + // The historical glyphs and spacing. + (true, Indicator::Paused) => Glyph { + text: "⏸", gap: 2 + }, + (true, Indicator::Watching) => Glyph { + text: "👁", gap: 2 + }, + // The status dots used for process states: alive while watching, + // an idle ring while paused. They are single-cell symbols, so the + // label starts in the same column as after the checkmark, cross, + // and spinner. + (false, Indicator::Paused) => Glyph { + text: DOT_RING, + gap: 1, + }, + (false, Indicator::Watching) => Glyph { + text: DOT_RUNNING, + gap: 1, + }, + } + } +} + +impl Default for Indicators { + /// Emoji glyphs, preserving the existing output. + fn default() -> Self { + Self::new(true) + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn defaults_to_emoji() { + assert_eq!(Indicators::default(), Indicators::new(true)); + assert!(Indicators::default().emoji()); + } + + #[test] + fn emoji_glyphs_are_the_historical_ones() { + let indicators = Indicators::new(true); + assert_eq!(indicators.glyph(Indicator::Paused).text, "⏸"); + assert_eq!(indicators.glyph(Indicator::Watching).text, "👁"); + } + + #[test] + fn non_emoji_glyphs_are_single_non_emoji_characters() { + for indicator in Indicator::ALL { + let glyph = Indicators::new(false).glyph(indicator); + let mut chars = glyph.text.chars(); + assert!(chars.next().is_some()); + assert!( + chars.next().is_none(), + "{indicator:?} must be one character" + ); + assert_eq!(glyph.gap, 1); + } + } + + #[test] + fn glyphs_differ_between_modes() { + for indicator in Indicator::ALL { + assert_ne!( + Indicators::new(true).glyph(indicator), + Indicators::new(false).glyph(indicator) + ); + } + } +} diff --git a/devenv-shell/src/lib.rs b/devenv-shell/src/lib.rs index 4fc4ecaef6..d33d921721 100644 --- a/devenv-shell/src/lib.rs +++ b/devenv-shell/src/lib.rs @@ -6,6 +6,7 @@ pub mod dialect; pub mod escape; pub mod escape_state; +pub mod indicators; pub mod keybindings; mod protocol; mod pty; diff --git a/devenv-shell/src/session.rs b/devenv-shell/src/session.rs index 3a507c1088..273d260a90 100644 --- a/devenv-shell/src/session.rs +++ b/devenv-shell/src/session.rs @@ -8,6 +8,7 @@ use crate::escape_state::{ EscapeState, cleanup_forwarded_modes as escape_state_cleanup, process_escape_events as escape_state_process, }; +use crate::indicators::Indicators; use crate::keybindings::{ShellAction, ShellKeybindings}; use crate::protocol::{ShellCommand, ShellEvent}; use crate::pty::{Pty, PtyError, get_terminal_size}; @@ -1642,6 +1643,12 @@ impl ShellSession { self } + /// Select the glyphs used for status-line indicators. + pub fn with_indicators(mut self, indicators: Indicators) -> Self { + self.status_line.set_indicators(indicators); + self + } + /// Wire a shutdown token. On cancellation the session kills the inner /// shell so devenv can exit instead of orphaning it after a terminal /// hangup or SIGHUP/SIGINT/SIGTERM. diff --git a/devenv-shell/src/status_line.rs b/devenv-shell/src/status_line.rs index 44e20f94af..a12c8ad8e7 100644 --- a/devenv-shell/src/status_line.rs +++ b/devenv-shell/src/status_line.rs @@ -12,6 +12,7 @@ use std::io::{self, Write}; use std::path::PathBuf; use std::time::Instant; +use crate::indicators::{Indicator, Indicators}; use crate::keybindings::{ShellAction, ShellKeybindings}; // ============================================================================ @@ -295,6 +296,7 @@ fn watching_elements(count: usize) -> Vec> { pub struct StatusLine { state: StatusState, keybindings: ShellKeybindings, + indicators: Indicators, enabled: bool, /// Current spinner frame index (animated manually since we don't use iocraft runtime) spinner_frame: usize, @@ -485,6 +487,7 @@ impl StatusLine { Self { state: StatusState::new(), keybindings: ShellKeybindings::default(), + indicators: Indicators::default(), enabled: true, spinner_frame: 0, last_spinner_update: Instant::now(), @@ -522,6 +525,12 @@ impl StatusLine { self.cached_state = None; } + /// Select the glyphs used for indicators that have an emoji form. + pub fn set_indicators(&mut self, indicators: Indicators) { + self.indicators = indicators; + self.cached_state = None; + } + /// Check if the status line is enabled. pub fn is_enabled(&self) -> bool { self.enabled @@ -723,12 +732,13 @@ impl StatusLine { let keybind = self .keybindings .key_label(ShellAction::TogglePause, use_short); + let glyph = self.indicators.glyph(Indicator::Paused); element! { View(width: width as u32, height: 1, flex_direction: FlexDirection::Row, justify_content: JustifyContent::SpaceBetween, padding_left: 1, padding_right: 1) { View(flex_direction: FlexDirection::Row, flex_grow: 1.0_f32, min_width: 0, overflow: Overflow::Hidden) { - View(margin_right: 2) { - Text(content: "⏸", color: COLOR_SECONDARY) + View(margin_right: glyph.gap) { + Text(content: glyph.text, color: COLOR_SECONDARY) } Text(content: "devenv ", color: COLOR_SECONDARY) Text(content: "paused", weight: Weight::Bold, color: COLOR_ACTIVE) @@ -752,12 +762,13 @@ impl StatusLine { .keybindings .key_label(ShellAction::TogglePause, use_short); let count_str = self.state.watched_file_count.to_string(); + let glyph = self.indicators.glyph(Indicator::Watching); element! { View(width: width as u32, height: 1, flex_direction: FlexDirection::Row, justify_content: JustifyContent::SpaceBetween, padding_left: 1, padding_right: 1) { View(flex_direction: FlexDirection::Row, flex_grow: 1.0_f32, min_width: 0, overflow: Overflow::Hidden) { - View(margin_right: 2) { - Text(content: "👁", color: COLOR_SECONDARY) + View(margin_right: glyph.gap) { + Text(content: glyph.text, color: COLOR_SECONDARY) } Text(content: "devenv ", color: COLOR_SECONDARY) Text(content: "watching ", weight: Weight::Bold, color: COLOR_ACTIVE) @@ -1013,6 +1024,154 @@ mod tests { assert_eq!(status_line.cached_spinner_frame, Some(1)); } + /// Strip SGR sequences, leaving the text a terminal would show. + fn plain_text(content: &[u8]) -> String { + let mut text = String::new(); + let mut chars = String::from_utf8_lossy(content) + .into_owned() + .chars() + .collect::>() + .into_iter(); + while let Some(ch) = chars.next() { + if ch == '\u{1b}' { + for ch in chars.by_ref() { + if ch.is_ascii_alphabetic() { + break; + } + } + } else { + text.push(ch); + } + } + text.trim_end().to_string() + } + + fn status_line_with(emoji: bool, configure: impl FnOnce(&mut StatusLine)) -> StatusLine { + let mut status_line = StatusLine::new(); + status_line.set_indicators(Indicators::new(emoji)); + configure(&mut status_line); + status_line + } + + /// Assert the layout of a left label and right key hint on an 80-column row. + fn assert_row(row: &str, left: &str, right: &str) { + assert!(row.starts_with(left), "{row:?} should start with {left:?}"); + assert!(row.ends_with(right), "{row:?} should end with {right:?}"); + // The row is padded to the full width, leaving one column on the right. + assert_eq!(row.chars().count(), 79, "{row:?}"); + let middle = &row[left.len()..row.len() - right.len()]; + assert!(middle.chars().all(|ch| ch == ' '), "{row:?}"); + } + + #[test] + fn watching_indicator_follows_the_emoji_setting() { + let watching = |emoji| { + let status_line = + status_line_with(emoji, |sl| sl.state_mut().set_watched_file_count(11)); + plain_text(&uncached_content(&status_line, 80)) + }; + + assert_row( + &watching(true), + " 👁 devenv watching 11 files", + "Ctrl+Alt+D pause", + ); + assert_row( + &watching(false), + " ◉ devenv watching 11 files", + "Ctrl+Alt+D pause", + ); + } + + #[test] + fn paused_indicator_follows_the_emoji_setting() { + let paused = |emoji| { + let status_line = status_line_with(emoji, |sl| sl.state_mut().set_paused(true)); + plain_text(&uncached_content(&status_line, 80)) + }; + + assert_row(&paused(true), " ⏸ devenv paused", "Ctrl+Alt+D resume"); + assert_row(&paused(false), " ○ devenv paused", "Ctrl+Alt+D resume"); + } + + #[test] + fn emoji_is_the_default() { + let mut default = StatusLine::new(); + default.state_mut().set_watched_file_count(2); + let explicit = status_line_with(true, |sl| sl.state_mut().set_watched_file_count(2)); + assert_eq!( + uncached_content(&default, 80), + uncached_content(&explicit, 80) + ); + } + + #[test] + fn non_emoji_labels_align_with_the_other_states() { + // The label starts in the same column after every single-cell glyph. + let column = |content: &[u8]| { + let text = plain_text(content); + text.find("devenv").map(|byte| text[..byte].chars().count()) + }; + let watching = status_line_with(false, |sl| sl.state_mut().set_watched_file_count(1)); + let paused = status_line_with(false, |sl| sl.state_mut().set_paused(true)); + let ready = status_line_with(false, |sl| { + sl.state_mut() + .set_reload_ready(vec![PathBuf::from("a.nix")]) + }); + let expected = column(&uncached_content(&ready, 80)); + assert_eq!(column(&uncached_content(&watching, 80)), expected); + assert_eq!(column(&uncached_content(&paused, 80)), expected); + } + + #[test] + fn emoji_setting_does_not_change_other_states() { + let render = |emoji| { + let mut contents = Vec::new(); + let mut status_line = status_line_with(emoji, |_| {}); + contents.push(uncached_content(&status_line, 80)); + + status_line + .state_mut() + .set_building(vec![PathBuf::from("devenv.nix")]); + status_line.state_mut().build_start = None; + contents.push(uncached_content(&status_line, 80)); + + status_line + .state_mut() + .set_reload_ready(vec![PathBuf::from("devenv.nix")]); + status_line.state_mut().set_watched_file_count(3); + contents.push(uncached_content(&status_line, 80)); + + status_line.state_mut().set_reloaded(); + contents.push(uncached_content(&status_line, 80)); + + status_line + .state_mut() + .set_build_failed(vec![PathBuf::from("devenv.nix")], "error".to_string()); + contents.push(uncached_content(&status_line, 80)); + contents + }; + assert_eq!(render(true), render(false)); + } + + #[test] + fn status_line_cache_invalidates_when_indicators_change() { + let mut status_line = StatusLine::new(); + status_line.state_mut().set_watched_file_count(2); + assert_draw_matches_fresh_render(&mut status_line, 80); + let emoji = status_line.cached_content.clone(); + assert!(String::from_utf8_lossy(&emoji).contains('👁')); + + status_line.set_indicators(Indicators::new(false)); + assert_draw_matches_fresh_render(&mut status_line, 80); + assert_ne!(status_line.cached_content, emoji); + assert!(!String::from_utf8_lossy(&status_line.cached_content).contains('👁')); + + status_line.set_indicators(Indicators::new(true)); + assert_draw_matches_fresh_render(&mut status_line, 80); + assert_eq!(status_line.cached_content, emoji); + } + #[test] fn status_line_cache_matches_fresh_render_for_every_status_branch() { let mut status_line = StatusLine::new(); diff --git a/devenv-shell/tests/session_tests.rs b/devenv-shell/tests/session_tests.rs index 8dc41755a6..0caf986008 100644 --- a/devenv-shell/tests/session_tests.rs +++ b/devenv-shell/tests/session_tests.rs @@ -1,6 +1,7 @@ #![cfg(feature = "test-pty")] use devenv_mailbox::{FrontendCommand, FrontendEvent, ProcessCommand}; +use devenv_shell::indicators::Indicators; use devenv_shell::keybindings::{ShellAction, ShellKeyChord, ShellKeyCode, ShellKeybindings}; use devenv_shell::vt_utils::{DEFAULT_MAX_SCROLLBACK, active_point, row_plain_text, screen_point}; use devenv_shell::{ @@ -824,13 +825,17 @@ async fn test_build_failed_error_toggle() { let _ = handle.await; } -#[tokio::test(flavor = "multi_thread", worker_threads = 2)] -async fn test_watching_paused_status_line() { +/// Drive a session through watching, paused, and resumed, and snapshot the +/// status line in the last two states. +async fn assert_watching_paused_status_line( + session: ShellSession, + paused_snapshot: &'static str, + resumed_snapshot: &'static str, +) { let (io, mut stdin_ours, mut stdout_ours) = test_io(); let (cmd_tx, cmd_rx) = mpsc::channel(10); let (event_tx, _event_rx) = mpsc::channel(10); - let session = status_line_session(); let handle = tokio::spawn(async move { session.run(cmd_rx, event_tx, io).await }); cmd_tx.send(spawn_cmd("read unused")).await.unwrap(); @@ -854,7 +859,7 @@ async fn test_watching_paused_status_line() { Duration::from_secs(5), )); let rows = render(&all_bytes, 80, 24); - insta::assert_snapshot!("paused", rows[23]); + insta::assert_snapshot!(paused_snapshot, rows[23]); // Resume watching cmd_tx @@ -867,7 +872,7 @@ async fn test_watching_paused_status_line() { Duration::from_secs(5), )); let rows = render(&all_bytes, 80, 24); - insta::assert_snapshot!("resumed", rows[23]); + insta::assert_snapshot!(resumed_snapshot, rows[23]); let _ = stdin_ours.write_all(b"\n"); drop(stdin_ours); @@ -875,6 +880,18 @@ async fn test_watching_paused_status_line() { let _ = handle.await; } +#[tokio::test(flavor = "multi_thread", worker_threads = 2)] +async fn test_watching_paused_status_line() { + assert_watching_paused_status_line(status_line_session(), "paused", "resumed").await; +} + +#[tokio::test(flavor = "multi_thread", worker_threads = 2)] +async fn test_watching_paused_status_line_without_emoji() { + let session = status_line_session().with_indicators(Indicators::new(false)); + assert_watching_paused_status_line(session, "paused_without_emoji", "resumed_without_emoji") + .await; +} + #[tokio::test(flavor = "multi_thread", worker_threads = 2)] async fn test_print_watched_files() { let (io, mut stdin_ours, mut stdout_ours) = test_io(); diff --git a/devenv-shell/tests/snapshots/session_tests__paused_without_emoji.snap b/devenv-shell/tests/snapshots/session_tests__paused_without_emoji.snap new file mode 100644 index 0000000000..58fc241328 --- /dev/null +++ b/devenv-shell/tests/snapshots/session_tests__paused_without_emoji.snap @@ -0,0 +1,5 @@ +--- +source: devenv-shell/tests/session_tests.rs +expression: "rows[23]" +--- + ○ devenv paused Ctrl+Alt+D resume diff --git a/devenv-shell/tests/snapshots/session_tests__resumed_without_emoji.snap b/devenv-shell/tests/snapshots/session_tests__resumed_without_emoji.snap new file mode 100644 index 0000000000..8f3a00954d --- /dev/null +++ b/devenv-shell/tests/snapshots/session_tests__resumed_without_emoji.snap @@ -0,0 +1,5 @@ +--- +source: devenv-shell/tests/session_tests.rs +expression: "rows[23]" +--- + ◉ devenv watching 1 files Ctrl+Alt+D pause diff --git a/devenv-tasks/src/executor.rs b/devenv-tasks/src/executor.rs index 4bebd7643c..01ca5fc85d 100644 --- a/devenv-tasks/src/executor.rs +++ b/devenv-tasks/src/executor.rs @@ -6,6 +6,8 @@ use tokio_util::sync::CancellationToken; #[derive(Debug)] pub struct ExecutionResult { pub success: bool, + /// Whether the command exited, including termination by a signal. + pub exited: bool, pub pid: Option, pub exit_code: Option, pub stdout_lines: Vec<(std::time::Instant, String)>, @@ -17,6 +19,7 @@ impl ExecutionResult { fn failed(error: impl Into) -> Self { Self { success: false, + exited: false, pid: None, exit_code: None, stdout_lines: Vec::new(), @@ -218,6 +221,7 @@ pub async fn execute( error!("Error waiting for command: {}", e); return ExecutionResult { success: false, + exited: false, pid: Some(child_pid), exit_code: None, stdout_lines, @@ -242,6 +246,7 @@ pub async fn execute( ) }); let (wait_result, cleanup_result) = tokio::join!(child.wait(), cleanup); + let exited = wait_result.is_ok(); let exit_code = match wait_result { Ok(status) => status.code(), Err(error) => { @@ -257,6 +262,7 @@ pub async fn execute( return ExecutionResult { success: false, + exited, pid: Some(child_pid), exit_code, stdout_lines, @@ -270,6 +276,7 @@ pub async fn execute( let success = exit_status.map(|s| s.success()).unwrap_or(false); ExecutionResult { success, + exited: exit_status.is_some(), pid: Some(child_pid), exit_code: exit_status.and_then(|status| status.code()), stdout_lines, diff --git a/devenv-tasks/src/native_manager.rs b/devenv-tasks/src/native_manager.rs index 455ae3ccd1..02f8bc1958 100644 --- a/devenv-tasks/src/native_manager.rs +++ b/devenv-tasks/src/native_manager.rs @@ -817,6 +817,70 @@ mod tests { manager.stop_all().await.unwrap(); } + #[tokio::test] + async fn start_request_starts_never_started_process_dependencies() { + let temp_dir = tempfile::tempdir().unwrap(); + let mut helper = process_task("helper", "exec tail -f /dev/null"); + helper.process.as_mut().unwrap().start.enable = true; + let mut app = process_task("app", "exec tail -f /dev/null"); + app.process.as_mut().unwrap().start.enable = true; + app.after = vec![format!("{}helper@started", crate::PROCESS_TASK_PREFIX)]; + let mut unrelated = process_task("unrelated", "exec tail -f /dev/null"); + unrelated.process.as_mut().unwrap().start.enable = true; + + let manager = test_manager( + &temp_dir, + vec![ + process_task("db", "exec tail -f /dev/null"), + helper, + app, + unrelated, + ], + ManagerResidence::Daemon, + ) + .await; + manager.tasks.run(true).await; + let _server = NativeApiServer::start(Arc::clone(&manager)).unwrap(); + + let response = NativeManagerClient::api_request( + &manager.api_socket_path(), + &ApiRequest::Start { + names: vec!["db".to_string()], + }, + ) + .await + .unwrap(); + assert!(matches!(response, ApiResponse::Start { outcome } if outcome.scheduled == ["db"])); + wait_for_phase(&manager, "db", ProcessPhase::Ready).await; + assert_eq!( + manager.process_runner().get_phase("helper").await, + Some(ProcessPhase::NotStarted) + ); + + let response = NativeManagerClient::api_request( + &manager.api_socket_path(), + &ApiRequest::Start { + names: vec!["app".to_string()], + }, + ) + .await + .unwrap(); + assert!(matches!( + response, + ApiResponse::Start { outcome } + if outcome.scheduled == ["helper", "app"] + && outcome.skipped.is_empty() + && outcome.unknown.is_empty() + && outcome.failed.is_empty() + )); + wait_for_phase(&manager, "app", ProcessPhase::Ready).await; + assert_eq!( + manager.process_runner().get_phase("unrelated").await, + Some(ProcessPhase::NotStarted) + ); + manager.stop_all().await.unwrap(); + } + /// Closing the requesting socket must not cancel work owned by the daemon. #[tokio::test] async fn interrupted_start_client_does_not_cancel_daemon_work() { diff --git a/devenv-tasks/src/task_state.rs b/devenv-tasks/src/task_state.rs index 369ec50380..5db55c76ea 100644 --- a/devenv-tasks/src/task_state.rs +++ b/devenv-tasks/src/task_state.rs @@ -516,63 +516,72 @@ impl TaskState { output_file_path: std::path::Path::new("/dev/null"), exports_file_path: exports_file.path(), }; - let mut command = ctx.build_command(); - - // Create a Command activity for the status check (automatically parented to task_activity) + // Status probes need the same process-scope cancellation + // cleanup as the task command so graceful joins can finish. let status_activity = devenv_activity::start!( Activity::command("check status") .command(cmd) .level(ActivityLevel::Debug), devenv.command.exit_code = tracing::field::Empty, - devenv.command.stdout_bytes = tracing::field::Empty, - devenv.command.stderr_bytes = tracing::field::Empty + devenv.command.stdout_line_count = tracing::field::Empty, + devenv.command.stderr_line_count = tracing::field::Empty ); - - match command.output().await { - Ok(output) => { - if let Some(exit_code) = output.status.code() { - status_activity.record("devenv.command.exit_code", exit_code as i64); - } - status_activity.record("devenv.command.stdout_bytes", output.stdout.len()); - status_activity.record("devenv.command.stderr_bytes", output.stderr.len()); - // A nonzero exit is a normal status/cache miss: fall through - // to run the command. Only a spawn/execution error of the - // status probe itself (the `Err` arm below) is a real failure. - if output.status.success() { - // Start with cached output, merge in any exports from the status command - let mut result = cached_output.unwrap_or_else(|| serde_json::json!({})); - if let Ok(data) = tokio::fs::read(exports_file.path()).await { - let exports = Self::parse_exports(&data); - if let (false, Some(env_obj)) = ( - exports.is_empty(), - get_or_create_devenv_env_mut(&mut result), - ) { - for (k, v) in exports { - env_obj.insert(k, serde_json::Value::String(v)); - } - } + let result = crate::executor::execute( + ctx, + &crate::executor::NoOpCallback, + cancellation.clone(), + ) + .await; + if let Some(exit_code) = result.exit_code { + status_activity.record("devenv.command.exit_code", exit_code as i64); + } + status_activity.record( + "devenv.command.stdout_line_count", + result.stdout_lines.len(), + ); + status_activity.record( + "devenv.command.stderr_line_count", + result.stderr_lines.len(), + ); + if result.error.as_deref() == Some("Task cancelled") { + status_activity.cancel(); + task_activity.cancel(); + return Ok(TaskCompleted::Cancelled(Some(now.elapsed()))); + } + if result.success { + // Start with cached output, merge in any exports from the status command + let mut result = cached_output.unwrap_or_else(|| serde_json::json!({})); + if let Ok(data) = tokio::fs::read(exports_file.path()).await { + let exports = Self::parse_exports(&data); + if let (false, Some(env_obj)) = ( + exports.is_empty(), + get_or_create_devenv_env_mut(&mut result), + ) { + for (k, v) in exports { + env_obj.insert(k, serde_json::Value::String(v)); } - let output = Output(Some(result)); - tracing::trace!( - "Task {} skipped with output: {:?}", - self.task.name, - output - ); - task_activity.cached(); - return Ok(TaskCompleted::Skipped(Skipped::Cached(output))); } } - Err(e) => { - status_activity.fail_with_description(e.to_string()); - return Ok(TaskCompleted::Failed( - now.elapsed(), - TaskFailure { - stdout: Vec::new(), - stderr: Vec::new(), - error: e.to_string(), - }, - )); - } + let output = Output(Some(result)); + tracing::trace!("Task {} skipped with output: {:?}", self.task.name, output); + task_activity.cached(); + return Ok(TaskCompleted::Skipped(Skipped::Cached(output))); + } + // A nonzero exit is a normal cache miss. A spawn/execution + // error of the probe itself is a task failure. + if !result.exited { + let error = result + .error + .unwrap_or_else(|| "Status command failed".to_string()); + status_activity.fail_with_description(&error); + return Ok(TaskCompleted::Failed( + now.elapsed(), + TaskFailure { + stdout: result.stdout_lines, + stderr: result.stderr_lines, + error, + }, + )); } } else if !self.task.exec_if_modified.is_empty() { let files_modified = match self.check_files_modified(cache).await { diff --git a/devenv-tasks/src/tasks.rs b/devenv-tasks/src/tasks.rs index 63f34c2381..73272d5bb2 100644 --- a/devenv-tasks/src/tasks.rs +++ b/devenv-tasks/src/tasks.rs @@ -688,8 +688,9 @@ impl Tasks { /// Schedule named process tasks and their dependencies against the live graph. /// /// Names omit the `devenv:processes:` prefix. The result classifies each - /// unique name as scheduled, skipped, unknown, or failed. This returns after - /// scheduling; dependencies may keep a process `Waiting` in the background. + /// unique requested name and started prerequisite as scheduled, skipped, + /// unknown, or failed. This returns after scheduling; dependencies may keep + /// a process `Waiting` in the background. pub async fn start_with_deps(&self, names: I) -> StartOutcome where I: IntoIterator, @@ -699,9 +700,37 @@ impl Tasks { let _serialize = self.start_with_deps_lock.lock().await; let mut outcome = StartOutcome::default(); + // Start never-started process prerequisites before their requested + // dependents. An explicitly stopped prerequisite stays stopped. + let mut expanded = Vec::new(); + for name in names.into_iter().map(Into::into) { + let task_name = format!("{PROCESS_TASK_PREFIX}{name}"); + if let Some(&index) = self.task_index_by_name.get(&task_name) + && !matches!( + self.process_runner.get_phase(&name).await, + Some(ProcessPhase::Starting | ProcessPhase::Ready) + ) + { + expanded.extend( + self.unstarted_process_dependencies(index) + .await + .into_iter() + .map(|dependency| (dependency, false)), + ); + } + expanded.push((name, true)); + } + // Deduplicate without changing result order. let mut seen = std::collections::HashSet::new(); - for name in names.into_iter().map(Into::into) { + for (name, explicitly_requested) in expanded { + // A stop can race closure discovery. Only a requested process may + // re-arm an entry that the user has explicitly stopped. + if !explicitly_requested + && self.process_runner.get_phase(&name).await != Some(ProcessPhase::NotStarted) + { + continue; + } if !seen.insert(name.clone()) { continue; } @@ -820,6 +849,64 @@ impl Tasks { outcome } + /// Find process prerequisites that are eligible for a dynamic start. + /// Traverse pending one-shots too, since they can depend on processes. + async fn unstarted_process_dependencies(&self, root: NodeIndex) -> Vec { + let mut stack = vec![(root, false)]; + let mut visited = HashSet::new(); + let mut processes = Vec::new(); + + while let Some((node, after_dependencies)) = stack.pop() { + if after_dependencies { + if node != root { + let task = self.graph[node].read().await; + if task.task.r#type == TaskType::Process { + let name = crate::types::process_name(&task.task.name); + if self.process_runner.get_phase(name).await + == Some(ProcessPhase::NotStarted) + { + processes.push(name.to_string()); + } + } + } + continue; + } + if !visited.insert(node) { + continue; + } + stack.push((node, true)); + + for edge in self + .graph + .edges_directed(node, petgraph::Direction::Incoming) + { + let predecessor = edge.source(); + let state = self.graph[predecessor].read().await; + let visit = if state.task.r#type == TaskType::Process { + let name = crate::types::process_name(&state.task.name); + match self.process_runner.get_phase(name).await { + Some(ProcessPhase::NotStarted) => { + *edge.weight() != DependencyKind::Completed + && state + .task + .process + .as_ref() + .is_none_or(|process| process.start.enable) + } + Some(ProcessPhase::Waiting) => true, + _ => false, + } + } else { + !matches!(state.status, TaskStatus::Completed(_)) + }; + if visit { + stack.push((predecessor, false)); + } + } + } + processes + } + /// Publish one task's terminal progress and wake observers. fn signal_task_done( completed_tasks: &std::sync::atomic::AtomicU64, @@ -1632,12 +1719,15 @@ impl Tasks { let _ = scheduled_signal.send(()); } - // Wait for all tasks to complete - running_tasks.wait_all().await; + // Task dependency and readiness waits observe shutdown themselves. + // Let running one-shots drain their process scopes before returning; + // aborting their futures skips the executor's cancellation cleanup. + running_tasks.wait_all_gracefully().await; - // wait_all() aborts spawned futures on shutdown so that run_event_loop() - // can proceed to stop_all(). Aborted futures never write back their - // completion status, so sweep any still-Running tasks to Cancelled. + // Process tasks leave their lifecycle status with the manager. Mark + // still-pending processes cancelled before run_event_loop() proceeds + // to stop_all(). Tasks skipped before their future started also need + // their cancellation status recorded here. if self.shutdown.is_cancelled() { for &index in &self.tasks_order { let (is_process, task_name, running_oneshot_start) = { @@ -3201,22 +3291,15 @@ mod schedule_tests { let outcome = tasks.start_with_deps(["downstream"]).await; assert_eq!( outcome.scheduled, - ["downstream"], + if case.dependency.kind() == DependencyKind::Completed { + vec!["downstream".to_string()] + } else { + vec!["source".to_string(), "downstream".to_string()] + }, "{}: dynamic root was not scheduled", case_name ); - if case.dependency.kind() != DependencyKind::Completed { - assert_eq!( - tasks.process_runner().get_phase("downstream").await, - Some(ProcessPhase::Waiting), - "{}: downstream must wait while its process predecessor is not started", - case_name - ); - let outcome = tasks.start_with_deps(["source"]).await; - assert_eq!(outcome.scheduled, ["source"]); - } - wait_task_completed(&tasks, bridge_name).await; if case.dependency.allows_dependent(case.exit) { wait_phase(&tasks, "downstream", ProcessPhase::Ready).await; @@ -3401,13 +3484,7 @@ mod schedule_tests { if dynamic { wait_phase(&tasks, "alpha", ProcessPhase::Ready).await; let outcome = tasks.start_with_deps(["backend"]).await; - assert_eq!(outcome.scheduled, ["backend"]); - assert_eq!( - tasks.process_runner().get_phase("backend").await, - Some(ProcessPhase::Waiting) - ); - let outcome = tasks.start_with_deps(["source"]).await; - assert_eq!(outcome.scheduled, ["source"]); + assert_eq!(outcome.scheduled, ["source", "backend"]); } wait_phase(&tasks, "backend", ProcessPhase::Ready).await; @@ -3431,6 +3508,146 @@ mod schedule_tests { run_heterogeneous_diamond(true).await; } + #[tokio::test] + async fn shutdown_drains_nested_oneshot_processes_before_returning() { + check_shutdown_drains_nested_task_processes(false).await; + } + + #[tokio::test] + async fn shutdown_drains_nested_status_processes_before_returning() { + check_shutdown_drains_nested_task_processes(true).await; + } + + #[tokio::test] + async fn status_probe_exit_preserves_cache_hit_and_miss_behavior() { + for (probe, cached) in [ + ("exit 0", true), + ("exit 1", false), + ("kill -TERM $$", false), + ] { + let files = tempfile::tempdir().unwrap(); + let status = executable_script(files.path(), "status", probe); + let command = executable_script(files.path(), "command", "touch command-ran"); + let mut task = oneshot_task("test:status", vec![]); + task.status = Some(status.to_string_lossy().into_owned()); + task.command = Some(command.to_string_lossy().into_owned()); + task.cwd = Some(files.path().to_string_lossy().into_owned()); + let (tasks, _tmp) = + build_test_tasks(vec![task], vec!["test:status".into()], false).await; + tasks.run(false).await; + let state = tasks.graph[tasks.task_index_by_name["test:status"]] + .read() + .await; + if cached { + assert!(matches!( + state.status, + TaskStatus::Completed(TaskCompleted::Skipped(_)) + )); + } else { + assert!( + matches!( + state.status, + TaskStatus::Completed(TaskCompleted::Success(_, _)) + ), + "status probe {probe} must be a cache miss: {:?}", + state.status + ); + } + assert_eq!(files.path().join("command-ran").exists(), !cached); + } + } + + async fn check_shutdown_drains_nested_task_processes(status_check: bool) { + struct FixtureCleanup(std::path::PathBuf); + + impl Drop for FixtureCleanup { + fn drop(&mut self) { + // Only signal the session created by this fixture, including + // when an assertion fails on the unfixed scheduler. + if let Ok(pid) = std::fs::read_to_string(self.0.join("leader.pid")) + && let Ok(pid) = pid.trim().parse::() + { + let _ = nix::sys::signal::killpg( + nix::unistd::Pid::from_raw(pid), + nix::sys::signal::Signal::SIGKILL, + ); + } + } + } + + let files = tempfile::tempdir().unwrap(); + let _cleanup = FixtureCleanup(files.path().to_path_buf()); + let started = named_pipe(files.path(), "started"); + let script = executable_script( + files.path(), + "observer", + &format!( + "trap '' TERM INT\necho $$ > '{dir}/leader.pid'\n\ + sh -c 'trap \"\" TERM INT; echo $$ > \"$1/nested.pid\"; \ + printf x > \"$1/started\"; exec sleep 120' sh '{dir}' &\nwait", + dir = files.path().display(), + ), + ); + let mut observer = oneshot_task("test:observer", vec![]); + if status_check { + observer.status = Some(script.to_string_lossy().into_owned()); + let command = executable_script(files.path(), "command", "touch command-ran"); + observer.command = Some(command.to_string_lossy().into_owned()); + observer.cwd = Some(files.path().to_string_lossy().into_owned()); + } else { + observer.command = Some(script.to_string_lossy().into_owned()); + } + let dependent = oneshot_task("test:dependent", vec!["test:observer"]); + let (tasks, _tmp) = build_test_tasks( + vec![observer, dependent], + vec!["test:dependent".into()], + false, + ) + .await; + let tasks = Arc::new(tasks); + let listener = listen_for_pipe_signal(started); + let running = Arc::clone(&tasks); + let run = tokio::spawn(async move { running.run(true).await }); + wait_for_pipe_signal(listener, "nested task child to start").await; + + let nested_pid: i32 = std::fs::read_to_string(files.path().join("nested.pid")) + .unwrap() + .trim() + .parse() + .unwrap(); + tasks.shutdown.shutdown(); + tokio::time::timeout(std::time::Duration::from_secs(10), run) + .await + .expect("cancelled task did not finish cleanup") + .expect("scheduler panicked"); + + // A zombie is already stopped, even if init has not reaped it yet. + let state = std::process::Command::new("ps") + .args(["-o", "stat=", "-p", &nested_pid.to_string()]) + .output() + .unwrap(); + let state = String::from_utf8_lossy(&state.stdout); + assert!( + state.trim().is_empty() || state.trim().starts_with('Z'), + "scheduler returned with nested task child {nested_pid} still alive: {state}" + ); + assert!( + !files.path().join("command-ran").exists(), + "cancelled status check must not run the task command" + ); + for name in ["test:observer", "test:dependent"] { + let state = tasks.graph[tasks.task_index_by_name[name]].read().await; + assert!( + matches!( + state.status, + TaskStatus::Completed(TaskCompleted::Cancelled(_)) + ), + "{name} did not record cancellation: {:?}", + state.status + ); + } + } + #[tokio::test] async fn shutdown_cancels_cold_heterogeneous_closure() { let files = tempfile::tempdir().unwrap(); @@ -3735,7 +3952,7 @@ mod schedule_tests { /// Wait for a lifecycle notification that publishes the requested phase. async fn wait_phase(tasks: &Tasks, name: &str, want: ProcessPhase) { - tokio::time::timeout(std::time::Duration::from_secs(60), async { + let waited = tokio::time::timeout(std::time::Duration::from_secs(60), async { loop { let notified = tasks.notify_finished.notified(); tokio::pin!(notified); @@ -3746,8 +3963,12 @@ mod schedule_tests { notified.await; } }) - .await - .unwrap_or_else(|_| panic!("timed out waiting for process {name} to reach {want:?}")) + .await; + assert!( + waited.is_ok(), + "timed out waiting for process {name} to reach {want:?}; current phase: {:?}", + tasks.process_runner().get_phase(name).await + ) } async fn wait_task_completed(tasks: &Tasks, name: &str) { @@ -3963,6 +4184,76 @@ mod schedule_tests { tasks.process_runner().stop_all().await.unwrap(); } + #[tokio::test] + async fn start_with_deps_starts_never_started_process_prerequisites() { + let (tasks, _tmp) = build_test_tasks_with_run_mode( + vec![ + long_process_task("db", vec![]), + long_process_task("helper", vec![]), + long_process_task("app", vec!["helper@started"]), + long_process_task("unrelated", vec![]), + ], + vec![format!("{PROCESS_TASK_PREFIX}db")], + RunMode::Before, + false, + ) + .await; + + tasks.run(true).await; + wait_phase(&tasks, "db", ProcessPhase::Ready).await; + assert_eq!( + tasks.process_runner().get_phase("helper").await, + Some(ProcessPhase::NotStarted) + ); + + let outcome = tasks.start_with_deps(["app"]).await; + assert_eq!(outcome.scheduled, ["helper", "app"]); + wait_phase(&tasks, "app", ProcessPhase::Ready).await; + assert_eq!( + tasks.process_runner().get_phase("unrelated").await, + Some(ProcessPhase::NotStarted) + ); + tasks.process_runner().stop_all().await.unwrap(); + } + + #[tokio::test] + async fn start_with_deps_keeps_disabled_process_prerequisites_off() { + let mut helper = long_process_task("helper", vec![]); + helper.process = Some(ProcessConfig { + start: devenv_processes::config::StartConfig { enable: false }, + ..Default::default() + }); + let (tasks, _tmp) = build_test_tasks_with_run_mode( + vec![ + long_process_task("db", vec![]), + helper, + long_process_task("app", vec!["helper@started"]), + ], + vec![format!("{PROCESS_TASK_PREFIX}db")], + RunMode::Before, + false, + ) + .await; + + tasks.run(true).await; + wait_phase(&tasks, "db", ProcessPhase::Ready).await; + let outcome = tasks.start_with_deps(["app"]).await; + assert_eq!(outcome.scheduled, ["app"]); + assert_eq!( + tasks.process_runner().get_phase("helper").await, + Some(ProcessPhase::NotStarted) + ); + assert_eq!( + tasks.process_runner().get_phase("app").await, + Some(ProcessPhase::Waiting) + ); + + let outcome = tasks.start_with_deps(["helper"]).await; + assert_eq!(outcome.scheduled, ["helper"]); + wait_phase(&tasks, "app", ProcessPhase::Ready).await; + tasks.process_runner().stop_all().await.unwrap(); + } + #[tokio::test] async fn start_with_deps_runs_unseen_oneshot_dependency_closure() { let prepare = "devenv:tasks:prepare"; @@ -4244,10 +4535,21 @@ mod schedule_tests { #[tokio::test] async fn concurrent_dynamic_starts_launch_each_process_and_oneshot_once() { + check_concurrent_dynamic_starts(false).await; + } + + #[tokio::test(flavor = "multi_thread", worker_threads = 4)] + async fn concurrent_dynamic_starts_share_never_started_process_prerequisite() { + check_concurrent_dynamic_starts(true).await; + } + + async fn check_concurrent_dynamic_starts(shared_process: bool) { let scripts = tempfile::tempdir().unwrap(); let setup_count = scripts.path().join("setup-count"); let beta_count = scripts.path().join("beta-count"); let gamma_count = scripts.path().join("gamma-count"); + let source_count = scripts.path().join("source-count"); + let source_ready = scripts.path().join("source-ready"); let setup_script = scripts.path().join("setup"); std::fs::write( @@ -4263,6 +4565,9 @@ mod schedule_tests { let setup_name = "devenv:tasks:shared-setup"; let mut setup = oneshot_task(setup_name, vec![]); setup.command = Some(setup_script.to_string_lossy().into_owned()); + if shared_process { + setup.after = vec![format!("{PROCESS_TASK_PREFIX}source@ready")]; + } let mut beta = process_task_with_command( "beta", @@ -4285,8 +4590,27 @@ mod schedule_tests { gamma.after = vec![setup_name.to_string()]; gamma.process = Some(no_restart_process_config(Some(&gamma_count))); + let mut configs = vec![long_process_task("alpha", vec![]), setup, beta, gamma]; + if shared_process { + let mut source = process_task_with_command( + "source", + vec![], + &format!( + "echo source >> '{}'; exec tail -f /dev/null", + source_count.display() + ), + ); + let mut config = no_restart_process_config(Some(&source_ready)); + config.ready.as_mut().unwrap().exec = Some(format!( + "test -f '{}' && test -f '{}'", + source_ready.display(), + source_count.display() + )); + source.process = Some(config); + configs.push(source); + } let (tasks, _tmp) = build_test_tasks_with_run_mode( - vec![long_process_task("alpha", vec![]), setup, beta, gamma], + configs, vec![format!("{PROCESS_TASK_PREFIX}alpha")], RunMode::Before, false, @@ -4297,12 +4621,40 @@ mod schedule_tests { tasks.run(true).await; wait_phase(&tasks, "alpha", ProcessPhase::Ready).await; + if shared_process { + assert_eq!( + tasks.process_runner().get_phase("source").await, + Some(ProcessPhase::NotStarted) + ); + } + let barrier = Arc::new(tokio::sync::Barrier::new(3)); let first_tasks = Arc::clone(&tasks); + let first_barrier = Arc::clone(&barrier); + let first = tokio::spawn(async move { + first_barrier.wait().await; + if shared_process { + first_tasks.start_with_deps(["beta", "beta"]).await + } else { + first_tasks.start_with_deps(["beta", "gamma", "beta"]).await + } + }); let second_tasks = Arc::clone(&tasks); - let (first, second) = tokio::join!( - async move { first_tasks.start_with_deps(["beta", "gamma", "beta"]).await }, - async move { second_tasks.start_with_deps(["beta"]).await }, - ); + let second_barrier = Arc::clone(&barrier); + let second = tokio::spawn(async move { + second_barrier.wait().await; + if shared_process { + second_tasks.start_with_deps(["gamma", "beta"]).await + } else { + second_tasks.start_with_deps(["beta"]).await + } + }); + barrier.wait().await; + // The source stays unready until these requests have both replied. + let (first, second) = tokio::time::timeout(std::time::Duration::from_secs(10), async { + (first.await.unwrap(), second.await.unwrap()) + }) + .await + .expect("concurrent start requests waited for prerequisite readiness"); let beta_scheduled = first .scheduled @@ -4329,6 +4681,37 @@ mod schedule_tests { ); assert!(first.failed.is_empty() && second.failed.is_empty()); + if shared_process { + assert_eq!( + first + .scheduled + .iter() + .chain(&second.scheduled) + .filter(|name| name.as_str() == "source") + .count(), + 1, + "shared never-started prerequisite must be scheduled exactly once" + ); + wait_phase(&tasks, "source", ProcessPhase::Starting).await; + assert_eq!( + tasks.process_runner().get_phase("beta").await, + Some(ProcessPhase::Waiting) + ); + assert_eq!( + tasks.process_runner().get_phase("gamma").await, + Some(ProcessPhase::Waiting) + ); + for path in [&setup_count, &beta_count, &gamma_count] { + assert!( + !path.exists(), + "{} ran before prerequisite readiness", + path.display() + ); + } + std::fs::write(&source_ready, "ready").unwrap(); + wait_phase(&tasks, "source", ProcessPhase::Ready).await; + } + wait_phase(&tasks, "beta", ProcessPhase::Ready).await; wait_phase(&tasks, "gamma", ProcessPhase::Ready).await; wait_task_completed(&tasks, setup_name).await; @@ -4347,6 +4730,93 @@ mod schedule_tests { ); } + if shared_process { + assert_eq!( + std::fs::read_to_string(source_count).unwrap(), + "source\n", + "shared process prerequisite must launch exactly once" + ); + } + tasks.process_runner().stop_all().await.unwrap(); + } + + #[tokio::test(flavor = "multi_thread", worker_threads = 4)] + async fn concurrent_start_stop_keeps_explicitly_stopped_dependencies_off() { + let mut source = long_process_task("source", vec![]); + source.process = Some(ProcessConfig { + ready: Some(devenv_processes::ReadyConfig { + exec: Some("true".into()), + ..Default::default() + }), + ..Default::default() + }); + let (tasks, _tmp) = build_test_tasks_with_run_mode( + vec![ + long_process_task("alpha", vec![]), + source, + long_process_task("downstream", vec!["source@ready"]), + ], + vec![format!("{PROCESS_TASK_PREFIX}alpha")], + RunMode::Before, + false, + ) + .await; + tasks.run(true).await; + wait_phase(&tasks, "alpha", ProcessPhase::Ready).await; + tasks.start_with_deps(["downstream"]).await; + wait_phase(&tasks, "source", ProcessPhase::Ready).await; + wait_phase(&tasks, "downstream", ProcessPhase::Ready).await; + + for cycle in 0..25 { + eprintln!("start/stop cycle {cycle}"); + tasks + .process_runner() + .stop_and_keep("downstream") + .await + .unwrap(); + let (first, second, stopped) = tokio::join!( + tasks.start_with_deps(["downstream"]), + tasks.start_with_deps(["downstream"]), + tasks.process_runner().stop_and_keep("source"), + ); + stopped.unwrap(); + assert!(first.failed.is_empty() && second.failed.is_empty()); + assert_eq!( + first + .scheduled + .iter() + .chain(&second.scheduled) + .filter(|name| name.as_str() == "downstream") + .count(), + 1, + "duplicate downstream start in cycle {cycle}" + ); + wait_phase(&tasks, "source", ProcessPhase::Stopped).await; + + // Stop the dependent after the race, then start it again. Its + // explicitly stopped prerequisite must remain off until requested. + tasks.process_runner().cancel_waiting("downstream").await; + if tasks.process_runner().get_phase("downstream").await != Some(ProcessPhase::Stopped) { + wait_phase(&tasks, "downstream", ProcessPhase::Ready).await; + tasks + .process_runner() + .stop_and_keep("downstream") + .await + .unwrap(); + } + let outcome = tasks.start_with_deps(["downstream"]).await; + assert_eq!(outcome.scheduled, ["downstream"]); + wait_phase(&tasks, "downstream", ProcessPhase::Waiting).await; + assert_eq!( + tasks.process_runner().get_phase("source").await, + Some(ProcessPhase::Stopped), + "implicit start resurrected stopped source in cycle {cycle}" + ); + let source_outcome = tasks.start_with_deps(["source"]).await; + assert_eq!(source_outcome.scheduled, ["source"], "cycle {cycle}"); + wait_phase(&tasks, "source", ProcessPhase::Ready).await; + wait_phase(&tasks, "downstream", ProcessPhase::Ready).await; + } tasks.process_runner().stop_all().await.unwrap(); } diff --git a/devenv-tui/src/config.rs b/devenv-tui/src/config.rs index 80d69536c8..491218eb8a 100644 --- a/devenv-tui/src/config.rs +++ b/devenv-tui/src/config.rs @@ -1,5 +1,6 @@ use crossterm::event::{KeyCode, KeyEvent, KeyModifiers}; use crossterm::style::Color; +use devenv_shell::indicators::Indicators; use devenv_shell::keybindings::{ShellAction, ShellKeyChord, ShellKeyCode, ShellKeybindings}; use miette::{Diagnostic, NamedSource, SourceSpan}; use schemars::{JsonSchema, Schema, SchemaGenerator, json_schema}; @@ -209,9 +210,12 @@ impl TuiRunContext { } } -#[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema)] +#[derive(Clone, Debug, Serialize, Deserialize, JsonSchema)] #[serde(default, deny_unknown_fields)] pub struct TuiPreferences { + /// Use emoji for display indicators, such as the eye in the shell status line. + /// Set to `false` to use non-emoji Unicode glyphs instead. + pub emoji: bool, pub viewport: ViewportPlacement, pub theme: ThemeConfig, pub statusline: StatuslineConfig, @@ -219,7 +223,25 @@ pub struct TuiPreferences { pub behavior: BehaviorConfig, } +impl Default for TuiPreferences { + fn default() -> Self { + Self { + emoji: true, + viewport: ViewportPlacement::default(), + theme: ThemeConfig::default(), + statusline: StatuslineConfig::default(), + keybindings: KeybindingsConfig::default(), + behavior: BehaviorConfig::default(), + } + } +} + impl TuiPreferences { + /// The glyphs for display indicators that have an emoji form. + pub fn indicators(&self) -> Indicators { + Indicators::new(self.emoji) + } + pub fn validate(&self) -> Result<(), UserConfigError> { self.theme.validate()?; self.statusline.validate(&self.theme.palette)?; @@ -1795,6 +1817,78 @@ mod tests { assert!(!disabled.shell.prompt_prefix); } + #[test] + fn tui_emoji_defaults_to_true() { + assert!(TuiPreferences::default().emoji); + assert!(UserConfig::default().tui.emoji); + assert!(TuiPreferences::default().indicators().emoji()); + for yaml in [ + "version: 1\n", + "version: 1\ntui: {}\n", + "version: 1\ntui:\n viewport: top\n statusline:\n enabled: false\n", + ] { + let config = UserConfig::from_yaml("config.yaml", yaml.into()).unwrap(); + assert!(config.tui.emoji, "{yaml}"); + assert_eq!(config.tui.indicators(), Indicators::new(true), "{yaml}"); + } + } + + #[test] + fn tui_emoji_can_be_disabled_without_changing_other_settings() { + let config = + UserConfig::from_yaml("config.yaml", "version: 1\ntui:\n emoji: false\n".into()) + .unwrap(); + assert!(!config.tui.emoji); + assert_eq!(config.tui.indicators(), Indicators::new(false)); + // Everything else keeps its default, including statusline visibility. + assert!(config.tui.statusline.enabled); + assert!(config.tui.uses_default_statusline()); + assert_eq!(config.tui.viewport, ViewportPlacement::Inline); + + let enabled = + UserConfig::from_yaml("config.yaml", "version: 1\ntui:\n emoji: true\n".into()) + .unwrap(); + assert!(enabled.tui.emoji); + } + + #[test] + fn tui_emoji_must_be_a_boolean() { + for value in ["maybe", "1", "[]"] { + let error = UserConfig::from_yaml( + "config.yaml", + format!("version: 1\ntui:\n emoji: {value}\n"), + ) + .unwrap_err(); + assert!(matches!(error, UserConfigError::Parse { .. }), "{value}"); + } + } + + #[test] + fn tui_emoji_round_trips() { + for emoji in [true, false] { + let mut config = UserConfig::default(); + config.tui.emoji = emoji; + let parsed = UserConfig::from_yaml("config.yaml", config.to_yaml().unwrap()).unwrap(); + assert_eq!(parsed.tui.emoji, emoji); + } + } + + #[test] + fn tui_emoji_indicators_use_single_cell_glyphs_without_emoji() { + use unicode_width::UnicodeWidthStr; + + let indicators = TuiPreferences { + emoji: false, + ..TuiPreferences::default() + } + .indicators(); + for indicator in devenv_shell::indicators::Indicator::ALL { + let glyph = indicators.glyph(indicator); + assert_eq!(glyph.text.width(), 1, "{indicator:?}"); + assert_eq!(glyph.gap, 1, "{indicator:?}"); + } + } + #[test] fn default_config_round_trips() { let config = UserConfig::default(); @@ -1815,6 +1909,14 @@ mod tests { let schema = serde_json::to_value(schemars::schema_for!(UserConfig)).unwrap(); assert!(schema.pointer("/properties/$schema").is_none()); + assert_eq!( + schema.pointer("/$defs/TuiPreferences/properties/emoji/type"), + Some(&"boolean".into()) + ); + assert_eq!( + schema.pointer("/$defs/TuiPreferences/properties/emoji/default"), + Some(&true.into()) + ); assert_eq!( schema.pointer("/properties/version/minimum"), Some(&1.into()) diff --git a/devenv/hooks/hook.fish b/devenv/hooks/hook.fish index e732c90f78..e2a6fa7ae9 100644 --- a/devenv/hooks/hook.fish +++ b/devenv/hooks/hook.fish @@ -56,13 +56,14 @@ function _devenv_hook_activate if test -n "$DEVENV_ROOT" return end - # `command` skips user functions named `env` (e.g. grc wraps it and pipes stdout). + # `command` skips user functions shadowing external tools (e.g. grc wraps + # `env` and pipes stdout, so `devenv shell` never sees the terminal). command env -C $project_dir _DEVENV_HOOK_DIR=$project_dir _DEVENV_CALLER=hook _DEVENV_SHELL_HINT=fish devenv shell@DEVENV_SHELL_ARGS@ # If the devenv shell exited due to cd outside the project, follow the user there set -l exit_dir_file "$project_dir/.devenv/exit-dir" if test -f "$exit_dir_file" - set -l target_dir (cat "$exit_dir_file") - rm -f "$exit_dir_file" + set -l target_dir (command cat "$exit_dir_file") + command rm -f "$exit_dir_file" if test -d "$target_dir" # `builtin cd`, not `cd`: avoids "zoxide: infinite loop detected" # when the user overrides `cd` (e.g. `zoxide init --cmd=cd`). @@ -103,9 +104,9 @@ function _devenv_hook --on-event fish_prompt # Suppress stderr when re-checking the same untrusted PWD (hint already shown). set -l project_dir if test "$_DEVENV_HOOK_UNTRUSTED" = "$PWD" - set project_dir (devenv hook-should-activate 2>/dev/null) + set project_dir (command devenv hook-should-activate 2>/dev/null) else - set project_dir (devenv hook-should-activate) + set project_dir (command devenv hook-should-activate) end set -l exit_code $status diff --git a/devenv/src/devenv/machines.rs b/devenv/src/devenv/machines.rs index db68f997e5..c5ceca8cb9 100644 --- a/devenv/src/devenv/machines.rs +++ b/devenv/src/devenv/machines.rs @@ -1122,11 +1122,22 @@ fn target_secretspec_installer_script( /// Build the `NIX_SSHOPTS` env var value used by `nix copy`. Nix parses this /// as a shell-style word list, so preserve every argv token's boundary. fn nix_ssh_opts_env(user_opts: &[String]) -> String { - ssh_opts_argv(user_opts) - .iter() - .map(|token| shell_quote(token)) - .collect::>() - .join(" ") + // Nix waits for this local command to signal that SSH is connected. Pin + // both settings before the install policy and configured options because + // OpenSSH uses the first value. Direct SSH commands retain the policy's + // PermitLocalCommand=no; only Nix's fixed handshake is allowed here. + [ + "-o", + "PermitLocalCommand=yes", + "-o", + "LocalCommand=echo started", + ] + .into_iter() + .map(String::from) + .chain(ssh_opts_argv(user_opts)) + .map(|token| shell_quote(&token)) + .collect::>() + .join(" ") } /// One row in the `devenv machines info` table. Columns follow the @@ -3560,10 +3571,28 @@ mod tests { let env = nix_ssh_opts_env(&user); assert_eq!( env, - r#"'-o' 'ProxyCommand=ssh -W %h:%p bastion' '-i' '/tmp/team'\''s identity' '-o' 'StrictHostKeyChecking=accept-new' '-o' 'ConnectTimeout=10'"# + r#"'-o' 'PermitLocalCommand=yes' '-o' 'LocalCommand=echo started' '-o' 'ProxyCommand=ssh -W %h:%p bastion' '-i' '/tmp/team'\''s identity' '-o' 'StrictHostKeyChecking=accept-new' '-o' 'ConnectTimeout=10'"# ); } + #[test] + fn nix_ssh_handshake_overrides_sensitive_install_policy_and_custom_local_command() { + let user = vec![ + "-o".to_string(), + "LocalCommand=touch /tmp/unwanted".to_string(), + ]; + let configured = sensitive_install_ssh_opts(&user); + let env = nix_ssh_opts_env(&configured); + assert!(env.starts_with("'-o' 'PermitLocalCommand=yes' '-o' 'LocalCommand=echo started' ")); + assert!(env.contains("'StrictHostKeyChecking=yes'")); + assert!(env.contains("'ClearAllForwardings=yes'")); + assert!(env.contains("'SendEnv=-*'")); + + let direct = ssh_opts_argv(&configured); + assert!(direct.iter().any(|opt| opt == "PermitLocalCommand=no")); + assert!(!direct.iter().any(|opt| opt == "PermitLocalCommand=yes")); + } + #[cfg(target_os = "linux")] #[tokio::test] async fn install_file_receiver_supports_root_and_replaces_only_after_complete_payload() { diff --git a/devenv/src/main.rs b/devenv/src/main.rs index 9a4971d786..438582d341 100644 --- a/devenv/src/main.rs +++ b/devenv/src/main.rs @@ -904,10 +904,16 @@ fn backend_thread_main( }) } +/// Presentation settings for the interactive PTY shell session. +struct ShellSessionOptions { + keybindings: devenv_shell::keybindings::ShellKeybindings, + indicators: devenv_shell::indicators::Indicators, +} + fn frontend_thread_main( renderer: Renderer, session_status_line: Option, - shell_keybindings: devenv_shell::keybindings::ShellKeybindings, + shell_session: ShellSessionOptions, frontend_rx: tokio_mpsc::Receiver, event_tx: tokio_mpsc::Sender, verbosity: VerbosityLevel, @@ -924,7 +930,8 @@ fn frontend_thread_main( .block_on( ShellSession::with_defaults() .with_status_line(show_status_line) - .with_keybindings(shell_keybindings) + .with_keybindings(shell_session.keybindings) + .with_indicators(shell_session.indicators) .with_shutdown_token(shutdown.cancellation_token()) .run(frontend_rx, event_tx, SessionIo::default()), ) @@ -960,7 +967,10 @@ fn run(prepared: PreparedCommand, caller: Caller) -> Result { let (renderer, _activity_guard) = Renderer::init(&frontend); let tui = matches!(&renderer, Renderer::Tui { .. }); - let shell_keybindings = frontend.shell_keybindings.clone(); + let shell_session = ShellSessionOptions { + keybindings: frontend.shell_keybindings.clone(), + indicators: frontend.tui_preferences.indicators(), + }; let _tracing_guard = devenv_tracing::init_tracing(frontend.log_level, &frontend.tracing_specs); @@ -1045,7 +1055,7 @@ fn run(prepared: PreparedCommand, caller: Caller) -> Result { frontend_thread_main( renderer, session_status_line, - shell_keybindings, + shell_session, frontend_rx, event_tx, verbosity, diff --git a/devenv/src/user_config.rs b/devenv/src/user_config.rs index 3b6c8ffe6b..8b838db93a 100644 --- a/devenv/src/user_config.rs +++ b/devenv/src/user_config.rs @@ -53,6 +53,22 @@ mod tests { ); } + #[test] + fn emoji_setting_is_loaded_and_defaults_to_true() { + let directory = tempfile::tempdir().unwrap(); + let path = directory.path().join("config.yaml"); + + std::fs::write(&path, "version: 1\n").unwrap(); + let config = load(Some(&path)).unwrap(); + assert!(config.tui.emoji); + assert!(config.tui.indicators().emoji()); + + std::fs::write(&path, "version: 1\ntui:\n emoji: false\n").unwrap(); + let config = load(Some(&path)).unwrap(); + assert!(!config.tui.emoji); + assert!(!config.tui.indicators().emoji()); + } + #[test] fn explicit_missing_file_is_an_error() { let directory = tempfile::tempdir().unwrap(); diff --git a/devenv/tests/hook_outer_shell_survives.rs b/devenv/tests/hook_outer_shell_survives.rs index 3a947c9c62..6b86592e41 100644 --- a/devenv/tests/hook_outer_shell_survives.rs +++ b/devenv/tests/hook_outer_shell_survives.rs @@ -10,6 +10,7 @@ //! - `posix_activates_sibling_after_cd_out` — #2944 //! - `activates_again_after_returning_to_the_same_project` — stale //! `_DEVENV_HOOK_ACTIVATED` after a follow-cd (`nu_` variant for nushell) +//! - `fish_hook_bypasses_user_functions_shadowing_external_tools` — #3222 use std::fs; use std::os::unix::fs::PermissionsExt; @@ -498,6 +499,61 @@ fn fish_follow_cd_out_preserves_history_for_cd_dash() { ); } +#[test] +fn fish_hook_bypasses_user_functions_shadowing_external_tools() { + // #3222: grc's fish plugin defines `function env; grc.wrap env $argv; end`, + // which pipes stdout through `grcat`, so the hook-spawned `devenv shell` + // never saw the terminal and auto-activation hung. The hook must reach the + // real executables for every external tool it runs. + if !have("fish") { + return; + } + let project = fake_project(); + let target = tempfile::tempdir().unwrap(); + let (shim_dir, calls) = cd_out_shim(project.path(), target.path()); + + let bin = devenv_bin(); + let script = format!( + "set -e DEVENV_ROOT; set -e _DEVENV_HOOK_DIR\n\ + for tool in env cat rm devenv\n\ + function $tool --inherit-variable tool\n\ + echo INTERCEPTED_$tool\n\ + return 97\n\ + end\n\ + end\n\ + {bin} hook fish | source\n\ + {po}\n\ + builtin cd {project:?}\n\ + _devenv_hook\n\ + echo AFTER=$PWD\n", + po = fish_path_override(shim_dir.path()), + project = project.path(), + ); + let out = run("fish", &script); + let stdout = String::from_utf8_lossy(&out.stdout); + let stderr = String::from_utf8_lossy(&out.stderr); + assert!( + !stdout.contains("INTERCEPTED_"), + "fish hook called a user function instead of the real tool.\n\ + stdout: {stdout}\nstderr: {stderr}", + ); + let recorded = fs::read_to_string(&calls).unwrap_or_default(); + assert_eq!( + recorded, + format!("shell {}\n", project.path().display()), + "fish hook did not spawn exactly one devenv shell.\nstdout: {stdout}\nstderr: {stderr}", + ); + assert!( + stdout.contains(&format!("AFTER={}", target.path().display())), + "fish hook did not follow the user out via the exit-dir file.\n\ + stdout: {stdout}\nstderr: {stderr}", + ); + assert!( + !project.path().join(".devenv/exit-dir").exists(), + "fish hook did not remove the exit-dir file", + ); +} + /// A shimmed `devenv` whose `shell` records the call and reports that the user /// cd'd out to `target`, i.e. the hook-spawned shell left the project. fn cd_out_shim(project: &Path, target: &Path) -> (tempfile::TempDir, PathBuf) { diff --git a/docs/public/devenv.user.schema.json b/docs/public/devenv.user.schema.json index 7474450511..327c6b912c 100644 --- a/docs/public/devenv.user.schema.json +++ b/docs/public/devenv.user.schema.json @@ -12,6 +12,7 @@ "tui": { "$ref": "#/$defs/TuiPreferences", "default": { + "emoji": true, "viewport": "inline", "theme": { "preset": "devenv", @@ -96,6 +97,11 @@ "TuiPreferences": { "type": "object", "properties": { + "emoji": { + "description": "Use emoji for display indicators, such as the eye in the shell status line.\nSet to `false` to use non-emoji Unicode glyphs instead.", + "type": "boolean", + "default": true + }, "viewport": { "$ref": "#/$defs/ViewportPlacement", "default": "inline" diff --git a/docs/src/content/docs/languages/elixir.md b/docs/src/content/docs/languages/elixir.md index aecd0f820a..04e2d55baf 100644 --- a/docs/src/content/docs/languages/elixir.md +++ b/docs/src/content/docs/languages/elixir.md @@ -4,6 +4,15 @@ title: "elixir" +Enable Elixir with: + +```nix +languages.elixir.enable = true; +``` + +Since devenv 2.4.1, this also provides `erl`, `erlc`, and `escript` from the Erlang runtime used to build your selected Elixir package. Selecting a different `languages.elixir.package` automatically selects its matching runtime. + +For custom packages that do not expose their Erlang dependency, set `languages.elixir.erlang.package` explicitly to the runtime used to build that package. [comment]: # (Please add your documentation on top of this line) @@ -64,6 +73,32 @@ pkgs.beamPackages.elixir +### languages.elixir.erlang.package + + + +The Erlang runtime to include in the environment alongside Elixir. +Defaults to the runtime used to build the selected Elixir package. +Set this explicitly for custom packages that do not expose their Erlang dependency. + + + +*Type:* +package + + + +*Default:* + +```nix +the Erlang runtime used to build languages.elixir.package +``` + +*Declared by:* + - [https://github.com/cachix/devenv/blob/main/src/modules/languages/elixir.nix](https://github.com/cachix/devenv/blob/main/src/modules/languages/elixir.nix) + + + ### languages.elixir.lsp.enable diff --git a/docs/src/content/docs/languages/zig.md b/docs/src/content/docs/languages/zig.md index 34dd7899f6..d5f702f06b 100644 --- a/docs/src/content/docs/languages/zig.md +++ b/docs/src/content/docs/languages/zig.md @@ -6,7 +6,8 @@ title: "zig" ## Getting Started -The simplest way to get started with Zig is to use the `version` attribute, which automatically sets up both the Zig compiler and ZLS (Zig Language Server) from the [zig-overlay](https://github.com/mitchellh/zig-overlay): +Use the `version` attribute to select the Zig compiler from [zig-overlay](https://github.com/mitchellh/zig-overlay) +and the matching [ZLS](https://github.com/zigtools/zls) (Zig Language Server) release: ```nix languages.zig = { @@ -20,13 +21,25 @@ This will automatically: - Use the specified Zig version from zig-overlay - Install the corresponding ZLS version (e.g., version "0.15.1" uses ZLS 0.15.0) +Add the required inputs before starting the environment. For the example above: + +```sh +devenv inputs add zig-overlay github:mitchellh/zig-overlay --follows nixpkgs +devenv inputs add zls github:zigtools/zls/0.15.0 --follows nixpkgs --follows zig-overlay +``` + +For Zig 0.16.0, use `version = "0.16.0"` and add ZLS with +`devenv inputs add zls github:zigtools/zls/0.16.0 --follows nixpkgs`. +ZLS 0.16 uses its own `zig-flake` input instead of zig-overlay. +Setting `languages.zig.lsp.enable = false` disables ZLS and removes the need for the `zls` input. + Alternatively, you can manually specify packages: ```nix languages.zig = { enable = true; package = pkgs.zig; - zls.package = pkgs.zls; + lsp.package = pkgs.zls; }; ``` @@ -149,7 +162,8 @@ pkgs.zls The Zig version to use. -This automatically sets the ` languages.zig.package ` and ` languages.zig.lsp.package ` using [zig-overlay](https://github.com/mitchellh/zig-overlay). +This sets ` languages.zig.package ` using [zig-overlay](https://github.com/mitchellh/zig-overlay) +and ` languages.zig.lsp.package ` using the matching [ZLS](https://github.com/zigtools/zls) release. diff --git a/docs/src/content/docs/processes.mdx b/docs/src/content/docs/processes.mdx index b681fdd8f5..8171445943 100644 --- a/docs/src/content/docs/processes.mdx +++ b/docs/src/content/docs/processes.mdx @@ -191,7 +191,7 @@ In Bash, Zsh, and Fish, shell completion suggests configured process names for The suggestions use the same cache as task completion. Run `devenv tasks list` to populate it immediately, or try completion again after the first attempt. -A bare `devenv up` starts only processes with `start.enable = true`; explicitly named processes always start, even when their `start.enable` is `false`. The same applies to `devenv processes start `, which uses the same dependency-aware launch path: if a dependency is not running, the process waits for it instead of starting without it. When no process manager is running yet, `devenv processes start ` starts one in the background launching only the named process, like `devenv up -d `. +A bare `devenv up` starts only processes with `start.enable = true`; explicitly named processes always start, even when their `start.enable` is `false`. The same applies to `devenv processes start `. Starting a named process also starts its dependencies that have never started and have `start.enable = true`. Dependencies explicitly stopped by the user, or configured with `start.enable = false`, stay off; the named process waits for them. When no process manager is running yet, `devenv processes start ` starts one in the background launching the named process and its enabled dependencies, like `devenv up -d `. The attached client is a non-interactive live view: stdin is not connected to the processes, and Ctrl-C detaches while leaving them running (the TUI restart/stop keybindings still work). diff --git a/docs/src/content/docs/services/mailpit.md b/docs/src/content/docs/services/mailpit.md index f9e96cc1a4..ff40aa9f4e 100644 --- a/docs/src/content/docs/services/mailpit.md +++ b/docs/src/content/docs/services/mailpit.md @@ -104,6 +104,10 @@ list of strings concatenated with “\\n” Listen address for SMTP. +Either ` : `, where the port is the base devenv allocates +from, or a unix socket as ` unix:: `, which is passed +to mailpit as given. Mailpit requires the permissions. + *Type:* @@ -117,6 +121,14 @@ string "127.0.0.1:1025" ``` + + +*Example:* + +```nix +"unix:${config.env.DEVENV_RUNTIME}/mailpit-smtp.sock:660" +``` + *Declared by:* - [https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix) @@ -128,6 +140,10 @@ string Listen address for UI. +Either ` : `, where the port is the base devenv allocates +from, or a unix socket as ` unix:: `, which is passed +to mailpit as given. Mailpit requires the permissions. + *Type:* @@ -141,5 +157,13 @@ string "127.0.0.1:8025" ``` + + +*Example:* + +```nix +"unix:${config.env.DEVENV_RUNTIME}/mailpit-ui.sock:660" +``` + *Declared by:* - [https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix](https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix) diff --git a/docs/src/content/docs/tui-customization.md b/docs/src/content/docs/tui-customization.md index 99a391e7b4..7fd3c507c0 100644 --- a/docs/src/content/docs/tui-customization.md +++ b/docs/src/content/docs/tui-customization.md @@ -45,6 +45,7 @@ This example keeps the TUI at the command's terminal position, adds profiles and version: 1 tui: + emoji: true viewport: inline theme: preset: devenv @@ -98,6 +99,25 @@ tui: viewport: top ``` +## Emoji and glyphs + +`tui.emoji` selects between emoji and non-emoji Unicode glyphs for display indicators. It defaults to `true`, which keeps the existing output. Added in devenv 2.4.1. + +```yaml +version: 1 +tui: + emoji: false +``` + +It applies to the persistent status line in an interactive `devenv shell`. The TUI's activity views currently use no emoji, so the setting changes nothing there: + +| Indicator | `emoji: true` | `emoji: false` | +| --- | --- | --- | +| Watching files (`devenv watching 11 files`) | `👁` | `◉` | +| File watching paused (`devenv paused`) | `⏸` | `○` | + +Terminals disagree on how wide emoji are, so the non-emoji glyphs are the plain single-column status dots that devenv also uses for process states. Other symbols, such as the braille spinner and the checkmark, are not emoji and do not change. The setting does not hide the status line (see `tui.statusline.enabled`), disable file watching, or change automatic reloads, text, colors, or keybindings. Changes take effect when you start a new shell. + ## Statusline layouts `tui.statusline.position` accepts `inline` (the default), `top`, or `bottom`. `inline` keeps devenv's normal terminal behavior by placing the statusline directly after the current activity output without reserving the terminal height. `top` and `bottom` are sticky modes that pin the statusline to the chosen terminal edge as activities expand or collapse. Fullscreen logs always fill the terminal. In fullscreen logs, `inline` uses the conventional bottom footer. diff --git a/docs/src/data/options.json b/docs/src/data/options.json index 4df62ca39c..7204d2c7b4 100644 --- a/docs/src/data/options.json +++ b/docs/src/data/options.json @@ -1 +1 @@ -{"android.abis": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"arm64-v8a\"\n \"x86_64\"\n]"}, "description": "The Android ABIs to install.\nBy default, the arm64-v8a and x86_64 ABIs are installed.\n", "loc": ["android", "abis"], "readOnly": false, "type": "list of string"}, "android.android-studio.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable the installation of Android Studio.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["android", "android-studio", "enable"], "readOnly": false, "type": "boolean"}, "android.android-studio.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.android-studio"}, "description": "The Android Studio package to use.\nBy default, the Android Studio package from nixpkgs is used.\n", "loc": ["android", "android-studio", "package"], "readOnly": false, "type": "package"}, "android.buildTools.version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"34.0.0\"\n]"}, "description": "The version of the Android build tools to install.\nBy default, version 30.0.3 is installed or [ \"35.0.0\" \"33.0.2\" \"30.0.3\" ] if flutter is enabled.\n", "loc": ["android", "buildTools", "version"], "readOnly": false, "type": "list of string"}, "android.cmake.version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"3.22.1\"\n]"}, "description": "The CMake versions to install for Android.\nBy default, version 3.22.1 is installed.\n", "loc": ["android", "cmake", "version"], "readOnly": false, "type": "list of string"}, "android.cmdLineTools.version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "\"11.0\""}, "description": "The version of the Android command line tools to install.\nBy default, version 11.0 is installed or 8.0 if flutter is enabled.\n", "loc": ["android", "cmdLineTools", "version"], "readOnly": false, "type": "string"}, "android.emulator.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to include the Android Emulator.\nBy default, the emulator is included.\n", "loc": ["android", "emulator", "enable"], "readOnly": false, "type": "boolean"}, "android.emulator.version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalMD", "text": "Latest version in nixpkgs"}, "description": "The version of the Android Emulator to install.\nAvailable versions depend on the nixpkgs version.\nTo see available versions, try building with an invalid version; the error message will list all available options.\n", "loc": ["android", "emulator", "version"], "readOnly": false, "type": "string"}, "android.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Android Development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["android", "enable"], "readOnly": false, "type": "boolean"}, "android.extraLicenses": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"android-sdk-preview-license\"\n \"android-googletv-license\"\n \"android-sdk-arm-dbt-license\"\n \"google-gdk-license\"\n \"intel-android-extra-license\"\n \"intel-android-sysimage-license\"\n \"mips-android-sysimage-license\"\n]"}, "description": "The additional Android licenses to accept.\nBy default, several standard licenses are accepted.\n", "loc": ["android", "extraLicenses"], "readOnly": false, "type": "list of string"}, "android.extras": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"extras;google;gcm\"\n]"}, "description": "The Android extras to install.\nBy default, the Google Cloud Messaging (GCM) extra is installed.\n", "loc": ["android", "extras"], "readOnly": false, "type": "list of string"}, "android.flutter.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to include the Flutter tools.\n", "loc": ["android", "flutter", "enable"], "readOnly": false, "type": "boolean"}, "android.flutter.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.flutter"}, "description": "The Flutter package to use.\nBy default, the Flutter package from nixpkgs is used.\n", "loc": ["android", "flutter", "package"], "readOnly": false, "type": "package"}, "android.googleAPIs.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to use the Google APIs.\nBy default, the Google APIs are used.\n", "loc": ["android", "googleAPIs", "enable"], "readOnly": false, "type": "boolean"}, "android.googleTVAddOns.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to use the Google TV Add-Ons.\nBy default, the Google TV Add-Ons are used.\n", "loc": ["android", "googleTVAddOns", "enable"], "readOnly": false, "type": "boolean"}, "android.ndk.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to include the Android NDK (Native Development Kit).\nBy default, the NDK is included.\n", "loc": ["android", "ndk", "enable"], "readOnly": false, "type": "boolean"}, "android.ndk.version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"26.1.10909125\"\n]"}, "description": "The version of the Android NDK (Native Development Kit) to install.\nBy default, version 26.1.10909125 is installed or for flutter version 28.2.13676358.\n", "loc": ["android", "ndk", "version"], "readOnly": false, "type": "list of string"}, "android.platformTools.version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalMD", "text": "Latest version in nixpkgs"}, "description": "The version of the Android platform tools to install.\nAvailable versions depend on the nixpkgs version.\nTo see available versions, try building with an invalid version; the error message will list all available options.\n", "loc": ["android", "platformTools", "version"], "readOnly": false, "type": "string"}, "android.platforms.version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"32\"\n \"34\"\n \"36\"\n]"}, "description": "The Android platform versions to install.\nBy default, versions 32, 34 and 36 are installed.\n", "loc": ["android", "platforms", "version"], "readOnly": false, "type": "list of string"}, "android.reactNative.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to include the React Native tools.\n", "loc": ["android", "reactNative", "enable"], "readOnly": false, "type": "boolean"}, "android.sources.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to include the Android sources.\nBy default, the sources are not included.\n", "loc": ["android", "sources", "enable"], "readOnly": false, "type": "boolean"}, "android.systemImageTypes": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"google_apis_playstore\"\n]"}, "description": "The Android system image types to install.\nBy default, the google_apis_playstore system image is installed.\n", "loc": ["android", "systemImageTypes"], "readOnly": false, "type": "list of string"}, "android.systemImages.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to include the Android system images.\nBy default, the system images are included.\n", "loc": ["android", "systemImages", "enable"], "readOnly": false, "type": "boolean"}, "android.tools.version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "\"26.1.1\""}, "description": "The version of the Android SDK tools to install.\nBy default, version 26.1.1 is installed.\n", "loc": ["android", "tools", "version"], "readOnly": false, "type": "string"}, "apple.sdk": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix"}], "default": {"_type": "literalExpression", "text": "if pkgs.stdenv.hostPlatform.isDarwin then pkgs.apple-sdk else null"}, "description": "The Apple SDK to add to the developer environment on macOS.\n\nIf set to `null`, the system SDK can be used if the shell allows access to external environment variables.\n", "example": {"_type": "literalExpression", "text": "pkgs.apple-sdk_15"}, "loc": ["apple", "sdk"], "readOnly": false, "type": "null or package"}, "aws-vault.awscliWrapper": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix"}], "default": {"_type": "literalExpression", "text": "pkgs"}, "description": "Attribute set of packages including awscli2", "loc": ["aws-vault", "awscliWrapper"], "readOnly": false, "type": "submodule"}, "aws-vault.awscliWrapper.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Wraps awscli2 binary as `aws-vault exec -- aws `.\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["aws-vault", "awscliWrapper", "enable"], "readOnly": false, "type": "boolean"}, "aws-vault.awscliWrapper.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.awscli2"}, "description": "The awscli2 package to use.", "loc": ["aws-vault", "awscliWrapper", "package"], "readOnly": false, "type": "package"}, "aws-vault.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable aws-vault integration.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["aws-vault", "enable"], "readOnly": false, "type": "boolean"}, "aws-vault.opentofuWrapper": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix"}], "default": {"_type": "literalExpression", "text": "pkgs"}, "description": "Attribute set of packages including opentofu", "loc": ["aws-vault", "opentofuWrapper"], "readOnly": false, "type": "submodule"}, "aws-vault.opentofuWrapper.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Wraps opentofu binary as `aws-vault exec -- opentofu `.\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["aws-vault", "opentofuWrapper", "enable"], "readOnly": false, "type": "boolean"}, "aws-vault.opentofuWrapper.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.opentofu"}, "description": "The opentofu package to use.", "loc": ["aws-vault", "opentofuWrapper", "package"], "readOnly": false, "type": "package"}, "aws-vault.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.aws-vault"}, "description": "The aws-vault package to use.", "loc": ["aws-vault", "package"], "readOnly": false, "type": "package"}, "aws-vault.profile": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix"}], "description": "The profile name passed to `aws-vault exec`.\n", "loc": ["aws-vault", "profile"], "readOnly": false, "type": "string"}, "aws-vault.terraformWrapper": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix"}], "default": {"_type": "literalExpression", "text": "pkgs"}, "description": "Attribute set of packages including terraform", "loc": ["aws-vault", "terraformWrapper"], "readOnly": false, "type": "submodule"}, "aws-vault.terraformWrapper.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Wraps terraform binary as `aws-vault exec -- terraform `.\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["aws-vault", "terraformWrapper", "enable"], "readOnly": false, "type": "boolean"}, "aws-vault.terraformWrapper.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.terraform"}, "description": "The terraform package to use.", "loc": ["aws-vault", "terraformWrapper", "package"], "readOnly": false, "type": "package"}, "cachix.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/cachix.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/cachix.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Cachix integration.", "loc": ["cachix", "enable"], "readOnly": false, "type": "boolean"}, "cachix.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/cachix.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/cachix.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.cachix"}, "description": "The cachix package to use.", "loc": ["cachix", "package"], "readOnly": false, "type": "package"}, "cachix.pull": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/cachix.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/cachix.nix"}], "default": {"_type": "literalExpression", "text": "[ \"devenv\" ]"}, "description": "Which Cachix caches to pull from.", "loc": ["cachix", "pull"], "readOnly": false, "type": "list of string"}, "cachix.push": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/cachix.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/cachix.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Which Cachix cache to push to. This cache is also added to `cachix.pull`.", "loc": ["cachix", "push"], "readOnly": false, "type": "null or string"}, "certFile": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/mkcert.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/mkcert.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Custom certificate file name, uses mkcert default if unset", "example": {"_type": "literalExpression", "text": "\"mycert.pem\""}, "loc": ["certFile"], "readOnly": false, "type": "null or string"}, "certificates": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/mkcert.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/mkcert.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of domains to generate certificates for.", "example": {"_type": "literalExpression", "text": "[\n \"example.com\"\n \"*.example.com\"\n]"}, "loc": ["certificates"], "readOnly": false, "type": "list of string"}, "changelogs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/changelogs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/changelogs.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of changelog entries for this module.", "loc": ["changelogs"], "readOnly": false, "type": "list of (submodule)"}, "changelogs.*.date": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/changelogs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/changelogs.nix"}], "description": "Date of the changelog entry in YYYY-MM-DD format.", "example": {"_type": "literalExpression", "text": "\"2025-01-15\""}, "loc": ["changelogs", "*", "date"], "readOnly": false, "type": "string matching the pattern ^[0-9]{4}-[0-9]{2}-[0-9]{2}$"}, "changelogs.*.description": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/changelogs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/changelogs.nix"}], "description": "Markdown description of the change.", "loc": ["changelogs", "*", "description"], "readOnly": false, "type": "string"}, "changelogs.*.title": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/changelogs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/changelogs.nix"}], "description": "Title of the changelog entry.", "example": {"_type": "literalExpression", "text": "\"git-hooks.package is now pkgs.prek\""}, "loc": ["changelogs", "*", "title"], "readOnly": false, "type": "string"}, "changelogs.*.when": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/changelogs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/changelogs.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to include this changelog entry (useful for conditional changelogs).", "loc": ["changelogs", "*", "when"], "readOnly": false, "type": "boolean"}, "claude.code.agent": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The agent to use as Claude Code's primary agent.", "loc": ["claude", "code", "agent"], "readOnly": false, "type": "null or string"}, "claude.code.agents": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Custom Claude Code sub-agents to create in the project.\nSub-agents are specialized AI assistants that handle specific tasks\nwith their own context window and can be invoked automatically or explicitly.\n\nFor more details, see: https://docs.anthropic.com/en/docs/claude-code/sub-agents\n", "example": {"_type": "literalExpression", "text": "{\n code-reviewer = {\n description = \"Expert code review specialist that checks for quality, security, and best practices. Use proactively after code changes.\";\n model = \"opus\";\n tools = [ \"Read\" \"Grep\" \"TodoWrite\" ];\n permissionMode = \"plan\";\n prompt = ''\n You are an expert code reviewer. When reviewing code, check for:\n - Code readability and maintainability\n - Proper error handling\n - Security vulnerabilities\n - Performance issues\n - Adherence to project conventions\n\n Provide constructive feedback with specific suggestions for improvement.\n '';\n };\n\n test-writer = {\n description = \"Specialized in writing comprehensive test suites\";\n tools = [ \"Read\" \"Write\" \"Edit\" \"Bash\" ];\n prompt = ''\n You are a test writing specialist. Create comprehensive test suites that:\n - Cover edge cases and error conditions\n - Follow the project's testing conventions\n - Include unit, integration, and property-based tests where appropriate\n - Have clear test names that describe what is being tested\n '';\n };\n}\n"}, "loc": ["claude", "code", "agents"], "readOnly": false, "type": "attribute set of (submodule)"}, "claude.code.agents..description": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "description": "What the sub-agent does", "loc": ["claude", "code", "agents", "", "description"], "readOnly": false, "type": "string"}, "claude.code.agents..effort": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Override the effort level for this agent.", "loc": ["claude", "code", "agents", "", "effort"], "readOnly": false, "type": "null or one of \"low\", \"medium\", \"high\", \"xhigh\", \"max\""}, "claude.code.agents..model": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Override the model for this agent.\nAccepts an alias (`sonnet`, `opus`, `haiku`, `fable`), a full model ID (e.g. `claude-opus-5`), or `inherit`.\n", "example": {"_type": "literalExpression", "text": "\"opus\""}, "loc": ["claude", "code", "agents", "", "model"], "readOnly": false, "type": "null or string"}, "claude.code.agents..permissionMode": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Permission mode for this specific sub-agent.\n`manual` is an alias for `default`.\n", "loc": ["claude", "code", "agents", "", "permissionMode"], "readOnly": false, "type": "null or one of \"default\", \"manual\", \"acceptEdits\", \"plan\", \"auto\", \"dontAsk\", \"bypassPermissions\""}, "claude.code.agents..prompt": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "description": "The system prompt for the sub-agent", "loc": ["claude", "code", "agents", "", "prompt"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "claude.code.agents..tools": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of allowed tools for this sub-agent", "loc": ["claude", "code", "agents", "", "tools"], "readOnly": false, "type": "list of string"}, "claude.code.apiKeyHelper": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Custom script for generating authentication tokens.\nThe script should output the API key to stdout.\n", "example": {"_type": "literalExpression", "text": "\"aws secretsmanager get-secret-value --secret-id claude-api-key | jq -r .SecretString\""}, "loc": ["claude", "code", "apiKeyHelper"], "readOnly": false, "type": "null or string"}, "claude.code.cleanupPeriodDays": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Retention period for chat transcripts in days.\n", "example": {"_type": "literalExpression", "text": "30"}, "loc": ["claude", "code", "cleanupPeriodDays"], "readOnly": false, "type": "null or signed integer"}, "claude.code.commands": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Custom Claude Code slash commands to create in the project.\nCommands are invoked with `/command-name` in Claude Code.\n", "example": {"_type": "literalExpression", "text": "{\n test = ''\n Run all tests in the project\n\n ```bash\n cargo test\n ```\n '';\n fmt = ''\n Format all code in the project\n\n ```bash\n cargo fmt\n nixfmt **/*.nix\n ```\n '';\n}\n"}, "loc": ["claude", "code", "commands"], "readOnly": false, "type": "attribute set of string"}, "claude.code.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Claude Code integration with automatic hooks and commands setup.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["claude", "code", "enable"], "readOnly": false, "type": "boolean"}, "claude.code.env": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Custom environment variables for Claude Code sessions.\n", "example": {"_type": "literalExpression", "text": "{\n NODE_ENV = \"development\";\n PYTHONPATH = \"/custom/python/path\";\n}"}, "loc": ["claude", "code", "env"], "readOnly": false, "type": "attribute set of string"}, "claude.code.forceLoginMethod": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Restrict the login method.\n- claudeai: only claude.ai accounts\n- console: only Claude Console (API key) accounts\n- gateway: only a cloud gateway\n", "example": {"_type": "literalExpression", "text": "\"claudeai\""}, "loc": ["claude", "code", "forceLoginMethod"], "readOnly": false, "type": "null or one of \"claudeai\", \"console\", \"gateway\""}, "claude.code.hooks": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Hooks that run at different points in Claude Code's workflow.\n", "example": {"_type": "literalExpression", "text": "{\n protect-secrets = {\n enable = true;\n name = \"Protect sensitive files\";\n hookType = \"PreToolUse\";\n matcher = \"^(Edit|MultiEdit|Write)$\";\n command = ''\n json=$(cat);\n file_path = $(echo \"$json\" | jq - r '.file_path // empty');\n grep -q 'SECRET\\\\|PASSWORD\\\\|API_KEY' \"$file_path\" && echo 'Blocked: sensitive data detected' && exit 1 || exit 0\n '';\n };\n run-tests = {\n enable = true;\n name = \"Run tests after edit\";\n hookType = \"PostToolUse\";\n matcher = \"^(Edit|MultiEdit|Write)$\";\n command = \"cargo test\";\n };\n log-completion = {\n enable = true;\n name = \"Log when Claude finishes\";\n hookType = \"Stop\";\n command = \"echo 'Claude finished responding' >> claude.log\";\n };\n}\n"}, "loc": ["claude", "code", "hooks"], "readOnly": false, "type": "open submodule of attribute set of (submodule)"}, "claude.code.hooks..command": {"declarations": [], "description": "The command to execute.", "loc": ["claude", "code", "hooks", "", "command"], "readOnly": false, "type": "string"}, "claude.code.hooks..enable": {"declarations": [], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable this hook.", "loc": ["claude", "code", "hooks", "", "enable"], "readOnly": false, "type": "boolean"}, "claude.code.hooks..hookType": {"declarations": [], "default": {"_type": "literalExpression", "text": "\"PostToolUse\""}, "description": "The type of hook:\n- PreToolUse: Runs before tool calls (can block them)\n- PostToolUse: Runs after tool calls complete\n- PostToolUseFailure: Runs after a tool call fails\n- Notification: Runs when Claude Code sends notifications\n- UserPromptSubmit: Runs when user submits a prompt\n- SessionStart: Runs when a Claude Code session starts\n- SessionEnd: Runs when a Claude Code session ends\n- Stop: Runs when Claude Code finishes responding\n- SubagentStart: Runs when a subagent task starts\n- SubagentStop: Runs when subagent tasks complete\n- PreCompact: Runs before message compaction\n- PermissionRequest: Runs when a permission is requested\n- WorktreeCreate: Runs when a new worktree is created\n- WorktreeRemove: Runs when a worktree is removed\n- TeammateIdle: Runs when a teammate agent becomes idle\n- TaskCompleted: Runs when a task is completed\n- ConfigChange: Runs when configuration changes\n", "loc": ["claude", "code", "hooks", "", "hookType"], "readOnly": false, "type": "one of \"PreToolUse\", \"PostToolUse\", \"PostToolUseFailure\", \"Notification\", \"UserPromptSubmit\", \"SessionStart\", \"SessionEnd\", \"Stop\", \"SubagentStart\", \"SubagentStop\", \"PreCompact\", \"PermissionRequest\", \"WorktreeCreate\", \"WorktreeRemove\", \"TeammateIdle\", \"TaskCompleted\", \"ConfigChange\""}, "claude.code.hooks..matcher": {"declarations": [], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Regex pattern to match against tool names (for PreToolUse/PostToolUse hooks).", "loc": ["claude", "code", "hooks", "", "matcher"], "readOnly": false, "type": "string"}, "claude.code.hooks..name": {"declarations": [], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "The name of the hook (appears in logs).", "loc": ["claude", "code", "hooks", "", "name"], "readOnly": false, "type": "string"}, "claude.code.hooks.git-hooks-run": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "{\n enable = config.git-hooks.enable;\n name = \"Run git-hooks\";\n hookType = \"PostToolUse\";\n matcher = \"^(Edit|MultiEdit|Write)$\";\n command = \"cd \\\"$DEVENV_ROOT\\\" && \\${config.git-hooks.package.meta.mainProgram} run\";\n}\n"}, "description": "Automatically runs git-hooks after Claude edits files.\nEnabled by default when `git-hooks.enable` is true.\n", "loc": ["claude", "code", "hooks", "git-hooks-run"], "readOnly": false, "type": "submodule"}, "claude.code.hooks.git-hooks-run.command": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "description": "The command to execute.", "loc": ["claude", "code", "hooks", "git-hooks-run", "command"], "readOnly": false, "type": "string"}, "claude.code.hooks.git-hooks-run.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable this hook.", "loc": ["claude", "code", "hooks", "git-hooks-run", "enable"], "readOnly": false, "type": "boolean"}, "claude.code.hooks.git-hooks-run.hookType": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "\"PostToolUse\""}, "description": "The type of hook:\n- PreToolUse: Runs before tool calls (can block them)\n- PostToolUse: Runs after tool calls complete\n- PostToolUseFailure: Runs after a tool call fails\n- Notification: Runs when Claude Code sends notifications\n- UserPromptSubmit: Runs when user submits a prompt\n- SessionStart: Runs when a Claude Code session starts\n- SessionEnd: Runs when a Claude Code session ends\n- Stop: Runs when Claude Code finishes responding\n- SubagentStart: Runs when a subagent task starts\n- SubagentStop: Runs when subagent tasks complete\n- PreCompact: Runs before message compaction\n- PermissionRequest: Runs when a permission is requested\n- WorktreeCreate: Runs when a new worktree is created\n- WorktreeRemove: Runs when a worktree is removed\n- TeammateIdle: Runs when a teammate agent becomes idle\n- TaskCompleted: Runs when a task is completed\n- ConfigChange: Runs when configuration changes\n", "loc": ["claude", "code", "hooks", "git-hooks-run", "hookType"], "readOnly": false, "type": "one of \"PreToolUse\", \"PostToolUse\", \"PostToolUseFailure\", \"Notification\", \"UserPromptSubmit\", \"SessionStart\", \"SessionEnd\", \"Stop\", \"SubagentStart\", \"SubagentStop\", \"PreCompact\", \"PermissionRequest\", \"WorktreeCreate\", \"WorktreeRemove\", \"TeammateIdle\", \"TaskCompleted\", \"ConfigChange\""}, "claude.code.hooks.git-hooks-run.matcher": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Regex pattern to match against tool names (for PreToolUse/PostToolUse hooks).", "loc": ["claude", "code", "hooks", "git-hooks-run", "matcher"], "readOnly": false, "type": "string"}, "claude.code.hooks.git-hooks-run.name": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "The name of the hook (appears in logs).", "loc": ["claude", "code", "hooks", "git-hooks-run", "name"], "readOnly": false, "type": "string"}, "claude.code.mcpServers": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "{\n \"mcp.devenv.sh\" = {\n type = \"http\";\n url = \"https://mcp.devenv.sh\";\n };\n}"}, "description": "MCP (Model Context Protocol) servers to configure.\nThese servers provide additional capabilities and context to Claude Code.\n", "example": {"_type": "literalExpression", "text": "{\n awslabs-iam-mcp-server = {\n type = \"stdio\";\n command = lib.getExe pkgs.awslabs-iam-mcp-server;\n args = [ ];\n env = { };\n };\n github = {\n type = \"http\";\n url = \"https://api.githubcopilot.com/mcp/\";\n headers = {\n Authorization = \"Bearer GITHUB_PAT\";\n };\n };\n linear = {\n type = \"http\";\n url = \"https://mcp.linear.app/mcp\";\n };\n devenv = {\n type = \"stdio\";\n command = \"devenv\";\n args = [ \"mcp\" ];\n env = {\n DEVENV_ROOT = config.devenv.root;\n };\n };\n}\n"}, "loc": ["claude", "code", "mcpServers"], "readOnly": false, "type": "attribute set of (submodule)"}, "claude.code.mcpServers..args": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Arguments to pass to the command for stdio MCP servers.", "loc": ["claude", "code", "mcpServers", "", "args"], "readOnly": false, "type": "list of string"}, "claude.code.mcpServers..command": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Command to execute for stdio MCP servers.", "loc": ["claude", "code", "mcpServers", "", "command"], "readOnly": false, "type": "null or string"}, "claude.code.mcpServers..env": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Environment variables for stdio MCP servers.", "loc": ["claude", "code", "mcpServers", "", "env"], "readOnly": false, "type": "attribute set of string"}, "claude.code.mcpServers..headers": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "HTTP headers for HTTP MCP servers (e.g., for authentication).", "loc": ["claude", "code", "mcpServers", "", "headers"], "readOnly": false, "type": "attribute set of string"}, "claude.code.mcpServers..type": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "description": "Type of MCP server connection.", "loc": ["claude", "code", "mcpServers", "", "type"], "readOnly": false, "type": "one of \"stdio\", \"http\""}, "claude.code.mcpServers..url": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "URL for HTTP MCP servers.", "loc": ["claude", "code", "mcpServers", "", "url"], "readOnly": false, "type": "null or string"}, "claude.code.model": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Override the default Claude model.\n", "example": {"_type": "literalExpression", "text": "\"claude-3-opus-20240229\""}, "loc": ["claude", "code", "model"], "readOnly": false, "type": "null or string"}, "claude.code.permissions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Fine-grained permissions for tool usage.\nSupports global settings and per-tool allow/ask/deny rules.\nTool rules can be placed under `rules` or directly (backward compatible).\n", "example": {"_type": "literalExpression", "text": "{\n defaultMode = \"acceptEdits\";\n disableBypassPermissionsMode = true;\n additionalDirectories = [ \"/shared/libs\" ];\n rules = {\n Edit = {\n deny = [ \"*.secret\" \"*.env\" ];\n };\n Bash = {\n allow = [ \"ls:*\" \"cat:*\" ];\n ask = [ \"git:*\" \"npm:*\" ];\n deny = [ \"rm -rf:*\" \"sudo:*\" ];\n };\n # Use an empty string to emit a bare tool entry for tools\n # without a matcher format (e.g. WebSearch, AskUserQuestion).\n WebSearch.allow = [ \"\" ];\n AskUserQuestion.deny = [ \"\" ];\n };\n}\n"}, "loc": ["claude", "code", "permissions"], "readOnly": false, "type": "open submodule of attribute set of (submodule)"}, "claude.code.permissions..allow": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of allowed patterns. An empty string emits a bare tool entry\n(e.g. `WebSearch` rather than `WebSearch(pattern)`), matching the\ntool regardless of input. Use this for tools without a matcher\nformat such as `WebSearch` or `AskUserQuestion`.\n", "loc": ["claude", "code", "permissions", "", "allow"], "readOnly": false, "type": "list of string"}, "claude.code.permissions..ask": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of patterns that require user approval. An empty string emits\na bare tool entry (e.g. `WebSearch` rather than `WebSearch(pattern)`).\n", "loc": ["claude", "code", "permissions", "", "ask"], "readOnly": false, "type": "list of string"}, "claude.code.permissions..deny": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of denied patterns. An empty string emits a bare tool entry\n(e.g. `AskUserQuestion` rather than `AskUserQuestion(pattern)`),\nwhich is required to deny tools without a matcher format outright.\n", "loc": ["claude", "code", "permissions", "", "deny"], "readOnly": false, "type": "list of string"}, "claude.code.permissions.additionalDirectories": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Allow Claude Code to access directories outside the project root.\n", "example": {"_type": "literalExpression", "text": "[\n \"/shared/libs\"\n \"/common/configs\"\n]"}, "loc": ["claude", "code", "permissions", "additionalDirectories"], "readOnly": false, "type": "list of string"}, "claude.code.permissions.defaultMode": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Global permission mode for Claude Code.\n- default: Prompts on first use of each tool (`manual` is an alias)\n- acceptEdits: Auto-accepts file edits\n- plan: Read-only mode\n- auto: Auto-approves tool calls with background safety checks\n- dontAsk: Auto-denies unless pre-approved via permissions\n- bypassPermissions: Skips all permission prompts\n", "example": {"_type": "literalExpression", "text": "\"acceptEdits\""}, "loc": ["claude", "code", "permissions", "defaultMode"], "readOnly": false, "type": "null or one of \"default\", \"manual\", \"acceptEdits\", \"plan\", \"auto\", \"dontAsk\", \"bypassPermissions\""}, "claude.code.permissions.disableBypassPermissionsMode": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Security option to prevent the dangerous bypassPermissions mode.\nWritten to `settings.json` as `\"disableBypassPermissionsMode\": \"disable\"`.\n", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["claude", "code", "permissions", "disableBypassPermissionsMode"], "readOnly": false, "type": "null or boolean"}, "claude.code.permissions.rules": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Per-tool permission rules. Preferred location for tool permissions.\n", "loc": ["claude", "code", "permissions", "rules"], "readOnly": false, "type": "attribute set of (submodule)"}, "claude.code.permissions.rules..allow": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of allowed patterns. An empty string emits a bare tool entry\n(e.g. `WebSearch` rather than `WebSearch(pattern)`), matching the\ntool regardless of input. Use this for tools without a matcher\nformat such as `WebSearch` or `AskUserQuestion`.\n", "loc": ["claude", "code", "permissions", "rules", "", "allow"], "readOnly": false, "type": "list of string"}, "claude.code.permissions.rules..ask": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of patterns that require user approval. An empty string emits\na bare tool entry (e.g. `WebSearch` rather than `WebSearch(pattern)`).\n", "loc": ["claude", "code", "permissions", "rules", "", "ask"], "readOnly": false, "type": "list of string"}, "claude.code.permissions.rules..deny": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of denied patterns. An empty string emits a bare tool entry\n(e.g. `AskUserQuestion` rather than `AskUserQuestion(pattern)`),\nwhich is required to deny tools without a matcher format outright.\n", "loc": ["claude", "code", "permissions", "rules", "", "deny"], "readOnly": false, "type": "list of string"}, "claude.code.skills": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Custom Claude Code skills to create in the project.\nA skill is a folder of instructions Claude loads on demand when its\ndescription matches the task, keeping specialised knowledge out of the\nalways-on context.\n\nFor more details, see: https://docs.anthropic.com/en/docs/claude-code/skills\n", "example": {"_type": "literalExpression", "text": "{\n database-migrations = {\n description = \"How to write and run migrations in this project. Use when adding, editing or rolling back a migration.\";\n content = ''\n Migrations live in `migrations/` and are applied with `diesel migration run`.\n\n - One logical change per migration; never edit an applied migration.\n - Always write the matching `down.sql`.\n - Run `devenv tasks run db:reset` before opening a pull request.\n '';\n };\n\n api-conventions = {\n description = \"REST conventions for this codebase. Use when adding or changing an HTTP endpoint.\";\n allowedTools = [ \"Read\" \"Grep\" ];\n resources = {\n \"references/error-codes.md\" = ./docs/error-codes.md;\n };\n content = ''\n Endpoints are versioned under `/v1`.\n Read references/error-codes.md before inventing a new error code.\n '';\n };\n}\n"}, "loc": ["claude", "code", "skills"], "readOnly": false, "type": "attribute set of (submodule)"}, "claude.code.skills..agent": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Which subagent type to use when `context = \"fork\"` is set, such as one of\n`claude.code.agents`.\n", "example": {"_type": "literalExpression", "text": "\"code-reviewer\""}, "loc": ["claude", "code", "skills", "", "agent"], "readOnly": false, "type": "null or string"}, "claude.code.skills..allowedTools": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Tools Claude can use without asking permission during the turn that invokes\nthis skill. The grant clears when you send your next message.\n\nThis pre-approves tools rather than restricting them; use `disallowedTools`\nto take tools away.\n", "example": {"_type": "literalExpression", "text": "[\n \"Read\"\n \"Grep\"\n \"Bash(git status:*)\"\n]"}, "loc": ["claude", "code", "skills", "", "allowedTools"], "readOnly": false, "type": "list of string"}, "claude.code.skills..argumentHint": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Hint shown during autocomplete to indicate the expected arguments.", "example": {"_type": "literalExpression", "text": "\"[issue-number]\""}, "loc": ["claude", "code", "skills", "", "argumentHint"], "readOnly": false, "type": "null or string"}, "claude.code.skills..arguments": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Named positional arguments, substituted into `content` as `$name`. Names map\nto argument positions in order.\n", "example": {"_type": "literalExpression", "text": "[\n \"issue\"\n \"branch\"\n]"}, "loc": ["claude", "code", "skills", "", "arguments"], "readOnly": false, "type": "list of string"}, "claude.code.skills..background": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Only applies with `context = \"fork\"`. Set to false to wait for the forked\nsubagent's result in the turn that invoked the skill, instead of letting it\nrun in the background.\n", "loc": ["claude", "code", "skills", "", "background"], "readOnly": false, "type": "null or boolean"}, "claude.code.skills..content": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "description": "The body of SKILL.md, loaded when the skill triggers.", "loc": ["claude", "code", "skills", "", "content"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "claude.code.skills..context": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Set to `fork` to run the skill in a forked subagent context.\n", "loc": ["claude", "code", "skills", "", "context"], "readOnly": false, "type": "null or value \"fork\" (singular enum)"}, "claude.code.skills..copyMode": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "\"symlink\""}, "description": "How to materialise the skill's files, as in `files..copyMode`.\nUse `seed` to hand-edit a skill after devenv writes it once.\n", "loc": ["claude", "code", "skills", "", "copyMode"], "readOnly": false, "type": "one of \"symlink\", \"seed\", \"copy\""}, "claude.code.skills..description": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "description": "What the skill covers and when Claude should load it.\nDescriptions are the only part of a skill kept in context at all\ntimes, so this is what decides whether the skill ever triggers.\n", "loc": ["claude", "code", "skills", "", "description"], "readOnly": false, "type": "string"}, "claude.code.skills..disableModelInvocation": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Prevent Claude from automatically loading this skill. Use for workflows you\nwant to trigger manually with `/\u2039name\u203a`.\n", "loc": ["claude", "code", "skills", "", "disableModelInvocation"], "readOnly": false, "type": "boolean"}, "claude.code.skills..disallowedTools": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Tools removed from Claude's available pool while this skill is active; the\nrestriction clears when you send your next message. Use it for a skill that\nshould never call a given tool, such as an autonomous loop that must not stop\nto ask a question.\n", "example": {"_type": "literalExpression", "text": "[\n \"AskUserQuestion\"\n]"}, "loc": ["claude", "code", "skills", "", "disallowedTools"], "readOnly": false, "type": "list of string"}, "claude.code.skills..effort": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Override the effort level while this skill is active.\nWhich levels are available depends on the model.\n", "loc": ["claude", "code", "skills", "", "effort"], "readOnly": false, "type": "null or one of \"low\", \"medium\", \"high\", \"xhigh\", \"max\""}, "claude.code.skills..model": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Model to use while this skill is active, for the rest of the current turn.\nAccepts an alias (`sonnet`, `opus`, `haiku`, `fable`), a full model ID\n(e.g. `claude-opus-5`), or `inherit`. With `context = \"fork\"` it sets the\nforked subagent's model instead.\n", "example": {"_type": "literalExpression", "text": "\"opus\""}, "loc": ["claude", "code", "skills", "", "model"], "readOnly": false, "type": "null or string"}, "claude.code.skills..resources": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Files placed alongside SKILL.md, keyed by path relative to the\nskill directory. Claude reads these on demand, so bulky reference\nmaterial belongs here rather than in `content`.\n", "example": {"_type": "literalExpression", "text": "{\n \"references/api.md\" = ./api.md;\n \"scripts/check.sh\" = { source = ./check.sh; executable = true; };\n}\n"}, "loc": ["claude", "code", "skills", "", "resources"], "readOnly": false, "type": "attribute set of ((submodule) or absolute path convertible to it)"}, "claude.code.skills..resources..executable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Make the file executable", "loc": ["claude", "code", "skills", "", "resources", "", "executable"], "readOnly": false, "type": "boolean"}, "claude.code.skills..resources..ini": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "ini contents", "loc": ["claude", "code", "skills", "", "resources", "", "ini"], "readOnly": false, "type": "null or (attribute set of section of an INI file (attrs of INI atom (null, bool, int, float or string)))"}, "claude.code.skills..resources..json": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "json contents", "loc": ["claude", "code", "skills", "", "resources", "", "json"], "readOnly": false, "type": "null or JSON value"}, "claude.code.skills..resources..source": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "source contents", "loc": ["claude", "code", "skills", "", "resources", "", "source"], "readOnly": false, "type": "null or absolute path"}, "claude.code.skills..resources..text": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "text contents", "loc": ["claude", "code", "skills", "", "resources", "", "text"], "readOnly": false, "type": "null or string"}, "claude.code.skills..resources..toml": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "toml contents", "loc": ["claude", "code", "skills", "", "resources", "", "toml"], "readOnly": false, "type": "null or TOML value"}, "claude.code.skills..resources..yaml": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "yaml contents", "loc": ["claude", "code", "skills", "", "resources", "", "yaml"], "readOnly": false, "type": "null or YAML 1.1 value"}, "claude.code.skills..userInvocable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether you can invoke the skill yourself with `/\u2039name\u203a`. Set to false when\nonly Claude should invoke it, for background knowledge rather than a command.\n", "loc": ["claude", "code", "skills", "", "userInvocable"], "readOnly": false, "type": "boolean"}, "claude.code.skills..whenToUse": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Additional context for when Claude should invoke the skill, such as trigger\nphrases or example requests. Appended to `description` in the skill listing\nand counts toward the 1536-character cap.\n", "example": {"_type": "literalExpression", "text": "\"Use when the user mentions migrations, schema changes or rollbacks.\""}, "loc": ["claude", "code", "skills", "", "whenToUse"], "readOnly": false, "type": "null or string"}, "container.isBuilding": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Devenv set it to true when the environment is a container.\n\nExample:\n```nix\n{ pkgs, config, lib, ... }:\n{\n packages = [ pkgs.openssl ]\n ++ lib.optionals (!config.container.isBuilding) [ pkgs.git ];\n}\n```\n", "loc": ["container", "isBuilding"], "readOnly": false, "type": "boolean"}, "containers": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Container specifications that can be built, copied and ran using `devenv container`.", "loc": ["containers"], "readOnly": false, "type": "attribute set of (submodule)"}, "containers..copyToRoot": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "self"}, "description": "Add a path to the container. Defaults to the whole git repo.", "loc": ["containers", "", "copyToRoot"], "readOnly": false, "type": "absolute path or list of absolute path"}, "containers..defaultCopyArgs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Default arguments to pass to `skopeo copy`.\nYou can override them by passing arguments to the script.\n", "loc": ["containers", "", "defaultCopyArgs"], "readOnly": false, "type": "list of string"}, "containers..enableLayerDeduplication": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable layer deduplication using the approach described at https://blog.eigenvalue.net/2023-nix2container-everything-once/\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["containers", "", "enableLayerDeduplication"], "readOnly": false, "type": "boolean"}, "containers..entrypoint": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "[ entrypoint ]"}, "description": "Entrypoint of the container.", "loc": ["containers", "", "entrypoint"], "readOnly": false, "type": "list of anything"}, "containers..fromImage": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "An existing OCI base image to build on top of, built with nix2container's pullImage.", "loc": ["containers", "", "fromImage"], "readOnly": false, "type": "null or package"}, "containers..isBuilding": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Set to true when the environment is building this container.", "loc": ["containers", "", "isBuilding"], "readOnly": false, "type": "boolean"}, "containers..layers": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "The layers to create.", "loc": ["containers", "", "layers"], "readOnly": false, "type": "list of (submodule)"}, "containers..layers.*.copyToRoot": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "A list of derivations copied to the image root directory.\n\nStore path prefixes ``/nix/store/hash-path`` are removed in order to relocate them to the image ``/``.\n", "loc": ["containers", "", "layers", "*", "copyToRoot"], "readOnly": false, "type": "list of package"}, "containers..layers.*.deps": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "A list of store paths to include in the layer.", "loc": ["containers", "", "layers", "*", "deps"], "readOnly": false, "type": "list of package"}, "containers..layers.*.ignore": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "A store path to ignore when building the layer. This is mainly useful to ignore the configuration file from the container layer.\n", "loc": ["containers", "", "layers", "*", "ignore"], "readOnly": false, "type": "null or path in the Nix store"}, "containers..layers.*.maxLayers": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "1"}, "description": "The maximum number of layers to create.", "loc": ["containers", "", "layers", "*", "maxLayers"], "readOnly": false, "type": "signed integer"}, "containers..layers.*.perms": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "A list of file permissions which are set when the tar layer is created.\n\nThese permissions are not written to the Nix store.\n", "loc": ["containers", "", "layers", "*", "perms"], "readOnly": false, "type": "list of (submodule)"}, "containers..layers.*.perms.*.gid": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The group ID to apply to all of the files matched by the ``regex``.", "example": {"_type": "literalExpression", "text": "\"1000\""}, "loc": ["containers", "", "layers", "*", "perms", "*", "gid"], "readOnly": false, "type": "null or signed integer"}, "containers..layers.*.perms.*.gname": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The group name to apply to all of the files matched by the ``regex``.", "example": {"_type": "literalExpression", "text": "\"root\""}, "loc": ["containers", "", "layers", "*", "perms", "*", "gname"], "readOnly": false, "type": "null or string"}, "containers..layers.*.perms.*.mode": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The numeric permissions mode to apply to all of the files matched by the ``regex``.", "example": {"_type": "literalExpression", "text": "\"644\""}, "loc": ["containers", "", "layers", "*", "perms", "*", "mode"], "readOnly": false, "type": "null or string"}, "containers..layers.*.perms.*.path": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "description": "A store path.", "loc": ["containers", "", "layers", "*", "perms", "*", "path"], "readOnly": false, "type": "path in the Nix store"}, "containers..layers.*.perms.*.regex": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "A regex pattern to select files or directories to apply the ``mode`` to.", "example": {"_type": "literalExpression", "text": "\".*\""}, "loc": ["containers", "", "layers", "*", "perms", "*", "regex"], "readOnly": false, "type": "null or string"}, "containers..layers.*.perms.*.uid": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The user ID to apply to all of the files matched by the ``regex``.", "example": {"_type": "literalExpression", "text": "\"1000\""}, "loc": ["containers", "", "layers", "*", "perms", "*", "uid"], "readOnly": false, "type": "null or signed integer"}, "containers..layers.*.perms.*.uname": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The user name to apply to all of the files matched by the ``regex``.", "example": {"_type": "literalExpression", "text": "\"root\""}, "loc": ["containers", "", "layers", "*", "perms", "*", "uname"], "readOnly": false, "type": "null or string"}, "containers..layers.*.reproducible": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether the layer should be reproducible.", "loc": ["containers", "", "layers", "*", "reproducible"], "readOnly": false, "type": "boolean"}, "containers..maxLayers": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "1"}, "description": "Maximum number of container layers created.", "loc": ["containers", "", "maxLayers"], "readOnly": false, "type": "null or signed integer"}, "containers..name": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "\"top-level name or containers.mycontainer.name\""}, "description": "Name of the container.", "loc": ["containers", "", "name"], "readOnly": false, "type": "null or string"}, "containers..registry": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "\"docker-daemon:\""}, "description": "Registry to push the container to.", "loc": ["containers", "", "registry"], "readOnly": false, "type": "null or string"}, "containers..startupCommand": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Command to run in the container.\n\nCan be a string, a package, or a list of strings for individual arguments.\nUse a list when your entrypoint expects separate arguments, e.g.:\n`startupCommand = [ \"-f\" \"/var/lib/haproxy/haproxy.cfg\" ];`\n", "loc": ["containers", "", "startupCommand"], "readOnly": false, "type": "null or string or package or list of string"}, "containers..version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "\"latest\""}, "description": "Version/tag of the container.", "loc": ["containers", "", "version"], "readOnly": false, "type": "null or string"}, "containers..workingDir": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "\"/env\""}, "description": "Working directory of the container.", "loc": ["containers", "", "workingDir"], "readOnly": false, "type": "string"}, "delta.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/delta.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/delta.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Integrate delta into git: https://dandavison.github.io/delta/.", "loc": ["delta", "enable"], "readOnly": false, "type": "boolean"}, "devcontainer.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable generation .devcontainer.json for devenv integration.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["devcontainer", "enable"], "readOnly": false, "type": "boolean"}, "devcontainer.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Devcontainer settings.\n", "loc": ["devcontainer", "settings"], "readOnly": false, "type": "open submodule of (JSON value)"}, "devcontainer.settings.customizations.vscode.extensions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"mkhl.direnv\"\n]"}, "description": "A list of pre-installed VS Code extensions.\n", "loc": ["devcontainer", "settings", "customizations", "vscode", "extensions"], "readOnly": false, "type": "list of string"}, "devcontainer.settings.customizations.zed.extensions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "A list of pre-installed Zed extensions.\n", "loc": ["devcontainer", "settings", "customizations", "zed", "extensions"], "readOnly": false, "type": "list of string"}, "devcontainer.settings.image": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix"}], "default": {"_type": "literalExpression", "text": "\"ghcr.io/cachix/devenv/devcontainer:latest\""}, "description": "The name of an image in a container registry.\n", "loc": ["devcontainer", "settings", "image"], "readOnly": false, "type": "string"}, "devcontainer.settings.overrideCommand": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Override the default command.\n", "loc": ["devcontainer", "settings", "overrideCommand"], "readOnly": false, "type": "anything"}, "devcontainer.settings.updateContentCommand": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix"}], "default": {"_type": "literalExpression", "text": "\"devenv test\""}, "description": "A command to run after the container is created.\n", "loc": ["devcontainer", "settings", "updateContentCommand"], "readOnly": false, "type": "anything"}, "devenv.cliVersion": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/update-check.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/update-check.nix"}], "description": "Alias of {option}`devenv.cli.version`.", "loc": ["devenv", "cliVersion"], "readOnly": false, "type": "null or string"}, "devenv.debug": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/debug.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/debug.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable debug mode of devenv enterShell script.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["devenv", "debug"], "readOnly": false, "type": "boolean"}, "devenv.flakesIntegration": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/update-check.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/update-check.nix"}], "default": {"_type": "literalMD", "text": "`true` when devenv is invoked via the flake integration; `false` otherwise."}, "description": "Tells if devenv is being imported by a flake.nix file\n", "loc": ["devenv", "flakesIntegration"], "readOnly": false, "type": "boolean"}, "devenv.isTesting": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tests.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tests.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether the environment is being used for testing.", "loc": ["devenv", "isTesting"], "readOnly": false, "type": "boolean"}, "devenv.latestVersion": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/update-check.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/update-check.nix"}], "default": {"_type": "literalExpression", "text": "\"2.4.0\""}, "description": "The latest version of devenv.\n", "loc": ["devenv", "latestVersion"], "readOnly": false, "type": "string"}, "devenv.warnOnNewVersion": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/update-check.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/update-check.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to warn when a new version of either devenv or the direnv integration is available.\n", "loc": ["devenv", "warnOnNewVersion"], "readOnly": false, "type": "boolean"}, "difftastic.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/difftastic.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/difftastic.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Integrate difftastic into git: https://difftastic.wilfred.me.uk/.", "loc": ["difftastic", "enable"], "readOnly": false, "type": "boolean"}, "dotenv.disableHint": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/dotenv.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/dotenv.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Disable the hint printed when a dotenv file is present but the integration is not enabled.", "loc": ["dotenv", "disableHint"], "readOnly": false, "type": "boolean"}, "dotenv.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/dotenv.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/dotenv.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable .env integration.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["dotenv", "enable"], "readOnly": false, "type": "boolean"}, "dotenv.filename": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/dotenv.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/dotenv.nix"}], "default": {"_type": "literalExpression", "text": "\".env\""}, "description": "The path of the dotenv file to load, or a list of dotenv files to load in order of precedence.", "loc": ["dotenv", "filename"], "readOnly": false, "type": "string or list of string"}, "dotenv.substitution": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/dotenv.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/dotenv.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to expand variable references such as `$NAME`, `${NAME}`, and\n`${NAME:-default}` in dotenv values. Disabled by default so dollar signs\nin passwords, hashes, and tokens remain literal.\n", "loc": ["dotenv", "substitution"], "readOnly": false, "type": "boolean"}, "enterShell": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Bash code to execute when entering the shell.", "loc": ["enterShell"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "enterTest": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tests.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tests.nix"}], "description": "Bash code to execute to run the test.", "loc": ["enterTest"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "env": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Environment variables to be exposed inside the developer environment.", "loc": ["env"], "readOnly": false, "type": "open submodule of lazy attribute set of anything"}, "files": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "A set of files that will be linked into devenv root.", "loc": ["files"], "readOnly": false, "type": "attribute set of (submodule)"}, "files..copyMode": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix"}], "default": {"_type": "literalExpression", "text": "\"symlink\""}, "description": "How to materialize the file in the project root:\n\n- `symlink` (default): symlink to the read-only file in the Nix store. Edits are not possible; devenv keeps the link pointed at the current contents.\n- `seed`: copy the file into place once, only if it does not already exist, and make it writable. Existing files are left untouched, so your edits are preserved. Useful for seeding configuration from templates the user then edits.\n- `copy`: copy the file into place as a writable file, overwriting it with fresh contents on every shell entry. The file is replaced atomically, so tools that walk the project never see it missing. Useful when a tool must write to the file in place but devenv should remain the source of truth.\n", "loc": ["files", "", "copyMode"], "readOnly": false, "type": "one of \"symlink\", \"seed\", \"copy\""}, "files..executable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Make the file executable", "loc": ["files", "", "executable"], "readOnly": false, "type": "boolean"}, "files..ini": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "ini contents", "loc": ["files", "", "ini"], "readOnly": false, "type": "null or (attribute set of section of an INI file (attrs of INI atom (null, bool, int, float or string)))"}, "files..json": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "json contents", "loc": ["files", "", "json"], "readOnly": false, "type": "null or JSON value"}, "files..source": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "source contents", "loc": ["files", "", "source"], "readOnly": false, "type": "null or absolute path"}, "files..text": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "text contents", "loc": ["files", "", "text"], "readOnly": false, "type": "null or string"}, "files..toml": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "toml contents", "loc": ["files", "", "toml"], "readOnly": false, "type": "null or TOML value"}, "files..yaml": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "yaml contents", "loc": ["files", "", "yaml"], "readOnly": false, "type": "null or YAML 1.1 value"}, "git-hooks": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/git-hooks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/git-hooks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Integration with https://github.com/cachix/git-hooks.nix", "loc": ["git-hooks"], "readOnly": false, "type": "submodule"}, "git-hooks.addGcRoot": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to add the generated pre-commit config to the garbage collector roots.\nThis prevents Nix from garbage-collecting the tools used by hooks.\n", "loc": ["git-hooks", "addGcRoot"], "readOnly": false, "type": "boolean"}, "git-hooks.configFile": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "The pre-commit configuration file.\n", "loc": ["git-hooks", "configFile"], "readOnly": true, "type": "package"}, "git-hooks.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "default": {"_type": "literalExpression", "text": "\".pre-commit-config.yaml\""}, "description": "The path where to generate the pre-commit configuration file.\n\nThis path is relative to the root of the project. By default,\nthis is set to \".pre-commit-config.yaml\", which is the standard\nlocation expected by pre-commit.\n", "loc": ["git-hooks", "configPath"], "readOnly": false, "type": "string"}, "git-hooks.default_stages": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"pre-commit\"\n]"}, "description": "A configuration wide option for the stages property.\nInstalls hooks to the defined stages.\nSee [https://pre-commit.com/#confining-hooks-to-run-at-certain-stages](https://pre-commit.com/#confining-hooks-to-run-at-certain-stages).\n", "loc": ["git-hooks", "default_stages"], "readOnly": false, "type": "list of (one of \"commit-msg\", \"post-checkout\", \"post-commit\", \"post-merge\", \"post-rewrite\", \"pre-commit\", \"pre-merge-commit\", \"pre-push\", \"pre-rebase\", \"prepare-commit-msg\", \"manual\", \"commit\", \"push\", \"merge-commit\")"}, "git-hooks.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable the pre-commit hooks module.\n\nWhen set to false, this disables the entire module.\n", "loc": ["git-hooks", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.enabledPackages": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "All packages provided by hooks that are enabled.\n\nUseful for including into the developer environment.\n", "loc": ["git-hooks", "enabledPackages"], "readOnly": false, "type": "list of unspecified value"}, "git-hooks.excludes": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Exclude files that were matched by these patterns.\n", "loc": ["git-hooks", "excludes"], "readOnly": false, "type": "list of string"}, "git-hooks.gitPackage": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.gitMinimal"}, "description": "The `git` package to use.\n", "loc": ["git-hooks", "gitPackage"], "readOnly": false, "type": "package"}, "git-hooks.hooks": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}, {"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "The hook definitions.\n\nYou can both specify your own hooks here and you can enable predefined hooks.\n\nExample of enabling a predefined hook:\n\n```nix\nhooks.nixpkgs-fmt.enable = true;\n```\n\nExample of a custom hook:\n\n```nix\nhooks.my-tool = {\n enable = true;\n name = \"my-tool\";\n description = \"Run MyTool on all files in the project\";\n files = \"\\\\.mtl$\";\n entry = \"${pkgs.my-tool}/bin/mytoolctl\";\n};\n```\n\nThe predefined hooks are:\n\n**`action-validator`**\n\nTool to validate GitHub Action and Workflow YAML files\n\n\n**`actionlint`**\n\nStatic checker for GitHub Actions workflow files\n\n\n**`alejandra`**\n\nThe Uncompromising Nix Code Formatter\n\n\n**`annex`**\n\nRuns the git-annex hook for large file support\n\n\n**`ansible-lint`**\n\nAnsible linter\n\n\n**`autoflake`**\n\nRemove unused imports and variables from Python code\n\n\n**`bats`**\n\nRun bash unit tests\n\n\n**`beautysh`**\n\nFormat shell files\n\n\n**`biome`**\n\nA toolchain for web projects, aimed to provide functionalities to maintain them\n\n\n**`black`**\n\nThe uncompromising Python code formatter\n\n\n**`cabal-fmt`**\n\nFormat Cabal files\n\n\n**`cabal-gild`**\n\nFormat Cabal files\n\n\n**`cabal2nix`**\n\nRun `cabal2nix` on all `*.cabal` files to generate corresponding `.nix` files\n\n\n**`cargo-check`**\n\nCheck the cargo package for errors\n\n\n**`chart-testing`**\n\nCLI tool for linting and testing Helm charts\n\n\n**`check-added-large-files`**\n\nPrevent very large files to be committed (e.g. binaries).\n\n\n**`check-builtin-literals`**\n\nRequire literal syntax when initializing empty or zero builtin types in Python.\n\n\n**`check-case-conflicts`**\n\nCheck for files that would conflict in case-insensitive filesystems.\n\n\n**`check-docstring-first`**\n\nCheck that all docstrings appear above the code.\n\n\n**`check-executables-have-shebangs`**\n\nEnsure that all non-binary executables have shebangs.\n\n\n**`check-json`**\n\nCheck syntax of JSON files.\n\n\n**`check-merge-conflicts`**\n\nCheck for files that contain merge conflict strings.\n\n\n**`check-python`**\n\nCheck syntax of Python file by parsing Python abstract syntax tree.\n\n\n**`check-shebang-scripts-are-executable`**\n\nEnsure that all (non-binary) files with a shebang are executable.\n\n\n**`check-symlinks`**\n\nFind broken symlinks.\n\n\n**`check-toml`**\n\nCheck syntax of TOML files.\n\n\n**`check-vcs-permalinks`**\n\nEnsure that links to VCS websites are permalinks.\n\n\n**`check-xml`**\n\nCheck syntax of XML files.\n\n\n**`check-yaml`**\n\nCheck syntax of YAML files.\n\n\n**`checkmake`**\n\nExperimental linter/analyzer for Makefiles\n\n\n**`chktex`**\n\nLaTeX semantic checker\n\n\n**`circleci`**\n\nValidate CircleCI config files.\n\n\n**`clang-format`**\n\nFormat your code using `clang-format`.\n\n\n**`clang-tidy`**\n\nStatic analyzer for C++ code.\n\n\n**`clippy`**\n\nLint Rust code.\n\n\n**`cljfmt`**\n\nA tool for formatting Clojure code.\n\n\n**`cmake-format`**\n\nA tool for formatting CMake-files.\n\n\n**`commitizen`**\n\nCheck whether the current commit message follows committing rules.\n\n\n\n**`comrak`**\n\nA 100% CommonMark-compatible GitHub Flavored Markdown formatter\n\n\n**`conform`**\n\nPolicy enforcement for commits.\n\n\n**`convco`**\n\n\n\n\n**`credo`**\n\nRuns a static code analysis using Credo\n\n\n**`crystal`**\n\nA tool that automatically formats Crystal source code\n\n\n**`cspell`**\n\nA Spell Checker for Code\n\n\n**`cue-fmt`**\n\nFormat CUE files\n\n\n**`dart-analyze`**\n\nDart analyzer\n\n\n**`dart-format`**\n\nDart formatter\n\n\n**`deadnix`**\n\nScan Nix files for dead code (unused variable bindings).\n\n\n**`denofmt`**\n\nAuto-format JavaScript, TypeScript, Markdown, and JSON files.\n\n\n**`denolint`**\n\nLint JavaScript/TypeScript source code.\n\n\n**`detect-aws-credentials`**\n\nDetect AWS credentials from the AWS cli credentials file.\n\n\n**`detect-private-keys`**\n\nDetect the presence of private keys.\n\n\n**`dhall-format`**\n\nDhall code formatter.\n\n\n**`dialyzer`**\n\nRuns a static code analysis using Dialyzer\n\n\n**`dune-fmt`**\n\nRuns Dune's formatters on the code tree.\n\n\n**`dune-opam-sync`**\n\nCheck that Dune-generated OPAM files are in sync.\n\n\n**`eclint`**\n\nEditorConfig linter written in Go.\n\n\n**`editorconfig-checker`**\n\nVerify that the files are in harmony with the `.editorconfig`.\n\n\n**`elm-format`**\n\nFormat Elm files.\n\n\n**`elm-review`**\n\nAnalyzes Elm projects, to help find mistakes before your users find them.\n\n\n**`elm-test`**\n\nRun unit tests and fuzz tests for Elm code.\n\n\n**`end-of-file-fixer`**\n\nEnsures that a file is either empty, or ends with a single newline.\n\n\n**`eslint`**\n\nFind and fix problems in your JavaScript code.\n\n\n**`fix-byte-order-marker`**\n\nRemove UTF-8 byte order marker.\n\n\n**`fix-encoding-pragma`**\n\nAdds # -*- coding: utf-8 -*- to the top of Python files.'\n\n\n**`flake-checker`**\n\nRun health checks on your flake-powered Nix projects.\n\n\n**`flake8`**\n\nCheck the style and quality of Python files.\n\n\n**`flynt`**\n\nCLI tool to convert a python project's %-formatted strings to f-strings.\n\n\n**`forbid-new-submodules`**\n\nPrevent addition of new Git submodules.\n\n\n**`fourmolu`**\n\nHaskell code prettifier.\n\n\n**`fprettify`**\n\nAuto-formatter for modern Fortran code.\n\n\n**`gitlint`**\n\nLinting for your git commit messages\n\n\n**`gofmt`**\n\nA tool that automatically formats Go source code\n\n\n**`golangci-lint`**\n\nFast linters runner for Go.\n\n\n**`golines`**\n\nA golang formatter that fixes long lines\n\n\n**`gotest`**\n\nRun go tests\n\n\n**`govet`**\n\nChecks correctness of Go programs.\n\n\n**`gptcommit`**\n\nGenerate a commit message using GPT3.\n\n\n**`hadolint`**\n\nDockerfile linter, validate inline bash.\n\n\n**`headache`**\n\nLightweight tool for managing headers in source code files.\n\n\n**`hindent`**\n\nHaskell code prettifier.\n\n\n**`hledger-fmt`**\n\nOpinionated hledger's journal files formatter.\n\n\n**`hlint`**\n\nHLint gives suggestions on how to improve your source code.\n\n\n**`hpack`**\n\n`hpack` converts package definitions in the hpack format (`package.yaml`) to Cabal files.\n\n\n**`html-tidy`**\n\nHTML linter.\n\n\n**`hunspell`**\n\nSpell checker and morphological analyzer.\n\n\n**`isort`**\n\nA Python utility / library to sort imports.\n\n\n**`juliaformatter`**\n\nRun JuliaFormatter.jl against Julia source files\n\n\n**`keep-sorted`**\n\nLanguage-agnostic formatter that sorts lines between two markers in a larger file.\n\n\n**`lacheck`**\n\nA consistency checker for LaTeX documents.\n\n\n**`latexindent`**\n\nPerl script to add indentation to LaTeX files.\n\n\n**`lua-ls`**\n\nUses the lua-language-server CLI to statically type-check and lint Lua code.\n\n\n**`luacheck`**\n\nA tool for linting and static analysis of Lua code.\n\n\n**`lychee`**\n\nA fast, async, stream-based link checker that finds broken hyperlinks and mail addresses inside Markdown, HTML, reStructuredText, or any other text file or website.\n\n\n**`markdownlint`**\n\nStyle checker and linter for markdown files.\n\n\n**`mdformat`**\n\nCommonMark compliant Markdown formatter\n\n\n**`mdl`**\n\nA tool to check markdown files and flag style issues.\n\n\n**`mdsh`**\n\nMarkdown shell pre-processor.\n\n\n**`mix-format`**\n\nRuns the built-in Elixir syntax formatter\n\n\n**`mix-test`**\n\nRuns the built-in Elixir test framework\n\n\n**`mixed-line-endings`**\n\nResolve mixed line endings.\n\n\n**`mkdocs-linkcheck`**\n\nValidate links associated with markdown-based, statically generated websites.\n\n\n**`mypy`**\n\nStatic type checker for Python\n\n\n**`name-tests-test`**\n\nVerify that Python test files are named correctly.\n\n\n**`nbstripout`**\n\nStrip output from Jupyter notebooks\n\n\n**`nil`**\n\nIncremental analysis assistant for writing in Nix.\n\n\n**`nixf-diagnose`**\n\nwrapper for nixf-tidy.\n\n\n**`nixfmt`**\n\nOfficial Nix code formatter.\n\n\n**`nixfmt-classic`**\n\nNix code prettifier (classic).\n\n\n**`nixfmt-rfc-style`**\n\nNix code prettifier (RFC 166 style).\n\n\n**`nixpkgs-fmt`**\n\nNix code prettifier.\n\n\n**`no-commit-to-branch`**\n\nDisallow committing to certain branch/branches.\n\n\n**`ocp-indent`**\n\nA tool to indent OCaml code.\n\n\n**`opam-lint`**\n\nOCaml package manager configuration checker.\n\n\n**`openapi-spec-validator`**\n\nA tool to validate OpenAPI spec files\n\n\n**`ormolu`**\n\nHaskell code prettifier.\n\n\n**`php-cs-fixer`**\n\nLint PHP files.\n\n\n**`phpcbf`**\n\nLint PHP files.\n\n\n**`phpcs`**\n\nLint PHP files.\n\n\n**`phpstan`**\n\nStatic Analysis of PHP files.\n\n\n**`poetry-check`**\n\nCheck the Poetry config for errors\n\n\n**`poetry-lock`**\n\nUpdate the Poetry lock file\n\n\n**`pre-commit-hook-ensure-sops`**\n\n\n\n\n**`prettier`**\n\nOpinionated multi-language code formatter.\n\n\n**`pretty-format-json`**\n\nFormats JSON files.\n\n\n**`proselint`**\n\nA linter for prose.\n\n\n**`psalm`**\n\nStatic Analysis of PHP files.\n\n\n**`purs-tidy`**\n\nFormat purescript files.\n\n\n**`pylint`**\n\nLint Python files.\n\n\n**`pyright`**\n\nStatic type checker for Python\n\n\n**`python-debug-statements`**\n\nCheck for debugger imports and py37+ `breakpoint()` calls in python source.\n\n\n**`pyupgrade`**\n\nAutomatically upgrade syntax for newer versions.\n\n\n**`regal`**\n\nA linter for Rego policies\n\n\n**`reuse`**\n\nreuse is a tool for compliance with the REUSE recommendations.\n\n\n**`revive`**\n\nA linter for Go source code.\n\n\n**`ripsecrets`**\n\nPrevent committing secret keys into your source code\n\n\n**`rome`**\n\n\n\n\n**`ruff`**\n\nAn extremely fast Python linter, written in Rust.\n\n\n**`ruff-format`**\n\nAn extremely fast Python code formatter, written in Rust.\n\n\n**`rumdl`**\n\nStyle checker and linter for rumdl files.\n\n\n**`rustfmt`**\n\nFormat Rust code.\n\n\n**`selene`**\n\nA blazing-fast modern Lua linter written in Rust.\n\n\n**`shellcheck`**\n\nFormat shell files.\n\n\n**`shfmt`**\n\nFormat shell files.\n\n\n**`single-quoted-strings`**\n\nReplace double quoted strings with single quoted strings.\n\n\n**`sort-file-contents`**\n\nSort the lines in specified files (defaults to alphabetical).\n\n\n**`sort-requirements-txt`**\n\nSort requirements in requirements.txt and constraints.txt files.\n\n\n**`sort-simple-yaml`**\n\nSort simple YAML files which consist only of top-level keys, preserving comments and blocks.\n\n\n**`staticcheck`**\n\nState of the art linter for the Go programming language\n\n\n**`statix`**\n\nLints and suggestions for the Nix programming language.\n\n\n**`stylish-haskell`**\n\nA simple Haskell code prettifier\n\n\n**`stylua`**\n\nAn Opinionated Lua Code Formatter.\n\n\n**`tagref`**\n\nHave tagref check all references and tags.\n\n\n\n**`taplo`**\n\nFormat TOML files with taplo fmt\n\n\n**`terraform-format`**\n\nFormat Terraform (`.tf`) files.\n\n\n**`terraform-validate`**\n\nValidates terraform configuration files (`.tf`).\n\n\n**`tflint`**\n\nA Pluggable Terraform Linter.\n\n\n**`topiary`**\n\nA universal formatter engine within the Tree-sitter ecosystem, with support for many languages.\n\n\n**`treefmt`**\n\nOne CLI to format the code tree.\n\n\n**`trim-trailing-whitespace`**\n\nTrim trailing whitespace.\n\n\n**`trufflehog`**\n\nSecrets scanner\n\n\n**`typos`**\n\nSource code spell checker\n\n\n**`typstyle`**\n\nBeautiful and reliable typst code formatter\n\n\n**`uv-check`**\n\nCheck if uv's lockfile is up-to-date.\n\n\n**`uv-export`**\n\nExport uv's lockfile.\n\n\n**`uv-lock`**\n\nUpdate uv's lockfile.\n\n\n**`vale`**\n\nA markup-aware linter for prose built with speed and extensibility in mind.\n\n\n**`woodpecker-cli-lint`**\n\nCommand line client for the Woodpecker Continuous Integration server (lint only).\n\n\n**`yamlfmt`**\n\nFormatter for YAML files.\n\n\n**`yamllint`**\n\nLinter for YAML files.\n\n\n**`zizmor`**\n\nStatic analysis for GitHub Actions\n\n\n**`zprint`**\n\nBeautifully format Clojure and Clojurescript source code and s-expressions.\n\n\n", "loc": ["git-hooks", "hooks"], "readOnly": false, "type": "open submodule of attribute set of (submodule)"}, "git-hooks.hooks..after": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of hooks that should run before this hook.\n", "loc": ["git-hooks", "hooks", "", "after"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks..always_run": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "if true this hook will run even if there are no matching files.\n", "loc": ["git-hooks", "hooks", "", "always_run"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks..args": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of additional parameters to pass to the hook.\n", "loc": ["git-hooks", "hooks", "", "args"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks..before": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of hooks that should run after this hook.\n", "loc": ["git-hooks", "hooks", "", "before"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks..description": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Description of the hook. Used for metadata purposes only.\n", "loc": ["git-hooks", "hooks", "", "description"], "readOnly": false, "type": "string"}, "git-hooks.hooks..enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks..entry": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "description": "The entry point - the executable to run. {option}`entry` can also contain arguments that will not be overridden, such as `entry = \"autopep8 -i\";`.\n", "loc": ["git-hooks", "hooks", "", "entry"], "readOnly": false, "type": "string"}, "git-hooks.hooks..exclude_types": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of file types to exclude. See [Filtering files with types](https://pre-commit.com/#filtering-files-with-types).\n", "loc": ["git-hooks", "hooks", "", "exclude_types"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks..excludes": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Exclude files that were matched by these patterns.\n", "loc": ["git-hooks", "hooks", "", "excludes"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks..extraPackages": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Additional packages required to run the hook.\n\nThese are propagated to `enabledPackages` for constructing developer\nenvironments.\n", "loc": ["git-hooks", "hooks", "", "extraPackages"], "readOnly": false, "type": "list of package"}, "git-hooks.hooks..fail_fast": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "if true pre-commit will stop running hooks if this hook fails.\n", "loc": ["git-hooks", "hooks", "", "fail_fast"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks..files": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "The pattern of files to run on.\n", "loc": ["git-hooks", "hooks", "", "files"], "readOnly": false, "type": "string"}, "git-hooks.hooks..id": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "\"the attribute name the hook submodule is bound to\""}, "description": "The unique identifier for the hook.\n\nYou do not need to set or modify this value.\n\nThe `id` is used to reference a hook when using `pre-commit run `.\nIt can also be used to reference the hook in other hooks' `before` and `after` fields to define the order in which hooks run.\n\nThe `id` is set to the attribute name the hook submodule is bound to in the parent module.\nFor example, the `id` of following hook would be `my-hook`.\n\n```nix\n{\n hooks = {\n my-hook = {\n enable = true;\n entry = \"my-hook\";\n };\n }\n}\n```\n", "loc": ["git-hooks", "hooks", "", "id"], "readOnly": false, "type": "string"}, "git-hooks.hooks..language": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "\"system\" or \"unsupported\" depending on pre-commit version"}, "description": "The language of the hook - tells pre-commit how to install the hook.\n\nDefaults to `\"system\"`, or `\"unsupported\"` when using pre-commit >= 4.4.0.\n\nNote: `\"unsupported\"` does not mean deprecated.\nPre-commit >= 4.4.0 renamed `\"system\"` to `\"unsupported\"` because\nwhen using this language pre-commit does not provision the tools, and using externally\nmanaged tools (e.g. via Nix) is not an officially supported workflow.\nBoth values are functionally equivalent.\n", "loc": ["git-hooks", "hooks", "", "language"], "readOnly": false, "type": "string"}, "git-hooks.hooks..name": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "the attribute name the hook submodule is bound to, same as `id`"}, "description": "The name of the hook. Shown during hook execution.\n", "loc": ["git-hooks", "hooks", "", "name"], "readOnly": false, "type": "string"}, "git-hooks.hooks..package": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "An optional package that provides the hook.\n", "loc": ["git-hooks", "hooks", "", "package"], "readOnly": false, "type": "null or package"}, "git-hooks.hooks..pass_filenames": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to pass filenames as arguments to the entry point.\n", "loc": ["git-hooks", "hooks", "", "pass_filenames"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks..priority": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Defines the order in which the hooks are executed. Default priority is set by the order in the list of hooks.\nEvaluation goes from 0 and up.\nIf two hooks have the same priority, they\u2019ll run in parallel.\nThis works only if cfg.package is set to prek.\n", "loc": ["git-hooks", "hooks", "", "priority"], "readOnly": false, "type": "null or 32 bit unsigned integer; between 0 and 4294967295 (both inclusive)"}, "git-hooks.hooks..raw": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "description": "Raw fields of a pre-commit hook. This is mostly for internal use but\nexposed in case you need to work around something.\n\nDefault: taken from the other hook options.\n", "loc": ["git-hooks", "hooks", "", "raw"], "readOnly": false, "type": "attribute set of unspecified value"}, "git-hooks.hooks..require_serial": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "if true this hook will execute using a single process instead of in parallel.\n", "loc": ["git-hooks", "hooks", "", "require_serial"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks..stages": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "default_stages"}, "description": "Confines the hook to run at a particular stage.\n", "loc": ["git-hooks", "hooks", "", "stages"], "readOnly": false, "type": "list of (one of \"commit-msg\", \"post-checkout\", \"post-commit\", \"post-merge\", \"post-rewrite\", \"pre-commit\", \"pre-merge-commit\", \"pre-push\", \"pre-rebase\", \"prepare-commit-msg\", \"manual\", \"commit\", \"push\", \"merge-commit\")"}, "git-hooks.hooks..types": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"file\"\n]"}, "description": "List of file types to run on. See [Filtering files with types](https://pre-commit.com/#filtering-files-with-types).\n", "loc": ["git-hooks", "hooks", "", "types"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks..types_or": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of file types to run on, where only a single type needs to match.\n", "loc": ["git-hooks", "hooks", "", "types_or"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks..verbose": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "forces the output of the hook to be printed even when the hook passes.\n", "loc": ["git-hooks", "hooks", "", "verbose"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.alejandra": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "alejandra hook", "loc": ["git-hooks", "hooks", "alejandra"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.alejandra.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "alejandra", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.alejandra.settings.check": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Check if the input is already formatted and disable writing in-place the modified content", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["git-hooks", "hooks", "alejandra", "settings", "check"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.alejandra.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "(experimental) Path to the alejandra.toml configuration file.", "loc": ["git-hooks", "hooks", "alejandra", "settings", "configPath"], "readOnly": false, "type": "null or string or absolute path"}, "git-hooks.hooks.alejandra.settings.exclude": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Files or directories to exclude from formatting.", "example": {"_type": "literalExpression", "text": "[\n \"flake.nix\"\n \"./templates\"\n]"}, "loc": ["git-hooks", "hooks", "alejandra", "settings", "exclude"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.alejandra.settings.threads": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Number of formatting threads to spawn.", "example": {"_type": "literalExpression", "text": "8"}, "loc": ["git-hooks", "hooks", "alejandra", "settings", "threads"], "readOnly": false, "type": "null or signed integer"}, "git-hooks.hooks.alejandra.settings.verbosity": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"normal\""}, "description": "Whether informational messages or all messages should be hidden or not.", "example": {"_type": "literalExpression", "text": "\"quiet\""}, "loc": ["git-hooks", "hooks", "alejandra", "settings", "verbosity"], "readOnly": false, "type": "one of \"normal\", \"quiet\", \"silent\""}, "git-hooks.hooks.ansible-lint": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "ansible-lint hook", "loc": ["git-hooks", "hooks", "ansible-lint"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.ansible-lint.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "ansible-lint", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.ansible-lint.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to the YAML configuration file.", "loc": ["git-hooks", "hooks", "ansible-lint", "settings", "configPath"], "readOnly": false, "type": "string"}, "git-hooks.hooks.ansible-lint.settings.subdir": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to the Ansible subdirectory.", "loc": ["git-hooks", "hooks", "ansible-lint", "settings", "subdir"], "readOnly": false, "type": "string"}, "git-hooks.hooks.autoflake": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "autoflake hook", "loc": ["git-hooks", "hooks", "autoflake"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.autoflake.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "autoflake", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.autoflake.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"${tools.autoflake}/bin/autoflake\"\n"}, "description": "Path to autoflake binary.", "loc": ["git-hooks", "hooks", "autoflake", "settings", "binPath"], "readOnly": false, "type": "null or string"}, "git-hooks.hooks.autoflake.settings.flags": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"--in-place --expand-star-imports --remove-duplicate-keys --remove-unused-variables\""}, "description": "Flags passed to autoflake.", "loc": ["git-hooks", "hooks", "autoflake", "settings", "flags"], "readOnly": false, "type": "string"}, "git-hooks.hooks.biome": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "biome hook", "loc": ["git-hooks", "hooks", "biome"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.biome.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "biome", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.biome.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"${tools.biome}/bin/biome\"\n"}, "description": "`biome` binary path.\nFor example, if you want to use the `biome` binary from `node_modules`, use `\"./node_modules/.bin/biome\"`.\nUse a string instead of a path to avoid having to Git track the file in projects that use Nix flakes.\n", "example": {"_type": "literalExpression", "text": "\"./node_modules/.bin/biome\"\n"}, "loc": ["git-hooks", "hooks", "biome", "settings", "binPath"], "readOnly": false, "type": "null or string or absolute path"}, "git-hooks.hooks.biome.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to the configuration JSON file", "loc": ["git-hooks", "hooks", "biome", "settings", "configPath"], "readOnly": false, "type": "string"}, "git-hooks.hooks.biome.settings.write": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to edit files inplace.", "loc": ["git-hooks", "hooks", "biome", "settings", "write"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.black": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "black hook", "loc": ["git-hooks", "hooks", "black"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.black.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "black", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.black.settings.flags": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Flags passed to black. See all available [here](https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#command-line-options).", "example": {"_type": "literalExpression", "text": "\"--skip-magic-trailing-comma\""}, "loc": ["git-hooks", "hooks", "black", "settings", "flags"], "readOnly": false, "type": "string"}, "git-hooks.hooks.cabal2nix": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "cabal2nix hook", "loc": ["git-hooks", "hooks", "cabal2nix"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.cabal2nix.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "cabal2nix", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.cabal2nix.settings.outputFilename": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"default.nix\""}, "description": "The name of the output file generated after running `cabal2nix`.", "loc": ["git-hooks", "hooks", "cabal2nix", "settings", "outputFilename"], "readOnly": false, "type": "string"}, "git-hooks.hooks.clippy": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "clippy hook", "loc": ["git-hooks", "hooks", "clippy"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.clippy.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "clippy", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.clippy.packageOverrides.cargo": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "The cargo package to use", "loc": ["git-hooks", "hooks", "clippy", "packageOverrides", "cargo"], "readOnly": false, "type": "package"}, "git-hooks.hooks.clippy.packageOverrides.clippy": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "The clippy package to use", "loc": ["git-hooks", "hooks", "clippy", "packageOverrides", "clippy"], "readOnly": false, "type": "package"}, "git-hooks.hooks.clippy.settings.allFeatures": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Run clippy with --all-features", "loc": ["git-hooks", "hooks", "clippy", "settings", "allFeatures"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.clippy.settings.denyWarnings": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Fail when warnings are present", "loc": ["git-hooks", "hooks", "clippy", "settings", "denyWarnings"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.clippy.settings.extraArgs": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Additional arguments to pass to clippy", "loc": ["git-hooks", "hooks", "clippy", "settings", "extraArgs"], "readOnly": false, "type": "string"}, "git-hooks.hooks.clippy.settings.offline": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Run clippy offline", "loc": ["git-hooks", "hooks", "clippy", "settings", "offline"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.cmake-format": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "cmake-format hook", "loc": ["git-hooks", "hooks", "cmake-format"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.cmake-format.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "cmake-format", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.cmake-format.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to the configuration file (.json,.python,.yaml)", "example": {"_type": "literalExpression", "text": "\".cmake-format.json\""}, "loc": ["git-hooks", "hooks", "cmake-format", "settings", "configPath"], "readOnly": false, "type": "string"}, "git-hooks.hooks.convco": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "convco hook", "loc": ["git-hooks", "hooks", "convco"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.convco.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "convco", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.convco.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Path to the configuration file (YAML or JSON)", "loc": ["git-hooks", "hooks", "convco", "settings", "configPath"], "readOnly": false, "type": "null or string or absolute path"}, "git-hooks.hooks.credo": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "credo hook", "loc": ["git-hooks", "hooks", "credo"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.credo.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "credo", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.credo.settings.strict": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to auto-promote the changes.", "loc": ["git-hooks", "hooks", "credo", "settings", "strict"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.deadnix": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "deadnix hook", "loc": ["git-hooks", "hooks", "deadnix"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.deadnix.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "deadnix", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.deadnix.settings.edit": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Remove unused code and write to source file.", "loc": ["git-hooks", "hooks", "deadnix", "settings", "edit"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.deadnix.settings.exclude": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Files to exclude from analysis.", "loc": ["git-hooks", "hooks", "deadnix", "settings", "exclude"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.deadnix.settings.hidden": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Recurse into hidden subdirectories and process hidden .*.nix files.", "loc": ["git-hooks", "hooks", "deadnix", "settings", "hidden"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.deadnix.settings.noLambdaArg": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Don't check lambda parameter arguments.", "loc": ["git-hooks", "hooks", "deadnix", "settings", "noLambdaArg"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.deadnix.settings.noLambdaPatternNames": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Don't check lambda pattern names (don't break nixpkgs `callPackage`).", "loc": ["git-hooks", "hooks", "deadnix", "settings", "noLambdaPatternNames"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.deadnix.settings.noUnderscore": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Don't check any bindings that start with a `_`.", "loc": ["git-hooks", "hooks", "deadnix", "settings", "noUnderscore"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.deadnix.settings.quiet": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Don't print a dead code report.", "loc": ["git-hooks", "hooks", "deadnix", "settings", "quiet"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.denofmt": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "denofmt hook", "loc": ["git-hooks", "hooks", "denofmt"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.denofmt.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "denofmt", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.denofmt.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to the configuration JSON file", "loc": ["git-hooks", "hooks", "denofmt", "settings", "configPath"], "readOnly": false, "type": "string"}, "git-hooks.hooks.denofmt.settings.write": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to edit files inplace.", "loc": ["git-hooks", "hooks", "denofmt", "settings", "write"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.denolint": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "denolint hook", "loc": ["git-hooks", "hooks", "denolint"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.denolint.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "denolint", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.denolint.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to the configuration JSON file", "loc": ["git-hooks", "hooks", "denolint", "settings", "configPath"], "readOnly": false, "type": "string"}, "git-hooks.hooks.denolint.settings.format": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"default\""}, "description": "Output format.", "loc": ["git-hooks", "hooks", "denolint", "settings", "format"], "readOnly": false, "type": "one of \"default\", \"compact\", \"json\""}, "git-hooks.hooks.dune-fmt": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "dune-fmt hook", "loc": ["git-hooks", "hooks", "dune-fmt"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.dune-fmt.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "dune-fmt", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.dune-fmt.settings.auto-promote": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to auto-promote the changes.", "loc": ["git-hooks", "hooks", "dune-fmt", "settings", "auto-promote"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.dune-fmt.settings.extraRuntimeInputs": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Extra runtimeInputs to add to the environment, eg. `ocamlformat`.", "loc": ["git-hooks", "hooks", "dune-fmt", "settings", "extraRuntimeInputs"], "readOnly": false, "type": "list of package"}, "git-hooks.hooks.eclint": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "eclint hook", "loc": ["git-hooks", "hooks", "eclint"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.eclint.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "eclint", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.eclint.settings.color": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"auto\""}, "description": "When to generate colored output.", "loc": ["git-hooks", "hooks", "eclint", "settings", "color"], "readOnly": false, "type": "one of \"auto\", \"always\", \"never\""}, "git-hooks.hooks.eclint.settings.exclude": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Filter to exclude files.", "loc": ["git-hooks", "hooks", "eclint", "settings", "exclude"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.eclint.settings.fix": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Modify files in place rather than showing the errors.", "loc": ["git-hooks", "hooks", "eclint", "settings", "fix"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.eclint.settings.summary": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Only show number of errors per file.", "loc": ["git-hooks", "hooks", "eclint", "settings", "summary"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.eclint.settings.verbosity": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "0"}, "description": "Log level verbosity", "loc": ["git-hooks", "hooks", "eclint", "settings", "verbosity"], "readOnly": false, "type": "one of 0, 1, 2, 3, 4"}, "git-hooks.hooks.eslint": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "eslint hook", "loc": ["git-hooks", "hooks", "eslint"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.eslint.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "eslint", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.eslint.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"${tools.eslint}/bin/eslint\"\n"}, "description": "`eslint` binary path.\nFor example, if you want to use the `eslint` binary from `node_modules`, use `\"./node_modules/.bin/eslint\"`.\nUse a string instead of a path to avoid having to Git track the file in projects that use Nix flakes.\n", "example": {"_type": "literalExpression", "text": "\"./node_modules/.bin/eslint\"\n"}, "loc": ["git-hooks", "hooks", "eslint", "settings", "binPath"], "readOnly": false, "type": "null or string or absolute path"}, "git-hooks.hooks.eslint.settings.extensions": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\\\\.js$\""}, "description": "The pattern of files to run on, see [https://pre-commit.com/#hooks-files](https://pre-commit.com/#hooks-files).", "loc": ["git-hooks", "hooks", "eslint", "settings", "extensions"], "readOnly": false, "type": "string"}, "git-hooks.hooks.flake8": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "flake8 hook", "loc": ["git-hooks", "hooks", "flake8"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.flake8.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "flake8", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.flake8.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"${tools.flake8}/bin/flake8\"\n"}, "description": "flake8 binary path. Should be used to specify flake8 binary from your Python environment.", "loc": ["git-hooks", "hooks", "flake8", "settings", "binPath"], "readOnly": false, "type": "null or string"}, "git-hooks.hooks.flake8.settings.extendIgnore": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of additional ignore codes", "example": {"_type": "literalExpression", "text": "[\n \"E501\"\n]"}, "loc": ["git-hooks", "hooks", "flake8", "settings", "extendIgnore"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.flake8.settings.format": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"default\""}, "description": "Output format.", "loc": ["git-hooks", "hooks", "flake8", "settings", "format"], "readOnly": false, "type": "string"}, "git-hooks.hooks.flynt": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "flynt hook", "loc": ["git-hooks", "hooks", "flynt"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.flynt.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "flynt", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.flynt.settings.aggressive": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Include conversions with potentially changed behavior.", "loc": ["git-hooks", "hooks", "flynt", "settings", "aggressive"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.flynt.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "flynt binary path. Can be used to specify the flynt binary from an existing Python environment.", "loc": ["git-hooks", "hooks", "flynt", "settings", "binPath"], "readOnly": false, "type": "null or string"}, "git-hooks.hooks.flynt.settings.dry-run": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Do not change files in-place and print diff instead.", "loc": ["git-hooks", "hooks", "flynt", "settings", "dry-run"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.flynt.settings.exclude": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Ignore files with given strings in their absolute path.", "loc": ["git-hooks", "hooks", "flynt", "settings", "exclude"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.flynt.settings.fail-on-change": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Fail when diff is not empty (for linting purposes).", "loc": ["git-hooks", "hooks", "flynt", "settings", "fail-on-change"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.flynt.settings.line-length": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Convert expressions spanning multiple lines, only if the resulting single line will fit into this line length limit.", "loc": ["git-hooks", "hooks", "flynt", "settings", "line-length"], "readOnly": false, "type": "null or signed integer"}, "git-hooks.hooks.flynt.settings.no-multiline": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Convert only single line expressions.", "loc": ["git-hooks", "hooks", "flynt", "settings", "no-multiline"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.flynt.settings.quiet": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Run without output.", "loc": ["git-hooks", "hooks", "flynt", "settings", "quiet"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.flynt.settings.string": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Interpret the input as a Python code snippet and print the converted version.", "loc": ["git-hooks", "hooks", "flynt", "settings", "string"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.flynt.settings.transform-concats": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Replace string concatenations with f-strings.", "loc": ["git-hooks", "hooks", "flynt", "settings", "transform-concats"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.flynt.settings.verbose": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Run with verbose output.", "loc": ["git-hooks", "hooks", "flynt", "settings", "verbose"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.fourmolu": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "fourmolu hook", "loc": ["git-hooks", "hooks", "fourmolu"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.fourmolu.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "fourmolu", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.fourmolu.settings.defaultExtensions": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Haskell language extensions to enable.", "loc": ["git-hooks", "hooks", "fourmolu", "settings", "defaultExtensions"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.golines": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "golines hook", "loc": ["git-hooks", "hooks", "golines"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.golines.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "golines", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.golines.settings.flags": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Flags passed to golines. See all available [here](https://github.com/segmentio/golines?tab=readme-ov-file#options)", "example": {"_type": "literalExpression", "text": "\"-m 120\""}, "loc": ["git-hooks", "hooks", "golines", "settings", "flags"], "readOnly": false, "type": "string"}, "git-hooks.hooks.gotest": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "gotest hook", "loc": ["git-hooks", "hooks", "gotest"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.gotest.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "gotest", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.gotest.settings.flags": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Flags passed to gotest. See all available [here](https://pkg.go.dev/cmd/go#hdr-Test_packages).", "example": {"_type": "literalExpression", "text": "\"-tags integration\""}, "loc": ["git-hooks", "hooks", "gotest", "settings", "flags"], "readOnly": false, "type": "string"}, "git-hooks.hooks.headache": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "headache hook", "loc": ["git-hooks", "hooks", "headache"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.headache.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "headache", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.headache.settings.header-file": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\".header\""}, "description": "Path to the header file.", "loc": ["git-hooks", "hooks", "headache", "settings", "header-file"], "readOnly": false, "type": "string"}, "git-hooks.hooks.hledger-fmt": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "hledger-fmt hook", "loc": ["git-hooks", "hooks", "hledger-fmt"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.hledger-fmt.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "hledger-fmt", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.hledger-fmt.settings.fix": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Fix the files in place.", "loc": ["git-hooks", "hooks", "hledger-fmt", "settings", "fix"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.hlint": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "hlint hook", "loc": ["git-hooks", "hooks", "hlint"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.hlint.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "hlint", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.hlint.settings.hintFile": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Path to hlint.yaml. By default, hlint searches for .hlint.yaml in the project root.", "loc": ["git-hooks", "hooks", "hlint", "settings", "hintFile"], "readOnly": false, "type": "null or string or absolute path"}, "git-hooks.hooks.hpack": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "hpack hook", "loc": ["git-hooks", "hooks", "hpack"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.hpack.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "hpack", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.hpack.settings.silent": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether generation should be silent.", "loc": ["git-hooks", "hooks", "hpack", "settings", "silent"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.isort": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "isort hook", "loc": ["git-hooks", "hooks", "isort"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.isort.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "isort", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.isort.settings.flags": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Flags passed to isort. See all available [here](https://pycqa.github.io/isort/docs/configuration/options.html).", "loc": ["git-hooks", "hooks", "isort", "settings", "flags"], "readOnly": false, "type": "string"}, "git-hooks.hooks.isort.settings.profile": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Built-in profiles to allow easy interoperability with common projects and code styles.", "loc": ["git-hooks", "hooks", "isort", "settings", "profile"], "readOnly": false, "type": "one of \"\", \"black\", \"django\", \"pycharm\", \"google\", \"open_stack\", \"plone\", \"attrs\", \"hug\", \"wemake\", \"appnexus\""}, "git-hooks.hooks.lacheck": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "lacheck hook", "loc": ["git-hooks", "hooks", "lacheck"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.lacheck.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "lacheck", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.latexindent": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "latexindent hook", "loc": ["git-hooks", "hooks", "latexindent"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.latexindent.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "latexindent", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.latexindent.settings.flags": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"--local --silent --overwriteIfDifferent\""}, "description": "Flags passed to latexindent. See available flags [here](https://latexindentpl.readthedocs.io/en/latest/sec-how-to-use.html#from-the-command-line)", "loc": ["git-hooks", "hooks", "latexindent", "settings", "flags"], "readOnly": false, "type": "string"}, "git-hooks.hooks.lua-ls": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "lua-ls hook", "loc": ["git-hooks", "hooks", "lua-ls"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.lua-ls.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "lua-ls", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.lua-ls.settings.checklevel": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"Warning\""}, "description": "The diagnostic check level", "loc": ["git-hooks", "hooks", "lua-ls", "settings", "checklevel"], "readOnly": false, "type": "one of \"Error\", \"Warning\", \"Information\", \"Hint\""}, "git-hooks.hooks.lua-ls.settings.configuration": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "See https://github.com/LuaLS/lua-language-server/wiki/Configuration-File#luarcjson", "loc": ["git-hooks", "hooks", "lua-ls", "settings", "configuration"], "readOnly": false, "type": "attribute set"}, "git-hooks.hooks.lychee": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "lychee hook", "loc": ["git-hooks", "hooks", "lychee"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.lychee.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "lychee", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.lychee.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to the config file.", "loc": ["git-hooks", "hooks", "lychee", "settings", "configPath"], "readOnly": false, "type": "string"}, "git-hooks.hooks.lychee.settings.flags": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Flags passed to lychee. See all available [here](https://lychee.cli.rs/#/usage/cli).", "loc": ["git-hooks", "hooks", "lychee", "settings", "flags"], "readOnly": false, "type": "string"}, "git-hooks.hooks.markdownlint": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "markdownlint hook", "loc": ["git-hooks", "hooks", "markdownlint"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.markdownlint.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "markdownlint", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.markdownlint.settings.configuration": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "See https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.jsonc", "loc": ["git-hooks", "hooks", "markdownlint", "settings", "configuration"], "readOnly": false, "type": "attribute set"}, "git-hooks.hooks.mdl": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "mdl hook", "loc": ["git-hooks", "hooks", "mdl"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.mdl.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "mdl", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.mdl.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "The configuration file to use.", "loc": ["git-hooks", "hooks", "mdl", "settings", "configPath"], "readOnly": false, "type": "string"}, "git-hooks.hooks.mdl.settings.git-recurse": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Only process files known to git when given a directory.", "loc": ["git-hooks", "hooks", "mdl", "settings", "git-recurse"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.mdl.settings.ignore-front-matter": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Ignore YAML front matter.", "loc": ["git-hooks", "hooks", "mdl", "settings", "ignore-front-matter"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.mdl.settings.json": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Format output as JSON.", "loc": ["git-hooks", "hooks", "mdl", "settings", "json"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.mdl.settings.rules": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Markdown rules to use for linting. Per default all rules are processed.", "loc": ["git-hooks", "hooks", "mdl", "settings", "rules"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.mdl.settings.rulesets": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Specify additional ruleset files to load.", "loc": ["git-hooks", "hooks", "mdl", "settings", "rulesets"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.mdl.settings.show-aliases": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Show rule alias instead of rule ID when viewing rules.", "loc": ["git-hooks", "hooks", "mdl", "settings", "show-aliases"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.mdl.settings.skip-default-ruleset": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Do not load the default markdownlint ruleset. Use this option if you only want to load custom rulesets.", "loc": ["git-hooks", "hooks", "mdl", "settings", "skip-default-ruleset"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.mdl.settings.style": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"default\""}, "description": "Select which style mdl uses.", "loc": ["git-hooks", "hooks", "mdl", "settings", "style"], "readOnly": false, "type": "string"}, "git-hooks.hooks.mdl.settings.tags": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Markdown rules to use for linting containing the given tags. Per default all rules are processed.", "loc": ["git-hooks", "hooks", "mdl", "settings", "tags"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.mdl.settings.verbose": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Increase verbosity.", "loc": ["git-hooks", "hooks", "mdl", "settings", "verbose"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.mdl.settings.warnings": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Show Kramdown warnings.", "loc": ["git-hooks", "hooks", "mdl", "settings", "warnings"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.mkdocs-linkcheck": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "mkdocs-linkcheck hook", "loc": ["git-hooks", "hooks", "mkdocs-linkcheck"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.mkdocs-linkcheck.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "mkdocs-linkcheck", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.mkdocs-linkcheck.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"${tools.mkdocs-linkcheck}/bin/mkdocs-linkcheck\"\n"}, "description": "mkdocs-linkcheck binary path. Should be used to specify the mkdocs-linkcheck binary from your Python environment.", "loc": ["git-hooks", "hooks", "mkdocs-linkcheck", "settings", "binPath"], "readOnly": false, "type": "null or string or absolute path"}, "git-hooks.hooks.mkdocs-linkcheck.settings.extension": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "File extension to scan for.", "loc": ["git-hooks", "hooks", "mkdocs-linkcheck", "settings", "extension"], "readOnly": false, "type": "string"}, "git-hooks.hooks.mkdocs-linkcheck.settings.local-only": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to only check local links.", "loc": ["git-hooks", "hooks", "mkdocs-linkcheck", "settings", "local-only"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.mkdocs-linkcheck.settings.method": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"get\""}, "description": "HTTP method to use when checking external links.", "loc": ["git-hooks", "hooks", "mkdocs-linkcheck", "settings", "method"], "readOnly": false, "type": "one of \"get\", \"head\""}, "git-hooks.hooks.mkdocs-linkcheck.settings.path": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to check", "loc": ["git-hooks", "hooks", "mkdocs-linkcheck", "settings", "path"], "readOnly": false, "type": "string"}, "git-hooks.hooks.mkdocs-linkcheck.settings.recurse": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to recurse directories under path.", "loc": ["git-hooks", "hooks", "mkdocs-linkcheck", "settings", "recurse"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.mypy": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "mypy hook", "loc": ["git-hooks", "hooks", "mypy"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.mypy.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "mypy", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.mypy.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"${tools.mypy}/bin/mypy\"\n"}, "description": "Mypy binary path. Should be used to specify the mypy executable in an environment containing your typing stubs.", "loc": ["git-hooks", "hooks", "mypy", "settings", "binPath"], "readOnly": false, "type": "null or string"}, "git-hooks.hooks.nbstripout": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "nbstripout hook", "loc": ["git-hooks", "hooks", "nbstripout"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.nbstripout.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "nbstripout", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.nil": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "nil hook", "loc": ["git-hooks", "hooks", "nil"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.nil.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "nil", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.nil.settings.denyWarnings": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Treat warnings like errors and exit with non-zero code", "loc": ["git-hooks", "hooks", "nil", "settings", "denyWarnings"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.nixf-diagnose": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "nixf-diagnose hook", "loc": ["git-hooks", "hooks", "nixf-diagnose"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.nixf-diagnose.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "nixf-diagnose", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.nixfmt": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "nixfmt hook", "loc": ["git-hooks", "hooks", "nixfmt"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.nixfmt-classic": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "nixfmt (classic) hook", "loc": ["git-hooks", "hooks", "nixfmt-classic"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.nixfmt-classic.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "nixfmt-classic", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.nixfmt-classic.settings.width": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Line width.", "loc": ["git-hooks", "hooks", "nixfmt-classic", "settings", "width"], "readOnly": false, "type": "null or signed integer"}, "git-hooks.hooks.nixfmt-rfc-style": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "nixfmt (RFC 166 style) hook", "loc": ["git-hooks", "hooks", "nixfmt-rfc-style"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.nixfmt-rfc-style.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "nixfmt-rfc-style", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.nixfmt-rfc-style.settings.indent": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Number of spaces to use for indentation.", "loc": ["git-hooks", "hooks", "nixfmt-rfc-style", "settings", "indent"], "readOnly": false, "type": "null or signed integer"}, "git-hooks.hooks.nixfmt-rfc-style.settings.width": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Maximum width in characters.", "loc": ["git-hooks", "hooks", "nixfmt-rfc-style", "settings", "width"], "readOnly": false, "type": "null or signed integer"}, "git-hooks.hooks.nixfmt.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "nixfmt", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.nixfmt.settings.indent": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Number of spaces to use for indentation.", "loc": ["git-hooks", "hooks", "nixfmt", "settings", "indent"], "readOnly": false, "type": "null or signed integer"}, "git-hooks.hooks.nixfmt.settings.width": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Maximum width in characters.", "loc": ["git-hooks", "hooks", "nixfmt", "settings", "width"], "readOnly": false, "type": "null or signed integer"}, "git-hooks.hooks.no-commit-to-branch": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "no-commit-to-branch-hook", "loc": ["git-hooks", "hooks", "no-commit-to-branch"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.no-commit-to-branch.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "no-commit-to-branch", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.no-commit-to-branch.settings.branch": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"main\"\n]"}, "description": "Branches to disallow commits to.", "example": {"_type": "literalExpression", "text": "[\n \"main\"\n \"master\"\n]"}, "loc": ["git-hooks", "hooks", "no-commit-to-branch", "settings", "branch"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.no-commit-to-branch.settings.pattern": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "RegEx patterns for branch names to disallow commits to.", "example": {"_type": "literalExpression", "text": "[\n \"ma.*\"\n]"}, "loc": ["git-hooks", "hooks", "no-commit-to-branch", "settings", "pattern"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.ormolu": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "ormolu hook", "loc": ["git-hooks", "hooks", "ormolu"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.ormolu.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "ormolu", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.ormolu.settings.cabalDefaultExtensions": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Use `default-extensions` from `.cabal` files.", "loc": ["git-hooks", "hooks", "ormolu", "settings", "cabalDefaultExtensions"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.ormolu.settings.defaultExtensions": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Haskell language extensions to enable.", "loc": ["git-hooks", "hooks", "ormolu", "settings", "defaultExtensions"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.php-cs-fixer": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "php-cs-fixer hook", "loc": ["git-hooks", "hooks", "php-cs-fixer"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.php-cs-fixer.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "php-cs-fixer", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.php-cs-fixer.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"${tools.php-cs-fixer}/bin/php-cs-fixer\"\n"}, "description": "PHP-CS-Fixer binary path.", "loc": ["git-hooks", "hooks", "php-cs-fixer", "settings", "binPath"], "readOnly": false, "type": "null or string"}, "git-hooks.hooks.phpcbf": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "phpcbf hook", "loc": ["git-hooks", "hooks", "phpcbf"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.phpcbf.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "phpcbf", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.phpcbf.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"${tools.phpcbf}/bin/phpcbf\"\n"}, "description": "PHP_CodeSniffer binary path.", "loc": ["git-hooks", "hooks", "phpcbf", "settings", "binPath"], "readOnly": false, "type": "null or string"}, "git-hooks.hooks.phpcs": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "phpcs hook", "loc": ["git-hooks", "hooks", "phpcs"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.phpcs.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "phpcs", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.phpcs.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"${tools.phpcs}/bin/phpcs\"\n"}, "description": "PHP_CodeSniffer binary path.", "loc": ["git-hooks", "hooks", "phpcs", "settings", "binPath"], "readOnly": false, "type": "null or string"}, "git-hooks.hooks.phpstan": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "phpstan hook", "loc": ["git-hooks", "hooks", "phpstan"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.phpstan.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "phpstan", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.phpstan.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"${tools.phpstan}/bin/phpstan\"\n"}, "description": "PHPStan binary path.", "loc": ["git-hooks", "hooks", "phpstan", "settings", "binPath"], "readOnly": false, "type": "null or string"}, "git-hooks.hooks.prettier": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "prettier hook", "loc": ["git-hooks", "hooks", "prettier"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.prettier.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "prettier", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.allow-parens": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"always\""}, "description": "Include parentheses around a sole arrow function parameter.", "loc": ["git-hooks", "hooks", "prettier", "settings", "allow-parens"], "readOnly": false, "type": "one of \"always\", \"avoid\""}, "git-hooks.hooks.prettier.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"${tools.prettier}/bin/prettier\"\n"}, "description": "`prettier` binary path.\nFor example, if you want to use the `prettier` binary from `node_modules`, use `\"./node_modules/.bin/prettier\"`.\nUse a string instead of a path to avoid having to Git track the file in projects that use Nix flakes.\n", "example": {"_type": "literalExpression", "text": "\"./node_modules/.bin/prettier\"\n"}, "loc": ["git-hooks", "hooks", "prettier", "settings", "binPath"], "readOnly": false, "type": "null or string or absolute path"}, "git-hooks.hooks.prettier.settings.bracket-same-line": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Put > of opening tags on the last line instead of on a new line.", "loc": ["git-hooks", "hooks", "prettier", "settings", "bracket-same-line"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.cache": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Only format changed files.", "loc": ["git-hooks", "hooks", "prettier", "settings", "cache"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.cache-location": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"./node_modules/.cache/prettier/.prettier-cache\""}, "description": "Path to the cache file location used by `--cache` flag.", "loc": ["git-hooks", "hooks", "prettier", "settings", "cache-location"], "readOnly": false, "type": "string"}, "git-hooks.hooks.prettier.settings.cache-strategy": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Strategy for the cache to use for detecting changed files.", "loc": ["git-hooks", "hooks", "prettier", "settings", "cache-strategy"], "readOnly": false, "type": "null or one of \"metadata\", \"content\""}, "git-hooks.hooks.prettier.settings.check": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Output a human-friendly message and a list of unformatted files, if any.", "loc": ["git-hooks", "hooks", "prettier", "settings", "check"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.color": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Colorize error messages.", "loc": ["git-hooks", "hooks", "prettier", "settings", "color"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.config-precedence": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"cli-override\""}, "description": "Defines how config file should be evaluated in combination of CLI options.", "loc": ["git-hooks", "hooks", "prettier", "settings", "config-precedence"], "readOnly": false, "type": "one of \"cli-override\", \"file-override\", \"prefer-file\""}, "git-hooks.hooks.prettier.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to a Prettier configuration file (.prettierrc, package.json, prettier.config.js).", "loc": ["git-hooks", "hooks", "prettier", "settings", "configPath"], "readOnly": false, "type": "string"}, "git-hooks.hooks.prettier.settings.embedded-language-formatting": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"auto\""}, "description": "Control how Prettier formats quoted code embedded in the file.", "loc": ["git-hooks", "hooks", "prettier", "settings", "embedded-language-formatting"], "readOnly": false, "type": "one of \"auto\", \"off\""}, "git-hooks.hooks.prettier.settings.end-of-line": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"lf\""}, "description": "Which end of line characters to apply.", "loc": ["git-hooks", "hooks", "prettier", "settings", "end-of-line"], "readOnly": false, "type": "one of \"lf\", \"crlf\", \"cr\", \"auto\""}, "git-hooks.hooks.prettier.settings.html-whitespace-sensitivity": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"css\""}, "description": "How to handle whitespaces in HTML.", "loc": ["git-hooks", "hooks", "prettier", "settings", "html-whitespace-sensitivity"], "readOnly": false, "type": "one of \"css\", \"strict\", \"ignore\""}, "git-hooks.hooks.prettier.settings.ignore-path": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Path to a file containing patterns that describe files to ignore.\n By default, prettier looks for `./.gitignore` and `./.prettierignore`.\n Multiple values are accepted.", "loc": ["git-hooks", "hooks", "prettier", "settings", "ignore-path"], "readOnly": false, "type": "list of (string or absolute path)"}, "git-hooks.hooks.prettier.settings.ignore-unknown": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Ignore unknown files.", "loc": ["git-hooks", "hooks", "prettier", "settings", "ignore-unknown"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.insert-pragma": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Insert @format pragma into file's first docblock comment.", "loc": ["git-hooks", "hooks", "prettier", "settings", "insert-pragma"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.jsx-single-quote": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Use single quotes in JSX.", "loc": ["git-hooks", "hooks", "prettier", "settings", "jsx-single-quote"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.list-different": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Print the filenames of files that are different from Prettier formatting.", "loc": ["git-hooks", "hooks", "prettier", "settings", "list-different"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.log-level": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"log\""}, "description": "What level of logs to report.", "example": {"_type": "literalExpression", "text": "\"debug\""}, "loc": ["git-hooks", "hooks", "prettier", "settings", "log-level"], "readOnly": false, "type": "one of \"silent\", \"error\", \"warn\", \"log\", \"debug\""}, "git-hooks.hooks.prettier.settings.no-bracket-spacing": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Do not print spaces between brackets.", "loc": ["git-hooks", "hooks", "prettier", "settings", "no-bracket-spacing"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.no-config": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Do not look for a configuration file.", "loc": ["git-hooks", "hooks", "prettier", "settings", "no-config"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.no-editorconfig": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Don't take .editorconfig into account when parsing configuration.", "loc": ["git-hooks", "hooks", "prettier", "settings", "no-editorconfig"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.no-error-on-unmatched-pattern": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Prevent errors when pattern is unmatched.", "loc": ["git-hooks", "hooks", "prettier", "settings", "no-error-on-unmatched-pattern"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.no-semi": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Do not print semicolons, except at the beginning of lines which may need them.", "loc": ["git-hooks", "hooks", "prettier", "settings", "no-semi"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.parser": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Which parser to use.", "loc": ["git-hooks", "hooks", "prettier", "settings", "parser"], "readOnly": false, "type": "one of \"\", \"flow\", \"babel\", \"babel-flow\", \"babel-ts\", \"typescript\", \"acorn\", \"espree\", \"meriyah\", \"css\", \"less\", \"scss\", \"json\", \"json5\", \"json-stringify\", \"graphql\", \"markdown\", \"mdx\", \"vue\", \"yaml\", \"glimmer\", \"html\", \"angular\", \"lwc\""}, "git-hooks.hooks.prettier.settings.plugins": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Add plugins from paths.", "loc": ["git-hooks", "hooks", "prettier", "settings", "plugins"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.prettier.settings.print-width": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "80"}, "description": "Line length that the printer will wrap on.", "loc": ["git-hooks", "hooks", "prettier", "settings", "print-width"], "readOnly": false, "type": "signed integer"}, "git-hooks.hooks.prettier.settings.prose-wrap": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"preserve\""}, "description": "When to or if at all hard wrap prose to print width.", "loc": ["git-hooks", "hooks", "prettier", "settings", "prose-wrap"], "readOnly": false, "type": "one of \"always\", \"never\", \"preserve\""}, "git-hooks.hooks.prettier.settings.quote-props": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"as-needed\""}, "description": "Change when properties in objects are quoted.", "loc": ["git-hooks", "hooks", "prettier", "settings", "quote-props"], "readOnly": false, "type": "one of \"as-needed\", \"consistent\", \"preserve\""}, "git-hooks.hooks.prettier.settings.require-pragma": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Require either '@prettier' or '@format' to be present in the file's first docblock comment.", "loc": ["git-hooks", "hooks", "prettier", "settings", "require-pragma"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.single-attribute-per-line": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Enforce single attribute per line in HTML, Vue andJSX.", "loc": ["git-hooks", "hooks", "prettier", "settings", "single-attribute-per-line"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.single-quote": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Number of spaces per indentation-level.", "loc": ["git-hooks", "hooks", "prettier", "settings", "single-quote"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.tab-width": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "2"}, "description": "Line length that the printer will wrap on.", "loc": ["git-hooks", "hooks", "prettier", "settings", "tab-width"], "readOnly": false, "type": "signed integer"}, "git-hooks.hooks.prettier.settings.trailing-comma": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"all\""}, "description": "Print trailing commas wherever possible in multi-line comma-separated syntactic structures.", "loc": ["git-hooks", "hooks", "prettier", "settings", "trailing-comma"], "readOnly": false, "type": "one of \"all\", \"es5\", \"none\""}, "git-hooks.hooks.prettier.settings.use-tabs": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Indent with tabs instead of spaces.", "loc": ["git-hooks", "hooks", "prettier", "settings", "use-tabs"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.vue-indent-script-and-style": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Indent script and style tags in Vue files.", "loc": ["git-hooks", "hooks", "prettier", "settings", "vue-indent-script-and-style"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.with-node-modules": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Process files inside 'node_modules' directory.", "loc": ["git-hooks", "hooks", "prettier", "settings", "with-node-modules"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.write": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Edit files in-place.", "loc": ["git-hooks", "hooks", "prettier", "settings", "write"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.pretty-format-json": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "pretty-format-json hook", "loc": ["git-hooks", "hooks", "pretty-format-json"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.pretty-format-json.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "pretty-format-json", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.pretty-format-json.settings.autofix": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Automatically format JSON files.", "loc": ["git-hooks", "hooks", "pretty-format-json", "settings", "autofix"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.pretty-format-json.settings.indent": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Control the indentation (either a number for a number of spaces or a string of whitespace). Defaults to 2 spaces.", "loc": ["git-hooks", "hooks", "pretty-format-json", "settings", "indent"], "readOnly": false, "type": "null or signed integer or string"}, "git-hooks.hooks.pretty-format-json.settings.no-ensure-ascii": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Preserve unicode characters instead of converting to escape sequences.", "loc": ["git-hooks", "hooks", "pretty-format-json", "settings", "no-ensure-ascii"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.pretty-format-json.settings.no-sort-keys": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "When autofixing, retain the original key ordering (instead of sorting the keys).", "loc": ["git-hooks", "hooks", "pretty-format-json", "settings", "no-sort-keys"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.pretty-format-json.settings.top-keys": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Keys to keep at the top of mappings.", "loc": ["git-hooks", "hooks", "pretty-format-json", "settings", "top-keys"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.proselint": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "proselint hook", "loc": ["git-hooks", "hooks", "proselint"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.proselint.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "proselint", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.proselint.settings.config": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Multiline-string configuration passed as config file.", "example": {"_type": "literalExpression", "text": "''\n {\n \"checks\": {\n \"typography.diacritical_marks\": false\n }\n }\n''"}, "loc": ["git-hooks", "hooks", "proselint", "settings", "config"], "readOnly": false, "type": "string"}, "git-hooks.hooks.proselint.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to the config file.", "loc": ["git-hooks", "hooks", "proselint", "settings", "configPath"], "readOnly": false, "type": "string"}, "git-hooks.hooks.proselint.settings.flags": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Flags passed to proselint.", "loc": ["git-hooks", "hooks", "proselint", "settings", "flags"], "readOnly": false, "type": "string"}, "git-hooks.hooks.psalm": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "psalm hook", "loc": ["git-hooks", "hooks", "psalm"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.psalm.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "psalm", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.psalm.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"${tools.psalm}/bin/psalm\"\n"}, "description": "Psalm binary path.", "loc": ["git-hooks", "hooks", "psalm", "settings", "binPath"], "readOnly": false, "type": "null or string"}, "git-hooks.hooks.pylint": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "pylint hook", "loc": ["git-hooks", "hooks", "pylint"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.pylint.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "pylint", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.pylint.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"${tools.pylint}/bin/pylint\"\n"}, "description": "Pylint binary path. Should be used to specify Pylint binary from your Python environment.", "loc": ["git-hooks", "hooks", "pylint", "settings", "binPath"], "readOnly": false, "type": "null or string"}, "git-hooks.hooks.pylint.settings.reports": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to display a full report.", "loc": ["git-hooks", "hooks", "pylint", "settings", "reports"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.pylint.settings.score": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to activate the evaluation score.", "loc": ["git-hooks", "hooks", "pylint", "settings", "score"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.pyright": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "pyright hook", "loc": ["git-hooks", "hooks", "pyright"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.pyright.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "pyright", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.pyright.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"${tools.pyright}/bin/pyright\"\n"}, "description": "Pyright binary path. Should be used to specify the pyright executable in an environment containing your typing stubs.", "loc": ["git-hooks", "hooks", "pyright", "settings", "binPath"], "readOnly": false, "type": "null or string"}, "git-hooks.hooks.pyupgrade": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "pyupgrade hook", "loc": ["git-hooks", "hooks", "pyupgrade"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.pyupgrade.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "pyupgrade", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.pyupgrade.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"${tools.pyupgrade}/bin/pyupgrade\"\n"}, "description": "pyupgrade binary path. Should be used to specify the pyupgrade binary from your Python environment.", "loc": ["git-hooks", "hooks", "pyupgrade", "settings", "binPath"], "readOnly": false, "type": "null or string"}, "git-hooks.hooks.regal": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "regal hook", "loc": ["git-hooks", "hooks", "regal"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.regal.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "regal", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.regal.settings.flags": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Flags passed to regal. For available options run 'regal lint --help'", "example": {"_type": "literalExpression", "text": "\"--disable-category style\""}, "loc": ["git-hooks", "hooks", "regal", "settings", "flags"], "readOnly": false, "type": "string"}, "git-hooks.hooks.reuse": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "reuse hook", "loc": ["git-hooks", "hooks", "reuse"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.reuse.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "reuse", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.reuse.settings.flags": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Flags passed to reuse. For available options run 'reuse lint --help'", "example": {"_type": "literalExpression", "text": "\"--json\""}, "loc": ["git-hooks", "hooks", "reuse", "settings", "flags"], "readOnly": false, "type": "string"}, "git-hooks.hooks.revive": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "revive hook", "loc": ["git-hooks", "hooks", "revive"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.revive.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "revive", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.revive.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to the configuration TOML file.", "loc": ["git-hooks", "hooks", "revive", "settings", "configPath"], "readOnly": false, "type": "string"}, "git-hooks.hooks.ripsecrets": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "ripsecrets hook", "loc": ["git-hooks", "hooks", "ripsecrets"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.ripsecrets.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "ripsecrets", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.ripsecrets.settings.additionalPatterns": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Additional regex patterns used to find secrets. If there is a matching group in the regex the matched group will be tested for randomness before being reported as a secret.", "loc": ["git-hooks", "hooks", "ripsecrets", "settings", "additionalPatterns"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.rumdl": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "rumdl hook", "loc": ["git-hooks", "hooks", "rumdl"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.rumdl.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "rumdl", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.rumdl.settings.configuration": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "See https://github.com/rvben/rumdl?tab=readme-ov-file#configuration", "example": {"_type": "literalExpression", "text": "{\n configuration = {\n MD013 = {\n line-length = 100;\n };\n };\n}"}, "loc": ["git-hooks", "hooks", "rumdl", "settings", "configuration"], "readOnly": false, "type": "attribute set"}, "git-hooks.hooks.rustfmt": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "Additional rustfmt settings\n\nOverride the `rustfmt` and `cargo` packages by setting `hooks.rustfmt.packageOverrides`.\n\n```\nhooks.rustfmt.packageOverrides.cargo = pkgs.cargo;\nhooks.rustfmt.packageOverrides.rustfmt = pkgs.rustfmt;\n```\n", "loc": ["git-hooks", "hooks", "rustfmt"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.rustfmt.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "rustfmt", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.rustfmt.packageOverrides.cargo": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "The cargo package to use.", "loc": ["git-hooks", "hooks", "rustfmt", "packageOverrides", "cargo"], "readOnly": false, "type": "package"}, "git-hooks.hooks.rustfmt.packageOverrides.rustfmt": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "The rustfmt package to use.", "loc": ["git-hooks", "hooks", "rustfmt", "packageOverrides", "rustfmt"], "readOnly": false, "type": "package"}, "git-hooks.hooks.rustfmt.settings.all": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Format all packages, and also their local path-based dependencies", "loc": ["git-hooks", "hooks", "rustfmt", "settings", "all"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.rustfmt.settings.check": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Run rustfmt in check mode", "loc": ["git-hooks", "hooks", "rustfmt", "settings", "check"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.rustfmt.settings.color": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"always\""}, "description": "Coloring the output", "loc": ["git-hooks", "hooks", "rustfmt", "settings", "color"], "readOnly": false, "type": "one of \"auto\", \"always\", \"never\""}, "git-hooks.hooks.rustfmt.settings.config": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Override configuration values", "loc": ["git-hooks", "hooks", "rustfmt", "settings", "config"], "readOnly": false, "type": "attribute set"}, "git-hooks.hooks.rustfmt.settings.config-path": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Path to rustfmt.toml config file", "loc": ["git-hooks", "hooks", "rustfmt", "settings", "config-path"], "readOnly": false, "type": "null or string"}, "git-hooks.hooks.rustfmt.settings.emit": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "What data to emit and how", "loc": ["git-hooks", "hooks", "rustfmt", "settings", "emit"], "readOnly": false, "type": "null or one of \"files\", \"stdout\""}, "git-hooks.hooks.rustfmt.settings.files-with-diff": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "", "loc": ["git-hooks", "hooks", "rustfmt", "settings", "files-with-diff"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.rustfmt.settings.manifest-path": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Path to Cargo.toml", "loc": ["git-hooks", "hooks", "rustfmt", "settings", "manifest-path"], "readOnly": false, "type": "null or string"}, "git-hooks.hooks.rustfmt.settings.message-format": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The output format of diagnostic messages", "loc": ["git-hooks", "hooks", "rustfmt", "settings", "message-format"], "readOnly": false, "type": "null or one of \"human\", \"short\""}, "git-hooks.hooks.rustfmt.settings.package": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Package(s) to check", "loc": ["git-hooks", "hooks", "rustfmt", "settings", "package"], "readOnly": false, "type": "list of string matching the pattern [][*?!0-9A-Za-z_-]+"}, "git-hooks.hooks.rustfmt.settings.verbose": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Use verbose output", "loc": ["git-hooks", "hooks", "rustfmt", "settings", "verbose"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.shfmt": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "shfmt hook", "loc": ["git-hooks", "hooks", "shfmt"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.shfmt.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "shfmt", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.shfmt.settings.binary-next-line": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Binary ops like && and | may start a line.", "loc": ["git-hooks", "hooks", "shfmt", "settings", "binary-next-line"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.shfmt.settings.case-indent": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Switch cases will be indented.", "loc": ["git-hooks", "hooks", "shfmt", "settings", "case-indent"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.shfmt.settings.func-next-line": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Function opening braces are placed on a separate line.", "loc": ["git-hooks", "hooks", "shfmt", "settings", "func-next-line"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.shfmt.settings.indent": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "0 for tabs, >0 for number of spaces.", "loc": ["git-hooks", "hooks", "shfmt", "settings", "indent"], "readOnly": false, "type": "null or signed integer or string"}, "git-hooks.hooks.shfmt.settings.keep-padding": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Keep column alignment paddings.", "loc": ["git-hooks", "hooks", "shfmt", "settings", "keep-padding"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.shfmt.settings.language-dialect": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"auto\""}, "description": "Shell language dialect.", "loc": ["git-hooks", "hooks", "shfmt", "settings", "language-dialect"], "readOnly": false, "type": "null or one of \"auto\", \"bash\", \"posix\", \"mksh\", \"bats\""}, "git-hooks.hooks.shfmt.settings.simplify": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Simplify the code.", "loc": ["git-hooks", "hooks", "shfmt", "settings", "simplify"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.shfmt.settings.space-redirects": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Redirect operators will be followed by a space.", "loc": ["git-hooks", "hooks", "shfmt", "settings", "space-redirects"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.sort-file-contents": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "sort-file-contents-hook", "loc": ["git-hooks", "hooks", "sort-file-contents"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.sort-file-contents.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "sort-file-contents", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.sort-file-contents.settings.ignore-case": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Fold lower case to upper case characters.", "loc": ["git-hooks", "hooks", "sort-file-contents", "settings", "ignore-case"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.sort-file-contents.settings.unique": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Ensure each line is unique.", "loc": ["git-hooks", "hooks", "sort-file-contents", "settings", "unique"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.statix": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "statix hook", "loc": ["git-hooks", "hooks", "statix"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.statix.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "statix", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.statix.settings.config": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Path to statix.toml or its parent directory.", "loc": ["git-hooks", "hooks", "statix", "settings", "config"], "readOnly": false, "type": "null or string"}, "git-hooks.hooks.statix.settings.format": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"errfmt\""}, "description": "Error Output format.", "loc": ["git-hooks", "hooks", "statix", "settings", "format"], "readOnly": false, "type": "one of \"stderr\", \"errfmt\", \"json\""}, "git-hooks.hooks.statix.settings.ignore": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Globs of file patterns to skip.", "example": {"_type": "literalExpression", "text": "[\n \"flake.nix\"\n \"_*\"\n]"}, "loc": ["git-hooks", "hooks", "statix", "settings", "ignore"], "readOnly": false, "type": "null or (list of string)"}, "git-hooks.hooks.statix.settings.unrestricted": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Don't respect .gitignore files.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["git-hooks", "hooks", "statix", "settings", "unrestricted"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.treefmt": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "Treefmt hook.\n\nInclude any additional formatters configured by treefmt as `hooks.treefmt.settings.formatters`.\n\n```\nhooks.treefmt.settings.formatters = [\n pkgs.nixpkgs-fmt\n pkgs.black\n];\n```\n\nOverride `treefmt` itself by setting `hooks.treefmt.packageOverrides.treefmt`.\n\n```\nhooks.treefmt.packageOverrides.treefmt = pkgs.treefmt;\n```\n", "loc": ["git-hooks", "hooks", "treefmt"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.treefmt.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "treefmt", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.treefmt.packageOverrides.treefmt": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "The treefmt package to use", "loc": ["git-hooks", "hooks", "treefmt", "packageOverrides", "treefmt"], "readOnly": false, "type": "package"}, "git-hooks.hooks.treefmt.settings.fail-on-change": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Fail if some files require re-formatting.", "loc": ["git-hooks", "hooks", "treefmt", "settings", "fail-on-change"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.treefmt.settings.formatters": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "The formatter packages configured by treefmt", "loc": ["git-hooks", "hooks", "treefmt", "settings", "formatters"], "readOnly": false, "type": "list of package"}, "git-hooks.hooks.treefmt.settings.no-cache": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Ignore the evaluation cache entirely.", "loc": ["git-hooks", "hooks", "treefmt", "settings", "no-cache"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.typos": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "typos hook", "loc": ["git-hooks", "hooks", "typos"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.typos.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "typos", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.typos.settings.binary": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to search binary files.", "loc": ["git-hooks", "hooks", "typos", "settings", "binary"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.typos.settings.color": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"auto\""}, "description": "When to use generate output.", "loc": ["git-hooks", "hooks", "typos", "settings", "color"], "readOnly": false, "type": "one of \"auto\", \"always\", \"never\""}, "git-hooks.hooks.typos.settings.config": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Configuration as in https://github.com/crate-ci/typos/blob/master/docs/reference.md.", "example": {"_type": "literalExpression", "text": "{\n default = {\n binary = false;\n };\n files = {\n ignore-dot = true;\n };\n type = {\n py = {\n extend-glob = [ ];\n };\n };\n}"}, "loc": ["git-hooks", "hooks", "typos", "settings", "config"], "readOnly": false, "type": "TOML value"}, "git-hooks.hooks.typos.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to a custom config file. Ignored if `typos.settings.config` is set.", "example": {"_type": "literalExpression", "text": "\".typos.toml\""}, "loc": ["git-hooks", "hooks", "typos", "settings", "configPath"], "readOnly": false, "type": "string"}, "git-hooks.hooks.typos.settings.diff": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Print a diff of what would change.", "loc": ["git-hooks", "hooks", "typos", "settings", "diff"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.typos.settings.exclude": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Ignore files and directories matching one of the globs.", "example": {"_type": "literalExpression", "text": "[\n \"*.nix\"\n]"}, "loc": ["git-hooks", "hooks", "typos", "settings", "exclude"], "readOnly": false, "type": "(list of string) or string convertible to it"}, "git-hooks.hooks.typos.settings.force-exclude": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Respect excluded files even for paths passed explicitly.", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["git-hooks", "hooks", "typos", "settings", "force-exclude"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.typos.settings.format": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"long\""}, "description": "Output format to use.", "loc": ["git-hooks", "hooks", "typos", "settings", "format"], "readOnly": false, "type": "one of \"silent\", \"brief\", \"long\", \"json\""}, "git-hooks.hooks.typos.settings.hidden": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Search hidden files and directories.", "loc": ["git-hooks", "hooks", "typos", "settings", "hidden"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.typos.settings.ignored-words": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Spellings and words to ignore.", "example": {"_type": "literalExpression", "text": "[\n \"MQTT\"\n \"mosquitto\"\n]"}, "loc": ["git-hooks", "hooks", "typos", "settings", "ignored-words"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.typos.settings.locale": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"en\""}, "description": "Which language to use for spell checking.", "loc": ["git-hooks", "hooks", "typos", "settings", "locale"], "readOnly": false, "type": "one of \"en\", \"en-us\", \"en-gb\", \"en-ca\", \"en-au\""}, "git-hooks.hooks.typos.settings.no-check-filenames": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Skip verifying spelling in file names.", "loc": ["git-hooks", "hooks", "typos", "settings", "no-check-filenames"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.typos.settings.no-check-files": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Skip verifying spelling in files.", "loc": ["git-hooks", "hooks", "typos", "settings", "no-check-files"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.typos.settings.no-unicode": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Only allow ASCII characters in identifiers.", "loc": ["git-hooks", "hooks", "typos", "settings", "no-unicode"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.typos.settings.quiet": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Less output per occurrence.", "loc": ["git-hooks", "hooks", "typos", "settings", "quiet"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.typos.settings.verbose": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "More output per occurrence.", "loc": ["git-hooks", "hooks", "typos", "settings", "verbose"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.typos.settings.write": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Fix spelling in files by writing them. Cannot be used with `typos.settings.diff`.", "loc": ["git-hooks", "hooks", "typos", "settings", "write"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.uv-export": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "uv export hook", "loc": ["git-hooks", "hooks", "uv-export"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.uv-export.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "uv-export", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.uv-export.settings.flags": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Flags passed to `uv export`", "loc": ["git-hooks", "hooks", "uv-export", "settings", "flags"], "readOnly": false, "type": "string"}, "git-hooks.hooks.uv-export.settings.format": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"pylock.toml\""}, "description": "Output format of the project's lockfile.", "example": {"_type": "literalExpression", "text": "\"requirements.txt\""}, "loc": ["git-hooks", "hooks", "uv-export", "settings", "format"], "readOnly": false, "type": "one of \"requirements.txt\", \"pylock.toml\""}, "git-hooks.hooks.uv-export.settings.locked": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Assert that the `uv.lock` will remain unchanged.\nRequires that the lockfile is up-to-date. If the lockfile is missing or needs to be updated, uv will exit with an error.\n", "loc": ["git-hooks", "hooks", "uv-export", "settings", "locked"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.vale": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "vale hook", "loc": ["git-hooks", "hooks", "vale"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.vale.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "vale", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.vale.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to the config file.", "loc": ["git-hooks", "hooks", "vale", "settings", "configPath"], "readOnly": false, "type": "string"}, "git-hooks.hooks.vale.settings.configuration": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Multiline-string configuration passed as config file.", "example": {"_type": "literalExpression", "text": "''\n MinAlertLevel = suggestion\n [*]\n BasedOnStyles = Vale\n''"}, "loc": ["git-hooks", "hooks", "vale", "settings", "configuration"], "readOnly": false, "type": "string"}, "git-hooks.hooks.vale.settings.flags": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Flags passed to vale.", "loc": ["git-hooks", "hooks", "vale", "settings", "flags"], "readOnly": false, "type": "string"}, "git-hooks.hooks.woodpecker-cli-lint": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "`woodpecker-cli lint` hook", "loc": ["git-hooks", "hooks", "woodpecker-cli-lint"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.woodpecker-cli-lint.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "woodpecker-cli-lint", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.woodpecker-cli-lint.settings.pluginsPrivileged": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "List of plugins, allowed to run in privileged mode", "loc": ["git-hooks", "hooks", "woodpecker-cli-lint", "settings", "pluginsPrivileged"], "readOnly": false, "type": "strings concatenated with \",\""}, "git-hooks.hooks.woodpecker-cli-lint.settings.pluginsTrustedClone": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "List of plugins, that are trusted to handle Git credentials in cloning steps.\nIf not set, the program defaults to\n\"docker.io/woodpeckerci/plugin-git:2.6.3,docker.io/woodpeckerci/plugin-git,quay.io/woodpeckerci/plugin-git\".\n", "loc": ["git-hooks", "hooks", "woodpecker-cli-lint", "settings", "pluginsTrustedClone"], "readOnly": false, "type": "strings concatenated with \",\""}, "git-hooks.hooks.woodpecker-cli-lint.settings.strict": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to treat warnings as errors.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["git-hooks", "hooks", "woodpecker-cli-lint", "settings", "strict"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.woodpecker-cli-lint.settings.workflowPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to the workflow config file/directory. If not set, the program\nlooks for `.woodpecker.ya?ml` file or `.woodpecker` directory.\n", "example": {"_type": "literalExpression", "text": "\".woodpecker.yml\""}, "loc": ["git-hooks", "hooks", "woodpecker-cli-lint", "settings", "workflowPath"], "readOnly": false, "type": "string"}, "git-hooks.hooks.yamlfmt": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "yamlfmt hook", "loc": ["git-hooks", "hooks", "yamlfmt"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.yamlfmt.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "yamlfmt", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.yamlfmt.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to a custom configuration file.", "example": {"_type": "literalExpression", "text": "\".yamlfmt\""}, "loc": ["git-hooks", "hooks", "yamlfmt", "settings", "configPath"], "readOnly": false, "type": "string"}, "git-hooks.hooks.yamlfmt.settings.lint-only": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Only lint the files, do not format them in place.", "loc": ["git-hooks", "hooks", "yamlfmt", "settings", "lint-only"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.yamllint": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "yamllint hook", "loc": ["git-hooks", "hooks", "yamllint"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.yamllint.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "yamllint", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.yamllint.settings.configData": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Serialized YAML object describing the configuration.", "example": {"_type": "literalExpression", "text": "\"{extends: relaxed, rules: {line-length: {max: 120}}}\""}, "loc": ["git-hooks", "hooks", "yamllint", "settings", "configData"], "readOnly": false, "type": "string"}, "git-hooks.hooks.yamllint.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to a custom configuration file.", "loc": ["git-hooks", "hooks", "yamllint", "settings", "configPath"], "readOnly": false, "type": "string"}, "git-hooks.hooks.yamllint.settings.configuration": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Multiline-string configuration passed as config file. If set, configuration file set in `yamllint.settings.configPath` gets ignored.", "example": {"_type": "literalExpression", "text": "''\n ---\n \n extends: relaxed\n \n rules:\n indentation: enable\n''"}, "loc": ["git-hooks", "hooks", "yamllint", "settings", "configuration"], "readOnly": false, "type": "string"}, "git-hooks.hooks.yamllint.settings.format": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"auto\""}, "description": "Format for parsing output.", "loc": ["git-hooks", "hooks", "yamllint", "settings", "format"], "readOnly": false, "type": "one of \"parsable\", \"standard\", \"colored\", \"github\", \"auto\""}, "git-hooks.hooks.yamllint.settings.preset": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"default\""}, "description": "The configuration preset to use.", "loc": ["git-hooks", "hooks", "yamllint", "settings", "preset"], "readOnly": false, "type": "one of \"default\", \"relaxed\""}, "git-hooks.hooks.yamllint.settings.strict": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Return non-zero exit code on warnings as well as errors.", "loc": ["git-hooks", "hooks", "yamllint", "settings", "strict"], "readOnly": false, "type": "boolean"}, "git-hooks.install.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable automatic installation of pre-commit hooks.\n\nWhen set to false, hooks will not be installed into the git repository,\nbut all other module functionality (like configuration generation) will still work.\n", "loc": ["git-hooks", "install", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.installStages": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "The stages to install the hooks to.\n", "loc": ["git-hooks", "installStages"], "readOnly": true, "type": "list of (string or anything)"}, "git-hooks.installationScript": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "description": "A bash snippet that installs the git hooks in the current repository.\n", "loc": ["git-hooks", "installationScript"], "readOnly": true, "type": "string"}, "git-hooks.package": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.pre-commit"}, "description": "The `pre-commit` package to use.\n", "example": {"_type": "literalExpression", "text": "pkgs.prek"}, "loc": ["git-hooks", "package"], "readOnly": false, "type": "package"}, "git-hooks.rootSrc": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "default": {"_type": "literalExpression", "text": "gitignoreSource config.src"}, "description": "The source of the project to be checked.\n\nThis is used in the derivation that performs the check.\n\nIf you use the `flakeModule`, the default is `self.outPath`; the whole flake\nsources.\n", "loc": ["git-hooks", "rootSrc"], "readOnly": false, "type": "absolute path"}, "git-hooks.run": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "default": {"_type": "literalExpression", "text": ""}, "description": "A derivation that tests whether the pre-commit hooks run cleanly on\nthe entire project.\n", "loc": ["git-hooks", "run"], "readOnly": false, "type": "package"}, "git-hooks.settings.rust.cargoManifestPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Path to Cargo.toml", "loc": ["git-hooks", "settings", "rust", "cargoManifestPath"], "readOnly": false, "type": "null or string"}, "git-hooks.settings.rust.check.cargoDeps": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Cargo dependencies needed to run the checks.", "example": {"_type": "literalExpression", "text": "\"pkgs.rustPlatform.importCargoLock { lockFile = ./Cargo.lock; }\""}, "loc": ["git-hooks", "settings", "rust", "check", "cargoDeps"], "readOnly": false, "type": "null or (attribute set)"}, "git-hooks.shellHook": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "description": "A shell hook that sets up the git hooks in a development shell.\n\nPass to `mkShell` as `shellHook` to use.\n", "loc": ["git-hooks", "shellHook"], "readOnly": true, "type": "string"}, "git-hooks.src": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "description": "Root of the project. By default this will be filtered with the `gitignoreSource`\nfunction later, unless `rootSrc` is specified.\n\nIf you use the `flakeModule`, the default is `self.outPath`; the whole flake\nsources.\n", "loc": ["git-hooks", "src"], "readOnly": false, "type": "absolute path"}, "git-hooks.tools": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "default": {"_type": "literalExpression", "text": "git-hooks.nix-pkgs.callPackage tools-dot-nix { inherit (pkgs) system; }\n"}, "description": "Tool set from which `nix-pre-commit-hooks` will pick binaries.\n\n`nix-pre-commit-hooks` comes with its own set of packages for this purpose.\n", "loc": ["git-hooks", "tools"], "readOnly": false, "type": "lazy attribute set of (null or package)"}, "git.root": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/git.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/git.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Git repository root path. This field is populated automatically in devenv 1.10 and newer.", "loc": ["git", "root"], "readOnly": false, "type": "null or string"}, "hosts": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/hostctl.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/hostctl.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "List of hosts entries.", "example": {"_type": "literalExpression", "text": "{\n \"another-example.com\" = [\n \"::1\"\n \"127.0.0.1\"\n ];\n \"example.com\" = \"127.0.0.1\";\n}"}, "loc": ["hosts"], "readOnly": false, "type": "attribute set of (string or list of string)"}, "hostsProfileName": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/hostctl.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/hostctl.nix"}], "default": {"_type": "literalExpression", "text": "\"devenv-\""}, "description": "Profile name to use.", "loc": ["hostsProfileName"], "readOnly": false, "type": "string"}, "infoSections": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/info.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/info.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Information about the environment", "loc": ["infoSections"], "readOnly": false, "type": "attribute set of list of string"}, "inputsFrom": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "A list of derivations whose build inputs will be merged into the shell environment.", "example": {"_type": "literalExpression", "text": "[\n pkgs.hello\n (pkgs.python3.withPackages (ps: [ ps.numpy ps.pandas ]))\n]\n"}, "loc": ["inputsFrom"], "readOnly": false, "type": "list of package"}, "integrations.gitnr": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/gitnr.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/gitnr.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Declarative generation of ignore files using gitnr templates.", "example": {"_type": "literalExpression", "text": "{\n \".gitignore\" = {\n enableDefaultTemplates = true;\n templates = [ \"tt:go\" \"tt:node\" ];\n content = [\n \"*.env\"\n ];\n };\n}\n"}, "loc": ["integrations", "gitnr"], "readOnly": false, "type": "attribute set of (submodule)"}, "integrations.gitnr..content": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/gitnr.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/gitnr.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Additional patterns to append to the generated ignore file.\nThese patterns will be added after the templates are processed.\n", "example": {"_type": "literalExpression", "text": "[\n \"*.log\"\n \"dist/\"\n]"}, "loc": ["integrations", "gitnr", "", "content"], "readOnly": false, "type": "list of string"}, "integrations.gitnr..enableDefaultTemplates": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/gitnr.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/gitnr.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Prepend a sensible default set of TopTal templates.", "loc": ["integrations", "gitnr", "", "enableDefaultTemplates"], "readOnly": false, "type": "boolean"}, "integrations.gitnr..package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/gitnr.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/gitnr.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.gitnr"}, "description": "The gitnr package to use for generating templates.", "loc": ["integrations", "gitnr", "", "package"], "readOnly": false, "type": "package"}, "integrations.gitnr..templates": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/gitnr.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/gitnr.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of templates to include in the ignore file.\n\nTemplate strings are passed directly to `gitnr create`.\n", "example": {"_type": "literalExpression", "text": "[\n \"tt:linux\"\n \"tt:macos\"\n \"tt:windows\"\n]"}, "loc": ["integrations", "gitnr", "", "templates"], "readOnly": false, "type": "list of string"}, "keyFile": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/mkcert.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/mkcert.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Custom key file name, uses mkcert default if unset", "example": {"_type": "literalExpression", "text": "\"mykey.pem\""}, "loc": ["keyFile"], "readOnly": false, "type": "null or string"}, "languages.ansible.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ansible.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ansible.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Ansible development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "ansible", "enable"], "readOnly": false, "type": "boolean"}, "languages.ansible.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ansible.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ansible.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Ansible Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "ansible", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.ansible.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ansible.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ansible.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.ansible-language-server"}, "description": "The Ansible language server package to use.", "loc": ["languages", "ansible", "lsp", "package"], "readOnly": false, "type": "null or package"}, "languages.ansible.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ansible.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ansible.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.ansible"}, "description": "The Ansible package to use.", "loc": ["languages", "ansible", "package"], "readOnly": false, "type": "package"}, "languages.c.debugger": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/c.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/c.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.gdb"}, "description": "An optional debugger package to use with c.\nThe default is `lldb` on macOS, `gdb` on Linux (if supported), or `null` otherwise.\n", "loc": ["languages", "c", "debugger"], "readOnly": false, "type": "null or package"}, "languages.c.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/c.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/c.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for C development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "c", "enable"], "readOnly": false, "type": "boolean"}, "languages.c.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/c.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/c.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable C Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "c", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.c.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/c.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/c.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.ccls"}, "description": "The C language server package to use.", "loc": ["languages", "c", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.clojure.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/clojure.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/clojure.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Clojure development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "clojure", "enable"], "readOnly": false, "type": "boolean"}, "languages.clojure.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/clojure.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/clojure.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Clojure Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "clojure", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.clojure.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/clojure.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/clojure.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.clojure-lsp"}, "description": "The Clojure language server package to use.", "loc": ["languages", "clojure", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.cplusplus.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/cplusplus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/cplusplus.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for C++ development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "cplusplus", "enable"], "readOnly": false, "type": "boolean"}, "languages.cplusplus.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/cplusplus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/cplusplus.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable C++ Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "cplusplus", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.cplusplus.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/cplusplus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/cplusplus.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.ccls"}, "description": "The C++ language server package to use.", "loc": ["languages", "cplusplus", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.crystal.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/crystal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/crystal.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Enable tools for Crystal development..", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "crystal", "enable"], "readOnly": false, "type": "boolean"}, "languages.crystal.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/crystal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/crystal.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Crystal Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "crystal", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.crystal.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/crystal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/crystal.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.crystalline"}, "description": "The Crystal language server package to use.", "loc": ["languages", "crystal", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.crystal.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/crystal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/crystal.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.crystal"}, "description": "The Crystal package to use.", "loc": ["languages", "crystal", "package"], "readOnly": false, "type": "package"}, "languages.crystal.shards": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/crystal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/crystal.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Configuration for shards", "loc": ["languages", "crystal", "shards"], "readOnly": false, "type": "submodule"}, "languages.crystal.shards.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/crystal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/crystal.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.shards"}, "description": "The Shards package to use.", "loc": ["languages", "crystal", "shards", "package"], "readOnly": false, "type": "package"}, "languages.cue.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/cue.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/cue.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Cue development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "cue", "enable"], "readOnly": false, "type": "boolean"}, "languages.cue.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/cue.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/cue.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable CUE Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "cue", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.cue.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/cue.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/cue.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.cuelsp"}, "description": "The CUE language server package to use.", "loc": ["languages", "cue", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.cue.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/cue.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/cue.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.cue"}, "description": "The CUE package to use.", "loc": ["languages", "cue", "package"], "readOnly": false, "type": "package"}, "languages.dart.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/dart.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/dart.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Dart development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "dart", "enable"], "readOnly": false, "type": "boolean"}, "languages.dart.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/dart.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/dart.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.dart"}, "description": "The Dart package to use.", "loc": ["languages", "dart", "package"], "readOnly": false, "type": "package"}, "languages.deno.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/deno.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/deno.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Deno development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "deno", "enable"], "readOnly": false, "type": "boolean"}, "languages.deno.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/deno.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/deno.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.deno"}, "description": "Which package of Deno to use.", "loc": ["languages", "deno", "package"], "readOnly": false, "type": "package"}, "languages.dotnet.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/dotnet.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/dotnet.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for .NET development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "dotnet", "enable"], "readOnly": false, "type": "boolean"}, "languages.dotnet.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/dotnet.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/dotnet.nix"}], "default": {"_type": "literalMD", "text": "`true` if csharp-ls is available on the host platform, `false` otherwise"}, "description": "Whether to enable .NET Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "dotnet", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.dotnet.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/dotnet.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/dotnet.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.csharp-ls"}, "description": "The .NET language server package to use.", "loc": ["languages", "dotnet", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.dotnet.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/dotnet.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/dotnet.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.dotnet-sdk"}, "description": "The .NET SDK package to use.", "loc": ["languages", "dotnet", "package"], "readOnly": false, "type": "package"}, "languages.elixir.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/elixir.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/elixir.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Elixir development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "elixir", "enable"], "readOnly": false, "type": "boolean"}, "languages.elixir.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/elixir.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/elixir.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Elixir Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "elixir", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.elixir.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/elixir.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/elixir.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.beamPackages.elixir-ls"}, "description": "The Elixir language server package to use.", "loc": ["languages", "elixir", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.elixir.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/elixir.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/elixir.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.beamPackages.elixir"}, "description": "Which Elixir package to use.", "loc": ["languages", "elixir", "package"], "readOnly": false, "type": "package"}, "languages.elm.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/elm.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/elm.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Elm development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "elm", "enable"], "readOnly": false, "type": "boolean"}, "languages.elm.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/elm.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/elm.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Elm Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "elm", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.elm.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/elm.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/elm.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.elmPackages.elm-language-server"}, "description": "The Elm language server package to use.", "loc": ["languages", "elm", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.erlang.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/erlang.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/erlang.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Erlang development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "erlang", "enable"], "readOnly": false, "type": "boolean"}, "languages.erlang.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/erlang.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/erlang.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Erlang Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "erlang", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.erlang.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/erlang.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/erlang.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.erlang-language-platform"}, "description": "The Erlang language server package to use.", "loc": ["languages", "erlang", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.erlang.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/erlang.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/erlang.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.beamPackages.erlang"}, "description": "Which Erlang package to use.", "loc": ["languages", "erlang", "package"], "readOnly": false, "type": "package"}, "languages.fortran.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/fortran.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/fortran.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Fortran Development..", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "fortran", "enable"], "readOnly": false, "type": "boolean"}, "languages.fortran.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/fortran.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/fortran.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Fortran Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "fortran", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.fortran.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/fortran.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/fortran.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.fortls"}, "description": "The Fortran language server package to use.", "loc": ["languages", "fortran", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.fortran.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/fortran.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/fortran.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.gfortran"}, "description": "The Fortran package to use.", "loc": ["languages", "fortran", "package"], "readOnly": false, "type": "package"}, "languages.gawk.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/gawk.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/gawk.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for GNU Awk development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "gawk", "enable"], "readOnly": false, "type": "boolean"}, "languages.gleam.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/gleam.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/gleam.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Gleam development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "gleam", "enable"], "readOnly": false, "type": "boolean"}, "languages.gleam.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/gleam.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/gleam.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.gleam"}, "description": "The Gleam package to use.", "loc": ["languages", "gleam", "package"], "readOnly": false, "type": "package"}, "languages.go.delve.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Delve debugger.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "go", "delve", "enable"], "readOnly": false, "type": "boolean"}, "languages.go.delve.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.delve"}, "description": "The Delve package to use. Override this to customize the build, e.g. to disable tests.", "loc": ["languages", "go", "delve", "package"], "readOnly": false, "type": "package"}, "languages.go.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Go development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "go", "enable"], "readOnly": false, "type": "boolean"}, "languages.go.enableHardeningWorkaround": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Enable hardening workaround required for Delve debugger (https://github.com/go-delve/delve/issues/3085)", "loc": ["languages", "go", "enableHardeningWorkaround"], "readOnly": false, "type": "boolean"}, "languages.go.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Go Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "go", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.go.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.gopls"}, "description": "The Go language server package to use.", "loc": ["languages", "go", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.go.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.go"}, "description": "The Go package to use.", "loc": ["languages", "go", "package"], "readOnly": false, "type": "package"}, "languages.go.version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The Go version to use.\nThis automatically sets the `languages.go.package` using [go-overlay](https://github.com/purpleclay/go-overlay).\n", "example": {"_type": "literalExpression", "text": "\"1.22.0\""}, "loc": ["languages", "go", "version"], "readOnly": false, "type": "null or string"}, "languages.hare.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/hare.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/hare.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Hare development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "hare", "enable"], "readOnly": false, "type": "boolean"}, "languages.haskell.cabal.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Cabal.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "haskell", "cabal", "enable"], "readOnly": false, "type": "boolean"}, "languages.haskell.cabal.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.cabal-install"}, "description": "Cabal package to use.\n", "loc": ["languages", "haskell", "cabal", "package"], "readOnly": false, "type": "package"}, "languages.haskell.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Haskell development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "haskell", "enable"], "readOnly": false, "type": "boolean"}, "languages.haskell.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Haskell Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "haskell", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.haskell.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.haskell-language-server"}, "description": "The Haskell language server package to use.", "loc": ["languages", "haskell", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.haskell.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.ghc"}, "description": "Haskell compiler to use.\n", "loc": ["languages", "haskell", "package"], "readOnly": false, "type": "package"}, "languages.haskell.stack.args": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix"}], "default": {"_type": "literalExpression", "text": "[ \"--no-nix\" \"--system-ghc\" \"--no-install-ghc\" ]"}, "description": "Additional arguments to pass to stack.\nBy default, stack is configured to use devenv's GHC installation.\n", "loc": ["languages", "haskell", "stack", "args"], "readOnly": false, "type": "list of string"}, "languages.haskell.stack.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Stack.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "haskell", "stack", "enable"], "readOnly": false, "type": "boolean"}, "languages.haskell.stack.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.stack"}, "description": "Haskell stack package to use.\n", "loc": ["languages", "haskell", "stack", "package"], "readOnly": false, "type": "package"}, "languages.helm.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/helm.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/helm.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Helm development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "helm", "enable"], "readOnly": false, "type": "boolean"}, "languages.helm.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/helm.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/helm.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Helm Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "helm", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.helm.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/helm.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/helm.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.helm-ls"}, "description": "The Helm language server package to use.", "loc": ["languages", "helm", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.helm.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/helm.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/helm.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.kubernetes-helm"}, "description": "The Helm package to use.", "loc": ["languages", "helm", "package"], "readOnly": false, "type": "package"}, "languages.helm.plugins": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/helm.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/helm.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of Helm plugin names to include from pkgs.kubernetes-helmPlugins.\n\nThey will be symlinked into one directory and exposed via HELM_PLUGINS.\n", "example": {"_type": "literalExpression", "text": "[\n \"helm-secrets\"\n \"helm-diff\"\n \"helm-unittest\"\n]"}, "loc": ["languages", "helm", "plugins"], "readOnly": false, "type": "list of string"}, "languages.idris.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/idris.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/idris.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Idris development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "idris", "enable"], "readOnly": false, "type": "boolean"}, "languages.idris.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/idris.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/idris.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Idris Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "idris", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.idris.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/idris.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/idris.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.idris2Packages.idris2Lsp"}, "description": "The Idris language server package to use.", "loc": ["languages", "idris", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.idris.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/idris.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/idris.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.idris2"}, "description": "The Idris package to use.\n", "example": {"_type": "literalExpression", "text": "pkgs.idris"}, "loc": ["languages", "idris", "package"], "readOnly": false, "type": "package"}, "languages.java.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Java development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "java", "enable"], "readOnly": false, "type": "boolean"}, "languages.java.gradle.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable gradle.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "java", "gradle", "enable"], "readOnly": false, "type": "boolean"}, "languages.java.gradle.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.gradle.override { java = cfg.jdk.package; }"}, "description": "The Gradle package to use.\nThe Gradle package by default inherits the JDK from `languages.java.jdk.package`.\n", "loc": ["languages", "java", "gradle", "package"], "readOnly": false, "type": "package"}, "languages.java.jdk.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.jdk"}, "description": "The JDK package to use.\nThis will also become available as `JAVA_HOME`.\n", "example": {"_type": "literalExpression", "text": "pkgs.jdk8"}, "loc": ["languages", "java", "jdk", "package"], "readOnly": false, "type": "package"}, "languages.java.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Java Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "java", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.java.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.jdt-language-server.override { jdk = cfg.jdk.package; }"}, "description": "The Java language server package to use.\nThe Java language server package by default inherits the JDK from `languages.java.jdk.package`.\n", "loc": ["languages", "java", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.java.maven.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable maven.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "java", "maven", "enable"], "readOnly": false, "type": "boolean"}, "languages.java.maven.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.maven.override { jdk_headless = cfg.jdk.package; }"}, "description": "The Maven package to use.\nThe Maven package by default inherits the JDK from `languages.java.jdk.package`.\n", "loc": ["languages", "java", "maven", "package"], "readOnly": false, "type": "package"}, "languages.javascript.bun.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable install bun.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "javascript", "bun", "enable"], "readOnly": false, "type": "boolean"}, "languages.javascript.bun.install.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable bun install during devenv initialisation.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "javascript", "bun", "install", "enable"], "readOnly": false, "type": "boolean"}, "languages.javascript.bun.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.bun"}, "description": "The bun package to use.", "loc": ["languages", "javascript", "bun", "package"], "readOnly": false, "type": "package"}, "languages.javascript.corepack.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable wrappers for npm, pnpm and Yarn via Node.js Corepack.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "javascript", "corepack", "enable"], "readOnly": false, "type": "boolean"}, "languages.javascript.directory": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "config.devenv.root"}, "description": "The JavaScript project's root directory. Defaults to the root of the devenv project.\nCan be an absolute path or one relative to the root of the devenv project.\n", "example": {"_type": "literalExpression", "text": "\"./directory\""}, "loc": ["languages", "javascript", "directory"], "readOnly": false, "type": "string"}, "languages.javascript.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for JavaScript development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "javascript", "enable"], "readOnly": false, "type": "boolean"}, "languages.javascript.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable TypeScript Language Server for JavaScript.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "javascript", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.javascript.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.typescript-language-server"}, "description": "The TypeScript/JavaScript language server package to use.", "loc": ["languages", "javascript", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.javascript.nodejs.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Node.js runtime.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "javascript", "nodejs", "enable"], "readOnly": false, "type": "boolean"}, "languages.javascript.npm.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable install npm.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "javascript", "npm", "enable"], "readOnly": false, "type": "boolean"}, "languages.javascript.npm.install.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable npm install during devenv initialisation.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "javascript", "npm", "install", "enable"], "readOnly": false, "type": "boolean"}, "languages.javascript.npm.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "languages.javascript.package"}, "description": "The npm package to use. Defaults to the npm output of the javascript package.", "loc": ["languages", "javascript", "npm", "package"], "readOnly": false, "type": "package"}, "languages.javascript.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.nodejs-slim"}, "description": "The Node.js package to use.", "loc": ["languages", "javascript", "package"], "readOnly": false, "type": "package"}, "languages.javascript.pnpm.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable install pnpm.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "javascript", "pnpm", "enable"], "readOnly": false, "type": "boolean"}, "languages.javascript.pnpm.install.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable pnpm install during devenv initialisation.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "javascript", "pnpm", "install", "enable"], "readOnly": false, "type": "boolean"}, "languages.javascript.pnpm.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.pnpm"}, "description": "The pnpm package to use.", "loc": ["languages", "javascript", "pnpm", "package"], "readOnly": false, "type": "package"}, "languages.javascript.yarn.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable install yarn.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "javascript", "yarn", "enable"], "readOnly": false, "type": "boolean"}, "languages.javascript.yarn.install.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable yarn install during devenv initialisation.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "javascript", "yarn", "install", "enable"], "readOnly": false, "type": "boolean"}, "languages.javascript.yarn.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.yarn"}, "description": "The yarn package to use.", "loc": ["languages", "javascript", "yarn", "package"], "readOnly": false, "type": "package"}, "languages.jsonnet.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/jsonnet.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/jsonnet.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for jsonnet development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "jsonnet", "enable"], "readOnly": false, "type": "boolean"}, "languages.jsonnet.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/jsonnet.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/jsonnet.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Jsonnet Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "jsonnet", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.jsonnet.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/jsonnet.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/jsonnet.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.jsonnet-language-server"}, "description": "The Jsonnet language server package to use.", "loc": ["languages", "jsonnet", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.julia.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/julia.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/julia.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Julia development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "julia", "enable"], "readOnly": false, "type": "boolean"}, "languages.julia.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/julia.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/julia.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.julia-bin"}, "description": "The Julia package to use.", "loc": ["languages", "julia", "package"], "readOnly": false, "type": "package"}, "languages.kotlin.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/kotlin.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/kotlin.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Kotlin development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "kotlin", "enable"], "readOnly": false, "type": "boolean"}, "languages.kotlin.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/kotlin.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/kotlin.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Kotlin Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "kotlin", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.kotlin.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/kotlin.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/kotlin.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.kotlin-language-server"}, "description": "The Kotlin language server package to use.", "loc": ["languages", "kotlin", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.lean4.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lean4.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lean4.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for lean4 development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "lean4", "enable"], "readOnly": false, "type": "boolean"}, "languages.lean4.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lean4.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lean4.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.lean4"}, "description": "The lean4 package to use.\n", "loc": ["languages", "lean4", "package"], "readOnly": false, "type": "package"}, "languages.lobster.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lobster.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lobster.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Lobster development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "lobster", "enable"], "readOnly": false, "type": "boolean"}, "languages.lobster.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lobster.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lobster.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.lobster"}, "description": "Which Lobster package to use.", "loc": ["languages", "lobster", "package"], "readOnly": false, "type": "package"}, "languages.lua.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lua.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lua.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Lua development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "lua", "enable"], "readOnly": false, "type": "boolean"}, "languages.lua.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lua.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lua.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Lua Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "lua", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.lua.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lua.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lua.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.lua-language-server"}, "description": "The Lua language server package to use.", "loc": ["languages", "lua", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.lua.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lua.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lua.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.lua"}, "description": "The Lua package to use.", "loc": ["languages", "lua", "package"], "readOnly": false, "type": "package"}, "languages.nim.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/nim.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/nim.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Nim development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "nim", "enable"], "readOnly": false, "type": "boolean"}, "languages.nim.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/nim.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/nim.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Nim Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "nim", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.nim.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/nim.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/nim.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.nimlangserver"}, "description": "The Nim language server package to use.", "loc": ["languages", "nim", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.nim.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/nim.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/nim.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.nim"}, "description": "The Nim package to use.", "loc": ["languages", "nim", "package"], "readOnly": false, "type": "package"}, "languages.nix.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/nix.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/nix.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Nix development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "nix", "enable"], "readOnly": false, "type": "boolean"}, "languages.nix.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/nix.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/nix.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Nix Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "nix", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.nix.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/nix.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/nix.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.nixd"}, "description": "The Nix language server package to use.", "loc": ["languages", "nix", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.ocaml.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ocaml.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ocaml.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for OCaml development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "ocaml", "enable"], "readOnly": false, "type": "boolean"}, "languages.ocaml.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ocaml.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ocaml.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable OCaml Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "ocaml", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.ocaml.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ocaml.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ocaml.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.ocamlPackages.ocaml-lsp"}, "description": "The OCaml language server package to use.", "loc": ["languages", "ocaml", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.ocaml.packages": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ocaml.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ocaml.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.ocaml-ng.ocamlPackages_4_12"}, "description": "The package set of OCaml to use", "loc": ["languages", "ocaml", "packages"], "readOnly": false, "type": "attribute set"}, "languages.odin.debugger": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/odin.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/odin.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.gdb"}, "description": "An optional debugger package to use with odin.\nThe default is `gdb`, if supported on the current system.\n", "loc": ["languages", "odin", "debugger"], "readOnly": false, "type": "null or package"}, "languages.odin.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/odin.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/odin.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Odin Language.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "odin", "enable"], "readOnly": false, "type": "boolean"}, "languages.odin.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/odin.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/odin.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Odin Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "odin", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.odin.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/odin.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/odin.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.ols"}, "description": "The Odin language server package to use.", "loc": ["languages", "odin", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.odin.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/odin.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/odin.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.odin"}, "description": "The odin package to use.", "loc": ["languages", "odin", "package"], "readOnly": false, "type": "package"}, "languages.opentofu.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/opentofu.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/opentofu.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for OpenTofu development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "opentofu", "enable"], "readOnly": false, "type": "boolean"}, "languages.opentofu.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/opentofu.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/opentofu.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable OpenTofu Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "opentofu", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.opentofu.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/opentofu.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/opentofu.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.tofu-ls"}, "description": "The OpenTofu language server package to use.", "loc": ["languages", "opentofu", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.opentofu.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/opentofu.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/opentofu.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.opentofu"}, "description": "The OpenTofu package to use.", "loc": ["languages", "opentofu", "package"], "readOnly": false, "type": "package"}, "languages.pascal.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/pascal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/pascal.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Pascal development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "pascal", "enable"], "readOnly": false, "type": "boolean"}, "languages.pascal.lazarus.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/pascal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/pascal.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable lazarus graphical IDE for the FreePascal language.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "pascal", "lazarus", "enable"], "readOnly": false, "type": "boolean"}, "languages.perl.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/perl.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/perl.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Perl development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "perl", "enable"], "readOnly": false, "type": "boolean"}, "languages.perl.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/perl.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/perl.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Perl Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "perl", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.perl.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/perl.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/perl.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.perlnavigator"}, "description": "The Perl language server package to use.", "loc": ["languages", "perl", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.perl.packages": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/perl.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/perl.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Perl packages to include", "example": {"_type": "literalExpression", "text": "[\n \"Mojolicious\"\n]"}, "loc": ["languages", "perl", "packages"], "readOnly": false, "type": "list of string"}, "languages.php.disableExtensions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "PHP extensions to disable.\n", "loc": ["languages", "php", "disableExtensions"], "readOnly": false, "type": "list of string"}, "languages.php.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for PHP development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "php", "enable"], "readOnly": false, "type": "boolean"}, "languages.php.extensions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "PHP extensions to enable.\n", "loc": ["languages", "php", "extensions"], "readOnly": false, "type": "list of string"}, "languages.php.fpm.extraConfig": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Extra configuration that should be put in the global section of\nthe PHP-FPM configuration file. Do not specify the options\n`error_log` or `daemonize` here, since they are generated by\nNixOS.\n", "loc": ["languages", "php", "fpm", "extraConfig"], "readOnly": false, "type": "null or strings concatenated with \"\\n\""}, "languages.php.fpm.phpOptions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Options appended to the PHP configuration file `php.ini`.\n", "example": {"_type": "literalExpression", "text": "''\n date.timezone = \"CET\"\n''"}, "loc": ["languages", "php", "fpm", "phpOptions"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "languages.php.fpm.pools": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "PHP-FPM pools. If no pools are defined, the PHP-FPM\nservice is disabled.\n", "example": {"_type": "literalExpression", "text": "{\n mypool = {\n user = \"php\";\n group = \"php\";\n phpPackage = pkgs.php;\n settings = {\n \"pm\" = \"dynamic\";\n \"pm.max_children\" = 75;\n \"pm.start_servers\" = 10;\n \"pm.min_spare_servers\" = 5;\n \"pm.max_spare_servers\" = 20;\n \"pm.max_requests\" = 500;\n };\n }\n}"}, "loc": ["languages", "php", "fpm", "pools"], "readOnly": false, "type": "attribute set of (submodule)"}, "languages.php.fpm.pools..extraConfig": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Extra lines that go into the pool configuration.\nSee the documentation on `php-fpm.conf` for\ndetails on configuration directives.\n", "loc": ["languages", "php", "fpm", "pools", "", "extraConfig"], "readOnly": false, "type": "null or strings concatenated with \"\\n\""}, "languages.php.fpm.pools..listen": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "The address on which to accept FastCGI requests.\n", "example": {"_type": "literalExpression", "text": "\"/path/to/unix/socket\""}, "loc": ["languages", "php", "fpm", "pools", "", "listen"], "readOnly": false, "type": "string"}, "languages.php.fpm.pools..phpEnv": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Environment variables used for this PHP-FPM pool.\n", "example": {"_type": "literalExpression", "text": "{\n HOSTNAME = \"$HOSTNAME\";\n TMP = \"/tmp\";\n TMPDIR = \"/tmp\";\n TEMP = \"/tmp\";\n}\n"}, "loc": ["languages", "php", "fpm", "pools", "", "phpEnv"], "readOnly": false, "type": "attribute set of string"}, "languages.php.fpm.pools..phpOptions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "description": "Options appended to the PHP configuration file `php.ini` used for this PHP-FPM pool.\n", "loc": ["languages", "php", "fpm", "pools", "", "phpOptions"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "languages.php.fpm.pools..phpPackage": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "phpfpm.phpPackage"}, "description": "The PHP package to use for running this PHP-FPM pool.\n", "loc": ["languages", "php", "fpm", "pools", "", "phpPackage"], "readOnly": false, "type": "package"}, "languages.php.fpm.pools..settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "PHP-FPM pool directives. Refer to the \"List of pool directives\" section of\n\nthe manual for details. Note that settings names must be\nenclosed in quotes (e.g. `\"pm.max_children\"` instead of\n`pm.max_children`).\n", "example": {"_type": "literalExpression", "text": "{\n \"pm\" = \"dynamic\";\n \"pm.max_children\" = 75;\n \"pm.start_servers\" = 10;\n \"pm.min_spare_servers\" = 5;\n \"pm.max_spare_servers\" = 20;\n \"pm.max_requests\" = 500;\n}\n"}, "loc": ["languages", "php", "fpm", "pools", "", "settings"], "readOnly": false, "type": "attribute set of (string or signed integer or boolean)"}, "languages.php.fpm.pools..socket": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "description": "Path to the Unix socket file on which to accept FastCGI requests.\n\nThis option is read-only and managed by NixOS.\n", "example": {"_type": "literalExpression", "text": "config.env.DEVENV_STATE + \"/php-fpm/.sock\""}, "loc": ["languages", "php", "fpm", "pools", "", "socket"], "readOnly": true, "type": "string"}, "languages.php.fpm.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "{\n error_log = config.env.DEVENV_STATE + \"/php-fpm/php-fpm.log\";\n}\n"}, "description": "PHP-FPM global directives. \n\nRefer to the \"List of global php-fpm.conf directives\" section of\n\nfor details. \n\nNote that settings names must be enclosed in\nquotes (e.g. `\"pm.max_children\"` instead of `pm.max_children`). \n\nYou need not specify the options `error_log` or `daemonize` here, since\nthey are already set.\n", "loc": ["languages", "php", "fpm", "settings"], "readOnly": false, "type": "attribute set of (string or signed integer or boolean)"}, "languages.php.ini": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "PHP.ini directives. Refer to the \"List of php.ini directives\" of PHP's\n", "loc": ["languages", "php", "ini"], "readOnly": false, "type": "null or strings concatenated with \"\\n\""}, "languages.php.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable PHP Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "php", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.php.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.phpactor"}, "description": "The PHP language server package to use.", "loc": ["languages", "php", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.php.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.php"}, "description": "Allows you to [override the default used package](https://nixos.org/manual/nixpkgs/stable/#ssec-php-user-guide)\nto adjust the settings or add more extensions. You can find the\nextensions using `devenv search 'php extensions'`\n", "example": {"_type": "literalExpression", "text": "pkgs.php.buildEnv {\n extensions = { all, enabled }: with all; enabled ++ [ xdebug ];\n extraConfig = ''\n memory_limit=1G\n '';\n};\n"}, "loc": ["languages", "php", "package"], "readOnly": false, "type": "package"}, "languages.php.packages": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "pkgs"}, "description": "Attribute set of packages including composer", "loc": ["languages", "php", "packages"], "readOnly": false, "type": "submodule"}, "languages.php.packages.composer": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.phpPackages.composer"}, "description": "composer package", "loc": ["languages", "php", "packages", "composer"], "readOnly": false, "type": "null or package"}, "languages.php.version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "The PHP version to use.", "loc": ["languages", "php", "version"], "readOnly": false, "type": "string"}, "languages.pkl.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/pkl.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/pkl.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Pkl development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "pkl", "enable"], "readOnly": false, "type": "boolean"}, "languages.pkl.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/pkl.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/pkl.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Pkl Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "pkl", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.pkl.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/pkl.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/pkl.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.pkl-lsp"}, "description": "The Pkl language server package to use.", "loc": ["languages", "pkl", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.pkl.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/pkl.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/pkl.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.pkl"}, "description": "The Pkl package to use.", "loc": ["languages", "pkl", "package"], "readOnly": false, "type": "package"}, "languages.purescript.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/purescript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/purescript.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for PureScript development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "purescript", "enable"], "readOnly": false, "type": "boolean"}, "languages.purescript.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/purescript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/purescript.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable PureScript Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "purescript", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.purescript.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/purescript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/purescript.nix"}], "default": {"_type": "literalExpression", "text": "purescript-overlay.packages.${pkgs.stdenv.system}.purescript-language-server"}, "description": "The PureScript language server package to use.\nUses [purescript-overlay](https://github.com/thomashoneyman/purescript-overlay) by default.\n", "loc": ["languages", "purescript", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.purescript.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/purescript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/purescript.nix"}], "default": {"_type": "literalExpression", "text": "purescript-overlay.packages.${pkgs.stdenv.system}.purs"}, "description": "The PureScript compiler package to use.\nUses [purescript-overlay](https://github.com/thomashoneyman/purescript-overlay) by default.\n", "loc": ["languages", "purescript", "package"], "readOnly": false, "type": "package"}, "languages.purescript.spago.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/purescript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/purescript.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Spago package manager.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "purescript", "spago", "enable"], "readOnly": false, "type": "boolean"}, "languages.purescript.spago.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/purescript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/purescript.nix"}], "default": {"_type": "literalExpression", "text": "purescript-overlay.packages.${pkgs.stdenv.system}.spago"}, "description": "The Spago package manager to use.\nUses [purescript-overlay](https://github.com/thomashoneyman/purescript-overlay) by default.\n", "loc": ["languages", "purescript", "spago", "package"], "readOnly": false, "type": "package"}, "languages.python.directory": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "config.devenv.root"}, "description": "The Python project's root directory. Defaults to the root of the devenv project.\nCan be an absolute path or one relative to the root of the devenv project.\n", "example": {"_type": "literalExpression", "text": "\"./directory\""}, "loc": ["languages", "python", "directory"], "readOnly": false, "type": "string"}, "languages.python.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Python development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "python", "enable"], "readOnly": false, "type": "boolean"}, "languages.python.import": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "description": "Import a Python project using uv2nix.\n\nThis function takes a path to a directory containing a pyproject.toml file\nand returns a derivation that builds the Python project using uv2nix.\n\nExample usage:\n```nix\nlet\n mypackage = config.languages.python.import ./path/to/python/project {};\nin {\n languages.python.enable = true;\n packages = [ mypackage ];\n}\n```\n", "loc": ["languages", "python", "import"], "readOnly": false, "type": "function that evaluates to a(n) function that evaluates to a(n) package"}, "languages.python.libraries": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "[ \"${config.devenv.dotfile}/profile\" ]\n"}, "description": "Additional libraries to make available to the Python interpreter.\n\nThis is useful when you want to use Python wheels that depend on native libraries.\n", "loc": ["languages", "python", "libraries"], "readOnly": false, "type": "list of absolute path"}, "languages.python.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Python Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "python", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.python.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "pkgs.pyright"}, "description": "The Python language server package to use.", "loc": ["languages", "python", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.python.manylinux.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to install manylinux2014 libraries.\n\nEnabled by default on linux;\n\nThis is useful when you want to use Python wheels that depend on manylinux2014 libraries.\n", "loc": ["languages", "python", "manylinux", "enable"], "readOnly": false, "type": "boolean"}, "languages.python.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "pkgs.python3"}, "description": "The Python package to use.", "loc": ["languages", "python", "package"], "readOnly": false, "type": "package"}, "languages.python.patches.buildEnv.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to apply fixes to Python's `buildEnv` for correct runtime initialization:\n- Executables use `--inherit-argv0` and `--resolve-argv0` to ensure Python initializes with correct `sys.prefix` and `sys.base_prefix`\n- Python package scripts are unwrapped to invoke the environment's interpreter directly\n\nWithout these fixes, Python may not initialize with the correct prefix paths.\n\nEnabled by default.\nNewer nixpkgs releases may include upstream fixes that make this patch obsolete.\n", "loc": ["languages", "python", "patches", "buildEnv", "enable"], "readOnly": false, "type": "boolean"}, "languages.python.poetry.activate.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to activate the poetry virtual environment automatically.", "loc": ["languages", "python", "poetry", "activate", "enable"], "readOnly": false, "type": "boolean"}, "languages.python.poetry.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable poetry.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "python", "poetry", "enable"], "readOnly": false, "type": "boolean"}, "languages.python.poetry.install.allExtras": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to install all extras. See `--all-extras`.", "loc": ["languages", "python", "poetry", "install", "allExtras"], "readOnly": false, "type": "boolean"}, "languages.python.poetry.install.allGroups": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to install all groups. See `--all-groups`.", "loc": ["languages", "python", "poetry", "install", "allGroups"], "readOnly": false, "type": "boolean"}, "languages.python.poetry.install.compile": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether `poetry install` should compile Python source files to bytecode.", "loc": ["languages", "python", "poetry", "install", "compile"], "readOnly": false, "type": "boolean"}, "languages.python.poetry.install.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable poetry install during devenv initialisation.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "python", "poetry", "install", "enable"], "readOnly": false, "type": "boolean"}, "languages.python.poetry.install.extras": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Which extras to install. See `--extras`.", "loc": ["languages", "python", "poetry", "install", "extras"], "readOnly": false, "type": "list of string"}, "languages.python.poetry.install.groups": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Which dependency groups to install. See `--with`.", "loc": ["languages", "python", "poetry", "install", "groups"], "readOnly": false, "type": "list of string"}, "languages.python.poetry.install.ignoredGroups": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Which dependency groups to ignore. See `--without`.", "loc": ["languages", "python", "poetry", "install", "ignoredGroups"], "readOnly": false, "type": "list of string"}, "languages.python.poetry.install.installRootPackage": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether the root package (your project) should be installed. See `--no-root`", "loc": ["languages", "python", "poetry", "install", "installRootPackage"], "readOnly": false, "type": "boolean"}, "languages.python.poetry.install.onlyGroups": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Which dependency groups to exclusively install. See `--only`.", "loc": ["languages", "python", "poetry", "install", "onlyGroups"], "readOnly": false, "type": "list of string"}, "languages.python.poetry.install.onlyInstallRootPackage": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to only install the root package (your project) should be installed, but no dependencies. See `--only-root`", "loc": ["languages", "python", "poetry", "install", "onlyInstallRootPackage"], "readOnly": false, "type": "boolean"}, "languages.python.poetry.install.quiet": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether `poetry install` should avoid outputting messages during devenv initialisation.", "loc": ["languages", "python", "poetry", "install", "quiet"], "readOnly": false, "type": "boolean"}, "languages.python.poetry.install.verbosity": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "\"no\""}, "description": "What level of verbosity the output of `poetry install` should have.", "loc": ["languages", "python", "poetry", "install", "verbosity"], "readOnly": false, "type": "one of \"no\", \"little\", \"more\", \"debug\""}, "languages.python.poetry.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "pkgs.poetry"}, "description": "The Poetry package to use.", "loc": ["languages", "python", "poetry", "package"], "readOnly": false, "type": "package"}, "languages.python.uv.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable uv.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "python", "uv", "enable"], "readOnly": false, "type": "boolean"}, "languages.python.uv.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "pkgs.uv"}, "description": "The uv package to use.", "loc": ["languages", "python", "uv", "package"], "readOnly": false, "type": "package"}, "languages.python.uv.sync.allExtras": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to install all extras. See `--all-extras`.", "loc": ["languages", "python", "uv", "sync", "allExtras"], "readOnly": false, "type": "boolean"}, "languages.python.uv.sync.allGroups": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to install all groups. See `--all-groups`.", "loc": ["languages", "python", "uv", "sync", "allGroups"], "readOnly": false, "type": "boolean"}, "languages.python.uv.sync.allPackages": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Sync all packages in the workspace. See `--all-packages`.", "loc": ["languages", "python", "uv", "sync", "allPackages"], "readOnly": false, "type": "boolean"}, "languages.python.uv.sync.arguments": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Command line arguments pass to `uv sync` during devenv initialisation.", "loc": ["languages", "python", "uv", "sync", "arguments"], "readOnly": false, "type": "list of string"}, "languages.python.uv.sync.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable uv sync during devenv initialisation.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "python", "uv", "sync", "enable"], "readOnly": false, "type": "boolean"}, "languages.python.uv.sync.extras": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Which extras to install. See `--extra`.", "loc": ["languages", "python", "uv", "sync", "extras"], "readOnly": false, "type": "list of string"}, "languages.python.uv.sync.groups": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Which dependency groups to install. See `--group`.", "loc": ["languages", "python", "uv", "sync", "groups"], "readOnly": false, "type": "list of string"}, "languages.python.uv.sync.packages": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Sync for specific packages in the workspace. See `--package`.", "loc": ["languages", "python", "uv", "sync", "packages"], "readOnly": false, "type": "list of string"}, "languages.python.venv.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Python virtual environment.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "python", "venv", "enable"], "readOnly": false, "type": "boolean"}, "languages.python.venv.quiet": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether `pip install` should avoid outputting messages during devenv initialisation.", "loc": ["languages", "python", "venv", "quiet"], "readOnly": false, "type": "boolean"}, "languages.python.venv.requirements": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Contents of pip requirements.txt file.\nThis is passed to `pip install -r` during `devenv shell` initialisation.\n", "loc": ["languages", "python", "venv", "requirements"], "readOnly": false, "type": "null or strings concatenated with \"\\n\" or absolute path"}, "languages.python.version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The Python version to use.\nThis automatically sets the `languages.python.package` using [nixpkgs-python](https://github.com/cachix/nixpkgs-python).\n", "example": {"_type": "literalExpression", "text": "\"3.11 or 3.11.2\""}, "loc": ["languages", "python", "version"], "readOnly": false, "type": "null or string"}, "languages.r.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/r.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/r.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for R development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "r", "enable"], "readOnly": false, "type": "boolean"}, "languages.r.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/r.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/r.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable R Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "r", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.r.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/r.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/r.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.rPackages.languageserver"}, "description": "The R language server package to use.", "loc": ["languages", "r", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.r.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/r.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/r.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.R"}, "description": "The R package to use.", "loc": ["languages", "r", "package"], "readOnly": false, "type": "package"}, "languages.r.radian.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/r.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/r.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable a 21 century R console.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "r", "radian", "enable"], "readOnly": false, "type": "boolean"}, "languages.r.radian.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/r.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/r.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.radianWrapper"}, "description": "The radian package to use.", "loc": ["languages", "r", "radian", "package"], "readOnly": false, "type": "package"}, "languages.racket.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/racket.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/racket.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Racket development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "racket", "enable"], "readOnly": false, "type": "boolean"}, "languages.racket.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/racket.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/racket.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.racket-minimal"}, "description": "The Racket package to use.", "loc": ["languages", "racket", "package"], "readOnly": false, "type": "package"}, "languages.raku.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/raku.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/raku.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Raku development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "raku", "enable"], "readOnly": false, "type": "boolean"}, "languages.robotframework.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/robotframework.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/robotframework.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Robot Framework development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "robotframework", "enable"], "readOnly": false, "type": "boolean"}, "languages.robotframework.python": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/robotframework.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/robotframework.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.python3"}, "description": "The Python package to use.", "loc": ["languages", "robotframework", "python"], "readOnly": false, "type": "package"}, "languages.ruby.bundler.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable bundler.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "ruby", "bundler", "enable"], "readOnly": false, "type": "boolean"}, "languages.ruby.bundler.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.bundler.override { ruby = cfg.package; }"}, "description": "The bundler package to use.", "loc": ["languages", "ruby", "bundler", "package"], "readOnly": false, "type": "package"}, "languages.ruby.documentation.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable documentation support for Ruby packages.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "ruby", "documentation", "enable"], "readOnly": false, "type": "boolean"}, "languages.ruby.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Ruby development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "ruby", "enable"], "readOnly": false, "type": "boolean"}, "languages.ruby.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Ruby Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "ruby", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.ruby.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.solargraph.override { ruby = cfg.package; }"}, "description": "The Ruby language server package to use.", "loc": ["languages", "ruby", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.ruby.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.ruby"}, "description": "The Ruby package to use.", "loc": ["languages", "ruby", "package"], "readOnly": false, "type": "package"}, "languages.ruby.version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The Ruby version to use.\nThis automatically sets the `languages.ruby.package` using [nixpkgs-ruby](https://github.com/bobvanderlinden/nixpkgs-ruby).\n", "example": {"_type": "literalExpression", "text": "\"3.2.1\""}, "loc": ["languages", "ruby", "version"], "readOnly": false, "type": "null or string"}, "languages.ruby.versionFile": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The .ruby-version file path to extract the Ruby version from.\nThis automatically sets the `languages.ruby.package` using [nixpkgs-ruby](https://github.com/bobvanderlinden/nixpkgs-ruby).\nWhen the `.ruby-version` file exists in the same directory as the devenv configuration, you can use:\n\n```nix\nlanguages.ruby.versionFile = ./.ruby-version;\n```\n", "example": {"_type": "literalExpression", "text": "./.ruby-version\n"}, "loc": ["languages", "ruby", "versionFile"], "readOnly": false, "type": "null or absolute path"}, "languages.rust.channel": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "\"nixpkgs\""}, "description": "The rustup toolchain to install.", "loc": ["languages", "rust", "channel"], "readOnly": false, "type": "one of \"nixpkgs\", \"stable\", \"beta\", \"nightly\""}, "languages.rust.clangLinker.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.stdenv.hostPlatform.isLinux"}, "description": "Use Clang as the Rust linker driver on Linux.\n\nThis avoids GCC's `collect2` wrapper, which can hit `Argument list too long`\nin large Nix development environments before the final linker receives\nRust's response file.\n\nOn x86_64 Linux (glibc), Clang uses LLD unless another linker is enabled.\n", "loc": ["languages", "rust", "clangLinker", "enable"], "readOnly": false, "type": "boolean"}, "languages.rust.components": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "[ \"rustc\" \"cargo\" \"clippy\" \"rustfmt\" \"rust-analyzer\" ]"}, "description": "List of [Rustup components](https://rust-lang.github.io/rustup/concepts/components.html)\nto install. Defaults to those available in `nixpkgs`.\n", "loc": ["languages", "rust", "components"], "readOnly": false, "type": "list of string"}, "languages.rust.cranelift.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Use [Cranelift](https://cranelift.dev/) as the codegen backend for dev builds.\n\nCranelift compiles significantly faster than LLVM at the cost of less optimized output.\nRequires the nightly channel.\n", "loc": ["languages", "rust", "cranelift", "enable"], "readOnly": false, "type": "boolean"}, "languages.rust.cranelift.excludePackages": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of crate names that should use the LLVM backend instead of Cranelift.\n\nGenerates per-package overrides in `.cargo/config.toml`.\n", "example": {"_type": "literalExpression", "text": "[\n \"aws-lc-sys\"\n \"aws-lc-rs\"\n \"rustls\"\n]"}, "loc": ["languages", "rust", "cranelift", "excludePackages"], "readOnly": false, "type": "list of string"}, "languages.rust.cranelift.forceBuildScriptsLlvm": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Force build scripts and proc macros to use the LLVM backend.\n\nSome build scripts may not work with Cranelift. Enable this to fall back to\nLLVM for build scripts while keeping Cranelift for regular code.\n", "loc": ["languages", "rust", "cranelift", "forceBuildScriptsLlvm"], "readOnly": false, "type": "boolean"}, "languages.rust.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Rust development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "rust", "enable"], "readOnly": false, "type": "boolean"}, "languages.rust.import": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "description": "Import a Cargo project using crate2nix.\n\nThis function takes a path to a directory containing a Cargo.toml file\nand returns a derivation that builds the Rust project using crate2nix.\n\nExample usage:\n```nix\nlet\nmypackage = config.languages.rust.import ./path/to/cargo/project {};\nin {\nlanguages.rust.enable = true;\npackages = [ mypackage ];\n}\n```\n", "loc": ["languages", "rust", "import"], "readOnly": false, "type": "function that evaluates to a(n) function that evaluates to a(n) package"}, "languages.rust.lld.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Use [lld](https://lld.llvm.org/) as the linker.\n\nlld is LLVM's linker and is the recommended fast linker for Darwin.\nWorks on both Linux and macOS.\n", "loc": ["languages", "rust", "lld", "enable"], "readOnly": false, "type": "boolean"}, "languages.rust.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Rust Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "rust", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.rust.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalMD", "text": "Depends on the configured toolchain:\n- `nixpkgs` channel: `pkgs.rust-analyzer`.\n- non-nixpkgs channel: the `rust-analyzer` component from the rust-overlay toolchain, with a fallback to `pkgs.rust-analyzer` if not present in the manifest.\n- `toolchainFile`: the aggregated toolchain package derived from the file.\n"}, "description": "The Rust language server package to use.", "loc": ["languages", "rust", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.rust.mold.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Use [mold](https://github.com/rui314/mold) as the linker.\n\nmold is a faster drop-in replacement for existing Unix linkers.\nIt is several times quicker than the LLVM lld linker.\n", "loc": ["languages", "rust", "mold", "enable"], "readOnly": false, "type": "boolean"}, "languages.rust.rustdocflags": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Extra flags to pass to Rustdoc.", "loc": ["languages", "rust", "rustdocflags"], "readOnly": false, "type": "string"}, "languages.rust.rustflags": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Extra flags to pass to the Rust compiler.", "loc": ["languages", "rust", "rustflags"], "readOnly": false, "type": "string"}, "languages.rust.targets": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of extra [targets](https://doc.rust-lang.org/nightly/rustc/platform-support.html)\nto install. Defaults to only the native target.\n", "loc": ["languages", "rust", "targets"], "readOnly": false, "type": "list of string"}, "languages.rust.toolchain": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "nixpkgs"}, "description": "Rust component packages. May optionally define additional components, for example `miri`.", "loc": ["languages", "rust", "toolchain"], "readOnly": false, "type": "open submodule of attribute set of package"}, "languages.rust.toolchain.cargo": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.cargo"}, "description": "cargo package", "loc": ["languages", "rust", "toolchain", "cargo"], "readOnly": false, "type": "null or package"}, "languages.rust.toolchain.clippy": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.clippy"}, "description": "clippy package", "loc": ["languages", "rust", "toolchain", "clippy"], "readOnly": false, "type": "null or package"}, "languages.rust.toolchain.rust-analyzer": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.rust-analyzer"}, "description": "rust-analyzer package", "loc": ["languages", "rust", "toolchain", "rust-analyzer"], "readOnly": false, "type": "null or package"}, "languages.rust.toolchain.rustc": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.rustc"}, "description": "rustc package", "loc": ["languages", "rust", "toolchain", "rustc"], "readOnly": false, "type": "null or package"}, "languages.rust.toolchain.rustfmt": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.rustfmt"}, "description": "rustfmt package", "loc": ["languages", "rust", "toolchain", "rustfmt"], "readOnly": false, "type": "null or package"}, "languages.rust.toolchainFile": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Path to a `rust-toolchain` or `rust-toolchain.toml` file for automatic toolchain configuration.\n\nWhen set, devenv will use rust-overlay's `fromRustupToolchainFile` to automatically\nconfigure the toolchain based on the file contents (channel, components, targets, profile).\n\nThis follows the standard Rust toolchain file format documented at:\nhttps://rust-lang.github.io/rustup/overrides.html#the-toolchain-file\n\nCannot be used together with manual `channel` or `version` configuration.\n\nExample:\n```nix\nlanguages.rust.toolchainFile = ./rust-toolchain.toml;\n```\n", "example": {"_type": "literalExpression", "text": "./rust-toolchain.toml"}, "loc": ["languages", "rust", "toolchainFile"], "readOnly": false, "type": "null or absolute path"}, "languages.rust.toolchainPackage": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "description": "The aggregated toolchain package, which includes the configured components and targets.\nThis is automatically set based on the channel and components configuration.\n", "loc": ["languages", "rust", "toolchainPackage"], "readOnly": false, "type": "package"}, "languages.rust.version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "\"latest\""}, "description": "Which version of rust to use, this value could be `latest`,`1.81.0`, `2021-01-01`.\nOnly works when languages.rust.channel is NOT nixpkgs.\n", "loc": ["languages", "rust", "version"], "readOnly": false, "type": "string"}, "languages.rust.wild.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Use [wild](https://github.com/wild-linker/wild) as the linker.\n\nwild is a very fast linker for Linux.\n", "loc": ["languages", "rust", "wild", "enable"], "readOnly": false, "type": "boolean"}, "languages.scala.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Scala development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "scala", "enable"], "readOnly": false, "type": "boolean"}, "languages.scala.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Scala Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "scala", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.scala.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.metals"}, "description": "The Scala language server package to use.", "loc": ["languages", "scala", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.scala.mill.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable mill, a simplified, fast build tool for Scala.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "scala", "mill", "enable"], "readOnly": false, "type": "boolean"}, "languages.scala.mill.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.mill"}, "description": "The mill package to use.", "loc": ["languages", "scala", "mill", "package"], "readOnly": false, "type": "package"}, "languages.scala.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.scala_3"}, "description": "The Scala package to use.\n", "loc": ["languages", "scala", "package"], "readOnly": false, "type": "package"}, "languages.scala.sbt.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable sbt, the standard build tool for Scala.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "scala", "sbt", "enable"], "readOnly": false, "type": "boolean"}, "languages.scala.sbt.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.sbt"}, "description": "The sbt package to use.", "example": {"_type": "literalExpression", "text": "sbt-with-scala-native"}, "loc": ["languages", "scala", "sbt", "package"], "readOnly": false, "type": "package"}, "languages.shell.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/shell.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/shell.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for shell development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "shell", "enable"], "readOnly": false, "type": "boolean"}, "languages.shell.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/shell.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/shell.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Shell Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "shell", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.shell.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/shell.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/shell.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.bash-language-server"}, "description": "The Shell language server package to use.", "loc": ["languages", "shell", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.solidity.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/solidity.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/solidity.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Solidity development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "solidity", "enable"], "readOnly": false, "type": "boolean"}, "languages.solidity.foundry.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/solidity.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/solidity.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable install Foundry.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "solidity", "foundry", "enable"], "readOnly": false, "type": "boolean"}, "languages.solidity.foundry.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/solidity.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/solidity.nix"}], "default": {"_type": "literalExpression", "text": "foundry.defaultPackage.$${pkgs.stdenv.system}"}, "description": "Which Foundry package to use.", "loc": ["languages", "solidity", "foundry", "package"], "readOnly": false, "type": "package"}, "languages.solidity.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/solidity.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/solidity.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.solc"}, "description": "Which compiler of Solidity to use.", "loc": ["languages", "solidity", "package"], "readOnly": false, "type": "package"}, "languages.standardml.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/standardml.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/standardml.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Standard ML development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "standardml", "enable"], "readOnly": false, "type": "boolean"}, "languages.standardml.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/standardml.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/standardml.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Standard ML Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "standardml", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.standardml.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/standardml.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/standardml.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.millet"}, "description": "The Standard ML language server package to use.", "loc": ["languages", "standardml", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.standardml.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/standardml.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/standardml.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.mlton"}, "description": "The Standard ML package to use.\n", "loc": ["languages", "standardml", "package"], "readOnly": false, "type": "package"}, "languages.swift.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/swift.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/swift.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Swift development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "swift", "enable"], "readOnly": false, "type": "boolean"}, "languages.swift.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/swift.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/swift.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Swift Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "swift", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.swift.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/swift.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/swift.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.sourcekit-lsp"}, "description": "The Swift language server package to use.", "loc": ["languages", "swift", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.swift.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/swift.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/swift.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.swift"}, "description": "The Swift package to use.\n", "loc": ["languages", "swift", "package"], "readOnly": false, "type": "package"}, "languages.terraform.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/terraform.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/terraform.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Terraform development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "terraform", "enable"], "readOnly": false, "type": "boolean"}, "languages.terraform.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/terraform.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/terraform.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Terraform Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "terraform", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.terraform.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/terraform.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/terraform.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.terraform-ls"}, "description": "The Terraform language server package to use.", "loc": ["languages", "terraform", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.terraform.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/terraform.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/terraform.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.terraform"}, "description": "The Terraform package to use.", "loc": ["languages", "terraform", "package"], "readOnly": false, "type": "package"}, "languages.terraform.version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/terraform.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/terraform.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The Terraform version to use.\nThis automatically sets the `languages.terraform.package` using [nixpkgs-terraform](https://github.com/stackbuilders/nixpkgs-terraform).\n", "example": {"_type": "literalExpression", "text": "\"1.5.0 or 1.6.2\""}, "loc": ["languages", "terraform", "version"], "readOnly": false, "type": "null or string"}, "languages.texlive.base": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/texlive.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/texlive.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.texliveSmall"}, "description": "TeX Live package set to use", "example": {"_type": "literalExpression", "text": "pkgs.texliveBasic"}, "loc": ["languages", "texlive", "base"], "readOnly": false, "type": "unspecified value"}, "languages.texlive.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/texlive.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/texlive.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable TeX Live.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "texlive", "enable"], "readOnly": false, "type": "boolean"}, "languages.texlive.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/texlive.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/texlive.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable TeX Live Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "texlive", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.texlive.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/texlive.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/texlive.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.texlab"}, "description": "The TeX Live language server package to use.", "loc": ["languages", "texlive", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.texlive.packages": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/texlive.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/texlive.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Extra packages to add to the base TeX Live set", "example": {"_type": "literalExpression", "text": "[\n \"algorithms\"\n \"latexmk\"\n]"}, "loc": ["languages", "texlive", "packages"], "readOnly": false, "type": "list of string"}, "languages.typescript.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typescript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typescript.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for TypeScript development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "typescript", "enable"], "readOnly": false, "type": "boolean"}, "languages.typescript.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typescript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typescript.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable TypeScript Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "typescript", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.typescript.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typescript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typescript.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.typescript-language-server"}, "description": "The TypeScript language server package to use.", "loc": ["languages", "typescript", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.typst.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typst.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typst.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Typst development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "typst", "enable"], "readOnly": false, "type": "boolean"}, "languages.typst.fontPaths": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typst.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typst.nix"}], "default": {"_type": "literalExpression", "text": "[]"}, "description": "Directories to be searched for fonts.", "example": {"_type": "literalExpression", "text": "[ \"${pkgs.roboto}/share/fonts/truetype\" ]"}, "loc": ["languages", "typst", "fontPaths"], "readOnly": false, "type": "list of string"}, "languages.typst.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typst.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typst.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Typst Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "typst", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.typst.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typst.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typst.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.tinymist"}, "description": "The Typst language server package to use.", "loc": ["languages", "typst", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.typst.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typst.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typst.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.typst"}, "description": "Which package of Typst to use.", "loc": ["languages", "typst", "package"], "readOnly": false, "type": "package"}, "languages.unison.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/unison.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/unison.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Unison development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "unison", "enable"], "readOnly": false, "type": "boolean"}, "languages.unison.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/unison.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/unison.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.unison-ucm"}, "description": "Which package of Unison to use", "loc": ["languages", "unison", "package"], "readOnly": false, "type": "package"}, "languages.v.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/v.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/v.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for V development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "v", "enable"], "readOnly": false, "type": "boolean"}, "languages.v.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/v.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/v.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.vlang"}, "description": "The V package to use.", "loc": ["languages", "v", "package"], "readOnly": false, "type": "package"}, "languages.vala.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/vala.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/vala.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Vala development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "vala", "enable"], "readOnly": false, "type": "boolean"}, "languages.vala.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/vala.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/vala.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Vala Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "vala", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.vala.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/vala.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/vala.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.vala-language-server"}, "description": "The Vala language server package to use.", "loc": ["languages", "vala", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.vala.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/vala.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/vala.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.vala"}, "description": "The Vala package to use.", "example": {"_type": "literalExpression", "text": "pkgs.vala_0_54"}, "loc": ["languages", "vala", "package"], "readOnly": false, "type": "package"}, "languages.zig.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/zig.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/zig.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Zig development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "zig", "enable"], "readOnly": false, "type": "boolean"}, "languages.zig.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/zig.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/zig.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Zig Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "zig", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.zig.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/zig.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/zig.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.zls"}, "description": "The Zig language server package to use.", "loc": ["languages", "zig", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.zig.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/zig.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/zig.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.zig"}, "description": "Which package of Zig to use.", "loc": ["languages", "zig", "package"], "readOnly": false, "type": "package"}, "languages.zig.version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/zig.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/zig.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The Zig version to use.\nThis automatically sets the `languages.zig.package` and `languages.zig.lsp.package` using [zig-overlay](https://github.com/mitchellh/zig-overlay).\n", "example": {"_type": "literalExpression", "text": "\"0.15.1\""}, "loc": ["languages", "zig", "version"], "readOnly": false, "type": "null or string"}, "machines": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Machines for NixOS, home-manager, and nix-darwin.", "loc": ["machines"], "readOnly": false, "type": "attribute set of (submodule)"}, "machines..deploy.healthCheck": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "\"true\""}, "description": "Root shell commands run on the target after transactional NixOS activation.\nA nonzero exit or failure to finish before `deploy.rollbackTimeout`\nprevents confirmation and triggers rollback at the deadline.\nUse absolute store paths for required tools.\n", "loc": ["machines", "", "deploy", "healthCheck"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "machines..deploy.rollbackTimeout": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "300"}, "description": "Seconds allowed for transactional activation, health checks and SSH\nconfirmation together. A target-side watchdog restores the previous\nsystem if this deadline expires without confirmation.\n", "loc": ["machines", "", "deploy", "rollbackTimeout"], "readOnly": false, "type": "integer between 30 and 600 (both inclusive)"}, "machines..hardware": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Hardware detection settings for this machine.", "loc": ["machines", "", "hardware"], "readOnly": false, "type": "submodule"}, "machines..hardware.facter": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "\".machines/${name}/facter.json\""}, "description": "Path to the [nixos-facter](https://github.com/nix-community/nixos-facter) hardware report for this machine.\n\nAccepts either a Nix path literal or a string path relative to the devenv project root.\nDefaults to `.machines//facter.json`, which `devenv machines install` generates\non first run by probing the target over SSH. The report must be committed to git so that\nteammates and CI can build the machine closure without reaching the target.\n\nSet to `null` to opt this machine out of facter, for example when it carries a hand written\n`hardware-configuration.nix` instead. Only applies to machines with a `nixos` module set;\n`nix-darwin` and `home-manager` entries ignore this option.\n", "example": {"_type": "literalExpression", "text": "./hardware/web1.json"}, "loc": ["machines", "", "hardware", "facter"], "readOnly": false, "type": "null or absolute path or string"}, "machines..home-manager": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Home Manager configuration for the machine.", "example": {"_type": "literalExpression", "text": "{\n home.username = \"jdoe\";\n home.homeDirectory = \"/home/jdoe\";\n programs.git.enable = true;\n}\n"}, "loc": ["machines", "", "home-manager"], "readOnly": false, "type": "null or unspecified value"}, "machines..install": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Install-time settings for `devenv machines install`.", "loc": ["machines", "", "install"], "readOnly": false, "type": "submodule"}, "machines..install.copyHostKeys": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Copy `/etc/ssh/ssh_host_*` from the live installer into the\ninstalled system before reboot. This keeps the SSH identity\nstable between the post-kexec installer and the first boot, so\nthat identity's `known_hosts` entry keeps working.\n", "loc": ["machines", "", "install", "copyHostKeys"], "readOnly": false, "type": "boolean"}, "machines..install.encryptionKeys": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Keyfiles dropped onto the installer **before disko runs**, so LUKS\nlayouts with `passwordFile = \"/tmp/luks.key\"` can unlock. Attribute\nnames are absolute target paths on the installer; values are local\nsource paths (string, absolute or relative to the devenv project root)\non the host running `devenv machines install`. Strings \u2014 not Nix path\nliterals \u2014 so LUKS keys never enter `/nix/store`.\n", "example": {"_type": "literalExpression", "text": "{\n \"/tmp/luks.key\" = \"secrets/luks.key\";\n}\n"}, "loc": ["machines", "", "install", "encryptionKeys"], "readOnly": false, "type": "attribute set of string"}, "machines..install.extraFiles": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Files to copy onto the installed system after `nixos-install` but\nbefore reboot. Attribute names are absolute target paths (e.g.\n`\"/var/lib/secret-age-key\"`). Use this for age/sops master keys,\nSSH host keys, or `/var/lib/*` seeds that need to exist on first boot.\nMatches nixos-anywhere's `--extra-files` and `--chown`.\n", "example": {"_type": "literalExpression", "text": "{\n \"/var/lib/secret-age-key\" = {\n source = \"secrets/age.key\";\n owner = \"0:0\";\n mode = \"0600\";\n };\n}\n"}, "loc": ["machines", "", "install", "extraFiles"], "readOnly": false, "type": "attribute set of (submodule)"}, "machines..install.extraFiles..mode": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "\"0644\""}, "description": "File mode applied via chmod on the target.", "loc": ["machines", "", "install", "extraFiles", "", "mode"], "readOnly": false, "type": "string"}, "machines..install.extraFiles..owner": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "\"0:0\""}, "description": "Numeric owner in `uid:gid` format applied via chown on the target.", "loc": ["machines", "", "install", "extraFiles", "", "owner"], "readOnly": false, "type": "string"}, "machines..install.extraFiles..source": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "description": "Local path to the file to copy onto the installed system.\nAccepts an absolute path or a path relative to the devenv project root.\nMust be a string (not a Nix path literal) so secrets stay on the host\nrunning `devenv machines install` and never enter `/nix/store`.\n", "loc": ["machines", "", "install", "extraFiles", "", "source"], "readOnly": false, "type": "string"}, "machines..install.kexec": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Kexec override settings for `devenv machines install`.", "loc": ["machines", "", "install", "kexec"], "readOnly": false, "type": "submodule"}, "machines..install.kexec.image": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Override the default nixos-images kexec tarball URL. Set this for\ncustom installer images, non-standard architectures, or VPN-enabled\ninstallers. Must be an HTTP(S) URL fetched on the remote target.\n", "example": {"_type": "literalExpression", "text": "\"https://example.com/custom-kexec-aarch64.tar.gz\""}, "loc": ["machines", "", "install", "kexec", "image"], "readOnly": false, "type": "null or string"}, "machines..install.kexec.postSshPort": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "SSH port to reconnect to after kexec lands in the installer. Set\nthis when the live sshd on the target listens on a non-22 port. All\nsubsequent install phases (facter, disko, nixos-install) use this\nport.\n", "example": {"_type": "literalExpression", "text": "2222"}, "loc": ["machines", "", "install", "kexec", "postSshPort"], "readOnly": false, "type": "null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "machines..install.secrets": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Bootstrap files populated from the active SecretSpec profile\nafter `nixos-install` and before reboot. Attribute names are\nabsolute paths in the installed system. Local execution streams\nvalues over strictly authenticated SSH; target execution sends\nonly a self-contained declaration manifest and fetches values\non the installer.\nBoth modes atomically install files without placing values in\n`/nix/store`.\n\nLocal execution requires SecretSpec to be enabled in\n`devenv.yaml`; use the global `--secretspec-provider` and\n`--secretspec-profile` flags to select its source. Target\nexecution only requires `secretspec.toml` and leaves provider\nand profile selection to the target unless explicitly overridden\nby `install.secretspec`.\n", "example": {"_type": "literalExpression", "text": "{\n \"/var/lib/sops-nix/key.txt\" = {\n secret = \"WEB1_AGE_KEY\";\n owner = \"0:0\";\n mode = \"0600\";\n };\n}\n"}, "loc": ["machines", "", "install", "secrets"], "readOnly": false, "type": "attribute set of (submodule)"}, "machines..install.secrets..mode": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "\"0600\""}, "description": "File mode applied via chmod on the target. Special and\nexecute bits, group write, and every permission for\nother users are rejected. Modes such as 0400, 0600, and\n0640 are accepted.\n", "loc": ["machines", "", "install", "secrets", "", "mode"], "readOnly": false, "type": "string"}, "machines..install.secrets..owner": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "\"0:0\""}, "description": "Numeric owner in `uid:gid` format applied via chown on the target.", "loc": ["machines", "", "install", "secrets", "", "owner"], "readOnly": false, "type": "string"}, "machines..install.secrets..secret": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "description": "Name of the secret in the active SecretSpec profile. The\nvalue is resolved at install time according to\n`install.secretspec.execution` and is never included in\nmachine metadata or a Nix store path.\n", "example": {"_type": "literalExpression", "text": "\"WEB1_AGE_KEY\""}, "loc": ["machines", "", "install", "secrets", "", "secret"], "readOnly": false, "type": "string"}, "machines..install.secretspec": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "How install-time SecretSpec bootstrap values are resolved.", "loc": ["machines", "", "install", "secretspec"], "readOnly": false, "type": "submodule"}, "machines..install.secretspec.execution": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "\"local\""}, "description": "Where SecretSpec resolves bootstrap values. `local`\nresolves on the workstation and streams values over SSH.\n`target` sends only a self-contained SecretSpec manifest and\nresolves through the provider on the installer machine.\n", "loc": ["machines", "", "install", "secretspec", "execution"], "readOnly": false, "type": "one of \"local\", \"target\""}, "machines..install.secretspec.extraPackages": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "_targetPkgs: [ ]"}, "description": "Function selecting additional target-architecture packages\nrequired by the chosen SecretSpec providers, such as `sops`\nor `pass`. These packages are included in a private resolver\nruntime for target execution, not the system-wide command\nnamespace.\n", "example": {"_type": "literalExpression", "text": "targetPkgs: [ targetPkgs.sops targetPkgs.pass ]"}, "loc": ["machines", "", "install", "secretspec", "extraPackages"], "readOnly": false, "type": "function that evaluates to a(n) list of package"}, "machines..install.secretspec.profile": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Explicit target-side profile override. When unset, devenv\ndoes not pass `--profile`; SecretSpec selects the profile\nfrom the target environment or target-global configuration,\nfalling back to `default`. The workstation profile is never\ninherited.\n", "loc": ["machines", "", "install", "secretspec", "profile"], "readOnly": false, "type": "null or string"}, "machines..install.secretspec.provider": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Explicit target-side provider override. When unset, devenv\ndoes not pass `--provider`; SecretSpec selects providers\nfrom the manifest, target environment, and target-global\nconfiguration. The workstation provider is never inherited.\nProvider credentials must be available independently on the\ninstaller and are never forwarded by devenv. This option is\nnon-secret metadata and must not contain credentials; use a\nprovider alias or target-global configuration instead.\n", "loc": ["machines", "", "install", "secretspec", "provider"], "readOnly": false, "type": "null or string"}, "machines..nix-darwin": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "nix-darwin configuration for the machine.", "example": {"_type": "literalExpression", "text": "{ pkgs, ... }: {\n environment.systemPackages = [\n pkgs.vim\n ];\n services.nix-daemon.enable = true;\n}\n"}, "loc": ["machines", "", "nix-darwin"], "readOnly": false, "type": "null or unspecified value"}, "machines..nixos": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "NixOS configuration for the machine.", "example": {"_type": "literalExpression", "text": "{\n fileSystems.\"/\".device = \"/dev/sda1\";\n boot.loader.systemd-boot.enable = true;\n services.openssh.enable = true;\n}\n"}, "loc": ["machines", "", "nixos"], "readOnly": false, "type": "null or unspecified value"}, "machines..system": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.stdenv.system"}, "description": "System architecture for the machine.", "example": {"_type": "literalExpression", "text": "\"x86_64-linux\""}, "loc": ["machines", "", "system"], "readOnly": false, "type": "string"}, "machines..target": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "SSH destination for install and deploy. See the `target.host` and `target.sshOpts` suboptions.", "loc": ["machines", "", "target"], "readOnly": false, "type": "submodule"}, "machines..target.host": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "SSH destination used by `devenv machines install` and `devenv machines deploy`.\nAccepts `user@host`, `user@host:port`, or a full `ssh://user@host:port` URI.\nLeave unset to activate in process on the current host; this is only valid for `home-manager`.\nSetting it to `\"localhost\"` is not the same as omitting it: `\"localhost\"` still routes through SSH.\n", "example": {"_type": "literalExpression", "text": "\"root@laptop.local\""}, "loc": ["machines", "", "target", "host"], "readOnly": false, "type": "null or string"}, "machines..target.sshOpts": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Extra `ssh -o` options applied before devenv's defaults\n(`StrictHostKeyChecking=accept-new` and a bounded `ConnectTimeout`).\nOpenSSH keeps the first value for most settings, so this list\noverrides the defaults. Installs that transmit SecretSpec bootstrap\nvalues, encryption keys, or extra files force stricter\nnon-overridable SSH settings.\n", "example": {"_type": "literalExpression", "text": "[ \"-o\" \"IdentitiesOnly=yes\" \"-o\" \"ConnectTimeout=10\" ]"}, "loc": ["machines", "", "target", "sshOpts"], "readOnly": false, "type": "list of string"}, "name": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix"}], "default": {"_type": "literalExpression", "text": "\"devenv-shell\""}, "description": "Name of the project.", "loc": ["name"], "readOnly": false, "type": "null or string"}, "opencode.agents": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Custom agents (placed in .opencode/agents/).\n\nThis option can either be:\n- an attribute set of agents, or\n- a path to a directory containing agent files.\n", "example": {"_type": "literalExpression", "text": "{\n \"code-reviewer\" = ''\n # Code Review Agent\n Review code for best practices and potential issues.\n '';\n \"documentation-writer\" = ./agents/doc-writer.md;\n}\n"}, "loc": ["opencode", "agents"], "readOnly": false, "type": "(attribute set of (strings concatenated with \"\\n\" or absolute path)) or absolute path"}, "opencode.commands": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Custom slash commands (placed in .opencode/commands/).\n\nThis option can either be:\n- an attribute set of commands, or\n- a path to a directory containing command files.\n", "example": {"_type": "literalExpression", "text": "{\n \"fix-tests\" = ''\n # Fix Tests Command\n Analyze failing tests and suggest fixes.\n '';\n \"review-pr\" = ./commands/review-pr.md;\n}\n"}, "loc": ["opencode", "commands"], "readOnly": false, "type": "(attribute set of (strings concatenated with \"\\n\" or absolute path)) or absolute path"}, "opencode.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable OpenCode configuration.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["opencode", "enable"], "readOnly": false, "type": "boolean"}, "opencode.mcp": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "MCP servers written to `opencode.jsonc` under `mcp`.\n\nThis option mirrors OpenCode's MCP configuration shape directly\n(`local`/`remote`, `command`, `environment`, `url`, `headers`,\n`oauth`, `enabled`, `timeout`, etc.).\n\nValues from `opencode.settings.mcp` take precedence over this option\nwhen both define the same MCP server name.\n", "example": {"_type": "literalExpression", "text": "{\n my-local = {\n type = \"local\";\n command = [ \"devenv\" \"mcp\" ];\n environment = {\n DEVENV_ROOT = \"{env:DEVENV_ROOT}\";\n };\n };\n\n context7 = {\n type = \"remote\";\n url = \"https://mcp.example.com\";\n headers = {\n Authorization = \"Bearer TOKEN\";\n };\n };\n}\n"}, "loc": ["opencode", "mcp"], "readOnly": false, "type": "attribute set of anything"}, "opencode.rules": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Global custom instructions (placed in .opencode/AGENTS.md).", "example": {"_type": "literalExpression", "text": "# Custom Development Rules\n- Always write tests\n- Use conventional commits\n- Document public APIs\n"}, "loc": ["opencode", "rules"], "readOnly": false, "type": "strings concatenated with \"\\n\" or absolute path"}, "opencode.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Attributes written to opencode.jsonc.", "example": {"_type": "literalExpression", "text": "{\n editor = \"nvim\";\n theme = \"dark\";\n features = {\n autocomplete = true;\n git_integration = true;\n };\n}\n"}, "loc": ["opencode", "settings"], "readOnly": false, "type": "attribute set of anything"}, "opencode.skills": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Custom skills for opencode.\n\nThis option can either be:\n- an attribute set defining skills, or\n- a path to a directory containing skill folders.\n\nIf an attribute set is used, each value can be:\n- inline content (creates `.opencode/skills//SKILL.md`)\n- a path to a file (creates `.opencode/skills//SKILL.md`)\n- a path to a directory (creates `.opencode/skills//`)\n", "example": {"_type": "literalExpression", "text": "{\n \"debug-helper\" = ''\n # Debug Helper Skill\n Helps diagnose and fix bugs systematically.\n '';\n \"api-generator\" = ./skills/api-generator.md;\n \"full-stack-skill\" = ./skills/full-stack;\n}\n"}, "loc": ["opencode", "skills"], "readOnly": false, "type": "(attribute set of (strings concatenated with \"\\n\" or absolute path or string)) or absolute path"}, "opencode.themes": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Custom themes for opencode.\n\nThis option can either be:\n- an attribute set defining themes, or\n- a path to a directory containing theme files.\n", "example": {"_type": "literalExpression", "text": "{\n my-theme = {\n colors = {\n background = \"#0f1115\";\n foreground = \"#d6d9e0\";\n };\n };\n custom = ./themes/custom.json;\n}\n"}, "loc": ["opencode", "themes"], "readOnly": false, "type": "(attribute set of ((attribute set of anything) or absolute path)) or absolute path"}, "opencode.tools": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Custom tools for opencode.\n\nThis option can either be:\n- an attribute set defining tools, or\n- a path to a directory containing tool files.\n", "example": {"_type": "literalExpression", "text": "{\n sample = \"export default { name: \\\"sample-tool\\\"; };\";\n lint = ./tools/lint.ts;\n}\n"}, "loc": ["opencode", "tools"], "readOnly": false, "type": "(attribute set of (strings concatenated with \"\\n\" or absolute path)) or absolute path"}, "opencode.web.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable opencode web service.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["opencode", "web", "enable"], "readOnly": false, "type": "boolean"}, "opencode.web.extraArgs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Extra arguments to pass to `opencode web`.\n\nThese arguments override web server options in the configuration file.\n", "example": {"_type": "literalExpression", "text": "[\n \"--hostname\"\n \"127.0.0.1\"\n \"--port\"\n \"4096\"\n]"}, "loc": ["opencode", "web", "extraArgs"], "readOnly": false, "type": "list of string"}, "outputs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/outputs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/outputs.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Nix outputs for `devenv build` consumption.\n", "example": {"_type": "literalExpression", "text": "{\n git = pkgs.git;\n foo = {\n ncdu = pkgs.ncdu;\n };\n}\n"}, "loc": ["outputs"], "readOnly": false, "type": "outputOf (attribute set)"}, "overlays": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of overlays to apply to pkgs. Each overlay is a function that takes two arguments: final and prev. Supported by devenv 1.4.2 or newer.", "example": {"_type": "literalExpression", "text": "[\n (final: prev: {\n hello = prev.hello.overrideAttrs (oldAttrs: {\n patches = (oldAttrs.patches or []) ++ [ ./hello-fix.patch ];\n });\n })\n]\n"}, "loc": ["overlays"], "readOnly": false, "type": "list of function that evaluates to a(n) function that evaluates to a(n) (attribute set)"}, "packages": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "A list of packages to expose inside the developer environment. Search available packages using ``devenv search NAME``.", "loc": ["packages"], "readOnly": false, "type": "list of package"}, "process.manager.adapter.client": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "description": "Client protocol used for attach, readiness, and individual process control.", "loc": ["process", "manager", "adapter", "client"], "readOnly": false, "type": "one of \"none\", \"native-api\""}, "process.manager.adapter.stop": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "description": "Adapter used to stop the running manager.", "loc": ["process", "manager", "adapter", "stop"], "readOnly": false, "type": "one of \"native-api\", \"command\", \"process-scope\""}, "process.manager.adapter.terminal": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "description": "Terminal required by the manager launcher.", "loc": ["process", "manager", "adapter", "terminal"], "readOnly": false, "type": "one of \"none\", \"controlling\""}, "process.manager.after": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Bash code to execute after stopping processes.", "loc": ["process", "manager", "after"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "process.manager.args": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "description": "Additional arguments to pass to the process manager.\n", "loc": ["process", "manager", "args"], "readOnly": false, "type": "attribute set"}, "process.manager.before": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Bash code to execute before starting processes.", "loc": ["process", "manager", "before"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "process.manager.capabilities.background_start": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "description": "Whether the manager can remain running after the launching client exits.", "loc": ["process", "manager", "capabilities", "background_start"], "readOnly": false, "type": "boolean"}, "process.manager.capabilities.cold_start_subset": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "description": "Whether the manager can initially start a named subset of processes.", "loc": ["process", "manager", "capabilities", "cold_start_subset"], "readOnly": false, "type": "boolean"}, "process.manager.capabilities.devenv_attach": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "description": "Whether devenv can attach its interactive client to an existing manager.", "loc": ["process", "manager", "capabilities", "devenv_attach"], "readOnly": false, "type": "boolean"}, "process.manager.capabilities.individual_control": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "description": "Whether devenv can start, stop, and restart individual processes through the manager.", "loc": ["process", "manager", "capabilities", "individual_control"], "readOnly": false, "type": "boolean"}, "process.manager.capabilities.wait_ready": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "description": "Whether devenv can wait for process readiness through the manager.", "loc": ["process", "manager", "capabilities", "wait_ready"], "readOnly": false, "type": "boolean"}, "process.manager.implementation": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalMD", "text": "`native` for devenv 2.0+, `process-compose` otherwise"}, "description": "The process manager to use when running processes with ``devenv up``.", "example": {"_type": "literalExpression", "text": "\"process-compose\""}, "loc": ["process", "manager", "implementation"], "readOnly": false, "type": "one of \"hivemind\", \"honcho\", \"mprocs\", \"native\", \"overmind\", \"process-compose\""}, "process.managers.hivemind.adapter.client": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix"}], "description": "Client protocol used for attach, readiness, and individual process control.", "loc": ["process", "managers", "hivemind", "adapter", "client"], "readOnly": false, "type": "one of \"none\", \"native-api\""}, "process.managers.hivemind.adapter.stop": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix"}], "description": "Adapter used to stop the running manager.", "loc": ["process", "managers", "hivemind", "adapter", "stop"], "readOnly": false, "type": "one of \"native-api\", \"command\", \"process-scope\""}, "process.managers.hivemind.adapter.terminal": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix"}], "description": "Terminal required by the manager launcher.", "loc": ["process", "managers", "hivemind", "adapter", "terminal"], "readOnly": false, "type": "one of \"none\", \"controlling\""}, "process.managers.hivemind.capabilities.background_start": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix"}], "description": "Whether the manager can remain running after the launching client exits.", "loc": ["process", "managers", "hivemind", "capabilities", "background_start"], "readOnly": false, "type": "boolean"}, "process.managers.hivemind.capabilities.cold_start_subset": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix"}], "description": "Whether the manager can initially start a named subset of processes.", "loc": ["process", "managers", "hivemind", "capabilities", "cold_start_subset"], "readOnly": false, "type": "boolean"}, "process.managers.hivemind.capabilities.devenv_attach": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix"}], "description": "Whether devenv can attach its interactive client to an existing manager.", "loc": ["process", "managers", "hivemind", "capabilities", "devenv_attach"], "readOnly": false, "type": "boolean"}, "process.managers.hivemind.capabilities.individual_control": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix"}], "description": "Whether devenv can start, stop, and restart individual processes through the manager.", "loc": ["process", "managers", "hivemind", "capabilities", "individual_control"], "readOnly": false, "type": "boolean"}, "process.managers.hivemind.capabilities.wait_ready": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix"}], "description": "Whether devenv can wait for process readiness through the manager.", "loc": ["process", "managers", "hivemind", "capabilities", "wait_ready"], "readOnly": false, "type": "boolean"}, "process.managers.hivemind.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.hivemind"}, "description": "The hivemind package to use.", "loc": ["process", "managers", "hivemind", "package"], "readOnly": false, "type": "package"}, "process.managers.honcho.adapter.client": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix"}], "description": "Client protocol used for attach, readiness, and individual process control.", "loc": ["process", "managers", "honcho", "adapter", "client"], "readOnly": false, "type": "one of \"none\", \"native-api\""}, "process.managers.honcho.adapter.stop": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix"}], "description": "Adapter used to stop the running manager.", "loc": ["process", "managers", "honcho", "adapter", "stop"], "readOnly": false, "type": "one of \"native-api\", \"command\", \"process-scope\""}, "process.managers.honcho.adapter.terminal": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix"}], "description": "Terminal required by the manager launcher.", "loc": ["process", "managers", "honcho", "adapter", "terminal"], "readOnly": false, "type": "one of \"none\", \"controlling\""}, "process.managers.honcho.capabilities.background_start": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix"}], "description": "Whether the manager can remain running after the launching client exits.", "loc": ["process", "managers", "honcho", "capabilities", "background_start"], "readOnly": false, "type": "boolean"}, "process.managers.honcho.capabilities.cold_start_subset": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix"}], "description": "Whether the manager can initially start a named subset of processes.", "loc": ["process", "managers", "honcho", "capabilities", "cold_start_subset"], "readOnly": false, "type": "boolean"}, "process.managers.honcho.capabilities.devenv_attach": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix"}], "description": "Whether devenv can attach its interactive client to an existing manager.", "loc": ["process", "managers", "honcho", "capabilities", "devenv_attach"], "readOnly": false, "type": "boolean"}, "process.managers.honcho.capabilities.individual_control": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix"}], "description": "Whether devenv can start, stop, and restart individual processes through the manager.", "loc": ["process", "managers", "honcho", "capabilities", "individual_control"], "readOnly": false, "type": "boolean"}, "process.managers.honcho.capabilities.wait_ready": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix"}], "description": "Whether devenv can wait for process readiness through the manager.", "loc": ["process", "managers", "honcho", "capabilities", "wait_ready"], "readOnly": false, "type": "boolean"}, "process.managers.honcho.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.honcho"}, "description": "The honcho package to use.", "loc": ["process", "managers", "honcho", "package"], "readOnly": false, "type": "package"}, "process.managers.mprocs.adapter.client": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix"}], "description": "Client protocol used for attach, readiness, and individual process control.", "loc": ["process", "managers", "mprocs", "adapter", "client"], "readOnly": false, "type": "one of \"none\", \"native-api\""}, "process.managers.mprocs.adapter.stop": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix"}], "description": "Adapter used to stop the running manager.", "loc": ["process", "managers", "mprocs", "adapter", "stop"], "readOnly": false, "type": "one of \"native-api\", \"command\", \"process-scope\""}, "process.managers.mprocs.adapter.terminal": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix"}], "description": "Terminal required by the manager launcher.", "loc": ["process", "managers", "mprocs", "adapter", "terminal"], "readOnly": false, "type": "one of \"none\", \"controlling\""}, "process.managers.mprocs.capabilities.background_start": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix"}], "description": "Whether the manager can remain running after the launching client exits.", "loc": ["process", "managers", "mprocs", "capabilities", "background_start"], "readOnly": false, "type": "boolean"}, "process.managers.mprocs.capabilities.cold_start_subset": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix"}], "description": "Whether the manager can initially start a named subset of processes.", "loc": ["process", "managers", "mprocs", "capabilities", "cold_start_subset"], "readOnly": false, "type": "boolean"}, "process.managers.mprocs.capabilities.devenv_attach": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix"}], "description": "Whether devenv can attach its interactive client to an existing manager.", "loc": ["process", "managers", "mprocs", "capabilities", "devenv_attach"], "readOnly": false, "type": "boolean"}, "process.managers.mprocs.capabilities.individual_control": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix"}], "description": "Whether devenv can start, stop, and restart individual processes through the manager.", "loc": ["process", "managers", "mprocs", "capabilities", "individual_control"], "readOnly": false, "type": "boolean"}, "process.managers.mprocs.capabilities.wait_ready": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix"}], "description": "Whether devenv can wait for process readiness through the manager.", "loc": ["process", "managers", "mprocs", "capabilities", "wait_ready"], "readOnly": false, "type": "boolean"}, "process.managers.mprocs.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.mprocs"}, "description": "The mprocs package to use.", "loc": ["process", "managers", "mprocs", "package"], "readOnly": false, "type": "package"}, "process.managers.mprocs.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Top-level mprocs.yaml options\n\nhttps://github.com/pvolok/mprocs?tab=readme-ov-file#config\n", "loc": ["process", "managers", "mprocs", "settings"], "readOnly": false, "type": "YAML 1.1 value"}, "process.managers.native.adapter.client": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix"}], "description": "Client protocol used for attach, readiness, and individual process control.", "loc": ["process", "managers", "native", "adapter", "client"], "readOnly": false, "type": "one of \"none\", \"native-api\""}, "process.managers.native.adapter.stop": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix"}], "description": "Adapter used to stop the running manager.", "loc": ["process", "managers", "native", "adapter", "stop"], "readOnly": false, "type": "one of \"native-api\", \"command\", \"process-scope\""}, "process.managers.native.adapter.terminal": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix"}], "description": "Terminal required by the manager launcher.", "loc": ["process", "managers", "native", "adapter", "terminal"], "readOnly": false, "type": "one of \"none\", \"controlling\""}, "process.managers.native.capabilities.background_start": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix"}], "description": "Whether the manager can remain running after the launching client exits.", "loc": ["process", "managers", "native", "capabilities", "background_start"], "readOnly": false, "type": "boolean"}, "process.managers.native.capabilities.cold_start_subset": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix"}], "description": "Whether the manager can initially start a named subset of processes.", "loc": ["process", "managers", "native", "capabilities", "cold_start_subset"], "readOnly": false, "type": "boolean"}, "process.managers.native.capabilities.devenv_attach": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix"}], "description": "Whether devenv can attach its interactive client to an existing manager.", "loc": ["process", "managers", "native", "capabilities", "devenv_attach"], "readOnly": false, "type": "boolean"}, "process.managers.native.capabilities.individual_control": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix"}], "description": "Whether devenv can start, stop, and restart individual processes through the manager.", "loc": ["process", "managers", "native", "capabilities", "individual_control"], "readOnly": false, "type": "boolean"}, "process.managers.native.capabilities.wait_ready": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix"}], "description": "Whether devenv can wait for process readiness through the manager.", "loc": ["process", "managers", "native", "capabilities", "wait_ready"], "readOnly": false, "type": "boolean"}, "process.managers.overmind.adapter.client": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix"}], "description": "Client protocol used for attach, readiness, and individual process control.", "loc": ["process", "managers", "overmind", "adapter", "client"], "readOnly": false, "type": "one of \"none\", \"native-api\""}, "process.managers.overmind.adapter.stop": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix"}], "description": "Adapter used to stop the running manager.", "loc": ["process", "managers", "overmind", "adapter", "stop"], "readOnly": false, "type": "one of \"native-api\", \"command\", \"process-scope\""}, "process.managers.overmind.adapter.terminal": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix"}], "description": "Terminal required by the manager launcher.", "loc": ["process", "managers", "overmind", "adapter", "terminal"], "readOnly": false, "type": "one of \"none\", \"controlling\""}, "process.managers.overmind.capabilities.background_start": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix"}], "description": "Whether the manager can remain running after the launching client exits.", "loc": ["process", "managers", "overmind", "capabilities", "background_start"], "readOnly": false, "type": "boolean"}, "process.managers.overmind.capabilities.cold_start_subset": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix"}], "description": "Whether the manager can initially start a named subset of processes.", "loc": ["process", "managers", "overmind", "capabilities", "cold_start_subset"], "readOnly": false, "type": "boolean"}, "process.managers.overmind.capabilities.devenv_attach": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix"}], "description": "Whether devenv can attach its interactive client to an existing manager.", "loc": ["process", "managers", "overmind", "capabilities", "devenv_attach"], "readOnly": false, "type": "boolean"}, "process.managers.overmind.capabilities.individual_control": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix"}], "description": "Whether devenv can start, stop, and restart individual processes through the manager.", "loc": ["process", "managers", "overmind", "capabilities", "individual_control"], "readOnly": false, "type": "boolean"}, "process.managers.overmind.capabilities.wait_ready": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix"}], "description": "Whether devenv can wait for process readiness through the manager.", "loc": ["process", "managers", "overmind", "capabilities", "wait_ready"], "readOnly": false, "type": "boolean"}, "process.managers.overmind.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.overmind"}, "description": "The overmind package to use.", "loc": ["process", "managers", "overmind", "package"], "readOnly": false, "type": "package"}, "process.managers.process-compose.adapter.client": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix"}], "description": "Client protocol used for attach, readiness, and individual process control.", "loc": ["process", "managers", "process-compose", "adapter", "client"], "readOnly": false, "type": "one of \"none\", \"native-api\""}, "process.managers.process-compose.adapter.stop": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix"}], "description": "Adapter used to stop the running manager.", "loc": ["process", "managers", "process-compose", "adapter", "stop"], "readOnly": false, "type": "one of \"native-api\", \"command\", \"process-scope\""}, "process.managers.process-compose.adapter.terminal": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix"}], "description": "Terminal required by the manager launcher.", "loc": ["process", "managers", "process-compose", "adapter", "terminal"], "readOnly": false, "type": "one of \"none\", \"controlling\""}, "process.managers.process-compose.capabilities.background_start": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix"}], "description": "Whether the manager can remain running after the launching client exits.", "loc": ["process", "managers", "process-compose", "capabilities", "background_start"], "readOnly": false, "type": "boolean"}, "process.managers.process-compose.capabilities.cold_start_subset": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix"}], "description": "Whether the manager can initially start a named subset of processes.", "loc": ["process", "managers", "process-compose", "capabilities", "cold_start_subset"], "readOnly": false, "type": "boolean"}, "process.managers.process-compose.capabilities.devenv_attach": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix"}], "description": "Whether devenv can attach its interactive client to an existing manager.", "loc": ["process", "managers", "process-compose", "capabilities", "devenv_attach"], "readOnly": false, "type": "boolean"}, "process.managers.process-compose.capabilities.individual_control": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix"}], "description": "Whether devenv can start, stop, and restart individual processes through the manager.", "loc": ["process", "managers", "process-compose", "capabilities", "individual_control"], "readOnly": false, "type": "boolean"}, "process.managers.process-compose.capabilities.wait_ready": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix"}], "description": "Whether devenv can wait for process readiness through the manager.", "loc": ["process", "managers", "process-compose", "capabilities", "wait_ready"], "readOnly": false, "type": "boolean"}, "process.managers.process-compose.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.process-compose"}, "description": "The process-compose package to use.", "loc": ["process", "managers", "process-compose", "package"], "readOnly": false, "type": "package"}, "process.managers.process-compose.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix"}], "default": {"_type": "literalExpression", "text": "8080"}, "description": "The port to bind the process-compose server to.\n\nNot used when `unixSocket.enable` is true.\n", "loc": ["process", "managers", "process-compose", "port"], "readOnly": false, "type": "signed integer"}, "process.managers.process-compose.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Top-level process-compose.yaml options\n\nExample: https://github.com/F1bonacc1/process-compose/blob/main/process-compose.yaml\n", "example": {"_type": "literalExpression", "text": "{\n availability = {\n backoff_seconds = 2;\n max_restarts = 5;\n restart = \"on_failure\";\n };\n depends_on = {\n some-other-process = {\n condition = \"process_completed_successfully\";\n };\n };\n environment = [\n \"ENVVAR_FOR_THIS_PROCESS_ONLY=foobar\"\n ];\n}"}, "loc": ["process", "managers", "process-compose", "settings"], "readOnly": false, "type": "YAML 1.1 value"}, "process.managers.process-compose.tui.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Enable the TUI (Terminal User Interface)", "loc": ["process", "managers", "process-compose", "tui", "enable"], "readOnly": false, "type": "boolean"}, "process.managers.process-compose.unixSocket.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable running the process-compose server over unix domain sockets instead of tcp.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["process", "managers", "process-compose", "unixSocket", "enable"], "readOnly": false, "type": "boolean"}, "process.managers.process-compose.unixSocket.path": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix"}], "default": {"_type": "literalExpression", "text": "${config.devenv.runtime}/pc.sock"}, "description": "Override the path to the unix socket.", "loc": ["process", "managers", "process-compose", "unixSocket", "path"], "readOnly": false, "type": "string"}, "process.proxy.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/process-proxy.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/process-proxy.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable the shared HTTP proxy for friendly process URLs under ``.localhost``\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["process", "proxy", "enable"], "readOnly": false, "type": "boolean"}, "processes": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Processes can be started with ``devenv up`` and run in the foreground.", "loc": ["processes"], "readOnly": false, "type": "attribute set of (submodule)"}, "processes..after": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Tasks that must be ready before this process starts.\nUse task names like \"devenv:processes:postgres\" or \"myapp:setup\".\nSupports @started, @ready (default for processes), and @completed suffixes for process dependencies.\nSupports @started, @succeeded (default for tasks), and @completed suffixes for task dependencies.\n", "example": {"_type": "literalExpression", "text": "[\n \"devenv:processes:postgres\"\n \"myapp:migrations@succeeded\"\n]"}, "loc": ["processes", "", "after"], "readOnly": false, "type": "list of string"}, "processes..before": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Tasks that should start after this process is ready.\n", "example": {"_type": "literalExpression", "text": "[\n \"devenv:processes:nginx\"\n]"}, "loc": ["processes", "", "before"], "readOnly": false, "type": "list of string"}, "processes..cwd": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Working directory to run the process in. If not specified, the current working directory will be used.", "loc": ["processes", "", "cwd"], "readOnly": false, "type": "null or string"}, "processes..env": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Environment variables to set for this process.", "loc": ["processes", "", "env"], "readOnly": false, "type": "attribute set of string"}, "processes..exec": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "description": "Bash code to run the process.", "loc": ["processes", "", "exec"], "readOnly": false, "type": "string"}, "processes..linux": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Linux-specific process configuration.\n\nRequires devenv 2.0+.\n", "loc": ["processes", "", "linux"], "readOnly": false, "type": "submodule"}, "processes..linux.capabilities": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Linux capabilities to add as ambient capabilities for this process\n(e.g., \"net_bind_service\", \"net_admin\").\n\nSupported capabilities are net_bind_service, net_raw, net_admin,\nipc_lock, sys_nice, sys_resource, sys_admin, chown, dac_override,\nand fowner. Starting a process with capabilities requires sudo\nauthentication.\n\nRequires devenv 2.0+.\n", "example": {"_type": "literalExpression", "text": "[\n \"net_bind_service\"\n \"net_admin\"\n]"}, "loc": ["processes", "", "linux", "capabilities"], "readOnly": false, "type": "list of string"}, "processes..listen": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Socket activation configuration for systemd-style socket passing.\n\nRequires devenv 2.0+.\n", "example": {"_type": "literalExpression", "text": "[\n {\n address = \"127.0.0.1:8080\";\n kind = \"tcp\";\n name = \"http\";\n }\n {\n kind = \"unix_stream\";\n mode = 384;\n name = \"admin\";\n path = \"$DEVENV_STATE/admin.sock\";\n }\n]"}, "loc": ["processes", "", "listen"], "readOnly": false, "type": "list of (submodule)"}, "processes..listen.*.address": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "TCP address (e.g., '127.0.0.1:8080'). Required for TCP sockets.", "loc": ["processes", "", "listen", "*", "address"], "readOnly": false, "type": "null or string"}, "processes..listen.*.backlog": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "128"}, "description": "Listen backlog size", "loc": ["processes", "", "listen", "*", "backlog"], "readOnly": false, "type": "null or signed integer"}, "processes..listen.*.kind": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "description": "Type of socket (tcp or unix_stream)", "loc": ["processes", "", "listen", "*", "kind"], "readOnly": false, "type": "one of \"tcp\", \"unix_stream\""}, "processes..listen.*.mode": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Unix socket file permissions (e.g., 384 for 0o600). Only for unix_stream.", "loc": ["processes", "", "listen", "*", "mode"], "readOnly": false, "type": "null or signed integer"}, "processes..listen.*.name": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "description": "Name of the socket (e.g., 'http', 'admin')", "loc": ["processes", "", "listen", "*", "name"], "readOnly": false, "type": "string"}, "processes..listen.*.path": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Unix socket path. Required for unix_stream sockets.", "loc": ["processes", "", "listen", "*", "path"], "readOnly": false, "type": "null or string"}, "processes..ports": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Named ports with auto-allocation for this process.\n\nDefine ports with a base value and devenv will automatically find\na free port starting from that base, incrementing until available.\n\nThe resolved port is available via `config.processes..ports..value`.\n\nRequires devenv 2.0+.\n", "example": {"_type": "literalExpression", "text": "{\n http.allocate = 8080;\n admin.allocate = 9000;\n}\n"}, "loc": ["processes", "", "ports"], "readOnly": false, "type": "attribute set of (submodule)"}, "processes..ports..allocate": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "description": "Base port for auto-allocation (increments until free)", "example": {"_type": "literalExpression", "text": "8080"}, "loc": ["processes", "", "ports", "", "allocate"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "processes..ports..proxy": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Shared HTTP proxy configuration for this port.", "loc": ["processes", "", "ports", "", "proxy"], "readOnly": false, "type": "submodule"}, "processes..ports..proxy.hostname": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Full `.localhost` hostname to use for this port when\n`process.proxy.enable` is enabled.\n\nThis takes precedence over `processes..proxy.hostname`\nand the generated hostname.\n", "example": {"_type": "literalExpression", "text": "\"admin.localhost\""}, "loc": ["processes", "", "ports", "", "proxy", "hostname"], "readOnly": false, "type": "null or string"}, "processes..ports..value": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalMD", "text": "Allocated port based on `allocate`"}, "description": "Resolved port value (allocated by devenv)", "loc": ["processes", "", "ports", "", "value"], "readOnly": true, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "processes..process-compose": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "process-compose.yaml specific process attributes.\n\nExample: https://github.com/F1bonacc1/process-compose/blob/main/process-compose.yaml\n\nOnly used when using ``process.manager.implementation = \"process-compose\";``\n", "example": {"_type": "literalExpression", "text": "{\n availability = {\n backoff_seconds = 2;\n max_restarts = 5;\n restart = \"on_failure\";\n };\n depends_on = {\n some-other-process = {\n condition = \"process_completed_successfully\";\n };\n };\n environment = [\n \"ENVVAR_FOR_THIS_PROCESS_ONLY=foobar\"\n ];\n}"}, "loc": ["processes", "", "process-compose"], "readOnly": false, "type": "YAML 1.1 value"}, "processes..proxy": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Shared HTTP proxy configuration for this process.", "loc": ["processes", "", "proxy"], "readOnly": false, "type": "submodule"}, "processes..proxy.hostname": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Full `.localhost` hostname to use for this process when\n`process.proxy.enable` is enabled.\n\nBy default, devenv derives the hostname from the process and\nproject names. Named ports without their own hostname override\nare prefixed to this hostname.\n", "example": {"_type": "literalExpression", "text": "\"app.localhost\""}, "loc": ["processes", "", "proxy", "hostname"], "readOnly": false, "type": "null or string"}, "processes..proxy.https.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable HTTPS proxy URLs for this process using the project's mkcert certificate authority.\nHTTP URLs remain available. Requires `process.proxy.enable`\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["processes", "", "proxy", "https", "enable"], "readOnly": false, "type": "boolean"}, "processes..ready": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "How to determine if this process is ready to serve.\n\nRequires devenv 2.0+.\n", "loc": ["processes", "", "ready"], "readOnly": false, "type": "null or (submodule)"}, "processes..ready.exec": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Shell command to execute. Exit 0 = ready.", "example": {"_type": "literalExpression", "text": "\"pg_isready -d template1\""}, "loc": ["processes", "", "ready", "exec"], "readOnly": false, "type": "null or string"}, "processes..ready.failure_threshold": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "3"}, "description": "Consecutive failures before marking unhealthy.", "loc": ["processes", "", "ready", "failure_threshold"], "readOnly": false, "type": "signed integer"}, "processes..ready.http": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "HTTP readiness probe configuration.", "loc": ["processes", "", "ready", "http"], "readOnly": false, "type": "submodule"}, "processes..ready.http.get": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "HTTP GET readiness check.", "loc": ["processes", "", "ready", "http", "get"], "readOnly": false, "type": "null or (submodule)"}, "processes..ready.http.get.host": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "Host to connect to.", "loc": ["processes", "", "ready", "http", "get", "host"], "readOnly": false, "type": "string"}, "processes..ready.http.get.path": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "\"/\""}, "description": "HTTP path to request.", "loc": ["processes", "", "ready", "http", "get", "path"], "readOnly": false, "type": "string"}, "processes..ready.http.get.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "description": "Port to connect to.", "loc": ["processes", "", "ready", "http", "get", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "processes..ready.http.get.scheme": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "\"http\""}, "description": "URL scheme (http or https).", "loc": ["processes", "", "ready", "http", "get", "scheme"], "readOnly": false, "type": "string"}, "processes..ready.initial_delay": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "0"}, "description": "Seconds to wait before first probe.", "loc": ["processes", "", "ready", "initial_delay"], "readOnly": false, "type": "signed integer"}, "processes..ready.notify": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Enable systemd notify protocol for readiness signaling.\nThe process must send READY=1 to the NOTIFY_SOCKET.\n", "loc": ["processes", "", "ready", "notify"], "readOnly": false, "type": "boolean"}, "processes..ready.period": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "10"}, "description": "Seconds between probes.", "loc": ["processes", "", "ready", "period"], "readOnly": false, "type": "signed integer"}, "processes..ready.probe_timeout": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "1"}, "description": "Seconds before a single probe times out.", "loc": ["processes", "", "ready", "probe_timeout"], "readOnly": false, "type": "signed integer"}, "processes..ready.success_threshold": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "1"}, "description": "Consecutive successes needed to be considered ready.", "loc": ["processes", "", "ready", "success_threshold"], "readOnly": false, "type": "signed integer"}, "processes..ready.timeout": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Overall deadline in seconds for the process to become ready. null = no deadline.", "loc": ["processes", "", "ready", "timeout"], "readOnly": false, "type": "null or (unsigned integer, meaning >=0)"}, "processes..restart": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Process restart policy.", "loc": ["processes", "", "restart"], "readOnly": false, "type": "submodule"}, "processes..restart.max": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "5"}, "description": "Maximum restart attempts. null = unlimited.", "loc": ["processes", "", "restart", "max"], "readOnly": false, "type": "null or signed integer"}, "processes..restart.on": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "\"on_failure\""}, "description": "When to restart: never, always, or on_failure.", "loc": ["processes", "", "restart", "on"], "readOnly": false, "type": "one of \"never\", \"always\", \"on_failure\""}, "processes..restart.window": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Sliding window in seconds for restart rate limiting. null = lifetime limit.", "loc": ["processes", "", "restart", "window"], "readOnly": false, "type": "null or (unsigned integer, meaning >=0)"}, "processes..shutdown": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Graceful shutdown signal and timeout", "loc": ["processes", "", "shutdown"], "readOnly": false, "type": "submodule"}, "processes..shutdown.grace": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "5"}, "description": "Seconds before shutdown escalates to SIGKILL", "loc": ["processes", "", "shutdown", "grace"], "readOnly": false, "type": "unsigned integer, meaning >=0"}, "processes..shutdown.signal": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "15"}, "description": "Unix signal number used for graceful shutdown", "loc": ["processes", "", "shutdown", "signal"], "readOnly": false, "type": "integer between 1 and 31 (both inclusive)"}, "processes..start": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Auto-start configuration for this process.", "loc": ["processes", "", "start"], "readOnly": false, "type": "submodule"}, "processes..start.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to start this process automatically with `devenv up`.\n\nDisabled processes are still visible in the TUI as stopped\nand can be started manually by selecting them and pressing Enter.\nThey also run when pulled in as a task dependency, for example\n`after = [ \"devenv:processes:@completed\" ]`.\n", "loc": ["processes", "", "start", "enable"], "readOnly": false, "type": "boolean"}, "processes..watch": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "File watching configuration for automatic process restarts.\n\nRequires devenv 2.0+.\n", "example": {"_type": "literalExpression", "text": "{\n paths = [ ./src ];\n extensions = [ \"rs\" \"toml\" ];\n ignore = [ \"target\" ];\n}\n"}, "loc": ["processes", "", "watch"], "readOnly": false, "type": "submodule"}, "processes..watch.extensions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "File extensions to watch (e.g., \"rs\", \"js\", \"py\").\nIf empty, all file extensions are watched.\n\nRequires devenv 2.0+.\n", "example": {"_type": "literalExpression", "text": "[\n \"rs\"\n \"toml\"\n]"}, "loc": ["processes", "", "watch", "extensions"], "readOnly": false, "type": "list of string"}, "processes..watch.ignore": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Glob patterns to ignore (e.g., \".git\", \"target\", \"*.log\").\n\nRequires devenv 2.0+.\n", "example": {"_type": "literalExpression", "text": "[\n \"*.log\"\n \".git\"\n \"target\"\n]"}, "loc": ["processes", "", "watch", "ignore"], "readOnly": false, "type": "list of string"}, "processes..watch.paths": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Paths to watch for changes (files or directories).\nWhen files in these paths change, the process is restarted\n(or, for a one-shot command that exits immediately, re-run).\n\nPaths are resolved relative to the location of `devenv.nix`\n(the project root), not relative to the process's `cwd`. Use\npath literals such as `./src`; they are passed to the watcher\nas absolute paths.\n\nRequires devenv 2.0+.\n", "example": {"_type": "literalExpression", "text": "[ ./src ./config.yaml ]\n"}, "loc": ["processes", "", "watch", "paths"], "readOnly": false, "type": "list of absolute path"}, "processes..watchdog": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Systemd watchdog configuration.\n\nRequires devenv 2.0+.\n", "example": {"_type": "literalExpression", "text": "{\n usec = 30000000; # 30 seconds\n require_ready = true;\n}\n"}, "loc": ["processes", "", "watchdog"], "readOnly": false, "type": "null or (submodule)"}, "processes..watchdog.require_ready": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Require READY=1 notification before enforcing watchdog", "loc": ["processes", "", "watchdog", "require_ready"], "readOnly": false, "type": "boolean"}, "processes..watchdog.usec": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "description": "Watchdog interval in microseconds", "loc": ["processes", "", "watchdog", "usec"], "readOnly": false, "type": "signed integer"}, "profiles": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/profiles.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/profiles.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Profile definitions that can be activated manually or automatically.", "example": {"_type": "literalExpression", "text": "{\n # Manual profiles (activated via --profile)\n \"base\" = {\n module = {\n languages.nix.enable = true;\n packages = [ pkgs.git ];\n };\n };\n \"python-3.14\" = {\n extends = [ \"base\" ];\n module = {\n languages.python.version = \"3.14\";\n };\n };\n \"backend\" = {\n extends = [ \"base\" ];\n module = {\n services.postgres.enable = true;\n services.redis.enable = true;\n };\n };\n \"fullstack\" = {\n extends = [ \"backend\" \"python-3.14\" ];\n module = {\n env.FULL_STACK = \"true\";\n };\n };\n # Automatic hostname-based profiles\n hostname.\"work-laptop\" = {\n extends = [ \"backend\" ];\n module = {\n env.WORK_ENV = \"true\";\n };\n };\n # Automatic user-based profiles\n user.\"alice\" = {\n extends = [ \"python-3.14\" ];\n module = {\n env.USER_ROLE = \"developer\";\n };\n };\n}\n"}, "loc": ["profiles"], "readOnly": false, "type": "open submodule of lazy attribute set of (submodule)"}, "profiles..extends": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of profile names to extend/inherit from.", "example": {"_type": "literalExpression", "text": "[\n \"base\"\n \"backend\"\n]"}, "loc": ["profiles", "", "extends"], "readOnly": false, "type": "list of string"}, "profiles..module": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Additional configuration to merge when this profile is active.", "loc": ["profiles", "", "module"], "readOnly": false, "type": "module"}, "profiles.hostname": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/profiles.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/profiles.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Profile definitions that are automatically activated based on the machine's hostname.", "loc": ["profiles", "hostname"], "readOnly": false, "type": "lazy attribute set of (submodule)"}, "profiles.hostname..extends": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/profiles.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/profiles.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of profile names to extend/inherit from.", "example": {"_type": "literalExpression", "text": "[\n \"base\"\n \"backend\"\n]"}, "loc": ["profiles", "hostname", "", "extends"], "readOnly": false, "type": "list of string"}, "profiles.hostname..module": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/profiles.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/profiles.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Additional configuration to merge when this profile is active.", "loc": ["profiles", "hostname", "", "module"], "readOnly": false, "type": "module"}, "profiles.user": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/profiles.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/profiles.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Profile definitions that are automatically activated based on the username.", "loc": ["profiles", "user"], "readOnly": false, "type": "lazy attribute set of (submodule)"}, "profiles.user..extends": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/profiles.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/profiles.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of profile names to extend/inherit from.", "example": {"_type": "literalExpression", "text": "[\n \"base\"\n \"backend\"\n]"}, "loc": ["profiles", "user", "", "extends"], "readOnly": false, "type": "list of string"}, "profiles.user..module": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/profiles.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/profiles.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Additional configuration to merge when this profile is active.", "loc": ["profiles", "user", "", "module"], "readOnly": false, "type": "module"}, "scripts": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "A set of scripts available when the environment is active.", "loc": ["scripts"], "readOnly": false, "type": "attribute set of (submodule)"}, "scripts..binary": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Override the binary name from the default `package.meta.mainProgram`", "loc": ["scripts", "", "binary"], "readOnly": false, "type": "null or string"}, "scripts..description": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Description of the script.", "loc": ["scripts", "", "description"], "readOnly": false, "type": "string"}, "scripts..exec": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix"}], "description": "Shell code to execute when the script is run, or path to a script file.", "loc": ["scripts", "", "exec"], "readOnly": false, "type": "string or absolute path"}, "scripts..package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.bash"}, "description": "The package to use to run the script.", "loc": ["scripts", "", "package"], "readOnly": false, "type": "package"}, "scripts..packages": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix"}], "default": {"_type": "literalExpression", "text": "[]"}, "description": "Packages to be available in PATH when the script runs.", "loc": ["scripts", "", "packages"], "readOnly": false, "type": "list of package"}, "secretspec.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/secretspec.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/secretspec.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether secretspec integration is enabled (automatically true when secrets are loaded)", "loc": ["secretspec", "enable"], "readOnly": true, "type": "boolean"}, "secretspec.profile": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/secretspec.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/secretspec.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The secretspec profile that was used to load secrets (read-only)", "loc": ["secretspec", "profile"], "readOnly": true, "type": "null or string"}, "secretspec.provider": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/secretspec.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/secretspec.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The explicit secretspec provider override selected through devenv, if any (read-only)", "loc": ["secretspec", "provider"], "readOnly": true, "type": "null or string"}, "secretspec.secrets": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/secretspec.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/secretspec.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Secrets loaded from secretspec.toml (read-only)", "loc": ["secretspec", "secrets"], "readOnly": true, "type": "attribute set of string"}, "services.adminer.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/adminer.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/adminer.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Adminer process.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "adminer", "enable"], "readOnly": false, "type": "boolean"}, "services.adminer.listen": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/adminer.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/adminer.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1:8080\""}, "description": "Listen address for the Adminer.", "loc": ["services", "adminer", "listen"], "readOnly": false, "type": "string"}, "services.adminer.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/adminer.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/adminer.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.adminer"}, "description": "Which package of Adminer to use.", "loc": ["services", "adminer", "package"], "readOnly": false, "type": "package"}, "services.blackfire.client-id": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Sets the client id used to authenticate with Blackfire.\nYou can find your personal client-id at .\n", "loc": ["services", "blackfire", "client-id"], "readOnly": false, "type": "string"}, "services.blackfire.client-token": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Sets the client token used to authenticate with Blackfire.\nYou can find your personal client-token at .\n", "loc": ["services", "blackfire", "client-token"], "readOnly": false, "type": "string"}, "services.blackfire.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Blackfire profiler agent\n\nIt automatically installs Blackfire PHP extension.\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "blackfire", "enable"], "readOnly": false, "type": "boolean"}, "services.blackfire.enableApm": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Enables application performance monitoring, requires special subscription.\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "blackfire", "enableApm"], "readOnly": false, "type": "boolean"}, "services.blackfire.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.blackfire"}, "description": "Which package of blackfire to use", "loc": ["services", "blackfire", "package"], "readOnly": false, "type": "package"}, "services.blackfire.server-id": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Sets the server id used to authenticate with Blackfire.\nYou can find your personal server-id at .\n", "loc": ["services", "blackfire", "server-id"], "readOnly": false, "type": "string"}, "services.blackfire.server-token": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Sets the server token used to authenticate with Blackfire.\nYou can find your personal server-token at .\n", "loc": ["services", "blackfire", "server-token"], "readOnly": false, "type": "string"}, "services.blackfire.socket": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix"}], "default": {"_type": "literalExpression", "text": "\"tcp://127.0.0.1:8307\""}, "description": "Sets the server socket path\n", "loc": ["services", "blackfire", "socket"], "readOnly": false, "type": "string"}, "services.caddy.adapter": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix"}], "default": {"_type": "literalExpression", "text": "\"caddyfile\""}, "description": "Name of the config adapter to use.\nSee for the full list.\n", "example": {"_type": "literalExpression", "text": "\"nginx\""}, "loc": ["services", "caddy", "adapter"], "readOnly": false, "type": "string"}, "services.caddy.ca": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix"}], "default": {"_type": "literalExpression", "text": "\"https://acme-v02.api.letsencrypt.org/directory\""}, "description": "Certificate authority ACME server. The default (Let's Encrypt\nproduction server) should be fine for most people. Set it to null if\nyou don't want to include any authority (or if you want to write a more\nfine-graned configuration manually).\n", "example": {"_type": "literalExpression", "text": "\"https://acme-staging-v02.api.letsencrypt.org/directory\""}, "loc": ["services", "caddy", "ca"], "readOnly": false, "type": "null or string"}, "services.caddy.config": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Verbatim Caddyfile to use.\n\nRefer to [https://caddyserver.com/docs/caddyfile](https://caddyserver.com/docs/caddyfile)\nfor more information.\n\nCaddy v2 supports multiple config formats via adapters (see [`services.caddy.adapter`](#servicescaddyconfig)).\n", "example": {"_type": "literalExpression", "text": "''\n # Global options block\n {\n debug\n }\n \n # Site block\n example.com {\n encode gzip\n log\n root /srv/http\n }\n''"}, "loc": ["services", "caddy", "config"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.caddy.dataDir": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix"}], "default": {"_type": "literalExpression", "text": "\"${config.env.DEVENV_STATE}/caddy\""}, "description": "The data directory, for storing certificates. Before 17.09, this\nwould create a .caddy directory. With 17.09 the contents of the\n.caddy directory are in the specified data directory instead.\nCaddy v2 replaced CADDYPATH with XDG directories.\nSee .\n", "loc": ["services", "caddy", "dataDir"], "readOnly": false, "type": "absolute path"}, "services.caddy.email": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Email address (for Let's Encrypt certificate).", "loc": ["services", "caddy", "email"], "readOnly": false, "type": "string"}, "services.caddy.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Caddy web server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "caddy", "enable"], "readOnly": false, "type": "boolean"}, "services.caddy.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.caddy"}, "description": "Caddy package to use.\n", "loc": ["services", "caddy", "package"], "readOnly": false, "type": "package"}, "services.caddy.resume": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Use saved config, if any (and prefer over configuration passed with [`caddy.config`](#servicescaddyconfig)).\n", "loc": ["services", "caddy", "resume"], "readOnly": false, "type": "boolean"}, "services.caddy.virtualHosts": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Declarative vhost config.", "example": {"_type": "literalExpression", "text": "{\n \"hydra.example.com\" = {\n serverAliases = [ \"www.hydra.example.com\" ];\n extraConfig = ''''\n encode gzip\n log\n root /srv/http\n '''';\n };\n};\n"}, "loc": ["services", "caddy", "virtualHosts"], "readOnly": false, "type": "attribute set of (submodule)"}, "services.caddy.virtualHosts..extraConfig": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "These lines go into the vhost verbatim.\n", "loc": ["services", "caddy", "virtualHosts", "", "extraConfig"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.caddy.virtualHosts..serverAliases": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Additional names of virtual hosts served by this virtual host configuration.\n", "example": {"_type": "literalExpression", "text": "[\n \"www.example.org\"\n \"example.org\"\n]"}, "loc": ["services", "caddy", "virtualHosts", "", "serverAliases"], "readOnly": false, "type": "list of string"}, "services.cassandra.allowClients": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Enables or disables the native transport server (CQL binary protocol)\n", "loc": ["services", "cassandra", "allowClients"], "readOnly": false, "type": "boolean"}, "services.cassandra.clusterName": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix"}], "default": {"_type": "literalExpression", "text": "\"Test Cluster\""}, "description": "The name of the cluster", "loc": ["services", "cassandra", "clusterName"], "readOnly": false, "type": "string"}, "services.cassandra.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Add Cassandra process script..", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "cassandra", "enable"], "readOnly": false, "type": "boolean"}, "services.cassandra.extraConfig": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Extra options to be merged into `cassandra.yaml` as nix attribute set.\n", "example": {"_type": "literalExpression", "text": "{\n commitlog_sync_batch_window_in_ms = 3;\n}"}, "loc": ["services", "cassandra", "extraConfig"], "readOnly": false, "type": "attribute set"}, "services.cassandra.jvmOpts": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Options to pass to the JVM through the JVM_OPTS environment variable", "loc": ["services", "cassandra", "jvmOpts"], "readOnly": false, "type": "list of string"}, "services.cassandra.listenAddress": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "Listen address", "example": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "loc": ["services", "cassandra", "listenAddress"], "readOnly": false, "type": "string"}, "services.cassandra.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.cassandra_4"}, "description": "Which version of Cassandra to use", "example": {"_type": "literalExpression", "text": "pkgs.cassandra_4;"}, "loc": ["services", "cassandra", "package"], "readOnly": false, "type": "package"}, "services.cassandra.seedAddresses": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"127.0.0.1\"\n]"}, "description": "The addresses of hosts designated as contact points of the cluster", "loc": ["services", "cassandra", "seedAddresses"], "readOnly": false, "type": "list of string"}, "services.clickhouse.config": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix"}], "description": "ClickHouse configuration in YAML.", "loc": ["services", "clickhouse", "config"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.clickhouse.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable clickhouse-server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "clickhouse", "enable"], "readOnly": false, "type": "boolean"}, "services.clickhouse.httpPort": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix"}], "default": {"_type": "literalExpression", "text": "8123"}, "description": "Which http port to run clickhouse on.", "loc": ["services", "clickhouse", "httpPort"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.clickhouse.keeper.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable keeper_server in ClickHouse.", "loc": ["services", "clickhouse", "keeper", "enable"], "readOnly": false, "type": "boolean"}, "services.clickhouse.keeper.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix"}], "default": {"_type": "literalExpression", "text": "9181"}, "description": "Which port to run clickhouse keeper service on.", "loc": ["services", "clickhouse", "keeper", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.clickhouse.keeper.raft.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix"}], "default": {"_type": "literalExpression", "text": "9234"}, "description": "Which http port to use clickhouse keeper for raft consensus.", "loc": ["services", "clickhouse", "keeper", "raft", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.clickhouse.macros.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable macros in ClickHouse.", "loc": ["services", "clickhouse", "macros", "enable"], "readOnly": false, "type": "boolean"}, "services.clickhouse.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.clickhouse"}, "description": "Which package of clickhouse to use", "loc": ["services", "clickhouse", "package"], "readOnly": false, "type": "package"}, "services.clickhouse.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix"}], "default": {"_type": "literalExpression", "text": "9000"}, "description": "Which port to run clickhouse on.", "loc": ["services", "clickhouse", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.clickhouse.remoteServers.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable remote_servers in ClickHouse.", "loc": ["services", "clickhouse", "remoteServers", "enable"], "readOnly": false, "type": "boolean"}, "services.clickhouse.timezone": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Which timezone to use for ClickHouse.", "loc": ["services", "clickhouse", "timezone"], "readOnly": false, "type": "null or string"}, "services.clickhouse.usersConfig": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Your `users.yaml` as a Nix attribute set.\nCheck the [documentation](https://clickhouse.com/docs/operations/configuration-files#user-settings)\nfor possible options.\n", "example": {"_type": "literalExpression", "text": "{\n profiles = {};\n\n users = {\n default = {\n profile = \"default\";\n password_sha256_hex = \"36dd292533174299fb0c34665df468bb881756ca9eaf9757d0cfde38f9ededa1\"; # `echo -n verysecret | sha256sum`\n };\n };\n}\n"}, "loc": ["services", "clickhouse", "usersConfig"], "readOnly": false, "type": "YAML 1.1 value"}, "services.cockroachdb.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/cockroachdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/cockroachdb.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Add CockroachDB process.\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "cockroachdb", "enable"], "readOnly": false, "type": "boolean"}, "services.cockroachdb.http_addr": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/cockroachdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/cockroachdb.nix"}], "default": {"_type": "literalExpression", "text": "\"localhost:8080\""}, "description": "The hostname or IP address to bind to for HTTP requests.\n", "loc": ["services", "cockroachdb", "http_addr"], "readOnly": false, "type": "string"}, "services.cockroachdb.listen_addr": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/cockroachdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/cockroachdb.nix"}], "default": {"_type": "literalExpression", "text": "\"localhost:26257\""}, "description": "The address/hostname and port to listen on.\n", "loc": ["services", "cockroachdb", "listen_addr"], "readOnly": false, "type": "string"}, "services.cockroachdb.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/cockroachdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/cockroachdb.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.cockroachdb"}, "description": "The CockroachDB package to use.", "loc": ["services", "cockroachdb", "package"], "readOnly": false, "type": "unspecified value"}, "services.couchdb.baseDir": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix"}], "default": {"_type": "literalExpression", "text": "config.env.DEVENV_STATE + \"/couchdb\""}, "description": "The directory where CouchDB will store its data.\n", "loc": ["services", "couchdb", "baseDir"], "readOnly": true, "type": "string"}, "services.couchdb.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable CouchDB process.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "couchdb", "enable"], "readOnly": false, "type": "boolean"}, "services.couchdb.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.couchdb3"}, "description": "Which version of CouchDB to use", "loc": ["services", "couchdb", "package"], "readOnly": false, "type": "package"}, "services.couchdb.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "CouchDB configuration.\nTo learn more about all settings, see the\n[CouchDB configuration reference](https://docs.couchdb.org/en/stable/config/couchdb.html).\n", "example": {"_type": "literalExpression", "text": "{\n couchdb = {\n database_dir = baseDir;\n single_node = true;\n view_index_dir = baseDir;\n uri_file = \"${config.services.couchdb.baseDir}/couchdb.uri\";\n };\n admins = {\n \"admin_username\" = \"pass\";\n };\n chttpd = {\n bind_address = \"127.0.0.1\";\n port = 5984;\n };\n}\n"}, "loc": ["services", "couchdb", "settings"], "readOnly": false, "type": "open submodule of attribute set of section of an INI file (attrs of INI atom (null, bool, int, float or string))"}, "services.couchdb.settings.chttpd.bind_address": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "Defines the IP address by which CouchDB will be accessible.\n", "loc": ["services", "couchdb", "settings", "chttpd", "bind_address"], "readOnly": false, "type": "string"}, "services.couchdb.settings.chttpd.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix"}], "default": {"_type": "literalExpression", "text": "5984"}, "description": "Defined the port number to listen.\n", "loc": ["services", "couchdb", "settings", "chttpd", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.couchdb.settings.couchdb.database_dir": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix"}], "default": {"_type": "literalExpression", "text": "config.env.DEVENV_STATE + \"/couchdb\""}, "description": "Specifies location of CouchDB database files (*.couch named). This\nlocation should be writable and readable for the user the CouchDB\nservice runs as (couchdb by default).\n", "loc": ["services", "couchdb", "settings", "couchdb", "database_dir"], "readOnly": false, "type": "absolute path"}, "services.couchdb.settings.couchdb.single_node": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "When this configuration setting is set to true, automatically create\nthe system databases on startup. Must be set false for a clustered\nCouchDB installation.\n", "loc": ["services", "couchdb", "settings", "couchdb", "single_node"], "readOnly": false, "type": "boolean"}, "services.couchdb.settings.couchdb.uri_file": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix"}], "default": {"_type": "literalExpression", "text": "config.env.DEVENV_STATE + \"/couchdb\"/couchdb.uri"}, "description": "This file contains the full URI that can be used to access this\ninstance of CouchDB. It is used to help discover the port CouchDB is\nrunning on (if it was set to 0 (e.g. automatically assigned any free\none). This file should be writable and readable for the user that\nruns the CouchDB service (couchdb by default).\n", "loc": ["services", "couchdb", "settings", "couchdb", "uri_file"], "readOnly": false, "type": "absolute path"}, "services.couchdb.settings.couchdb.view_index_dir": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix"}], "default": {"_type": "literalExpression", "text": "config.env.DEVENV_STATE + \"/couchdb\""}, "description": "Specifies location of CouchDB view index files. This location should\nbe writable and readable for the user that runs the CouchDB service\n(couchdb by default).\n", "loc": ["services", "couchdb", "settings", "couchdb", "view_index_dir"], "readOnly": false, "type": "absolute path"}, "services.dynamodb-local.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/dynamodb-local.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/dynamodb-local.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable DynamoDB Local.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "dynamodb-local", "enable"], "readOnly": false, "type": "boolean"}, "services.dynamodb-local.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/dynamodb-local.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/dynamodb-local.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.dynamodb-local"}, "description": "Which package of DynamoDB to use.", "loc": ["services", "dynamodb-local", "package"], "readOnly": false, "type": "package"}, "services.dynamodb-local.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/dynamodb-local.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/dynamodb-local.nix"}], "default": {"_type": "literalExpression", "text": "8000"}, "description": "Listen port for DynamoDB Local.", "loc": ["services", "dynamodb-local", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.dynamodb-local.sharedDb": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/dynamodb-local.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/dynamodb-local.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "If true, enables the -sharedDb flag for DynamoDB Local.\nWhen enabled, DynamoDB Local creates a single database file named shared-local-instance.db.\nEvery program that connects to DynamoDB accesses this file. If you delete the file, you lose any data stored in it.\n", "loc": ["services", "dynamodb-local", "sharedDb"], "readOnly": false, "type": "boolean"}, "services.elasticmq.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticmq.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticmq.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable elasticmq-server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "elasticmq", "enable"], "readOnly": false, "type": "boolean"}, "services.elasticmq.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticmq.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticmq.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.elasticmq-server-bin"}, "description": "Which package of elasticmq-server-bin to use", "loc": ["services", "elasticmq", "package"], "readOnly": false, "type": "package"}, "services.elasticmq.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticmq.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticmq.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Configuration for elasticmq-server", "loc": ["services", "elasticmq", "settings"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.elasticsearch.cluster_name": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix"}], "default": {"_type": "literalExpression", "text": "\"elasticsearch\""}, "description": "Elasticsearch name that identifies your cluster for auto-discovery.", "loc": ["services", "elasticsearch", "cluster_name"], "readOnly": false, "type": "string"}, "services.elasticsearch.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable elasticsearch.", "loc": ["services", "elasticsearch", "enable"], "readOnly": false, "type": "boolean"}, "services.elasticsearch.extraCmdLineOptions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Extra command line options for the elasticsearch launcher.", "loc": ["services", "elasticsearch", "extraCmdLineOptions"], "readOnly": false, "type": "list of string"}, "services.elasticsearch.extraConf": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Extra configuration for elasticsearch.", "example": {"_type": "literalExpression", "text": "''\n node.name: \"elasticsearch\"\n node.master: true\n node.data: false\n''"}, "loc": ["services", "elasticsearch", "extraConf"], "readOnly": false, "type": "string"}, "services.elasticsearch.extraJavaOptions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Extra command line options for Java.", "example": {"_type": "literalExpression", "text": "[\n \"-Djava.net.preferIPv4Stack=true\"\n]"}, "loc": ["services", "elasticsearch", "extraJavaOptions"], "readOnly": false, "type": "list of string"}, "services.elasticsearch.listenAddress": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "Elasticsearch listen address.", "loc": ["services", "elasticsearch", "listenAddress"], "readOnly": false, "type": "string"}, "services.elasticsearch.logging": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix"}], "default": {"_type": "literalExpression", "text": "''\n logger.action.name = org.elasticsearch.action\n logger.action.level = info\n appender.console.type = Console\n appender.console.name = console\n appender.console.layout.type = PatternLayout\n appender.console.layout.pattern = [%d{ISO8601}][%-5p][%-25c{1.}] %marker%m%n\n rootLogger.level = info\n rootLogger.appenderRef.console.ref = console\n''"}, "description": "Elasticsearch logging configuration.", "loc": ["services", "elasticsearch", "logging"], "readOnly": false, "type": "string"}, "services.elasticsearch.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.elasticsearch7"}, "description": "Elasticsearch package to use.", "loc": ["services", "elasticsearch", "package"], "readOnly": false, "type": "package"}, "services.elasticsearch.plugins": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Extra elasticsearch plugins", "example": {"_type": "literalExpression", "text": "[ pkgs.elasticsearchPlugins.discovery-ec2 ]"}, "loc": ["services", "elasticsearch", "plugins"], "readOnly": false, "type": "list of package"}, "services.elasticsearch.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix"}], "default": {"_type": "literalExpression", "text": "9200"}, "description": "Elasticsearch port to listen for HTTP traffic.", "loc": ["services", "elasticsearch", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.elasticsearch.single_node": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Start a single-node cluster", "loc": ["services", "elasticsearch", "single_node"], "readOnly": false, "type": "boolean"}, "services.elasticsearch.tcp_port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix"}], "default": {"_type": "literalExpression", "text": "9300"}, "description": "Elasticsearch port for the node to node communication.", "loc": ["services", "elasticsearch", "tcp_port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.garage.adminAddress": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1:3903\""}, "description": "IP address and port of the admin API.", "loc": ["services", "garage", "adminAddress"], "readOnly": false, "type": "string"}, "services.garage.adminToken": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix"}], "default": {"_type": "literalExpression", "text": "\"devtoken\""}, "description": "Admin API bearer token. Hard-coded for single-node dev; production\ndeployments override this with a real secret.\n", "loc": ["services", "garage", "adminToken"], "readOnly": false, "type": "string"}, "services.garage.afterStart": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Bash code to execute after the server is running and the cluster\nlayout is applied. The `garage` CLI in scope already points at the\nlocal instance via the generated config.\n", "example": {"_type": "literalExpression", "text": "''\n garage key new --name app-key\n garage bucket allow --read --write --owner my-bucket --key app-key\n''"}, "loc": ["services", "garage", "afterStart"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.garage.buckets": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of buckets to ensure exist on startup.", "loc": ["services", "garage", "buckets"], "readOnly": false, "type": "list of string"}, "services.garage.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Garage S3-compatible object storage.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "garage", "enable"], "readOnly": false, "type": "boolean"}, "services.garage.extraConfig": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Additional `garage.toml` snippet appended to the generated config.\n", "loc": ["services", "garage", "extraConfig"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.garage.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.garage_2"}, "description": "Garage package to use.", "loc": ["services", "garage", "package"], "readOnly": false, "type": "package"}, "services.garage.region": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix"}], "default": {"_type": "literalExpression", "text": "\"us-east-1\""}, "description": "S3 region label reported by the server. Defaults to AWS's canonical\n`us-east-1`.\n", "loc": ["services", "garage", "region"], "readOnly": false, "type": "string"}, "services.garage.replicationFactor": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix"}], "default": {"_type": "literalExpression", "text": "1"}, "description": "Cluster replication factor. Single-node devenv setups always use 1.\n", "loc": ["services", "garage", "replicationFactor"], "readOnly": false, "type": "signed integer"}, "services.garage.rpcSecret": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix"}], "default": {"_type": "literalExpression", "text": "\"0000000000000000000000000000000000000000000000000000000000000000\""}, "description": "RPC secret as 64 hex characters. Hard-coded for single-node dev;\nproduction deployments override this with a real secret.\n", "loc": ["services", "garage", "rpcSecret"], "readOnly": false, "type": "string"}, "services.garage.s3Address": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1:3900\""}, "description": "IP address and port of the S3 API.", "loc": ["services", "garage", "s3Address"], "readOnly": false, "type": "string"}, "services.garage.ui.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable a simple web UI.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "garage", "ui", "enable"], "readOnly": false, "type": "boolean"}, "services.garage.ui.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix"}], "default": {"_type": "literalExpression", "text": "3919"}, "description": "On which port the UI should run.\n", "example": {"_type": "literalExpression", "text": "3919"}, "loc": ["services", "garage", "ui", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.garage.ui.start": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to start the web UI automatically. When false it can be\nstarted manually. Only applies when `ui.enable = true`.\n", "loc": ["services", "garage", "ui", "start"], "readOnly": false, "type": "boolean"}, "services.httpbin.bind": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/httpbin.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/httpbin.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"127.0.0.1:8080\"\n]"}, "description": "Addresses for httpbin to listen on.", "loc": ["services", "httpbin", "bind"], "readOnly": false, "type": "list of string"}, "services.httpbin.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/httpbin.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/httpbin.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable httpbin.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "httpbin", "enable"], "readOnly": false, "type": "boolean"}, "services.httpbin.extraArgs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/httpbin.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/httpbin.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Gunicorn CLI arguments for httpbin.", "loc": ["services", "httpbin", "extraArgs"], "readOnly": false, "type": "list of string"}, "services.influxdb.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/influxdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/influxdb.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable influxdb.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "influxdb", "enable"], "readOnly": false, "type": "boolean"}, "services.influxdb.extraArgs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/influxdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/influxdb.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Additional arguments passed to `influxd` during startup.", "example": {"_type": "literalExpression", "text": "[\n \"--flux-log-enabled\"\n]"}, "loc": ["services", "influxdb", "extraArgs"], "readOnly": false, "type": "list of string"}, "services.influxdb.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/influxdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/influxdb.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.influxdb2-server"}, "description": "Which package of InfluxDB server to use", "loc": ["services", "influxdb", "package"], "readOnly": false, "type": "package"}, "services.influxdb.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/influxdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/influxdb.nix"}], "default": {"_type": "literalExpression", "text": "8086"}, "description": "The TCP port for the InfluxDB HTTP API.", "loc": ["services", "influxdb", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.kafka.configFiles.log4jProperties": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix"}], "default": {"_type": "literalExpression", "text": "\"pkgs.writeText \\\"log4j.properties\\\" cfg.log4jProperties\""}, "description": "Kafka log4j property configuration file path", "loc": ["services", "kafka", "configFiles", "log4jProperties"], "readOnly": false, "type": "absolute path"}, "services.kafka.configFiles.serverProperties": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix"}], "description": "Kafka server.properties configuration file path.\nDefaults to the rendered `settings`.\n", "loc": ["services", "kafka", "configFiles", "serverProperties"], "readOnly": false, "type": "absolute path"}, "services.kafka.connect.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Kafka Connect.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "kafka", "connect", "enable"], "readOnly": false, "type": "boolean"}, "services.kafka.connect.initialConnectors": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of Kafka Connect connectors to set up initially\n", "loc": ["services", "kafka", "connect", "initialConnectors"], "readOnly": false, "type": "list of (open submodule of lazy attribute set of (null or boolean or signed integer or string or list of (boolean or signed integer or string)))"}, "services.kafka.connect.initialConnectors.*.config": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix"}], "description": "Initial configuration for the connector\n", "loc": ["services", "kafka", "connect", "initialConnectors", "*", "config"], "readOnly": false, "type": "attribute set"}, "services.kafka.connect.initialConnectors.*.name": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix"}], "description": "Name of the connector\n", "loc": ["services", "kafka", "connect", "initialConnectors", "*", "name"], "readOnly": false, "type": "string"}, "services.kafka.connect.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "{file}`connect-standalone.properties`.\n\nNote that .properties files contain mappings from string to string.\nKeys with dots are NOT represented by nested attrs in these settings,\nbut instead as quoted strings (ie. `settings.\"broker.id\"`, NOT\n`settings.broker.id`).\n", "loc": ["services", "kafka", "connect", "settings"], "readOnly": false, "type": "open submodule of lazy attribute set of (null or boolean or signed integer or string or list of (boolean or signed integer or string))"}, "services.kafka.connect.settings.\"bootstrap.servers\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"localhost:9092\"\n]"}, "description": "A list of host/port pairs to use for establishing the initial connection to the Kafka cluster.\n", "loc": ["services", "kafka", "connect", "settings", "bootstrap.servers"], "readOnly": false, "type": "list of string"}, "services.kafka.connect.settings.\"key.converter\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix"}], "default": {"_type": "literalExpression", "text": "\"org.apache.kafka.connect.json.JsonConverter\""}, "description": "The key converter to use for the connector.\n", "loc": ["services", "kafka", "connect", "settings", "key.converter"], "readOnly": false, "type": "string"}, "services.kafka.connect.settings.\"key.converter.schemas.enable\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether the key converter should include schema information in the message.\n", "loc": ["services", "kafka", "connect", "settings", "key.converter.schemas.enable"], "readOnly": false, "type": "boolean"}, "services.kafka.connect.settings.\"offset.flush.interval.ms\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix"}], "default": {"_type": "literalExpression", "text": "10000"}, "description": "Interval at which to try committing offsets for tasks\n", "loc": ["services", "kafka", "connect", "settings", "offset.flush.interval.ms"], "readOnly": false, "type": "signed integer"}, "services.kafka.connect.settings.\"offset.storage.file.filename\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix"}], "default": {"_type": "literalExpression", "text": "${config.env.DEVENV_STATE}/kafka/connect/connect.offsets"}, "description": "The file to store connector offsets in. By storing offsets on disk, a standalone process can be stopped and started on a single node and resume where it previously left off.\n", "loc": ["services", "kafka", "connect", "settings", "offset.storage.file.filename"], "readOnly": false, "type": "string"}, "services.kafka.connect.settings.\"plugin.path\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The list should consist of top level directories that include any combination of:\na) directories immediately containing jars with plugins and their dependencies\nb) uber-jars with plugins and their dependencies\nc) directories immediately containing the package directory structure of classes of plugins and their dependencies\nNote: symlinks will be followed to discover dependencies or plugins.\n", "loc": ["services", "kafka", "connect", "settings", "plugin.path"], "readOnly": false, "type": "null or (list of (string or absolute path))"}, "services.kafka.connect.settings.\"value.converter\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix"}], "default": {"_type": "literalExpression", "text": "\"org.apache.kafka.connect.json.JsonConverter\""}, "description": "The value converter to use for the connector.\n", "loc": ["services", "kafka", "connect", "settings", "value.converter"], "readOnly": false, "type": "string"}, "services.kafka.connect.settings.\"value.converter.schemas.enable\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether the value converter should include schema information in the message.\n", "loc": ["services", "kafka", "connect", "settings", "value.converter.schemas.enable"], "readOnly": false, "type": "boolean"}, "services.kafka.connect.settings.listeners": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "List of listeners for Kafka Connect\n(By default Kafka Connect listens on http://localhost:8083)\n", "example": {"_type": "literalExpression", "text": "[\n \"http://localhost:8080\"\n]"}, "loc": ["services", "kafka", "connect", "settings", "listeners"], "readOnly": false, "type": "null or (list of string)"}, "services.kafka.defaultMode": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix"}], "default": {"_type": "literalExpression", "text": "\"kraft\""}, "description": "Which defaults to set for the mode Kafka should run in\n- `kraft` (default): Run Kafka in KRaft mode, Which requires no extra configuration.\n- `zookeeper`: Run Kafka in Zookeeper mode, this requires more configuration.\n", "loc": ["services", "kafka", "defaultMode"], "readOnly": false, "type": "one of \"zookeeper\", \"kraft\""}, "services.kafka.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Apache Kafka.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "kafka", "enable"], "readOnly": false, "type": "boolean"}, "services.kafka.formatLogDirs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to format log dirs in KRaft mode if all log dirs are\nunformatted, ie. they contain no meta.properties.\n", "loc": ["services", "kafka", "formatLogDirs"], "readOnly": false, "type": "boolean"}, "services.kafka.formatLogDirsIgnoreFormatted": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to ignore already formatted log dirs when formatting log dirs,\ninstead of failing. Useful when replacing or adding disks.\n", "loc": ["services", "kafka", "formatLogDirsIgnoreFormatted"], "readOnly": false, "type": "boolean"}, "services.kafka.jre": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.apacheKafka.passthru.jre"}, "description": "The JRE with which to run Kafka", "loc": ["services", "kafka", "jre"], "readOnly": false, "type": "package"}, "services.kafka.jvmOptions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Extra command line options for the JVM running Kafka.", "example": {"_type": "literalExpression", "text": "[\n \"-Djava.net.preferIPv4Stack=true\"\n \"-Dcom.sun.management.jmxremote\"\n \"-Dcom.sun.management.jmxremote.local.only=true\"\n]"}, "loc": ["services", "kafka", "jvmOptions"], "readOnly": false, "type": "list of string"}, "services.kafka.log4jProperties": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix"}], "default": {"_type": "literalExpression", "text": "''\n log4j.rootLogger=INFO, stdout\n \n log4j.appender.stdout=org.apache.log4j.ConsoleAppender\n log4j.appender.stdout.layout=org.apache.log4j.PatternLayout\n log4j.appender.stdout.layout.ConversionPattern=[%d] %p %m (%c)%n\n''"}, "description": "Kafka log4j property configuration.", "loc": ["services", "kafka", "log4jProperties"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.kafka.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.apacheKafka"}, "description": "The apacheKafka package to use.", "loc": ["services", "kafka", "package"], "readOnly": false, "type": "package"}, "services.kafka.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "[Kafka broker configuration](https://kafka.apache.org/documentation.html#brokerconfigs)\n{file}`server.properties`.\n\nNote that .properties files contain mappings from string to string.\nKeys with dots are NOT represented by nested attrs in these settings,\nbut instead as quoted strings (ie. `settings.\"broker.id\"`, NOT\n`settings.broker.id`).\n", "loc": ["services", "kafka", "settings"], "readOnly": false, "type": "open submodule of lazy attribute set of (null or boolean or signed integer or string or list of (boolean or signed integer or string))"}, "services.kafka.settings.\"broker.id\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Broker ID. -1 or null to auto-allocate in zookeeper mode.", "loc": ["services", "kafka", "settings", "broker.id"], "readOnly": false, "type": "null or signed integer"}, "services.kafka.settings.\"log.dirs\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix"}], "default": {"_type": "literalExpression", "text": "[ \"${config.devenv.state + \"/kafka\"}/logs\" ]"}, "description": "Log file directories.", "loc": ["services", "kafka", "settings", "log.dirs"], "readOnly": false, "type": "list of absolute path"}, "services.kafka.settings.listeners": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"PLAINTEXT://localhost:9092\"\n]"}, "description": "Kafka Listener List.\nSee [listeners](https://kafka.apache.org/documentation/#brokerconfigs_listeners).\nIf you change this, you should also update the readiness probe.\n", "loc": ["services", "kafka", "settings", "listeners"], "readOnly": false, "type": "list of string"}, "services.keycloak.database.type": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "\"dev-file\""}, "description": "The type of database Keycloak should connect to.\nIf you use `dev-mem`, the realm export over script\n`keycloak-realm-export-*` does not work.\n", "example": {"_type": "literalExpression", "text": "\"dev-mem\""}, "loc": ["services", "keycloak", "database", "type"], "readOnly": false, "type": "one of \"dev-mem\", \"dev-file\""}, "services.keycloak.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable the Keycloak identity and access management\nserver.\n", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "keycloak", "enable"], "readOnly": false, "type": "boolean"}, "services.keycloak.initialAdminPassword": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "\"admin\""}, "description": "Initial password set for the temporary `admin` user.\nThe password is not stored safely and should be changed\nimmediately in the admin panel.\n\nSee [Admin bootstrap and recovery](https://www.keycloak.org/server/bootstrap-admin-recovery) for details.\n", "loc": ["services", "keycloak", "initialAdminPassword"], "readOnly": false, "type": "string"}, "services.keycloak.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.keycloak"}, "description": "The keycloak package to use.", "loc": ["services", "keycloak", "package"], "readOnly": false, "type": "package"}, "services.keycloak.plugins": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Keycloak plugin jar, ear files or derivations containing\nthem. Packaged plugins are available through\n`pkgs.keycloak.plugins`.\n", "loc": ["services", "keycloak", "plugins"], "readOnly": false, "type": "list of absolute path"}, "services.keycloak.processes.exportRealms": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Global toggle to enable/disable the realms export process `keycloak-realm-export-all`\nif any realms have `realms.\u00abname\u00bb.export == true`.\n", "loc": ["services", "keycloak", "processes", "exportRealms"], "readOnly": false, "type": "boolean"}, "services.keycloak.realms": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Specify the realms you want to import on start up and\nexport on a manual start of process/script 'keycloak-realm-export-all'.\n", "example": {"_type": "literalExpression", "text": "{\n myrealm = {\n path = \"./myfolder/export.json\";\n import = true; # default\n export = true;\n };\n}\n"}, "loc": ["services", "keycloak", "realms"], "readOnly": false, "type": "attribute set of (submodule)"}, "services.keycloak.realms..export": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "If you want to export that realm on process/script launch `keycloak-export-realms`.\n", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "keycloak", "realms", "", "export"], "readOnly": false, "type": "boolean"}, "services.keycloak.realms..import": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "If you want to import that realm on start up, if the realm does not yet exist.\n", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "keycloak", "realms", "", "import"], "readOnly": false, "type": "boolean"}, "services.keycloak.realms..path": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The path (string, relative to `DEVENV_ROOT`) where you want to import (or export) this realm \u00abname\u00bb to.\nIf not set and `import` is `true` this realm is not imported.\nIf not set and `export` is `true` its exported to `$DEVENV_STATE/keycloak/realm-export/\u00abname\u00bb.json`.\n", "example": {"_type": "literalExpression", "text": "\"./realms/a.json\""}, "loc": ["services", "keycloak", "realms", "", "path"], "readOnly": false, "type": "null or relative path not in the Nix store"}, "services.keycloak.scripts.exportRealm": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Global toggle to enable/disable the **single** realm export\nscript `keycloak-realm-export`.\n", "loc": ["services", "keycloak", "scripts", "exportRealm"], "readOnly": false, "type": "boolean"}, "services.keycloak.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "description": "Configuration options corresponding to parameters set in\n{file}`conf/keycloak.conf`.\n\nMost available options are documented at .\n\nOptions containing secret data should be set to an attribute\nset containing the attribute `_secret` - a\nstring pointing to a file containing the value the option\nshould be set to. See the example to get a better picture of\nthis: in the resulting\n{file}`conf/keycloak.conf` file, the\n`https-key-store-password` key will be set\nto the contents of the\n{file}`/run/keys/store_password` file.\n", "example": {"_type": "literalExpression", "text": "{\n hostname = \"localhost\";\n https-key-store-file = \"/path/to/file\";\n https-key-store-password = { _secret = \"/run/keys/store_password\"; };\n}\n"}, "loc": ["services", "keycloak", "settings"], "readOnly": false, "type": "open submodule of attribute set of (null or string or signed integer or boolean or attribute set of absolute path)"}, "services.keycloak.settings.hostname": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "\"localhost\""}, "description": "The hostname part of the public URL used as base for\nall frontend requests.\n\nSee \nfor more information about hostname configuration.\n", "example": {"_type": "literalExpression", "text": "\"localhost\""}, "loc": ["services", "keycloak", "settings", "hostname"], "readOnly": false, "type": "string"}, "services.keycloak.settings.http-host": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "\"::\""}, "description": "On which address Keycloak should accept new connections.\n", "example": {"_type": "literalExpression", "text": "\"::1\""}, "loc": ["services", "keycloak", "settings", "http-host"], "readOnly": false, "type": "string"}, "services.keycloak.settings.http-port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "8080"}, "description": "On which port Keycloak should listen for new HTTP connections.\n", "example": {"_type": "literalExpression", "text": "8080"}, "loc": ["services", "keycloak", "settings", "http-port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.keycloak.settings.http-relative-path": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "\"/\""}, "description": "The path relative to `/` for serving\nresources.\n\n::: {.note}\nIn versions of Keycloak using Wildfly (<17),\nthis defaulted to `/auth`. If\nupgrading from the Wildfly version of Keycloak,\ni.e. a NixOS version before 22.05, you'll likely\nwant to set this to `/auth` to\nkeep compatibility with your clients.\n\nSee \nfor more information on migrating from Wildfly to Quarkus.\n:::\n", "example": {"_type": "literalExpression", "text": "\"/auth\""}, "loc": ["services", "keycloak", "settings", "http-relative-path"], "readOnly": false, "type": "string"}, "services.keycloak.settings.https-port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "34429"}, "description": "On which port Keycloak should listen for new HTTPS connections.\nIf its not set, its disabled.\n", "example": {"_type": "literalExpression", "text": "34429"}, "loc": ["services", "keycloak", "settings", "https-port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.keycloak.sslCertificate": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The path to a PEM formatted certificate to use for TLS/SSL\nconnections.\n", "example": {"_type": "literalExpression", "text": "\"/run/keys/ssl_cert\""}, "loc": ["services", "keycloak", "sslCertificate"], "readOnly": false, "type": "null or relative path not in the Nix store"}, "services.keycloak.sslCertificateKey": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The path to a PEM formatted private key to use for TLS/SSL\nconnections.\n", "example": {"_type": "literalExpression", "text": "\"/run/keys/ssl_key\""}, "loc": ["services", "keycloak", "sslCertificateKey"], "readOnly": false, "type": "null or relative path not in the Nix store"}, "services.mailhog.additionalArgs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Additional arguments passed to `mailhog`.\n", "example": {"_type": "literalExpression", "text": "[\n \"-invite-jim\"\n]"}, "loc": ["services", "mailhog", "additionalArgs"], "readOnly": false, "type": "list of strings concatenated with \"\\n\""}, "services.mailhog.apiListenAddress": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1:8025\""}, "description": "Listen address for API.", "loc": ["services", "mailhog", "apiListenAddress"], "readOnly": false, "type": "string"}, "services.mailhog.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable mailhog process.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "mailhog", "enable"], "readOnly": false, "type": "boolean"}, "services.mailhog.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.mailhog"}, "description": "Which package of mailhog to use", "loc": ["services", "mailhog", "package"], "readOnly": false, "type": "package"}, "services.mailhog.smtpListenAddress": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1:1025\""}, "description": "Listen address for SMTP.", "loc": ["services", "mailhog", "smtpListenAddress"], "readOnly": false, "type": "string"}, "services.mailhog.uiListenAddress": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1:8025\""}, "description": "Listen address for UI.", "loc": ["services", "mailhog", "uiListenAddress"], "readOnly": false, "type": "string"}, "services.mailpit.additionalArgs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Additional arguments passed to `mailpit`.\n", "example": {"_type": "literalExpression", "text": "[\n \"--max=500\"\n]"}, "loc": ["services", "mailpit", "additionalArgs"], "readOnly": false, "type": "list of strings concatenated with \"\\n\""}, "services.mailpit.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable mailpit process.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "mailpit", "enable"], "readOnly": false, "type": "boolean"}, "services.mailpit.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.mailpit"}, "description": "Which package of mailpit to use", "loc": ["services", "mailpit", "package"], "readOnly": false, "type": "package"}, "services.mailpit.smtpListenAddress": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1:1025\""}, "description": "Listen address for SMTP.", "loc": ["services", "mailpit", "smtpListenAddress"], "readOnly": false, "type": "string"}, "services.mailpit.uiListenAddress": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1:8025\""}, "description": "Listen address for UI.", "loc": ["services", "mailpit", "uiListenAddress"], "readOnly": false, "type": "string"}, "services.meilisearch.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Meilisearch.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "meilisearch", "enable"], "readOnly": false, "type": "boolean"}, "services.meilisearch.environment": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix"}], "default": {"_type": "literalExpression", "text": "\"development\""}, "description": "Defines the running environment of Meilisearch.", "loc": ["services", "meilisearch", "environment"], "readOnly": false, "type": "one of \"development\", \"production\""}, "services.meilisearch.listenAddress": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "Meilisearch listen address.", "loc": ["services", "meilisearch", "listenAddress"], "readOnly": false, "type": "string"}, "services.meilisearch.listenPort": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix"}], "default": {"_type": "literalExpression", "text": "7700"}, "description": "Meilisearch port to listen on.", "loc": ["services", "meilisearch", "listenPort"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.meilisearch.logLevel": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix"}], "default": {"_type": "literalExpression", "text": "\"INFO\""}, "description": "Defines how much detail should be present in Meilisearch's logs.\nMeilisearch currently supports four log levels, listed in order of increasing verbosity:\n- 'ERROR': only log unexpected events indicating Meilisearch is not functioning as expected\n- 'WARN:' log all unexpected events, regardless of their severity\n- 'INFO:' log all events. This is the default value\n- 'DEBUG': log all events and including detailed information on Meilisearch's internal processes.\n Useful when diagnosing issues and debugging\n", "loc": ["services", "meilisearch", "logLevel"], "readOnly": false, "type": "string"}, "services.meilisearch.maxIndexSize": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix"}], "default": {"_type": "literalExpression", "text": "\"107374182400\""}, "description": "Sets the maximum size of the index.\nValue must be given in bytes or explicitly stating a base unit.\nFor example, the default value can be written as 107374182400, '107.7Gb', or '107374 Mb'.\nDefault is 100 GiB\n", "loc": ["services", "meilisearch", "maxIndexSize"], "readOnly": false, "type": "string"}, "services.meilisearch.noAnalytics": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Deactivates analytics.\nAnalytics allow Meilisearch to know how many users are using Meilisearch,\nwhich versions and which platforms are used.\nThis process is entirely anonymous.\n", "loc": ["services", "meilisearch", "noAnalytics"], "readOnly": false, "type": "boolean"}, "services.meilisearch.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix"}], "default": {"_type": "literalExpression", "text": "\"pkgs.meilisearch\""}, "description": "Which Meilisearch package to use", "loc": ["services", "meilisearch", "package"], "readOnly": false, "type": "package"}, "services.memcached.bind": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/memcached.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/memcached.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "The IP interface to bind to.\n`null` means \"all interfaces\".\n", "example": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "loc": ["services", "memcached", "bind"], "readOnly": false, "type": "null or string"}, "services.memcached.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/memcached.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/memcached.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable memcached process.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "memcached", "enable"], "readOnly": false, "type": "boolean"}, "services.memcached.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/memcached.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/memcached.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.memcached"}, "description": "Which package of memcached to use", "loc": ["services", "memcached", "package"], "readOnly": false, "type": "package"}, "services.memcached.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/memcached.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/memcached.nix"}], "default": {"_type": "literalExpression", "text": "11211"}, "description": "The TCP port to accept connections.\nIf port 0 is specified memcached will not listen on a TCP socket.\n", "loc": ["services", "memcached", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.memcached.startArgs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/memcached.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/memcached.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Additional arguments passed to `memcached` during startup.\n", "example": {"_type": "literalExpression", "text": "[\n \"--memory-limit=100M\"\n]"}, "loc": ["services", "memcached", "startArgs"], "readOnly": false, "type": "list of strings concatenated with \"\\n\""}, "services.minio.accessKey": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix"}], "default": {"_type": "literalExpression", "text": "\"minioadmin\""}, "description": "Access key of 5 to 20 characters in length that clients use to access the server.\n", "loc": ["services", "minio", "accessKey"], "readOnly": false, "type": "string"}, "services.minio.afterStart": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Bash code to execute after minio is running.", "example": {"_type": "literalExpression", "text": "''\n mc anonymous set download local/mybucket\n''"}, "loc": ["services", "minio", "afterStart"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.minio.browser": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Enable or disable access to web UI.", "loc": ["services", "minio", "browser"], "readOnly": false, "type": "boolean"}, "services.minio.buckets": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of buckets to ensure exist on startup.\n", "loc": ["services", "minio", "buckets"], "readOnly": false, "type": "list of string"}, "services.minio.clientConfig": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix"}], "description": "Contents of the mc `config.json`, as a nix attribute set.\n\nBy default, `local` is configured to connect to the devenv minio service.\nUse `lib.mkForce null` to use your regular mc configuration from `$HOME/.mc` instead.\n", "loc": ["services", "minio", "clientConfig"], "readOnly": false, "type": "null or JSON value"}, "services.minio.clientPackage": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.minio-client"}, "description": "MinIO client package to use.", "loc": ["services", "minio", "clientPackage"], "readOnly": false, "type": "package"}, "services.minio.consoleAddress": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1:9001\""}, "description": "IP address and port of the web UI (console).", "loc": ["services", "minio", "consoleAddress"], "readOnly": false, "type": "string"}, "services.minio.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable MinIO Object Storage.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "minio", "enable"], "readOnly": false, "type": "boolean"}, "services.minio.listenAddress": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1:9000\""}, "description": "IP address and port of the server.", "loc": ["services", "minio", "listenAddress"], "readOnly": false, "type": "string"}, "services.minio.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.minio"}, "description": "MinIO package to use.", "loc": ["services", "minio", "package"], "readOnly": false, "type": "package"}, "services.minio.region": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix"}], "default": {"_type": "literalExpression", "text": "\"us-east-1\""}, "description": "The physical location of the server. By default it is set to us-east-1, which is same as AWS S3's and MinIO's default region.\n", "loc": ["services", "minio", "region"], "readOnly": false, "type": "string"}, "services.minio.secretKey": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix"}], "default": {"_type": "literalExpression", "text": "\"minioadmin\""}, "description": "Specify the Secret key of 8 to 40 characters in length that clients use to access the server.\n", "loc": ["services", "minio", "secretKey"], "readOnly": false, "type": "string"}, "services.mongodb.additionalArgs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"--noauth\"\n]"}, "description": "Additional arguments passed to `mongod`.\n", "example": {"_type": "literalExpression", "text": "[\n \"--port\"\n \"27017\"\n \"--noauth\"\n]"}, "loc": ["services", "mongodb", "additionalArgs"], "readOnly": false, "type": "list of strings concatenated with \"\\n\""}, "services.mongodb.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable MongoDB process and expose utilities.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "mongodb", "enable"], "readOnly": false, "type": "boolean"}, "services.mongodb.initDatabasePassword": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "This used in conjunction with initDatabaseUsername, create a new user and set that user's password. This user is created in the admin authentication database and given the role of root, which is a \"superuser\" role.\n", "example": {"_type": "literalExpression", "text": "\"secret\""}, "loc": ["services", "mongodb", "initDatabasePassword"], "readOnly": false, "type": "string"}, "services.mongodb.initDatabaseUsername": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "This used in conjunction with initDatabasePassword, create a new user and set that user's password. This user is created in the admin authentication database and given the role of root, which is a \"superuser\" role.\n", "example": {"_type": "literalExpression", "text": "\"mongoadmin\""}, "loc": ["services", "mongodb", "initDatabaseUsername"], "readOnly": false, "type": "string"}, "services.mongodb.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.mongodb-ce"}, "description": "Which MongoDB package to use.", "loc": ["services", "mongodb", "package"], "readOnly": false, "type": "package"}, "services.mongodb.replication.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable MongoDB replication with a 1-node replica-set..", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "mongodb", "replication", "enable"], "readOnly": false, "type": "boolean"}, "services.mongodb.replication.replSet": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix"}], "default": {"_type": "literalExpression", "text": "\"rs0\""}, "description": "Replica-set name", "example": {"_type": "literalExpression", "text": "\"rs0\""}, "loc": ["services", "mongodb", "replication", "replSet"], "readOnly": false, "type": "string"}, "services.mosquitto.bind": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mosquitto.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mosquitto.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "The IP interface to bind to.\n`null` means \"all interfaces\".\n", "example": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "loc": ["services", "mosquitto", "bind"], "readOnly": false, "type": "null or string"}, "services.mosquitto.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mosquitto.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mosquitto.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable mosquitto MQTT broker.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "mosquitto", "enable"], "readOnly": false, "type": "boolean"}, "services.mosquitto.extraConfig": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mosquitto.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mosquitto.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Additional text to append to `mosquitto.conf`.", "example": {"_type": "literalExpression", "text": "''\n max_queued_messages 1000\n''"}, "loc": ["services", "mosquitto", "extraConfig"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.mosquitto.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mosquitto.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mosquitto.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.mosquitto"}, "description": "Which package of mosquitto to use", "loc": ["services", "mosquitto", "package"], "readOnly": false, "type": "package"}, "services.mosquitto.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mosquitto.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mosquitto.nix"}], "default": {"_type": "literalExpression", "text": "1883"}, "description": "The TCP port to accept MQTT connections.", "loc": ["services", "mosquitto", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.mysql.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable MySQL process and expose utilities.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "mysql", "enable"], "readOnly": false, "type": "boolean"}, "services.mysql.ensureUsers": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Ensures that the specified users exist and have at least the ensured permissions.\nThe MySQL users will be identified using Unix socket authentication. This authenticates the Unix user with the\nsame name only, and that without the need for a password.\nThis option will never delete existing users or remove permissions, especially not when the value of this\noption is changed. This means that users created and permissions assigned once through this option or\notherwise have to be removed manually.\n", "example": {"_type": "literalExpression", "text": "[\n {\n name = \"devenv\";\n ensurePermissions = {\n \"devenv.*\" = \"ALL PRIVILEGES\";\n };\n }\n]\n"}, "loc": ["services", "mysql", "ensureUsers"], "readOnly": false, "type": "list of (submodule)"}, "services.mysql.ensureUsers.*.ensurePermissions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Permissions to ensure for the user, specified as attribute set.\nThe attribute names specify the database and tables to grant the permissions for,\nseparated by a dot. You may use wildcards here.\nThe attribute values specfiy the permissions to grant.\nYou may specify one or multiple comma-separated SQL privileges here.\nFor more information on how to specify the target\nand on which privileges exist, see the\n[GRANT syntax](https://mariadb.com/kb/en/library/grant/).\nThe attributes are used as `GRANT ${attrName} ON ${attrValue}`.\n", "example": {"_type": "literalExpression", "text": "{\n \"database.*\" = \"ALL PRIVILEGES\";\n \"*.*\" = \"SELECT, LOCK TABLES\";\n}\n"}, "loc": ["services", "mysql", "ensureUsers", "*", "ensurePermissions"], "readOnly": false, "type": "attribute set of string"}, "services.mysql.ensureUsers.*.host": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix"}], "default": {"_type": "literalExpression", "text": "\"localhost\""}, "description": "Host of the user to ensure.\n", "loc": ["services", "mysql", "ensureUsers", "*", "host"], "readOnly": false, "type": "string"}, "services.mysql.ensureUsers.*.name": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix"}], "description": "Name of the user to ensure.\n", "loc": ["services", "mysql", "ensureUsers", "*", "name"], "readOnly": false, "type": "string"}, "services.mysql.ensureUsers.*.password": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Password of the user to ensure.\n", "loc": ["services", "mysql", "ensureUsers", "*", "password"], "readOnly": false, "type": "null or string"}, "services.mysql.importTimeZones": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to import tzdata on the first startup of the mysql server\n", "loc": ["services", "mysql", "importTimeZones"], "readOnly": false, "type": "null or boolean"}, "services.mysql.initialDatabases": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of database names and their initial schemas that should be used to create databases on the first startup\nof MySQL. The schema attribute is optional: If not specified, an empty database is created.\n", "example": {"_type": "literalExpression", "text": "[\n { name = \"foodatabase\"; schema = ./foodatabase.sql; }\n { name = \"bardatabase\"; }\n]\n"}, "loc": ["services", "mysql", "initialDatabases"], "readOnly": false, "type": "list of (submodule)"}, "services.mysql.initialDatabases.*.name": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix"}], "description": "The name of the database to create.\n", "loc": ["services", "mysql", "initialDatabases", "*", "name"], "readOnly": false, "type": "string"}, "services.mysql.initialDatabases.*.schema": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The initial schema of the database; if null (the default),\nan empty database is created.\n", "loc": ["services", "mysql", "initialDatabases", "*", "schema"], "readOnly": false, "type": "null or absolute path"}, "services.mysql.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.mariadb"}, "description": "Which package of MySQL to use", "loc": ["services", "mysql", "package"], "readOnly": false, "type": "package"}, "services.mysql.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "MySQL configuration.\n", "example": {"_type": "literalExpression", "text": "{\n mysqld = {\n key_buffer_size = \"6G\";\n table_cache = 1600;\n log-error = \"/var/log/mysql_err.log\";\n plugin-load-add = [ \"server_audit\" \"ed25519=auth_ed25519\" ];\n };\n mysqldump = {\n quick = true;\n max_allowed_packet = \"16M\";\n };\n}\n"}, "loc": ["services", "mysql", "settings"], "readOnly": false, "type": "lazy attribute set of lazy attribute set of anything"}, "services.mysql.useDefaultsExtraFile": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to use defaults-exta-file for the mysql command instead of defaults-file.\nThis is useful if you want to provide a config file on the command line.\nHowever this can problematic if you have MySQL installed globaly because its config might leak into your environment.\nThis option does not affect the mysqld command.\n", "loc": ["services", "mysql", "useDefaultsExtraFile"], "readOnly": false, "type": "boolean"}, "services.nats.authorization.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable authorization for client connections.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "nats", "authorization", "enable"], "readOnly": false, "type": "boolean"}, "services.nats.authorization.password": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Password required for client connections.\nOnly used if authorization is enabled.\nWarning: This will be visible in the Nix store.\n", "example": {"_type": "literalExpression", "text": "\"nats-pass\""}, "loc": ["services", "nats", "authorization", "password"], "readOnly": false, "type": "string"}, "services.nats.authorization.token": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Token required for client connections.\nAlternative to user/password authentication.\nWarning: This will be visible in the Nix store.\n", "example": {"_type": "literalExpression", "text": "\"my-secret-token\""}, "loc": ["services", "nats", "authorization", "token"], "readOnly": false, "type": "string"}, "services.nats.authorization.user": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Username required for client connections.\nOnly used if authorization is enabled.\n", "example": {"_type": "literalExpression", "text": "\"nats-user\""}, "loc": ["services", "nats", "authorization", "user"], "readOnly": false, "type": "string"}, "services.nats.clientAdvertise": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Client URL to advertise to other servers in a cluster.\nUseful when running behind NAT or in containers.\n", "example": {"_type": "literalExpression", "text": "\"localhost:4222\""}, "loc": ["services", "nats", "clientAdvertise"], "readOnly": false, "type": "string"}, "services.nats.debug": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Enable debug logging for troubleshooting.\n", "loc": ["services", "nats", "debug"], "readOnly": false, "type": "boolean"}, "services.nats.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable the NATS messaging server.\n\nNATS is a simple, secure and high performance messaging\nsystem for cloud native applications, IoT messaging,\nand microservices architectures.\n", "loc": ["services", "nats", "enable"], "readOnly": false, "type": "boolean"}, "services.nats.host": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "Network host to listen on for client connections.\nSet to \"0.0.0.0\" to listen on all interfaces.\nDefault is localhost for security.\n", "example": {"_type": "literalExpression", "text": "\"0.0.0.0\""}, "loc": ["services", "nats", "host"], "readOnly": false, "type": "string"}, "services.nats.jetstream.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable JetStream persistence layer for streaming and queues.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "nats", "jetstream", "enable"], "readOnly": false, "type": "boolean"}, "services.nats.jetstream.maxFileStore": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "\"10G\""}, "description": "Maximum disk space for file-based streams.\nUse suffixes: K, M, G, T for sizes.\n", "example": {"_type": "literalExpression", "text": "\"100G\""}, "loc": ["services", "nats", "jetstream", "maxFileStore"], "readOnly": false, "type": "string"}, "services.nats.jetstream.maxMemory": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "\"1G\""}, "description": "Maximum memory for in-memory streams.\nUse suffixes: K, M, G, T for sizes.\n", "example": {"_type": "literalExpression", "text": "\"512M\""}, "loc": ["services", "nats", "jetstream", "maxMemory"], "readOnly": false, "type": "string"}, "services.nats.logFile": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to log file. If empty, logs to stdout.\nStdout is recommended for devenv as logs are captured by process manager.\n", "example": {"_type": "literalExpression", "text": "\"/var/log/nats-server.log\""}, "loc": ["services", "nats", "logFile"], "readOnly": false, "type": "string"}, "services.nats.monitoring.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Enable HTTP monitoring endpoint.\nProvides /healthz, /varz, /connz, and other monitoring endpoints.\nHighly recommended for production deployments.\n", "loc": ["services", "nats", "monitoring", "enable"], "readOnly": false, "type": "boolean"}, "services.nats.monitoring.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "8222"}, "description": "Port for HTTP monitoring endpoint.\nAccess monitoring at `http://host:port/varz`\n", "loc": ["services", "nats", "monitoring", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.nats.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.nats-server"}, "description": "Which NATS server package to use.\n", "loc": ["services", "nats", "package"], "readOnly": false, "type": "package"}, "services.nats.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "4222"}, "description": "Port to listen on for client connections.\n", "loc": ["services", "nats", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.nats.serverName": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Server name for identification in clusters.\nIf empty, NATS will auto-generate a unique name.\n", "example": {"_type": "literalExpression", "text": "\"nats-dev-1\""}, "loc": ["services", "nats", "serverName"], "readOnly": false, "type": "string"}, "services.nats.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Additional NATS server configuration as a Nix attribute set.\nThis will be converted to NATS config file format.\n\nUse this for advanced features like:\n- TLS/SSL configuration\n- Clustering with routes\n- MQTT gateway\n- WebSocket support\n- Custom authorization\n\nSee https://docs.nats.io/running-a-nats-service/configuration\n", "example": {"_type": "literalExpression", "text": "{\n tls = {\n cert_file = \"/path/to/cert.pem\";\n key_file = \"/path/to/key.pem\";\n verify = true;\n };\n cluster = {\n name = \"my-cluster\";\n listen = \"0.0.0.0:6222\";\n routes = [\n \"nats://node1:6222\"\n \"nats://node2:6222\"\n ];\n };\n}\n"}, "loc": ["services", "nats", "settings"], "readOnly": false, "type": "attribute set"}, "services.nats.trace": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Enable protocol tracing for deep debugging.\nWarning: Very verbose output.\n", "loc": ["services", "nats", "trace"], "readOnly": false, "type": "boolean"}, "services.nginx.defaultMimeTypes": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nginx.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nginx.nix"}], "default": {"_type": "literalExpression", "text": "${pkgs.mailcap}/etc/nginx/mime.types"}, "description": "Default MIME types for NGINX, as MIME types definitions from NGINX are very incomplete,\nwe use by default the ones bundled in the mailcap package, used by most of the other\nLinux distributions.\n", "example": {"_type": "literalExpression", "text": "${pkgs.nginx}/conf/mime.types"}, "loc": ["services", "nginx", "defaultMimeTypes"], "readOnly": false, "type": "absolute path"}, "services.nginx.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nginx.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nginx.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable nginx.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "nginx", "enable"], "readOnly": false, "type": "boolean"}, "services.nginx.eventsConfig": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nginx.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nginx.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "The nginx events configuration.", "loc": ["services", "nginx", "eventsConfig"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.nginx.httpConfig": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nginx.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nginx.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "The nginx configuration.", "loc": ["services", "nginx", "httpConfig"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.nginx.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nginx.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nginx.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.nginx"}, "description": "The nginx package to use.", "loc": ["services", "nginx", "package"], "readOnly": false, "type": "package"}, "services.nixseparatedebuginfod.cache.directory": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nixseparatedebuginfod.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nixseparatedebuginfod.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Override the directory where files downloaded from the substituter are stored.\n\nDefault is `$XDG_CACHE_DIR/nixseparatedebuginfod2`.\n", "loc": ["services", "nixseparatedebuginfod", "cache", "directory"], "readOnly": false, "type": "null or string"}, "services.nixseparatedebuginfod.cache.expiration": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nixseparatedebuginfod.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nixseparatedebuginfod.nix"}], "default": {"_type": "literalExpression", "text": "\"1d\""}, "description": "How long to keep cache entries.\nA number followed by a unit.\n", "loc": ["services", "nixseparatedebuginfod", "cache", "expiration"], "readOnly": false, "type": "string"}, "services.nixseparatedebuginfod.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nixseparatedebuginfod.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nixseparatedebuginfod.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable nixseparatedebuginfod.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "nixseparatedebuginfod", "enable"], "readOnly": false, "type": "boolean"}, "services.nixseparatedebuginfod.host": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nixseparatedebuginfod.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nixseparatedebuginfod.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "IP address for nixseparatedebuginfod to listen on.", "loc": ["services", "nixseparatedebuginfod", "host"], "readOnly": false, "type": "string"}, "services.nixseparatedebuginfod.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nixseparatedebuginfod.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nixseparatedebuginfod.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.nixseparatedebuginfod2"}, "description": "nixseparatedebuginfod package to use.", "loc": ["services", "nixseparatedebuginfod", "package"], "readOnly": false, "type": "package"}, "services.nixseparatedebuginfod.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nixseparatedebuginfod.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nixseparatedebuginfod.nix"}], "default": {"_type": "literalExpression", "text": "1949"}, "description": "Port for nixseparatedebuginfod to listen on.", "loc": ["services", "nixseparatedebuginfod", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.nixseparatedebuginfod.substituters": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nixseparatedebuginfod.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nixseparatedebuginfod.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"local:\"\n \"https://cache.nixos.org\"\n]"}, "description": "Substituters to fetch debuginfo from.\n", "loc": ["services", "nixseparatedebuginfod", "substituters"], "readOnly": false, "type": "list of string"}, "services.opensearch.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable OpenSearch.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "opensearch", "enable"], "readOnly": false, "type": "boolean"}, "services.opensearch.extraCmdLineOptions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Extra command line options for the OpenSearch launcher.", "loc": ["services", "opensearch", "extraCmdLineOptions"], "readOnly": false, "type": "list of string"}, "services.opensearch.extraJavaOptions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Extra command line options for Java.", "example": {"_type": "literalExpression", "text": "[\n \"-Djava.net.preferIPv4Stack=true\"\n]"}, "loc": ["services", "opensearch", "extraJavaOptions"], "readOnly": false, "type": "list of string"}, "services.opensearch.logging": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix"}], "default": {"_type": "literalExpression", "text": "''\n logger.action.name = org.opensearch.action\n logger.action.level = info\n appender.console.type = Console\n appender.console.name = console\n appender.console.layout.type = PatternLayout\n appender.console.layout.pattern = [%d{ISO8601}][%-5p][%-25c{1.}] %marker%m%n\n rootLogger.level = info\n rootLogger.appenderRef.console.ref = console\n''"}, "description": "OpenSearch logging configuration.", "loc": ["services", "opensearch", "logging"], "readOnly": false, "type": "string"}, "services.opensearch.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.opensearch"}, "description": "The OpenSearch package to use.", "loc": ["services", "opensearch", "package"], "readOnly": false, "type": "package"}, "services.opensearch.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "OpenSearch configuration.\n", "loc": ["services", "opensearch", "settings"], "readOnly": false, "type": "open submodule of (YAML 1.1 value)"}, "services.opensearch.settings.\"cluster.name\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix"}], "default": {"_type": "literalExpression", "text": "\"opensearch\""}, "description": "The name of the cluster.\n", "loc": ["services", "opensearch", "settings", "cluster.name"], "readOnly": false, "type": "string"}, "services.opensearch.settings.\"discovery.type\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix"}], "default": {"_type": "literalExpression", "text": "\"single-node\""}, "description": "The type of discovery to use.\n", "loc": ["services", "opensearch", "settings", "discovery.type"], "readOnly": false, "type": "string"}, "services.opensearch.settings.\"http.port\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix"}], "default": {"_type": "literalExpression", "text": "9200"}, "description": "The port to listen on for HTTP traffic.\n", "loc": ["services", "opensearch", "settings", "http.port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.opensearch.settings.\"network.host\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "Which port this service should listen on.\n", "loc": ["services", "opensearch", "settings", "network.host"], "readOnly": false, "type": "string"}, "services.opensearch.settings.\"plugins.security.disabled\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to disable the security plugin. When set to false, SSL configuration is required.\nTo enable SSL, set `plugins.security.ssl.transport.keystore_filepath` or both\n`plugins.security.ssl.transport.server.pemcert_filepath` and\n`plugins.security.ssl.transport.client.pemcert_filepath`.\n", "loc": ["services", "opensearch", "settings", "plugins.security.disabled"], "readOnly": false, "type": "boolean"}, "services.opensearch.settings.\"transport.port\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix"}], "default": {"_type": "literalExpression", "text": "9300"}, "description": "The port to listen on for transport traffic.\n", "loc": ["services", "opensearch", "settings", "transport.port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.opentelemetry-collector.configFile": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opentelemetry-collector.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opentelemetry-collector.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Override the configuration file used by OpenTelemetry Collector.\nBy default, a configuration is generated from `services.opentelemetry-collector.settings`.\n\nIf overriding, enable the `health_check` extension to allow the readiness probe to check whether the Collector is ready.\nOtherwise, disable the readiness probe by setting `processes.opentelemetry-collector.ready = lib.mkForce null;`.\n", "example": {"_type": "literalExpression", "text": "pkgs.writeTextFile { name = \"otel-config.yaml\"; text = \"...\"; }\n"}, "loc": ["services", "opentelemetry-collector", "configFile"], "readOnly": false, "type": "null or absolute path"}, "services.opentelemetry-collector.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opentelemetry-collector.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opentelemetry-collector.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable opentelemetry-collector.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "opentelemetry-collector", "enable"], "readOnly": false, "type": "boolean"}, "services.opentelemetry-collector.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opentelemetry-collector.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opentelemetry-collector.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.opentelemetry-collector-contrib"}, "description": "The OpenTelemetry Collector package to use", "loc": ["services", "opentelemetry-collector", "package"], "readOnly": false, "type": "package"}, "services.opentelemetry-collector.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opentelemetry-collector.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opentelemetry-collector.nix"}], "default": {"_type": "literalExpression", "text": "defaultSettings"}, "description": "OpenTelemetry Collector configuration.\nRefer to https://opentelemetry.io/docs/collector/configuration/\nfor more information on how to configure the Collector.\n", "loc": ["services", "opentelemetry-collector", "settings"], "readOnly": false, "type": "open submodule of (YAML 1.1 value)"}, "services.postgres.createDatabase": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Create a database named like current user on startup. Only applies when initialDatabases is an empty list.\n", "loc": ["services", "postgres", "createDatabase"], "readOnly": false, "type": "boolean"}, "services.postgres.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Add PostgreSQL process.\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "postgres", "enable"], "readOnly": false, "type": "boolean"}, "services.postgres.extensions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Additional PostgreSQL extensions to install.\n\nThe available extensions are:\n\n- age\n- anonymizer\n- apache_datasketches\n- callPackage\n- citus\n- cstore_fdw\n- h3-pg\n- hypopg\n- ip4r\n- jsonb_deep_sum\n- lantern\n- omnigres\n- periods\n- pg-gvm\n- pg-semver\n- pg_auto_failover\n- pg_background\n- pg_bigm\n- pg_byteamagic\n- pg_cron\n- pg_csv\n- pg_ed25519\n- pg_embedding\n- pg_graphql\n- pg_hint_plan\n- pg_hll\n- pg_ivm\n- pg_libversion\n- pg_net\n- pg_partman\n- pg_rational\n- pg_relusage\n- pg_repack\n- pg_roaringbitmap\n- pg_safeupdate\n- pg_search\n- pg_similarity\n- pg_squeeze\n- pg_tle\n- pg_topn\n- pg_uuidv7\n- pgaudit\n- pgddl\n- pgjwt\n- pgmq\n- pgroonga\n- pgrouting\n- pgsodium\n- pgsql-http\n- pgtap\n- pgvecto-rs\n- pgvector\n- pgvectorscale\n- pgx_ulid\n- plperl\n- plpgsql_check\n- plpython3\n- plr\n- pltcl\n- plv8\n- pointcloud\n- postgis\n- repmgr\n- rum\n- smlar\n- sqlite_fdw\n- system_stats\n- tds_fdw\n- temporal_tables\n- timescaledb\n- timescaledb-apache\n- timescaledb_toolkit\n- tsja\n- vectorchord\n- wal2json\n\n", "example": {"_type": "literalExpression", "text": "extensions: [\n extensions.pg_cron\n extensions.postgis\n extensions.timescaledb\n];\n"}, "loc": ["services", "postgres", "extensions"], "readOnly": false, "type": "null or (function that evaluates to a(n) list of package)"}, "services.postgres.hbaConf": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The contents of a custom pg_hba.conf file to copy into the postgres installation.\nThis allows for custom connection rules that you want to establish on the server.\n", "example": {"_type": "literalExpression", "text": "builtins.readFile ./my-custom/directory/to/pg_hba.conf\n"}, "loc": ["services", "postgres", "hbaConf"], "readOnly": false, "type": "null or string"}, "services.postgres.initdbArgs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"--locale=C\"\n \"--encoding=UTF8\"\n]"}, "description": "Additional arguments passed to `initdb` during data dir\ninitialisation.\n", "example": {"_type": "literalExpression", "text": "[\n \"--data-checksums\"\n \"--allow-group-access\"\n]"}, "loc": ["services", "postgres", "initdbArgs"], "readOnly": false, "type": "list of strings concatenated with \"\\n\""}, "services.postgres.initialDatabases": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of database names and their initial schemas that should be used to create databases on the first startup\nof Postgres. The schema attribute is optional: If not specified, an empty database is created.\n", "example": {"_type": "literalExpression", "text": "[\n {\n name = \"foodatabase\";\n schema = ./foodatabase.sql;\n }\n { name = \"bardatabase\"; }\n]\n"}, "loc": ["services", "postgres", "initialDatabases"], "readOnly": false, "type": "list of (submodule)"}, "services.postgres.initialDatabases.*.initialSQL": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "SQL commands to run on this specific database during it's initialization.\nMultiple SQL expressions can be separated by semicolons.\n", "example": {"_type": "literalExpression", "text": "CREATE TABLE users (id SERIAL PRIMARY KEY, name TEXT);\nINSERT INTO users (name) VALUES ('admin');\nCREATE EXTENSION IF NOT EXISTS pg_uuidv7;\n"}, "loc": ["services", "postgres", "initialDatabases", "*", "initialSQL"], "readOnly": false, "type": "null or string"}, "services.postgres.initialDatabases.*.name": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "description": "The name of the database to create.\n", "loc": ["services", "postgres", "initialDatabases", "*", "name"], "readOnly": false, "type": "string"}, "services.postgres.initialDatabases.*.pass": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Password of the database owner role. Requires `user` to be set.\n", "loc": ["services", "postgres", "initialDatabases", "*", "pass"], "readOnly": false, "type": "null or string"}, "services.postgres.initialDatabases.*.schema": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The initial schema of the database; if null (the default),\nan empty database is created.\n", "loc": ["services", "postgres", "initialDatabases", "*", "schema"], "readOnly": false, "type": "null or absolute path"}, "services.postgres.initialDatabases.*.user": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Username of owner of the database. If set, a role with this name is created and the database is owned by it. If null, the default $USER is used.\n", "loc": ["services", "postgres", "initialDatabases", "*", "user"], "readOnly": false, "type": "null or string"}, "services.postgres.initialScript": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Initial SQL commands to run during database initialization. This can be multiple\nSQL expressions separated by a semi-colon.\nUse `initialScript` for server-wide setup, such as creating roles or configuring\nglobal settings. For database-specific initialization, use `initialSQL` within\n`initialDatabases`. `initialScript` is executed after the `initialDatabases`\nsetup is done.\n", "example": {"_type": "literalExpression", "text": "CREATE ROLE postgres SUPERUSER;\nCREATE ROLE bar;\n"}, "loc": ["services", "postgres", "initialScript"], "readOnly": false, "type": "null or string"}, "services.postgres.listen_addresses": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "A comma-separated list of TCP/IP address(es) on which the server should listen for connections.\n\nBy default, the server only accepts connections over unix sockets.\n\nThis option is parsed to set the `PGHOST` environment variable.\n\nSpecial values:\n - \\'*\\' to listen on all available network interfaces.\n - \\'0.0.0.0\\' to listen on all available IPv4 network interfaces.\n - \\'::\\' to listen on all available IPv6 network interfaces.\n - \\'localhost\\' to listen only on the loopback interface.\n - \\'\\' (empty string) disables TCP/IP connections and listens only on the unix socket.\n", "example": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "loc": ["services", "postgres", "listen_addresses"], "readOnly": false, "type": "string"}, "services.postgres.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.postgresql"}, "description": "The PostgreSQL package to use. Use this to override the default with a specific version.\n", "example": {"_type": "literalExpression", "text": "pkgs.postgresql_15\n"}, "loc": ["services", "postgres", "package"], "readOnly": false, "type": "package"}, "services.postgres.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "default": {"_type": "literalExpression", "text": "5432"}, "description": "The TCP port to accept connections.\n", "loc": ["services", "postgres", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.postgres.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "PostgreSQL configuration. Refer to\n\nfor an overview of `postgresql.conf`.\n\nString values will automatically be enclosed in single quotes. Single quotes will be\nescaped with two single quotes as described by the upstream documentation linked above.\n", "example": {"_type": "literalExpression", "text": "{\n log_connections = true;\n log_statement = \"all\";\n logging_collector = true\n log_disconnections = true\n log_destination = lib.mkForce \"syslog\";\n}\n"}, "loc": ["services", "postgres", "settings"], "readOnly": false, "type": "attribute set of (boolean or floating point number or signed integer or string)"}, "services.prometheus.advanced.storage": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Storage configuration", "loc": ["services", "prometheus", "advanced", "storage"], "readOnly": false, "type": "attribute set"}, "services.prometheus.advanced.tsdb": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "TSDB configuration", "loc": ["services", "prometheus", "advanced", "tsdb"], "readOnly": false, "type": "attribute set"}, "services.prometheus.alerting": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Alerting configuration", "loc": ["services", "prometheus", "alerting"], "readOnly": false, "type": "null or (attribute set)"}, "services.prometheus.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Prometheus monitoring system.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "prometheus", "enable"], "readOnly": false, "type": "boolean"}, "services.prometheus.experimentalFeatures.enableExemplars": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Enable exemplar storage", "loc": ["services", "prometheus", "experimentalFeatures", "enableExemplars"], "readOnly": false, "type": "boolean"}, "services.prometheus.experimentalFeatures.enableOTLP": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Enable OTLP receiver", "loc": ["services", "prometheus", "experimentalFeatures", "enableOTLP"], "readOnly": false, "type": "boolean"}, "services.prometheus.experimentalFeatures.enableTracing": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Enable tracing", "loc": ["services", "prometheus", "experimentalFeatures", "enableTracing"], "readOnly": false, "type": "boolean"}, "services.prometheus.extraArgs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Additional arguments to pass to Prometheus", "loc": ["services", "prometheus", "extraArgs"], "readOnly": false, "type": "string"}, "services.prometheus.globalConfig": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "{\n evaluation_interval = \"1m\";\n scrape_interval = \"1m\";\n scrape_timeout = \"10s\";\n}"}, "description": "Global Prometheus configuration", "loc": ["services", "prometheus", "globalConfig"], "readOnly": false, "type": "attribute set"}, "services.prometheus.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.prometheus"}, "description": "Which package of Prometheus to use", "loc": ["services", "prometheus", "package"], "readOnly": false, "type": "package"}, "services.prometheus.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "9090"}, "description": "Port for Prometheus web interface.", "loc": ["services", "prometheus", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.prometheus.remoteRead": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Remote read configurations", "loc": ["services", "prometheus", "remoteRead"], "readOnly": false, "type": "list of (attribute set)"}, "services.prometheus.remoteWrite": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Remote write configurations", "loc": ["services", "prometheus", "remoteWrite"], "readOnly": false, "type": "list of (attribute set)"}, "services.prometheus.ruleFiles": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of rule files to load", "loc": ["services", "prometheus", "ruleFiles"], "readOnly": false, "type": "list of string"}, "services.prometheus.scrapeConfigs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of scrape configurations", "loc": ["services", "prometheus", "scrapeConfigs"], "readOnly": false, "type": "list of (attribute set)"}, "services.prometheus.storage.path": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "${config.devenv.state}/prometheus"}, "description": "Path where Prometheus will store its database", "loc": ["services", "prometheus", "storage", "path"], "readOnly": false, "type": "string"}, "services.prometheus.storage.retentionTime": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "\"15d\""}, "description": "How long to retain data", "loc": ["services", "prometheus", "storage", "retentionTime"], "readOnly": false, "type": "string"}, "services.rabbitmq.configItems": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Configuration options in RabbitMQ's new config file format,\nwhich is a simple key-value format that can not express nested\ndata structures. This is known as the `rabbitmq.conf` file,\nalthough outside NixOS that filename may have Erlang syntax, particularly\nprior to RabbitMQ 3.7.0.\nIf you do need to express nested data structures, you can use\n`config` option. Configuration from `config`\nwill be merged into these options by RabbitMQ at runtime to\nform the final configuration.\nSee \nFor the distinct formats, see \n", "example": {"_type": "literalExpression", "text": "{\n \"auth_backends.1.authn\" = \"rabbit_auth_backend_ldap\";\n \"auth_backends.1.authz\" = \"rabbit_auth_backend_internal\";\n}\n"}, "loc": ["services", "rabbitmq", "configItems"], "readOnly": false, "type": "attribute set of string"}, "services.rabbitmq.cookie": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Erlang cookie is a string of arbitrary length which must\nbe the same for several nodes to be allowed to communicate.\nLeave empty to generate automatically.\n", "loc": ["services", "rabbitmq", "cookie"], "readOnly": false, "type": "string"}, "services.rabbitmq.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable the RabbitMQ server, an Advanced Message\nQueuing Protocol (AMQP) broker.\n", "loc": ["services", "rabbitmq", "enable"], "readOnly": false, "type": "boolean"}, "services.rabbitmq.listenAddress": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "IP address on which RabbitMQ will listen for AMQP\nconnections. Set to the empty string to listen on all\ninterfaces. Note that RabbitMQ creates a user named\n`guest` with password\n`guest` by default, so you should delete\nthis user if you intend to allow external access.\nTogether with 'port' setting it's mostly an alias for\nconfigItems.\"listeners.tcp.1\" and it's left for backwards\ncompatibility with previous version of this module.\n", "example": {"_type": "literalExpression", "text": "\"\""}, "loc": ["services", "rabbitmq", "listenAddress"], "readOnly": false, "type": "string"}, "services.rabbitmq.managementPlugin.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable the management plugin.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "rabbitmq", "managementPlugin", "enable"], "readOnly": false, "type": "boolean"}, "services.rabbitmq.managementPlugin.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix"}], "default": {"_type": "literalExpression", "text": "15672"}, "description": "On which port to run the management plugin.\n", "loc": ["services", "rabbitmq", "managementPlugin", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.rabbitmq.nodeName": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix"}], "default": {"_type": "literalExpression", "text": "\"rabbit@localhost\""}, "description": "The name of the RabbitMQ node. This is used to identify\nthe node in a cluster. If you are running multiple\nRabbitMQ nodes on the same machine, you must give each\nnode a unique name. The name must be of the form\n`name@host`, where `name` is an arbitrary name and\n`host` is the domain name of the host.\n", "loc": ["services", "rabbitmq", "nodeName"], "readOnly": false, "type": "string"}, "services.rabbitmq.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.rabbitmq-server"}, "description": "Which rabbitmq package to use.\n", "loc": ["services", "rabbitmq", "package"], "readOnly": false, "type": "package"}, "services.rabbitmq.pluginDirs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "The list of directories containing external plugins", "loc": ["services", "rabbitmq", "pluginDirs"], "readOnly": false, "type": "list of absolute path"}, "services.rabbitmq.plugins": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "The names of plugins to enable", "loc": ["services", "rabbitmq", "plugins"], "readOnly": false, "type": "list of string"}, "services.rabbitmq.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix"}], "default": {"_type": "literalExpression", "text": "5672"}, "description": "Port on which RabbitMQ will listen for AMQP connections.\n", "loc": ["services", "rabbitmq", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.redis.bind": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/redis.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/redis.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "The IP interface to bind to.\n`null` means \"all interfaces\".\n", "example": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "loc": ["services", "redis", "bind"], "readOnly": false, "type": "null or string"}, "services.redis.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/redis.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/redis.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Redis process and expose utilities.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "redis", "enable"], "readOnly": false, "type": "boolean"}, "services.redis.extraConfig": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/redis.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/redis.nix"}], "default": {"_type": "literalExpression", "text": "\"locale-collate C\""}, "description": "Additional text to be appended to `redis.conf`.", "loc": ["services", "redis", "extraConfig"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.redis.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/redis.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/redis.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.redis"}, "description": "Which package of Redis to use", "loc": ["services", "redis", "package"], "readOnly": false, "type": "package"}, "services.redis.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/redis.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/redis.nix"}], "default": {"_type": "literalExpression", "text": "6379"}, "description": "The TCP port to accept connections.\nIf port 0 is specified, Redis will not listen on a TCP socket and a unix socket file will be found at $REDIS_UNIX_SOCKET.\n", "loc": ["services", "redis", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.rustfs.accessKey": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix"}], "default": {"_type": "literalExpression", "text": "\"rustfsadmin\""}, "description": "Access key for authentication (5 to 20 characters).", "loc": ["services", "rustfs", "accessKey"], "readOnly": false, "type": "string"}, "services.rustfs.bind": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "The IP interface to bind to.\n`null` means \"all interfaces\".\n", "loc": ["services", "rustfs", "bind"], "readOnly": false, "type": "null or string"}, "services.rustfs.consoleEnable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Enable or disable the web console.", "loc": ["services", "rustfs", "consoleEnable"], "readOnly": false, "type": "boolean"}, "services.rustfs.consolePort": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix"}], "default": {"_type": "literalExpression", "text": "9001"}, "description": "The TCP port for the web console.", "loc": ["services", "rustfs", "consolePort"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.rustfs.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable RustFS object storage.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "rustfs", "enable"], "readOnly": false, "type": "boolean"}, "services.rustfs.extraEnvironment": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Additional environment variables to pass to RustFS.\nSee the RustFS documentation for available options\n(e.g. `RUSTFS_CORS_ALLOWED_ORIGINS`, `RUSTFS_TLS_PATH`).\n", "example": {"_type": "literalExpression", "text": "{\n RUSTFS_OBJECT_CACHE_ENABLE = \"true\";\n RUSTFS_OBS_LOGGER_LEVEL = \"debug\";\n}"}, "loc": ["services", "rustfs", "extraEnvironment"], "readOnly": false, "type": "attribute set of string"}, "services.rustfs.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.rustfs"}, "description": "Which package of RustFS to use", "loc": ["services", "rustfs", "package"], "readOnly": false, "type": "package"}, "services.rustfs.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix"}], "default": {"_type": "literalExpression", "text": "9000"}, "description": "The TCP port for the S3 API.", "loc": ["services", "rustfs", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.rustfs.secretKey": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix"}], "default": {"_type": "literalExpression", "text": "\"rustfsadmin\""}, "description": "Secret key for authentication (8 to 40 characters).", "loc": ["services", "rustfs", "secretKey"], "readOnly": false, "type": "string"}, "services.sqld.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/sqld.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/sqld.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable sqld.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "sqld", "enable"], "readOnly": false, "type": "boolean"}, "services.sqld.extraArgs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/sqld.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/sqld.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Add other sqld flags.", "loc": ["services", "sqld", "extraArgs"], "readOnly": false, "type": "list of string"}, "services.sqld.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/sqld.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/sqld.nix"}], "default": {"_type": "literalExpression", "text": "8080"}, "description": "Port number to listen on.", "loc": ["services", "sqld", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.tailscale.funnel.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/tailscale.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/tailscale.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Tailscale funnel.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "tailscale", "funnel", "enable"], "readOnly": false, "type": "boolean"}, "services.tailscale.funnel.target": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/tailscale.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/tailscale.nix"}], "description": "Target host or host:port for Tailscale funnel", "loc": ["services", "tailscale", "funnel", "target"], "readOnly": false, "type": "string"}, "services.temporal.dynamicConfig": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Dynamic configuration for the Temporal server.", "example": {"_type": "literalExpression", "text": "{\n \"frontend.namespacerps\" = \"2500\";\n \"frontend.rps\" = \"2500\";\n}"}, "loc": ["services", "temporal", "dynamicConfig"], "readOnly": false, "type": "attribute set of string"}, "services.temporal.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Temporal process.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "temporal", "enable"], "readOnly": false, "type": "boolean"}, "services.temporal.ip": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "IPv4 address to bind the frontend service to.", "loc": ["services", "temporal", "ip"], "readOnly": false, "type": "string"}, "services.temporal.namespaces": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Specify namespaces that should be pre-created (namespace \"default\" is always created).", "example": {"_type": "literalExpression", "text": "[\n \"my-namespace\"\n \"my-other-namespace\"\n]"}, "loc": ["services", "temporal", "namespaces"], "readOnly": false, "type": "list of string"}, "services.temporal.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.temporal-cli"}, "description": "Which package of Temporal to use.", "loc": ["services", "temporal", "package"], "readOnly": false, "type": "package"}, "services.temporal.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix"}], "default": {"_type": "literalExpression", "text": "7233"}, "description": "Port for the frontend gRPC service.", "loc": ["services", "temporal", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.temporal.state": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "State configuration.", "loc": ["services", "temporal", "state"], "readOnly": false, "type": "submodule"}, "services.temporal.state.ephemeral": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "When enabled, the Temporal state gets lost when the process exists.", "loc": ["services", "temporal", "state", "ephemeral"], "readOnly": false, "type": "boolean"}, "services.temporal.state.sqlite-pragma": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Sqlite pragma statements", "example": {"_type": "literalExpression", "text": "{\n journal_mode = \"wal\";\n synchronous = \"2\";\n}"}, "loc": ["services", "temporal", "state", "sqlite-pragma"], "readOnly": false, "type": "attribute set of string"}, "services.temporal.ui": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "UI configuration.", "loc": ["services", "temporal", "ui"], "readOnly": false, "type": "submodule"}, "services.temporal.ui.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Enable the Web UI.", "loc": ["services", "temporal", "ui", "enable"], "readOnly": false, "type": "boolean"}, "services.temporal.ui.ip": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "IPv4 address to bind the Web UI to.", "loc": ["services", "temporal", "ui", "ip"], "readOnly": false, "type": "string"}, "services.temporal.ui.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix"}], "default": {"_type": "literalExpression", "text": "8233"}, "description": "Port for the Web UI.", "loc": ["services", "temporal", "ui", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.tideways.apiKey": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/tideways.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/tideways.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Sets the API-Key for the Tideways Daemon.\n", "loc": ["services", "tideways", "apiKey"], "readOnly": false, "type": "string"}, "services.tideways.cliPackage": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/tideways.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/tideways.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.tideways-cli"}, "description": "Which package of tideways-cli to use", "loc": ["services", "tideways", "cliPackage"], "readOnly": false, "type": "package"}, "services.tideways.daemonPackage": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/tideways.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/tideways.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.tideways-daemon"}, "description": "Which package of tideways-daemon to use", "loc": ["services", "tideways", "daemonPackage"], "readOnly": false, "type": "package"}, "services.tideways.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/tideways.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/tideways.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Tideways profiler daemon\n\nIt automatically installs Tideways PHP extension.\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "tideways", "enable"], "readOnly": false, "type": "boolean"}, "services.tideways.environment": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/tideways.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/tideways.nix"}], "default": {"_type": "literalExpression", "text": "\"devenv\""}, "description": "Sets the Environment for Tideways Daemon.\n", "loc": ["services", "tideways", "environment"], "readOnly": false, "type": "string"}, "services.tideways.profilingSpace": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/tideways.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/tideways.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "When the profiling space is enabled, the default monitoring will be disabled.\n", "loc": ["services", "tideways", "profilingSpace"], "readOnly": false, "type": "boolean"}, "services.tideways.service": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/tideways.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/tideways.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Sets the Service name for Tideways Daemon.\n", "loc": ["services", "tideways", "service"], "readOnly": false, "type": "string"}, "services.trafficserver.cache": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Caching rules that overrule the origin's caching policy.\n\nConsult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/cache.config.en.html)\nfor more details.\n", "example": {"_type": "literalExpression", "text": "\"dest_domain=example.com suffix=js action=never-cache\""}, "loc": ["services", "trafficserver", "cache"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.trafficserver.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Apache Traffic Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "trafficserver", "enable"], "readOnly": false, "type": "boolean"}, "services.trafficserver.hosting": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Partition the cache according to origin server or domain\n\nConsult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/hosting.config.en.html)\nfor more details.\n", "example": {"_type": "literalExpression", "text": "\"domain=example.com volume=1\""}, "loc": ["services", "trafficserver", "hosting"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.trafficserver.ipAllow": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalMD", "text": "upstream defaults"}, "description": "Control client access to Traffic Server and Traffic Server connections\nto upstream servers.\n\nConsult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/ip_allow.yaml.en.html)\nfor more details.\n", "example": {"_type": "literalExpression", "text": "{\n ip_allow = [{\n apply = \"in\";\n ip_addrs = \"127.0.0.1\";\n action = \"allow\";\n methods = \"ALL\";\n }];\n}\n"}, "loc": ["services", "trafficserver", "ipAllow"], "readOnly": false, "type": "null or YAML 1.1 value"}, "services.trafficserver.logging": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalMD", "text": "upstream defaults"}, "description": "Configure logs.\n\nConsult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/logging.yaml.en.html)\nfor more details.\n", "example": {"_type": "literalExpression", "text": "{ }"}, "loc": ["services", "trafficserver", "logging"], "readOnly": false, "type": "null or YAML 1.1 value"}, "services.trafficserver.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalExpression", "text": "pkgs.trafficserver"}, "description": "Apache Traffic Server package", "loc": ["services", "trafficserver", "package"], "readOnly": false, "type": "package"}, "services.trafficserver.parent": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Identify the parent proxies used in an cache hierarchy.\n\nConsult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/parent.config.en.html)\nfor more details.\n", "example": {"_type": "literalExpression", "text": "''\n dest_domain=. method=get parent=\"p1.example:8080; p2.example:8080\" round_robin=true\n''"}, "loc": ["services", "trafficserver", "parent"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.trafficserver.plugins": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Controls run-time loadable plugins available to Traffic Server, as\nwell as their configuration.\n\nConsult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/plugin.config.en.html)\nfor more details.\n", "loc": ["services", "trafficserver", "plugins"], "readOnly": false, "type": "list of (submodule)"}, "services.trafficserver.plugins.*.arg": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "arguments to pass to the plugin", "example": {"_type": "literalExpression", "text": "\"--header=ATS-My-Debug\""}, "loc": ["services", "trafficserver", "plugins", "*", "arg"], "readOnly": false, "type": "string"}, "services.trafficserver.plugins.*.path": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "description": "Path to plugin. The path can either be absolute, or relative to\nthe plugin directory.\n", "example": {"_type": "literalExpression", "text": "\"xdebug.so\""}, "loc": ["services", "trafficserver", "plugins", "*", "path"], "readOnly": false, "type": "string"}, "services.trafficserver.records": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "List of configurable variables used by Traffic Server.\n\nConsult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/records.config.en.html)\nfor more details.\n\nWhen defining the values for the option `x.y`, a nested attribute should\nbe used. Using a flat attribute set with the attribute name `x.y` will\nresult in an error.\n\nIf options for both `x.y` and `x.y.z` needs to be set, you can set\n`x.y._` as `x.y`. This only applies to Traffic Server versions prior to\n10. Traffic Server 10 and onwards uses YAML configuration, which doesn't\nhave this kind of problem.\n", "example": {"_type": "literalExpression", "text": "{\n proxy = {\n config = {\n proxy_name = \"my_server\";\n };\n };\n}"}, "loc": ["services", "trafficserver", "records"], "readOnly": false, "type": "Traffic Server records value"}, "services.trafficserver.remap": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "URL remapping rules used by Traffic Server.\n\nConsult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/remap.config.en.html)\nfor more details.\n", "example": {"_type": "literalExpression", "text": "\"map http://from.example http://origin.example\""}, "loc": ["services", "trafficserver", "remap"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.trafficserver.runroot": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "description": "File layout used by Traffic Server", "loc": ["services", "trafficserver", "runroot"], "readOnly": true, "type": "unspecified value"}, "services.trafficserver.sni": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Configure aspects of TLS connection handling for both inbound and\noutbound connections.\n\nConsult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/sni.yaml.en.html)\nfor more details.\n", "example": {"_type": "literalExpression", "text": "{\n sni = [{\n fqdn = \"no-http2.example.com\";\n https = \"off\";\n }];\n}\n"}, "loc": ["services", "trafficserver", "sni"], "readOnly": false, "type": "null or YAML 1.1 value"}, "services.trafficserver.splitDns": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Specify the DNS server that Traffic Server should use under specific\nconditions.\n\nConsult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/splitdns.config.en.html)\nfor more details.\n", "example": {"_type": "literalExpression", "text": "''\n dest_domain=internal.corp.example named=\"255.255.255.255:212 255.255.255.254\" def_domain=corp.example search_list=\"corp.example corp1.example\"\n dest_domain=!internal.corp.example named=255.255.255.253\n''"}, "loc": ["services", "trafficserver", "splitDns"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.trafficserver.sslMulticert": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Configure SSL server certificates to terminate the SSL sessions.\n\nConsult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/ssl_multicert.config.en.html)\nfor more details.\n", "example": {"_type": "literalExpression", "text": "\"dest_ip=* ssl_cert_name=default.pem\""}, "loc": ["services", "trafficserver", "sslMulticert"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.trafficserver.storage": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalExpression", "text": "\"${config.services.traffic-server.runroot.cachedir} 256M\""}, "description": "List all the storage that make up the Traffic Server cache.\n\nConsult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/storage.config.en.html)\nfor more details.\n", "example": {"_type": "literalExpression", "text": "\"/dev/disk/by-id/XXXXX volume=1\""}, "loc": ["services", "trafficserver", "storage"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.trafficserver.strategies": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Specify the next hop proxies used in an cache hierarchy and the\nalgorithms used to select the next proxy.\n\nConsult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/strategies.yaml.en.html)\nfor more details.\n", "loc": ["services", "trafficserver", "strategies"], "readOnly": false, "type": "null or YAML 1.1 value"}, "services.trafficserver.volume": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Manage cache space more efficiently and restrict disk usage by\ncreating cache volumes of different sizes.\n\nConsult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/volume.config.en.html)\nfor more details.\n", "example": {"_type": "literalExpression", "text": "\"volume=1 scheme=http size=20%\""}, "loc": ["services", "trafficserver", "volume"], "readOnly": false, "type": "null or YAML 1.1 value"}, "services.typesense.additionalArgs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Additional arguments passed to `typesense`.\n", "example": {"_type": "literalExpression", "text": "[ ]"}, "loc": ["services", "typesense", "additionalArgs"], "readOnly": false, "type": "list of strings concatenated with \"\\n\""}, "services.typesense.apiKey": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix"}], "default": {"_type": "literalExpression", "text": "\"example\""}, "description": "API Key.", "loc": ["services", "typesense", "apiKey"], "readOnly": false, "type": "string"}, "services.typesense.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable typesense process.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "typesense", "enable"], "readOnly": false, "type": "boolean"}, "services.typesense.host": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "The HTTP host to accept connections.\n", "loc": ["services", "typesense", "host"], "readOnly": false, "type": "string"}, "services.typesense.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.typesense"}, "description": "Which package of typesense to use", "loc": ["services", "typesense", "package"], "readOnly": false, "type": "package"}, "services.typesense.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix"}], "default": {"_type": "literalExpression", "text": "8108"}, "description": "The HTTP port to accept connections.\n", "loc": ["services", "typesense", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.typesense.searchOnlyKey": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Search Only Key.", "loc": ["services", "typesense", "searchOnlyKey"], "readOnly": false, "type": "null or string"}, "services.varnish.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Varnish process and expose utilities.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "varnish", "enable"], "readOnly": false, "type": "boolean"}, "services.varnish.extraModules": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Varnish modules (except 'std').\n", "example": {"_type": "literalExpression", "text": "[ pkgs.varnish73Packages.modules ]"}, "loc": ["services", "varnish", "extraModules"], "readOnly": false, "type": "list of package"}, "services.varnish.listen": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1:6081\""}, "description": "Which address to listen on.", "loc": ["services", "varnish", "listen"], "readOnly": false, "type": "string"}, "services.varnish.memorySize": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix"}], "default": {"_type": "literalExpression", "text": "\"64M\""}, "description": "How much memory to allocate to Varnish.", "loc": ["services", "varnish", "memorySize"], "readOnly": false, "type": "string"}, "services.varnish.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.varnish"}, "description": "Which Varnish package to use.", "loc": ["services", "varnish", "package"], "readOnly": false, "type": "package"}, "services.varnish.vcl": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix"}], "default": {"_type": "literalExpression", "text": "''\n vcl 4.0;\n \n backend default {\n .host = \"127.0.0.1\";\n .port = \"80\";\n }\n''"}, "description": "Varnish VCL configuration.", "loc": ["services", "varnish", "vcl"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.vault.address": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1:8200\""}, "description": "Specifies the address to bind to for listening\n", "loc": ["services", "vault", "address"], "readOnly": false, "type": "string"}, "services.vault.disableClustering": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Specifies whether clustering features such as request forwarding are enabled\n", "loc": ["services", "vault", "disableClustering"], "readOnly": false, "type": "boolean"}, "services.vault.disableMlock": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Disables the server from executing the mlock syscall\n", "loc": ["services", "vault", "disableMlock"], "readOnly": false, "type": "boolean"}, "services.vault.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable vault process.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "vault", "enable"], "readOnly": false, "type": "boolean"}, "services.vault.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.vault-bin"}, "description": "Which package of Vault to use.", "loc": ["services", "vault", "package"], "readOnly": false, "type": "package"}, "services.vault.ui": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Enables the built-in web UI\n", "loc": ["services", "vault", "ui"], "readOnly": false, "type": "boolean"}, "services.wiremock.disableBanner": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to disable print banner logo.\n", "loc": ["services", "wiremock", "disableBanner"], "readOnly": false, "type": "boolean"}, "services.wiremock.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable WireMock.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "wiremock", "enable"], "readOnly": false, "type": "boolean"}, "services.wiremock.mappings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "The mappings to mock.\nSee the JSON examples on for more information.\n", "example": {"_type": "literalExpression", "text": "[\n {\n request = {\n method = \"GET\";\n url = \"/body\";\n };\n response = {\n body = \"Literal text to put in the body\";\n headers = {\n Content-Type = \"text/plain\";\n };\n status = 200;\n };\n }\n {\n request = {\n method = \"GET\";\n url = \"/json\";\n };\n response = {\n jsonBody = {\n someField = \"someValue\";\n };\n status = 200;\n };\n }\n]"}, "loc": ["services", "wiremock", "mappings"], "readOnly": false, "type": "JSON value"}, "services.wiremock.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.wiremock"}, "description": "Which package of WireMock to use.\n", "loc": ["services", "wiremock", "package"], "readOnly": false, "type": "package"}, "services.wiremock.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix"}], "default": {"_type": "literalExpression", "text": "8080"}, "description": "The port number for the HTTP server to listen on.\n", "loc": ["services", "wiremock", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.wiremock.rootDir": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Path to the WireMock root directory containing mappings and files.\nCannot be set together with `mappings`.\nSee for more information.\n", "loc": ["services", "wiremock", "rootDir"], "readOnly": false, "type": "null or absolute path"}, "services.wiremock.verbose": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to log verbosely to stdout.\n", "loc": ["services", "wiremock", "verbose"], "readOnly": false, "type": "boolean"}, "starship.config.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/starship.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/starship.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Starship config override.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["starship", "config", "enable"], "readOnly": false, "type": "boolean"}, "starship.config.path": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/starship.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/starship.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The Starship configuration file to use.", "example": {"_type": "literalExpression", "text": "${config.env.DEVENV_ROOT}/starship.toml"}, "loc": ["starship", "config", "path"], "readOnly": false, "type": "null or absolute path"}, "starship.config.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/starship.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/starship.nix"}], "default": {"_type": "literalExpression", "text": "{}"}, "description": "Starship configuration to use", "loc": ["starship", "config", "settings"], "readOnly": false, "type": "TOML value"}, "starship.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/starship.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/starship.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable the Starship.rs command prompt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["starship", "enable"], "readOnly": false, "type": "boolean"}, "starship.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/starship.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/starship.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.starship"}, "description": "The Starship package to use.", "loc": ["starship", "package"], "readOnly": false, "type": "package"}, "stdenv": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.stdenv"}, "description": "The stdenv to use for the developer environment.", "loc": ["stdenv"], "readOnly": false, "type": "package"}, "tasks": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "description": "A set of tasks.", "loc": ["tasks"], "readOnly": false, "type": "attribute set of (submodule)"}, "tasks..after": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of tasks that must complete before this task runs.\n\nHere's a helpful mnemonic to remember: This task runs *after* these tasks.\n\nYou can append a suffix to control dependency behavior:\n- `task@started` - wait for task to begin execution\n- `task` or `task@ready` - wait for task to be ready/healthy (default for processes, processes only)\n- `task@succeeded` - wait for task to exit successfully (default for tasks, tasks only)\n- `task@completed` - wait for task to finish, regardless of exit code (soft dependency)\n\nExample: `after = [ \"pnpm:install@completed\" ];` allows this task to run\neven if pnpm:install fails.\n", "loc": ["tasks", "", "after"], "readOnly": false, "type": "list of string"}, "tasks..before": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of tasks that depend on this task completing first.\n\nHere's a helpful mnemonic to remember: This task runs *before* these tasks.\n\nYou can append a suffix to control dependency behavior:\n- `task@started` - the dependent waits for this task to begin execution\n- `task` or `task@ready` - the dependent waits for this task to be ready/healthy (default for processes, processes only)\n- `task@succeeded` - the dependent waits for this task to exit successfully (default for tasks, tasks only)\n- `task@completed` - the dependent waits for this task to finish (soft dependency)\n", "loc": ["tasks", "", "before"], "readOnly": false, "type": "list of string"}, "tasks..binary": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Override the binary name from the default `package.meta.mainProgram`.", "loc": ["tasks", "", "binary"], "readOnly": false, "type": "null or string"}, "tasks..cwd": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Working directory to run the task in. If not specified, the current working directory will be used.", "loc": ["tasks", "", "cwd"], "readOnly": false, "type": "null or string"}, "tasks..description": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Description of the task.", "loc": ["tasks", "", "description"], "readOnly": false, "type": "string"}, "tasks..env": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Environment variables to set for this task.", "loc": ["tasks", "", "env"], "readOnly": false, "type": "attribute set of string"}, "tasks..exec": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Command to execute the task.", "loc": ["tasks", "", "exec"], "readOnly": false, "type": "null or string"}, "tasks..execIfModified": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Paths to files that should trigger a task execution if modified.", "loc": ["tasks", "", "execIfModified"], "readOnly": false, "type": "list of string"}, "tasks..exports": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of environment variables to export.", "loc": ["tasks", "", "exports"], "readOnly": false, "type": "list of string"}, "tasks..input": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Input values for the task, encoded as JSON.", "loc": ["tasks", "", "input"], "readOnly": false, "type": "attribute set of anything"}, "tasks..package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.bash"}, "description": "Package to install for this task.", "loc": ["tasks", "", "package"], "readOnly": false, "type": "package"}, "tasks..process": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Process-specific configuration. Only used when type = \"process\".", "loc": ["tasks", "", "process"], "readOnly": false, "type": "submodule"}, "tasks..process.linux": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Linux-specific process configuration.\n\nRequires devenv 2.0+.\n", "loc": ["tasks", "", "process", "linux"], "readOnly": false, "type": "submodule"}, "tasks..process.linux.capabilities": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Linux capabilities to add as ambient capabilities for this process\n(e.g., \"net_bind_service\", \"net_admin\").\n\nSupported capabilities are net_bind_service, net_raw, net_admin,\nipc_lock, sys_nice, sys_resource, sys_admin, chown, dac_override,\nand fowner. Starting a process with capabilities requires sudo\nauthentication.\n\nRequires devenv 2.0+.\n", "example": {"_type": "literalExpression", "text": "[\n \"net_bind_service\"\n \"net_admin\"\n]"}, "loc": ["tasks", "", "process", "linux", "capabilities"], "readOnly": false, "type": "list of string"}, "tasks..process.listen": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Socket activation configuration for systemd-style socket passing.", "example": {"_type": "literalExpression", "text": "[\n {\n address = \"127.0.0.1:8080\";\n kind = \"tcp\";\n name = \"http\";\n }\n {\n kind = \"unix_stream\";\n mode = 384;\n name = \"admin\";\n path = \"$DEVENV_STATE/admin.sock\";\n }\n]"}, "loc": ["tasks", "", "process", "listen"], "readOnly": false, "type": "list of (submodule)"}, "tasks..process.listen.*.address": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "TCP address (e.g., '127.0.0.1:8080'). Required for TCP sockets.", "loc": ["tasks", "", "process", "listen", "*", "address"], "readOnly": false, "type": "null or string"}, "tasks..process.listen.*.backlog": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "128"}, "description": "Listen backlog size", "loc": ["tasks", "", "process", "listen", "*", "backlog"], "readOnly": false, "type": "null or signed integer"}, "tasks..process.listen.*.kind": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "description": "Type of socket (tcp or unix_stream)", "loc": ["tasks", "", "process", "listen", "*", "kind"], "readOnly": false, "type": "one of \"tcp\", \"unix_stream\""}, "tasks..process.listen.*.mode": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Unix socket file permissions (e.g., 384 for 0o600). Only for unix_stream.", "loc": ["tasks", "", "process", "listen", "*", "mode"], "readOnly": false, "type": "null or signed integer"}, "tasks..process.listen.*.name": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "description": "Name of the socket (e.g., 'http', 'admin')", "loc": ["tasks", "", "process", "listen", "*", "name"], "readOnly": false, "type": "string"}, "tasks..process.listen.*.path": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Unix socket path. Required for unix_stream sockets.", "loc": ["tasks", "", "process", "listen", "*", "path"], "readOnly": false, "type": "null or string"}, "tasks..process.ports": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Allocated ports for this process (name -> port number).\nPopulated automatically from process port allocation.\n", "loc": ["tasks", "", "process", "ports"], "readOnly": false, "type": "attribute set of 16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "tasks..process.proxy.hostname": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Full `.localhost` proxy hostname for this process.", "loc": ["tasks", "", "process", "proxy", "hostname"], "readOnly": false, "type": "null or string"}, "tasks..process.proxy.https.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable HTTPS proxy URLs for this process.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["tasks", "", "process", "proxy", "https", "enable"], "readOnly": false, "type": "boolean"}, "tasks..process.proxy.port_hostnames": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Full `.localhost` proxy hostnames keyed by port name.", "loc": ["tasks", "", "process", "proxy", "port_hostnames"], "readOnly": false, "type": "attribute set of string"}, "tasks..process.ready": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "How to determine if this process task is ready to serve.", "loc": ["tasks", "", "process", "ready"], "readOnly": false, "type": "null or (submodule)"}, "tasks..process.ready.exec": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Shell command to execute. Exit 0 = ready.", "example": {"_type": "literalExpression", "text": "\"pg_isready -d template1\""}, "loc": ["tasks", "", "process", "ready", "exec"], "readOnly": false, "type": "null or string"}, "tasks..process.ready.failure_threshold": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "3"}, "description": "Consecutive failures before marking unhealthy.", "loc": ["tasks", "", "process", "ready", "failure_threshold"], "readOnly": false, "type": "signed integer"}, "tasks..process.ready.http": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "HTTP readiness probe configuration.", "loc": ["tasks", "", "process", "ready", "http"], "readOnly": false, "type": "submodule"}, "tasks..process.ready.http.get": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "HTTP GET readiness check.", "loc": ["tasks", "", "process", "ready", "http", "get"], "readOnly": false, "type": "null or (submodule)"}, "tasks..process.ready.http.get.host": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "Host to connect to.", "loc": ["tasks", "", "process", "ready", "http", "get", "host"], "readOnly": false, "type": "string"}, "tasks..process.ready.http.get.path": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "\"/\""}, "description": "HTTP path to request.", "loc": ["tasks", "", "process", "ready", "http", "get", "path"], "readOnly": false, "type": "string"}, "tasks..process.ready.http.get.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "description": "Port to connect to.", "loc": ["tasks", "", "process", "ready", "http", "get", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "tasks..process.ready.http.get.scheme": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "\"http\""}, "description": "URL scheme (http or https).", "loc": ["tasks", "", "process", "ready", "http", "get", "scheme"], "readOnly": false, "type": "string"}, "tasks..process.ready.initial_delay": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "0"}, "description": "Seconds to wait before first probe.", "loc": ["tasks", "", "process", "ready", "initial_delay"], "readOnly": false, "type": "signed integer"}, "tasks..process.ready.notify": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Enable systemd notify protocol for readiness signaling.\nThe process must send READY=1 to the NOTIFY_SOCKET.\n", "loc": ["tasks", "", "process", "ready", "notify"], "readOnly": false, "type": "boolean"}, "tasks..process.ready.period": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "10"}, "description": "Seconds between probes.", "loc": ["tasks", "", "process", "ready", "period"], "readOnly": false, "type": "signed integer"}, "tasks..process.ready.probe_timeout": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "1"}, "description": "Seconds before a single probe times out.", "loc": ["tasks", "", "process", "ready", "probe_timeout"], "readOnly": false, "type": "signed integer"}, "tasks..process.ready.success_threshold": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "1"}, "description": "Consecutive successes needed to be considered ready.", "loc": ["tasks", "", "process", "ready", "success_threshold"], "readOnly": false, "type": "signed integer"}, "tasks..process.ready.timeout": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Overall deadline in seconds for the process to become ready. null = no deadline.", "loc": ["tasks", "", "process", "ready", "timeout"], "readOnly": false, "type": "null or (unsigned integer, meaning >=0)"}, "tasks..process.restart": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Process restart policy.", "loc": ["tasks", "", "process", "restart"], "readOnly": false, "type": "submodule"}, "tasks..process.restart.max": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "5"}, "description": "Maximum restart attempts. null = unlimited.", "loc": ["tasks", "", "process", "restart", "max"], "readOnly": false, "type": "null or signed integer"}, "tasks..process.restart.on": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "\"on_failure\""}, "description": "When to restart: never, always, or on_failure.", "loc": ["tasks", "", "process", "restart", "on"], "readOnly": false, "type": "one of \"never\", \"always\", \"on_failure\""}, "tasks..process.restart.window": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Sliding window in seconds for restart rate limiting. null = lifetime limit.", "loc": ["tasks", "", "process", "restart", "window"], "readOnly": false, "type": "null or (unsigned integer, meaning >=0)"}, "tasks..process.shutdown": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Graceful shutdown signal and timeout.", "loc": ["tasks", "", "process", "shutdown"], "readOnly": false, "type": "submodule"}, "tasks..process.shutdown.grace": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "5"}, "description": "Seconds before shutdown escalates to SIGKILL.", "loc": ["tasks", "", "process", "shutdown", "grace"], "readOnly": false, "type": "unsigned integer, meaning >=0"}, "tasks..process.shutdown.signal": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "15"}, "description": "Unix signal number used for graceful shutdown.", "loc": ["tasks", "", "process", "shutdown", "signal"], "readOnly": false, "type": "integer between 1 and 31 (both inclusive)"}, "tasks..process.start": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Auto-start configuration for this process.", "loc": ["tasks", "", "process", "start"], "readOnly": false, "type": "submodule"}, "tasks..process.start.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to start this process automatically with `devenv up`.\n\nDisabled processes still run when pulled in as a task\ndependency (for example via `@completed`).\n", "loc": ["tasks", "", "process", "start", "enable"], "readOnly": false, "type": "boolean"}, "tasks..process.watch": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "File watching configuration for automatic process restarts.", "loc": ["tasks", "", "process", "watch"], "readOnly": false, "type": "submodule"}, "tasks..process.watch.extensions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "File extensions to watch (e.g., \"rs\", \"js\", \"py\").\nIf empty, all file extensions are watched.\n", "loc": ["tasks", "", "process", "watch", "extensions"], "readOnly": false, "type": "list of string"}, "tasks..process.watch.ignore": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Glob patterns to ignore (e.g., \".git\", \"target\", \"*.log\").\n", "loc": ["tasks", "", "process", "watch", "ignore"], "readOnly": false, "type": "list of string"}, "tasks..process.watch.paths": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Paths to watch for changes (files or directories).\nWhen files in these paths change, the process will be restarted.\n", "loc": ["tasks", "", "process", "watch", "paths"], "readOnly": false, "type": "list of string"}, "tasks..process.watchdog": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Systemd watchdog configuration.", "example": {"_type": "literalExpression", "text": "{\n usec = 30000000; # 30 seconds\n require_ready = true;\n}\n"}, "loc": ["tasks", "", "process", "watchdog"], "readOnly": false, "type": "null or (submodule)"}, "tasks..process.watchdog.require_ready": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Require READY=1 notification before enforcing watchdog", "loc": ["tasks", "", "process", "watchdog", "require_ready"], "readOnly": false, "type": "boolean"}, "tasks..process.watchdog.usec": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "description": "Watchdog interval in microseconds", "loc": ["tasks", "", "process", "watchdog", "usec"], "readOnly": false, "type": "signed integer"}, "tasks..showOutput": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Always show task output (stdout and stderr), regardless of whether the task succeeds or fails.", "loc": ["tasks", "", "showOutput"], "readOnly": false, "type": "boolean"}, "tasks..status": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Check if the command should be ran", "loc": ["tasks", "", "status"], "readOnly": false, "type": "null or string"}, "tasks..type": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "\"oneshot\""}, "description": "Type of task:\n- oneshot: Task runs once and completes (default)\n- process: Task is a long-running process\n", "loc": ["tasks", "", "type"], "readOnly": false, "type": "one of \"oneshot\", \"process\""}, "tasks..wantedBy": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Tasks that select this task when they run, like systemd's `wantedBy`.\n\nWhen unset, running a task also runs the tasks ordered after it\n(in `after` and `all` modes). Once set, only the listed tasks select\nthis task, and `after`/`before` only order it. It still runs when\nnamed directly or when a selected task runs after it.\nUse `[ ]` to opt out of being selected by ordering edges.\n\nThis does not order the tasks, so combine it with `after` or `before`.\n", "example": {"_type": "literalExpression", "text": "[\n \"devenv:enterShell\"\n]"}, "loc": ["tasks", "", "wantedBy"], "readOnly": false, "type": "null or (list of string)"}, "treefmt.config": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/treefmt.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/treefmt.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "treefmt configuration.", "loc": ["treefmt", "config"], "readOnly": false, "type": "submodule"}, "treefmt.config.build.check": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "default": {"_type": "literalMD", "text": "Default check implementation"}, "description": "Create a flake check to test that the given project tree is already\nformatted.\n\nInput argument is the path to the project tree (usually 'self').\n", "loc": ["treefmt", "config", "build", "check"], "readOnly": false, "type": "function that evaluates to a(n) package"}, "treefmt.config.build.configFile": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "description": "Contains the generated config file derived from the settings.\n", "loc": ["treefmt", "config", "build", "configFile"], "readOnly": false, "type": "absolute path"}, "treefmt.config.build.devShell": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "description": "The development shell with treefmt and its underlying programs", "loc": ["treefmt", "config", "build", "devShell"], "readOnly": true, "type": "package"}, "treefmt.config.build.programs": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "default": {"_type": "literalMD", "text": "Programs used in configuration"}, "description": "Attrset of formatter programs enabled in treefmt configuration.\n\nThe key of the attrset is the formatter name, with the value being the\npackage used to do the formatting.\n", "loc": ["treefmt", "config", "build", "programs"], "readOnly": false, "type": "attribute set of package"}, "treefmt.config.build.wrapper": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "default": {"_type": "literalMD", "text": "wrapped `treefmt` command"}, "description": "The treefmt package, wrapped with the config file.\n", "loc": ["treefmt", "config", "build", "wrapper"], "readOnly": false, "type": "package"}, "treefmt.config.enableDefaultExcludes": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Enable the default excludes in the treefmt configuration.\n", "loc": ["treefmt", "config", "enableDefaultExcludes"], "readOnly": false, "type": "boolean"}, "treefmt.config.package": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.treefmt"}, "description": "The treefmt package to use.", "loc": ["treefmt", "config", "package"], "readOnly": false, "type": "package"}, "treefmt.config.pkgs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/treefmt.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/treefmt.nix"}], "description": "Nixpkgs to use in `treefmt`.\n", "loc": ["treefmt", "config", "pkgs"], "readOnly": false, "type": "lazy attribute set of raw value"}, "treefmt.config.programs.actionlint.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/actionlint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/actionlint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable actionlint.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "actionlint", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.aiken.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/aiken.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/aiken.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable aiken.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "aiken", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.alejandra.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/alejandra.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/alejandra.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable alejandra.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "alejandra", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.asmfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/asmfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/asmfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable asmfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "asmfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.autocorrect.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable autocorrect.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "autocorrect", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.autocorrect.settings.context": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Enable or disable in a specific context.", "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "context"], "readOnly": false, "type": "null or (submodule)"}, "treefmt.config.programs.autocorrect.settings.context.codeblock": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Enable or disable to format codeblock in Markdown or AsciiDoc etc.", "example": {"_type": "literalExpression", "text": "\"error\""}, "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "context", "codeblock"], "readOnly": false, "type": "null or one of \"off\", \"error\", \"warning\""}, "treefmt.config.programs.autocorrect.settings.fileTypes": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Configure the files associations, you config is higher priority than default.", "example": {"_type": "literalExpression", "text": "{\n \"*.js\" = \"javascript\";\n \".mdx\" = \"markdown\";\n Rakefile = \"ruby\";\n rb = \"ruby\";\n}"}, "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "fileTypes"], "readOnly": false, "type": "null or (attribute set of string)"}, "treefmt.config.programs.autocorrect.settings.rules": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Configure rules for autocorrect formatting.", "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "rules"], "readOnly": false, "type": "null or (submodule)"}, "treefmt.config.programs.autocorrect.settings.rules.fullwidth": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Convert to fullwidth.", "example": {"_type": "literalExpression", "text": "\"error\""}, "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "rules", "fullwidth"], "readOnly": false, "type": "null or one of \"off\", \"error\", \"warning\""}, "treefmt.config.programs.autocorrect.settings.rules.halfwidth-punctuation": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Fullwidth punctuations to halfwidth in english.", "example": {"_type": "literalExpression", "text": "\"error\""}, "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "rules", "halfwidth-punctuation"], "readOnly": false, "type": "null or one of \"off\", \"error\", \"warning\""}, "treefmt.config.programs.autocorrect.settings.rules.halfwidth-word": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Fullwidth alphanumeric characters to halfwidth.", "example": {"_type": "literalExpression", "text": "\"error\""}, "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "rules", "halfwidth-word"], "readOnly": false, "type": "null or one of \"off\", \"error\", \"warning\""}, "treefmt.config.programs.autocorrect.settings.rules.no-space-fullwidth": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Remove space near the fullwidth.", "example": {"_type": "literalExpression", "text": "\"error\""}, "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "rules", "no-space-fullwidth"], "readOnly": false, "type": "null or one of \"off\", \"error\", \"warning\""}, "treefmt.config.programs.autocorrect.settings.rules.space-backticks": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Add space between ``, when near the CJK.", "example": {"_type": "literalExpression", "text": "\"error\""}, "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "rules", "space-backticks"], "readOnly": false, "type": "null or one of \"off\", \"error\", \"warning\""}, "treefmt.config.programs.autocorrect.settings.rules.space-bracket": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Add space between brackets (), [] when near the CJK.", "example": {"_type": "literalExpression", "text": "\"error\""}, "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "rules", "space-bracket"], "readOnly": false, "type": "null or one of \"off\", \"error\", \"warning\""}, "treefmt.config.programs.autocorrect.settings.rules.space-dash": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Add space between dash `-`.", "example": {"_type": "literalExpression", "text": "\"off\""}, "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "rules", "space-dash"], "readOnly": false, "type": "null or one of \"off\", \"error\", \"warning\""}, "treefmt.config.programs.autocorrect.settings.rules.space-dollar": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Add space between dollar $ when near the CJK.", "example": {"_type": "literalExpression", "text": "\"off\""}, "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "rules", "space-dollar"], "readOnly": false, "type": "null or one of \"off\", \"error\", \"warning\""}, "treefmt.config.programs.autocorrect.settings.rules.space-punctuation": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Add space between some punctuations.", "example": {"_type": "literalExpression", "text": "\"error\""}, "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "rules", "space-punctuation"], "readOnly": false, "type": "null or one of \"off\", \"error\", \"warning\""}, "treefmt.config.programs.autocorrect.settings.rules.space-word": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Auto add spacing between CJK (Chinese, Japanese, Korean) and English words.", "example": {"_type": "literalExpression", "text": "\"off\""}, "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "rules", "space-word"], "readOnly": false, "type": "null or one of \"off\", \"error\", \"warning\""}, "treefmt.config.programs.autocorrect.settings.rules.spellcheck": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Spellcheck.", "example": {"_type": "literalExpression", "text": "\"warning\""}, "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "rules", "spellcheck"], "readOnly": false, "type": "null or one of \"off\", \"error\", \"warning\""}, "treefmt.config.programs.autocorrect.settings.spellcheck": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Spellcheck configuration.", "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "spellcheck"], "readOnly": false, "type": "null or (submodule)"}, "treefmt.config.programs.autocorrect.settings.spellcheck.words": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Correct Words (Case insensitive) for by Spellcheck.", "example": {"_type": "literalExpression", "text": "[\n \"GitHub\"\n \"App Store\"\n \"AppStore = App Store\"\n \"Git\"\n \"Node.js\"\n \"nodejs = Node.js\"\n \"VIM\"\n \"DNS\"\n \"HTTP\"\n \"SSL\"\n]"}, "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "spellcheck", "words"], "readOnly": false, "type": "null or (list of string)"}, "treefmt.config.programs.autocorrect.settings.textRules": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Configure special rules for some texts.", "example": {"_type": "literalExpression", "text": "{\n \"Hello\u4f60\u597d\" = \"warning\";\n \"Hi\u4f60\u597d\" = \"off\";\n}"}, "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "textRules"], "readOnly": false, "type": "null or (attribute set of (null or one of \"off\", \"error\", \"warning\"))"}, "treefmt.config.programs.autocorrect.threads": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Number of threads, 0 - use number of CPU. [default: 0]", "example": {"_type": "literalExpression", "text": "2"}, "loc": ["treefmt", "config", "programs", "autocorrect", "threads"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.beautysh.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/beautysh.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/beautysh.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable beautysh.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "beautysh", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.beautysh.indent_size": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/beautysh.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/beautysh.nix"}], "default": {"_type": "literalExpression", "text": "2"}, "description": "Sets the number of spaces to be used in indentation.\n", "example": {"_type": "literalExpression", "text": "4"}, "loc": ["treefmt", "config", "programs", "beautysh", "indent_size"], "readOnly": false, "type": "signed integer"}, "treefmt.config.programs.biome.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/biome.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/biome.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable biome.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "biome", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.biome.formatCommand": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/biome.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/biome.nix"}], "default": {"_type": "literalExpression", "text": "\"check\""}, "description": "The command to run Biome with.", "example": {"_type": "literalExpression", "text": "\"format\""}, "loc": ["treefmt", "config", "programs", "biome", "formatCommand"], "readOnly": false, "type": "one of \"format\", \"lint\", \"check\""}, "treefmt.config.programs.biome.formatUnsafe": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/biome.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/biome.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Allows to format a document that has unsafe fixes.", "loc": ["treefmt", "config", "programs", "biome", "formatUnsafe"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.biome.settings": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/biome.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/biome.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Raw Biome configuration (must conform to Biome JSON schema)", "example": {"_type": "literalExpression", "text": "{\n formatter = {\n indentStyle = \"space\";\n lineWidth = 100;\n };\n javascript = {\n formatter = {\n lineWidth = 120;\n quoteStyle = \"single\";\n };\n };\n json = {\n formatter = {\n enabled = false;\n };\n };\n}"}, "loc": ["treefmt", "config", "programs", "biome", "settings"], "readOnly": false, "type": "JSON value"}, "treefmt.config.programs.biome.validate.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/biome.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/biome.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to validate `treefmt.config.programs.biome.settings`.", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "biome", "validate", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.biome.validate.schema": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/biome.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/biome.nix"}], "default": {"_type": "literalMD", "text": "Fetches `\"https://biomejs.dev/schemas/${biomeVersion}/schema.json\"` using `pkgs.fetchurl`.\n"}, "description": "The biome schema file to validate against", "example": {"_type": "literalExpression", "text": "pkgs.fetchurl {\n url = \"https://biomejs.dev/schemas/2.1.2/schema.json\"\n hash = \"sha256-n4Y16J7g34e0VdQzRItu/P7n5oppkY4Vm4P1pQxOILU=\";\n}\n"}, "loc": ["treefmt", "config", "programs", "biome", "validate", "schema"], "readOnly": false, "type": "absolute path"}, "treefmt.config.programs.black.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/black.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/black.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable black.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "black", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.buf.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/buf.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/buf.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable buf.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "buf", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.buildifier.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/buildifier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/buildifier.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable buildifier.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "buildifier", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.cabal-fmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/cabal-fmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/cabal-fmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable cabal-fmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "cabal-fmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.cabal-gild.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/cabal-gild.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/cabal-gild.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable cabal-gild.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "cabal-gild", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.clang-format.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/clang-format.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/clang-format.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable clang-format.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "clang-format", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.clang-tidy.compileCommandsPath": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/clang-tidy.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/clang-tidy.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "used to read a compile command database", "example": {"_type": "literalExpression", "text": "\"/my/cmake/build/directory\""}, "loc": ["treefmt", "config", "programs", "clang-tidy", "compileCommandsPath"], "readOnly": false, "type": "null or absolute path or string"}, "treefmt.config.programs.clang-tidy.configFile": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/clang-tidy.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/clang-tidy.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Specify the path of .clang-tidy or custom config file", "example": {"_type": "literalExpression", "text": "\"/some/path/myTidyConfigFile\""}, "loc": ["treefmt", "config", "programs", "clang-tidy", "configFile"], "readOnly": false, "type": "null or absolute path"}, "treefmt.config.programs.clang-tidy.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/clang-tidy.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/clang-tidy.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable clang-tidy.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "clang-tidy", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.clang-tidy.quiet": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/clang-tidy.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/clang-tidy.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Run clang-tidy in quiet mode", "loc": ["treefmt", "config", "programs", "clang-tidy", "quiet"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.cljfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/cljfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/cljfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable cljfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "cljfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.cmake-format.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/cmake-format.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/cmake-format.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable cmake-format.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "cmake-format", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.csharpier.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/csharpier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/csharpier.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable csharpier.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "csharpier", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.cue.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/cue.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/cue.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable cue.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "cue", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.d2.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/d2.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/d2.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable d2.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "d2", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.dart-format.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dart-format.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dart-format.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable dart-format.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "dart-format", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.deadnix.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/deadnix.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/deadnix.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable deadnix.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "deadnix", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.deadnix.no-lambda-arg": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/deadnix.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/deadnix.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Don't check lambda parameter arguments.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "deadnix", "no-lambda-arg"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.deadnix.no-lambda-pattern-names": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/deadnix.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/deadnix.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Don't check lambda attrset pattern names (don't break nixpkgs callPackage).", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "deadnix", "no-lambda-pattern-names"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.deadnix.no-underscore": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/deadnix.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/deadnix.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Don't check any bindings that start with a _.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "deadnix", "no-underscore"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.deno.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/deno.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/deno.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable deno.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "deno", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.detekt.buildUponDefaultConfig": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/detekt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/detekt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Preconfigures detekt with a bunch of rules and some opinionated defaults for you. Allows additional provided configurations to override the defaults.", "loc": ["treefmt", "config", "programs", "detekt", "buildUponDefaultConfig"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.detekt.configFile": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/detekt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/detekt.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Path to detekt configuration file", "example": {"_type": "literalExpression", "text": "\"./detekt-config.yml\""}, "loc": ["treefmt", "config", "programs", "detekt", "configFile"], "readOnly": false, "type": "null or absolute path"}, "treefmt.config.programs.detekt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/detekt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/detekt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable detekt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "detekt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.dfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable dfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "dfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.dhall.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dhall.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dhall.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable dhall.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "dhall", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.dhall.lint": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dhall.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dhall.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to lint in addition to formatting.", "loc": ["treefmt", "config", "programs", "dhall", "lint"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.djlint.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/djlint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/djlint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable djlint.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "djlint", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.djlint.ignoreRules": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/djlint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/djlint.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Which H-rules to ignore", "loc": ["treefmt", "config", "programs", "djlint", "ignoreRules"], "readOnly": false, "type": "list of string"}, "treefmt.config.programs.djlint.indent": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/djlint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/djlint.nix"}], "default": {"_type": "literalExpression", "text": "4"}, "description": "Default indentation depth in spaces", "loc": ["treefmt", "config", "programs", "djlint", "indent"], "readOnly": false, "type": "unsigned integer, meaning >=0"}, "treefmt.config.programs.djlint.lint": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/djlint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/djlint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to lint in addition to formatting.", "loc": ["treefmt", "config", "programs", "djlint", "lint"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.dnscontrol.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dnscontrol.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dnscontrol.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable dnscontrol.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "dnscontrol", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.dockerfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dockerfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dockerfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable dockerfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "dockerfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.dockfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dockfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dockfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable dockfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "dockfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.dos2unix.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dos2unix.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dos2unix.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable dos2unix.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "dos2unix", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.dprint.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable dprint.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "dprint", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.dprint.settings": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Configuration to generate dprint.json with", "loc": ["treefmt", "config", "programs", "dprint", "settings"], "readOnly": false, "type": "open submodule of (JSON value)"}, "treefmt.config.programs.dprint.settings.extends": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Configurations to extend.", "example": {"_type": "literalExpression", "text": "\"https://dprint.dev/path/to/config/file.v1.json\""}, "loc": ["treefmt", "config", "programs", "dprint", "settings", "extends"], "readOnly": false, "type": "null or string or list of string"}, "treefmt.config.programs.dprint.settings.incremental": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to format files only when they change.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "dprint", "settings", "incremental"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.dprint.settings.indentWidth": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The number of characters for an indent", "example": {"_type": "literalExpression", "text": "2"}, "loc": ["treefmt", "config", "programs", "dprint", "settings", "indentWidth"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.dprint.settings.lineWidth": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The width of a line the printer will try to stay under. Note that the\nprinter may exceed this width in certain cases.\n", "example": {"_type": "literalExpression", "text": "80"}, "loc": ["treefmt", "config", "programs", "dprint", "settings", "lineWidth"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.dprint.settings.newLineKind": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The kind of newline to use (one of: auto, crlf, lf, system).\n", "example": {"_type": "literalExpression", "text": "\"auto\""}, "loc": ["treefmt", "config", "programs", "dprint", "settings", "newLineKind"], "readOnly": false, "type": "null or string"}, "treefmt.config.programs.dprint.settings.plugins": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Array of plugin URLs to format files.", "example": {"_type": "literalExpression", "text": "# (recommended) using plugins from nixpkgs\n# plugins is the list of all available dprint plugins in nixpkgs\n(pkgs.dprint-plugins.getPluginList (\n plugins: with plugins; [\n dprint-plugin-toml\n dprint-plugin-dockerfile\n g-plane-pretty_yaml\n # (pkgs.callPackage ./dprint/plugins/sample.nix {})\n ]\n))\n# (not recommended) using url plugins\n# treefmt then only works outside the nix sandbox, so treefmt nix flake check will fail\n++ [\n \"https://plugins.dprint.dev/json-0.17.2.wasm\"\n \"https://plugins.dprint.dev/markdown-0.15.2.wasm\"\n \"https://plugins.dprint.dev/typescript-0.84.4.wasm\"\n]\n"}, "loc": ["treefmt", "config", "programs", "dprint", "settings", "plugins"], "readOnly": false, "type": "null or (list of string)"}, "treefmt.config.programs.dprint.settings.useTabs": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to use tabs (true) or spaces (false) for indentation.\n", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "dprint", "settings", "useTabs"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.dscanner.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dscanner.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dscanner.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable dscanner.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "dscanner", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.efmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/efmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/efmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable efmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "efmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.elm-format.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/elm-format.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/elm-format.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable elm-format.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "elm-format", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.erlfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/erlfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/erlfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable erlfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "erlfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.erlfmt.print-width": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/erlfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/erlfmt.nix"}], "default": {"_type": "literalExpression", "text": "100"}, "description": "The line length that formatter would wrap on", "example": {"_type": "literalExpression", "text": "80"}, "loc": ["treefmt", "config", "programs", "erlfmt", "print-width"], "readOnly": false, "type": "signed integer"}, "treefmt.config.programs.fantomas.dotnet-sdk": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/fantomas.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/fantomas.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.dotnet-sdk"}, "description": "The dotnet-sdk package to use.", "loc": ["treefmt", "config", "programs", "fantomas", "dotnet-sdk"], "readOnly": false, "type": "package"}, "treefmt.config.programs.fantomas.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/fantomas.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/fantomas.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable fantomas.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "fantomas", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.fish_indent.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/fish_indent.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/fish_indent.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable fish_indent.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "fish_indent", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.flake-edit.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/flake-edit.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/flake-edit.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable flake-edit.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "flake-edit", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.flake-edit.noLock": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/flake-edit.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/flake-edit.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Skip updating the lockfile after editing flake.nix", "loc": ["treefmt", "config", "programs", "flake-edit", "noLock"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.flake-edit.settings.follow.aliases": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/flake-edit.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/flake-edit.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Mapping of canonical input names to alternative names.\nAllows nested inputs like \"nixpkgs-lib\" to follow \"nixpkgs\".\n", "example": {"_type": "literalExpression", "text": "{\n nixpkgs = [\n \"nixpkgs-lib\"\n ];\n}"}, "loc": ["treefmt", "config", "programs", "flake-edit", "settings", "follow", "aliases"], "readOnly": false, "type": "attribute set of list of string"}, "treefmt.config.programs.flake-edit.settings.follow.ignore": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/flake-edit.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/flake-edit.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of inputs to ignore when following.\nSupports simple names (\"systems\") or full paths (\"crane.nixpkgs\").\n", "example": {"_type": "literalExpression", "text": "[\n \"systems\"\n \"crane.flake-utils\"\n]"}, "loc": ["treefmt", "config", "programs", "flake-edit", "settings", "follow", "ignore"], "readOnly": false, "type": "list of string"}, "treefmt.config.programs.fnlfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/fnlfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/fnlfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable fnlfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "fnlfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.formatjson5.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/formatjson5.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/formatjson5.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable formatjson5.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "formatjson5", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.formatjson5.indent": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/formatjson5.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/formatjson5.nix"}], "default": {"_type": "literalExpression", "text": "4"}, "description": "Indent by the given number of spaces", "loc": ["treefmt", "config", "programs", "formatjson5", "indent"], "readOnly": false, "type": "signed integer"}, "treefmt.config.programs.formatjson5.noTrailingCommas": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/formatjson5.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/formatjson5.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Suppress trailing commas (otherwise added by default)", "loc": ["treefmt", "config", "programs", "formatjson5", "noTrailingCommas"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.formatjson5.oneElementLines": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/formatjson5.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/formatjson5.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Objects or arrays with a single child should collapse to a single line", "loc": ["treefmt", "config", "programs", "formatjson5", "oneElementLines"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.formatjson5.sortArrays": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/formatjson5.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/formatjson5.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Sort arrays of primitive values (string, number, boolean, or null) lexicographically", "loc": ["treefmt", "config", "programs", "formatjson5", "sortArrays"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.fourmolu.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/fourmolu.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/fourmolu.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable fourmolu.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "fourmolu", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.fourmolu.ghcOpts": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/fourmolu.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/fourmolu.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"BangPatterns\"\n \"PatternSynonyms\"\n \"TypeApplications\"\n]"}, "description": "Which GHC language extensions to enable", "loc": ["treefmt", "config", "programs", "fourmolu", "ghcOpts"], "readOnly": false, "type": "unspecified value"}, "treefmt.config.programs.fprettify.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/fprettify.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/fprettify.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable fprettify.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "fprettify", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.gdformat.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/gdformat.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/gdformat.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable gdformat.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "gdformat", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.genemichaels.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable [`genemichaels`](https://github.com/andrewbaxter/genemichaels/blob/master/readme_genemichaels.md), a Rust code formatter.\n", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "genemichaels", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.genemichaels.settings.comment_errors_fatal": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "If reformatting comments results in an error, abort formatting the\ndocument.\n", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "genemichaels", "settings", "comment_errors_fatal"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.genemichaels.settings.comment_width": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix"}], "default": {"_type": "literalExpression", "text": "80"}, "description": "Maximum relative line length for comments (past the comment\nindentation level). Can be `null` to disable relative wrapping. If\ndisabled, still wraps at `max_width`.\n", "example": {"_type": "literalExpression", "text": "null"}, "loc": ["treefmt", "config", "programs", "genemichaels", "settings", "comment_width"], "readOnly": false, "type": "null or (positive integer, meaning >0)"}, "treefmt.config.programs.genemichaels.settings.keep_max_blank_lines": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix"}], "default": {"_type": "literalExpression", "text": "0"}, "description": "Genemichaels will replace line breaks with it's own deterministic\nline breaks. You can use this to keep extra line breaks (1 will keep\nup to 1 extra line break) during comment extraction. This is unused\nduring formatting.\n", "example": {"_type": "literalExpression", "text": "1"}, "loc": ["treefmt", "config", "programs", "genemichaels", "settings", "keep_max_blank_lines"], "readOnly": false, "type": "unsigned integer, meaning >=0"}, "treefmt.config.programs.genemichaels.settings.max_width": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix"}], "default": {"_type": "literalExpression", "text": "120"}, "description": "Ideal maximum line width. If there's an unbreakable element the line\nwon't be split.\n", "example": {"_type": "literalExpression", "text": "80"}, "loc": ["treefmt", "config", "programs", "genemichaels", "settings", "max_width"], "readOnly": false, "type": "positive integer, meaning >0"}, "treefmt.config.programs.genemichaels.settings.root_splits": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "When breaking a child element, also break all parent elements.\n", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "genemichaels", "settings", "root_splits"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.genemichaels.settings.split_attributes": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Break a `#[]` on a separate line before the element it's associated\nwith.\n", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "genemichaels", "settings", "split_attributes"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.genemichaels.settings.split_brace_threshold": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix"}], "default": {"_type": "literalExpression", "text": "1"}, "description": "Break a `()` or `{}` if it has greater than this number of children.\nSet to `null` to disable breaking due to high child counts.\n", "example": {"_type": "literalExpression", "text": "null"}, "loc": ["treefmt", "config", "programs", "genemichaels", "settings", "split_brace_threshold"], "readOnly": false, "type": "null or (positive integer, meaning >0)"}, "treefmt.config.programs.genemichaels.settings.split_where": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Put the `where` clause on a new line.\n", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "genemichaels", "settings", "split_where"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.genemichaels.settingsFile": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix"}], "default": {"_type": "literalMD", "text": "Generated JSON file from `treefmt.config.programs.genemichaels.settings`"}, "description": "The configuration file used by `genemichaels`.", "example": {"_type": "literalExpression", "text": "./.genemichaels.json"}, "loc": ["treefmt", "config", "programs", "genemichaels", "settingsFile"], "readOnly": false, "type": "absolute path"}, "treefmt.config.programs.genemichaels.threadCount": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "How many threads to use for formatting multiple files. Set to `null` to\ndefault to the number of cores on the system.\n", "example": {"_type": "literalExpression", "text": "1"}, "loc": ["treefmt", "config", "programs", "genemichaels", "threadCount"], "readOnly": false, "type": "null or (unsigned integer, meaning >=0)"}, "treefmt.config.programs.gleam.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/gleam.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/gleam.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable gleam.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "gleam", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.gofmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/gofmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/gofmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable gofmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "gofmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.gofumpt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/gofumpt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/gofumpt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable gofumpt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "gofumpt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.gofumpt.extra": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/gofumpt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/gofumpt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable extra rules.\n", "loc": ["treefmt", "config", "programs", "gofumpt", "extra"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.goimports.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/goimports.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/goimports.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable goimports.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "goimports", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.golangci-lint.buildTags": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Build tags to use during analysis", "example": {"_type": "literalExpression", "text": "[\n \"integration\"\n \"e2e\"\n]"}, "loc": ["treefmt", "config", "programs", "golangci-lint", "buildTags"], "readOnly": false, "type": "list of string"}, "treefmt.config.programs.golangci-lint.concurrency": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Number of CPUs to use (auto-configured by default)", "example": {"_type": "literalExpression", "text": "4"}, "loc": ["treefmt", "config", "programs", "golangci-lint", "concurrency"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.golangci-lint.configFile": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Path to golangci-lint configuration file", "example": {"_type": "literalExpression", "text": "\".golangci.yml\""}, "loc": ["treefmt", "config", "programs", "golangci-lint", "configFile"], "readOnly": false, "type": "null or string"}, "treefmt.config.programs.golangci-lint.disableLinters": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Disable specific linters", "example": {"_type": "literalExpression", "text": "[\n \"typecheck\"\n]"}, "loc": ["treefmt", "config", "programs", "golangci-lint", "disableLinters"], "readOnly": false, "type": "list of string"}, "treefmt.config.programs.golangci-lint.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable golangci-lint.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "golangci-lint", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.golangci-lint.enableLinters": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Enable specific linters", "example": {"_type": "literalExpression", "text": "[\n \"govet\"\n \"errcheck\"\n \"staticcheck\"\n]"}, "loc": ["treefmt", "config", "programs", "golangci-lint", "enableLinters"], "readOnly": false, "type": "list of string"}, "treefmt.config.programs.golangci-lint.enableOnly": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Override configuration to run only specific linter(s)", "example": {"_type": "literalExpression", "text": "[\n \"govet\"\n \"gofmt\"\n]"}, "loc": ["treefmt", "config", "programs", "golangci-lint", "enableOnly"], "readOnly": false, "type": "list of string"}, "treefmt.config.programs.golangci-lint.fastOnly": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Run only fast linters from enabled linters set", "loc": ["treefmt", "config", "programs", "golangci-lint", "fastOnly"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.golangci-lint.maxIssuesPerLinter": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Maximum issues per linter (default: 50)", "example": {"_type": "literalExpression", "text": "50"}, "loc": ["treefmt", "config", "programs", "golangci-lint", "maxIssuesPerLinter"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.golangci-lint.maxSameIssues": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Maximum count of same issues (default: 3)", "example": {"_type": "literalExpression", "text": "3"}, "loc": ["treefmt", "config", "programs", "golangci-lint", "maxSameIssues"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.golangci-lint.newFromRev": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Show only new issues created after git revision REV", "example": {"_type": "literalExpression", "text": "\"HEAD~1\""}, "loc": ["treefmt", "config", "programs", "golangci-lint", "newFromRev"], "readOnly": false, "type": "null or string"}, "treefmt.config.programs.golangci-lint.noConfig": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Don't read any configuration file", "loc": ["treefmt", "config", "programs", "golangci-lint", "noConfig"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.golangci-lint.tests": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Analyze test files", "loc": ["treefmt", "config", "programs", "golangci-lint", "tests"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.golangci-lint.timeout": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Timeout for total work (e.g., '5m', '1h', '10s')", "example": {"_type": "literalExpression", "text": "\"5m\""}, "loc": ["treefmt", "config", "programs", "golangci-lint", "timeout"], "readOnly": false, "type": "null or string"}, "treefmt.config.programs.golangci-lint.verbose": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Enable verbose output", "loc": ["treefmt", "config", "programs", "golangci-lint", "verbose"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.golines.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golines.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golines.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable golines.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "golines", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.golines.maxLength": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golines.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golines.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Target maximum line length (default: 100)\n", "example": {"_type": "literalExpression", "text": "100"}, "loc": ["treefmt", "config", "programs", "golines", "maxLength"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.golines.tabLength": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golines.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golines.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Length of a tab (default: 4)\n", "example": {"_type": "literalExpression", "text": "4"}, "loc": ["treefmt", "config", "programs", "golines", "tabLength"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.google-java-format.aospStyle": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/google-java-format.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/google-java-format.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to use AOSP (Android Open Source Project) indentation.\nIn a few words, use 4-space indentation rather than the conventional\n2-space indentation width that Google uses.\n", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "google-java-format", "aospStyle"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.google-java-format.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/google-java-format.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/google-java-format.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable google-java-format.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "google-java-format", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.hclfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/hclfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/hclfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable hclfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "hclfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.hlint.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/hlint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/hlint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable hlint.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "hlint", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.hujsonfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/hujsonfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/hujsonfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable hujsonfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "hujsonfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.isort.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/isort.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/isort.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable isort.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "isort", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.isort.profile": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/isort.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/isort.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "The profile to use for isort.\n", "loc": ["treefmt", "config", "programs", "isort", "profile"], "readOnly": false, "type": "string"}, "treefmt.config.programs.json-sort-cli.autofix": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/json-sort-cli.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/json-sort-cli.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Update files with fixes instead of just reporting.\nDefaults to `false`.\n", "loc": ["treefmt", "config", "programs", "json-sort-cli", "autofix"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.json-sort-cli.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/json-sort-cli.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/json-sort-cli.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable json-sort-cli.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "json-sort-cli", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.json-sort-cli.end-of-line": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/json-sort-cli.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/json-sort-cli.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Specify the desired line ending for output.\nDefaults to system line ending.\nOverrides `.editorconfig` settings if an `.editorconfig` is found.\n", "loc": ["treefmt", "config", "programs", "json-sort-cli", "end-of-line"], "readOnly": false, "type": "null or one of \"lf\", \"crlf\", \"cr\", \"unset\""}, "treefmt.config.programs.json-sort-cli.indent-size": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/json-sort-cli.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/json-sort-cli.nix"}], "default": {"_type": "literalExpression", "text": "2"}, "description": "Number of spaces to indent, or the string \"tab\" to use tabs.\nDefaults to 2 spaces. Overrides `.editorconfig` settings if an `.editorconfig` is found.\n", "loc": ["treefmt", "config", "programs", "json-sort-cli", "indent-size"], "readOnly": false, "type": "signed integer"}, "treefmt.config.programs.json-sort-cli.indent-style": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/json-sort-cli.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/json-sort-cli.nix"}], "default": {"_type": "literalExpression", "text": "\"space\""}, "description": "Specify the desired indentation style for output.\nDefaults to `space`. Overrides `.editorconfig` settings if an `.editorconfig` is found.\n", "loc": ["treefmt", "config", "programs", "json-sort-cli", "indent-style"], "readOnly": false, "type": "one of \"space\", \"tab\""}, "treefmt.config.programs.json-sort-cli.insert-final-newline": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/json-sort-cli.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/json-sort-cli.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Insert a final newline after the sort. Defaults to `false`.\nOverrides `.editorconfig` settings if an `.editorconfig` is found.\n", "loc": ["treefmt", "config", "programs", "json-sort-cli", "insert-final-newline"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.jsonfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/jsonfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/jsonfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable jsonfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "jsonfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.jsonnet-lint.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/jsonnet-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/jsonnet-lint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable jsonnet-lint.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "jsonnet-lint", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.jsonnetfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/jsonnetfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/jsonnetfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable jsonnetfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "jsonnetfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.just.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/just.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/just.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable just.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "just", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.kdlfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/kdlfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/kdlfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable kdlfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "kdlfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.keep-sorted.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/keep-sorted.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/keep-sorted.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable keep-sorted.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "keep-sorted", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.ktfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/ktfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/ktfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable ktfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "ktfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.ktlint.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/ktlint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/ktlint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable ktlint.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "ktlint", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.latexindent.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/latexindent.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/latexindent.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable latexindent.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "latexindent", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.leptosfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/leptosfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/leptosfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable leptosfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "leptosfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.mbake.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable mbake.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "mbake", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.mbake.settings.auto_insert_phony_declarations": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to automatically insert .PHONY declarations for non-file targets", "loc": ["treefmt", "config", "programs", "mbake", "settings", "auto_insert_phony_declarations"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.mbake.settings.ensure_final_newline": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to ensure the file ends with a newline", "loc": ["treefmt", "config", "programs", "mbake", "settings", "ensure_final_newline"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.mbake.settings.fix_missing_recipe_tabs": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to fix recipe lines that are missing tabs", "loc": ["treefmt", "config", "programs", "mbake", "settings", "fix_missing_recipe_tabs"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.mbake.settings.group_phony_declarations": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to group all .PHONY declarations together", "loc": ["treefmt", "config", "programs", "mbake", "settings", "group_phony_declarations"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.mbake.settings.indent_nested_conditionals": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to indent nested conditional blocks (ifdef, ifndef, etc.)", "loc": ["treefmt", "config", "programs", "mbake", "settings", "indent_nested_conditionals"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.mbake.settings.max_consecutive_empty_lines": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Maximum number of consecutive empty lines allowed", "loc": ["treefmt", "config", "programs", "mbake", "settings", "max_consecutive_empty_lines"], "readOnly": false, "type": "null or (unsigned integer, meaning >=0)"}, "treefmt.config.programs.mbake.settings.max_line_length": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Maximum line length before wrapping", "loc": ["treefmt", "config", "programs", "mbake", "settings", "max_line_length"], "readOnly": false, "type": "null or (unsigned integer, meaning >=0)"}, "treefmt.config.programs.mbake.settings.normalize_empty_lines": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to normalize empty lines", "loc": ["treefmt", "config", "programs", "mbake", "settings", "normalize_empty_lines"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.mbake.settings.normalize_line_continuations": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to normalize line continuation backslashes", "loc": ["treefmt", "config", "programs", "mbake", "settings", "normalize_line_continuations"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.mbake.settings.phony_at_top": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to place .PHONY declarations at the top of the file", "loc": ["treefmt", "config", "programs", "mbake", "settings", "phony_at_top"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.mbake.settings.remove_trailing_whitespace": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to remove trailing whitespace from lines", "loc": ["treefmt", "config", "programs", "mbake", "settings", "remove_trailing_whitespace"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.mbake.settings.space_after_colon": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to add a space after colons in rules", "loc": ["treefmt", "config", "programs", "mbake", "settings", "space_after_colon"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.mbake.settings.space_around_assignment": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to add spaces around assignment operators (=, :=, etc.)", "loc": ["treefmt", "config", "programs", "mbake", "settings", "space_around_assignment"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.mbake.settings.space_before_colon": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to add a space before colons in rules", "loc": ["treefmt", "config", "programs", "mbake", "settings", "space_before_colon"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.mbake.settings.tab_width": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Tab width in spaces for display purposes", "loc": ["treefmt", "config", "programs", "mbake", "settings", "tab_width"], "readOnly": false, "type": "null or (unsigned integer, meaning >=0)"}, "treefmt.config.programs.mdformat.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mdformat.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mdformat.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable mdformat.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "mdformat", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.mdformat.plugins": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mdformat.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mdformat.nix"}], "default": {"_type": "literalExpression", "text": "ps: [ ];\n"}, "description": "Plugins for mdformat that extend its functionality (for Markdown\nextensions, formatting code blocks, etc).\n\nSee [mdformat docs](https://mdformat.readthedocs.io/en/stable/users/plugins.html)\nfor a (non-exhaustive) list of plugins.\n", "example": {"_type": "literalExpression", "text": "ps: [\n ps.mdformat-footnote\n ps.mdformat-gfm\n];\n"}, "loc": ["treefmt", "config", "programs", "mdformat", "plugins"], "readOnly": false, "type": "function that evaluates to a(n) list of package"}, "treefmt.config.programs.mdformat.settings.end-of-line": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mdformat.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mdformat.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Output file line ending mode.\n", "example": {"_type": "literalExpression", "text": "\"lf\""}, "loc": ["treefmt", "config", "programs", "mdformat", "settings", "end-of-line"], "readOnly": false, "type": "null or one of \"crlf\", \"lf\", \"keep\""}, "treefmt.config.programs.mdformat.settings.number": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mdformat.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mdformat.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Apply consecutive numbering to ordered lists.\n", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "mdformat", "settings", "number"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.mdformat.settings.wrap": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mdformat.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mdformat.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Paragraph word wrap mode.\nSet to an INTEGER to wrap at that length.\n", "example": {"_type": "literalExpression", "text": "\"keep\""}, "loc": ["treefmt", "config", "programs", "mdformat", "settings", "wrap"], "readOnly": false, "type": "null or signed integer or one of \"keep\", \"no\""}, "treefmt.config.programs.mdsh.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mdsh.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mdsh.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable mdsh.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "mdsh", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.meson.editorconfig": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/meson.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/meson.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Try to read configuration from .editorconfig\n", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "meson", "editorconfig"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.meson.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/meson.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/meson.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable meson.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "meson", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.mix-format.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mix-format.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mix-format.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable mix-format.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "mix-format", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.muon.editorconfig": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/muon.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/muon.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Try to read configuration from .editorconfig\n", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "muon", "editorconfig"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.muon.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/muon.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/muon.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable muon.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "muon", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.mypy.directories": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mypy.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mypy.nix"}], "default": {"_type": "literalExpression", "text": "{\n \"\" = { };\n}"}, "description": "Directories to run mypy in", "example": {"_type": "literalExpression", "text": "{\n \"\" = {\n modules = [\n \"mymodule\"\n \"tests\"\n ];\n };\n subdir = { };\n}"}, "loc": ["treefmt", "config", "programs", "mypy", "directories"], "readOnly": false, "type": "attribute set of (submodule)"}, "treefmt.config.programs.mypy.directories..directory": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mypy.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mypy.nix"}], "default": {"_type": "literalExpression", "text": "\"\u2039name\u203a\""}, "description": "Directory to run mypy in", "loc": ["treefmt", "config", "programs", "mypy", "directories", "", "directory"], "readOnly": false, "type": "string"}, "treefmt.config.programs.mypy.directories..extraPythonPackages": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mypy.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mypy.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Extra packages to add to PYTHONPATH", "example": {"_type": "literalMD", "text": "[ pkgs.python3.pkgs.requests ]"}, "loc": ["treefmt", "config", "programs", "mypy", "directories", "", "extraPythonPackages"], "readOnly": false, "type": "list of package"}, "treefmt.config.programs.mypy.directories..extraPythonPaths": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mypy.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mypy.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Extra paths to add to PYTHONPATH.\nPaths are interpreted relative to the directory options and are added before extraPythonPackages.\n", "example": {"_type": "literalExpression", "text": "[\n \"path/to/my/module\"\n]"}, "loc": ["treefmt", "config", "programs", "mypy", "directories", "", "extraPythonPaths"], "readOnly": false, "type": "list of string"}, "treefmt.config.programs.mypy.directories..modules": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mypy.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mypy.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"\"\n]"}, "description": "Modules to check", "example": {"_type": "literalExpression", "text": "[\n \"mymodule\"\n \"tests\"\n]"}, "loc": ["treefmt", "config", "programs", "mypy", "directories", "", "modules"], "readOnly": false, "type": "list of string"}, "treefmt.config.programs.mypy.directories..options": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mypy.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mypy.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Options to pass to mypy", "example": {"_type": "literalExpression", "text": "[\n \"--ignore-missing-imports\"\n]"}, "loc": ["treefmt", "config", "programs", "mypy", "directories", "", "options"], "readOnly": false, "type": "list of string"}, "treefmt.config.programs.mypy.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mypy.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mypy.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable mypy.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "mypy", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.nbstripout.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/nbstripout.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/nbstripout.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable nbstripout.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "nbstripout", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.nickel.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/nickel.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/nickel.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable nickel.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "nickel", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.nimpretty.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/nimpretty.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/nimpretty.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable nimpretty.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "nimpretty", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.nixf-diagnose.autoFix": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixf-diagnose.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixf-diagnose.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to automatically apply fixes to source files.", "loc": ["treefmt", "config", "programs", "nixf-diagnose", "autoFix"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.nixf-diagnose.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixf-diagnose.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixf-diagnose.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable nixf-diagnose.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "nixf-diagnose", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.nixf-diagnose.ignore": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixf-diagnose.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixf-diagnose.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Diagnostics to ignore, specified by their ID.", "example": {"_type": "literalExpression", "text": "[\n \"sema-primop-overridden\"\n]"}, "loc": ["treefmt", "config", "programs", "nixf-diagnose", "ignore"], "readOnly": false, "type": "list of string"}, "treefmt.config.programs.nixf-diagnose.only": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixf-diagnose.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixf-diagnose.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Only run this diagnostic.", "example": {"_type": "literalExpression", "text": "\"sema-primop-overridden\""}, "loc": ["treefmt", "config", "programs", "nixf-diagnose", "only"], "readOnly": false, "type": "null or string"}, "treefmt.config.programs.nixf-diagnose.variableLookup": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixf-diagnose.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixf-diagnose.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to enable variable lookup analysis.", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "nixf-diagnose", "variableLookup"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.nixfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable nixfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "nixfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.nixfmt.indent": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixfmt.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Number of spaces to use for indentation [default: 2]\n", "example": {"_type": "literalExpression", "text": "4"}, "loc": ["treefmt", "config", "programs", "nixfmt", "indent"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.nixfmt.strict": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Enable a stricter formatting mode that isn't influenced\nas much by how the input is formatted.\n", "loc": ["treefmt", "config", "programs", "nixfmt", "strict"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.nixfmt.width": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixfmt.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Maximum width in characters [default: 100]\n", "example": {"_type": "literalExpression", "text": "120"}, "loc": ["treefmt", "config", "programs", "nixfmt", "width"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.nixpkgs-fmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixpkgs-fmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixpkgs-fmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable nixpkgs-fmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "nixpkgs-fmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.ocamlformat.configFile": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/ocamlformat.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/ocamlformat.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Path to the .ocamlformat file. Used to pick the right version of ocamlformat if passed.", "loc": ["treefmt", "config", "programs", "ocamlformat", "configFile"], "readOnly": false, "type": "null or absolute path"}, "treefmt.config.programs.ocamlformat.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/ocamlformat.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/ocamlformat.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable ocamlformat.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "ocamlformat", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.ocamlformat.pkgs": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/ocamlformat.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/ocamlformat.nix"}], "default": {"_type": "literalMD", "text": "Nixpkgs from context"}, "description": "The package set used to get the ocamlformat package at a specific version.", "loc": ["treefmt", "config", "programs", "ocamlformat", "pkgs"], "readOnly": false, "type": "lazy attribute set of raw value"}, "treefmt.config.programs.odinfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/odinfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/odinfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable odinfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "odinfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.opa.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/opa.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/opa.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable opa.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "opa", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.ormolu.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/ormolu.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/ormolu.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable ormolu.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "ormolu", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.ormolu.ghcOpts": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/ormolu.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/ormolu.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"BangPatterns\"\n \"PatternSynonyms\"\n \"TypeApplications\"\n]"}, "description": "Which GHC language extensions to enable", "loc": ["treefmt", "config", "programs", "ormolu", "ghcOpts"], "readOnly": false, "type": "unspecified value"}, "treefmt.config.programs.oxfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/oxfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/oxfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable oxfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "oxfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.oxipng.alpha": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/oxipng.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/oxipng.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Perform additional optimization on images with an alpha channel.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "oxipng", "alpha"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.oxipng.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/oxipng.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/oxipng.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable oxipng.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "oxipng", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.oxipng.opt": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/oxipng.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/oxipng.nix"}], "default": {"_type": "literalExpression", "text": "\"2\""}, "description": "Set the optimization level preset", "example": {"_type": "literalExpression", "text": "\"max\""}, "loc": ["treefmt", "config", "programs", "oxipng", "opt"], "readOnly": false, "type": "string"}, "treefmt.config.programs.oxipng.scale16": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/oxipng.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/oxipng.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Forcibly reduce images with 16 bits per channel to 8 bits per channel.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "oxipng", "scale16"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.oxipng.strip": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/oxipng.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/oxipng.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Strip metadata chunks", "example": {"_type": "literalExpression", "text": "\"safe\""}, "loc": ["treefmt", "config", "programs", "oxipng", "strip"], "readOnly": false, "type": "null or string"}, "treefmt.config.programs.packer.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/packer.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/packer.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable packer.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "packer", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.perltidy.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/perltidy.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/perltidy.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable perltidy.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "perltidy", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.perltidy.perltidyrc": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/perltidy.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/perltidy.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "A path for perltidy's configuration file, usually named .perltidyrc", "loc": ["treefmt", "config", "programs", "perltidy", "perltidyrc"], "readOnly": false, "type": "null or absolute path"}, "treefmt.config.programs.php-cs-fixer.configFile": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/php-cs-fixer.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/php-cs-fixer.nix"}], "default": {"_type": "literalExpression", "text": "\"./.php-cs-fixer.php\""}, "description": "Path to php-cs-fixer config file.", "example": {"_type": "literalExpression", "text": "\"./.php-cs-fixer.dist.php\""}, "loc": ["treefmt", "config", "programs", "php-cs-fixer", "configFile"], "readOnly": false, "type": "string or absolute path"}, "treefmt.config.programs.php-cs-fixer.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/php-cs-fixer.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/php-cs-fixer.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable php-cs-fixer.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "php-cs-fixer", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.pinact.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/pinact.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/pinact.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable pinact.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "pinact", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.pinact.settings": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/pinact.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/pinact.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Configuration for pinact, see\n\nfor supported values.\n", "loc": ["treefmt", "config", "programs", "pinact", "settings"], "readOnly": false, "type": "open submodule of (YAML 1.1 value)"}, "treefmt.config.programs.pinact.update": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/pinact.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/pinact.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Update actions to latest versions.", "loc": ["treefmt", "config", "programs", "pinact", "update"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.pinact.verify": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/pinact.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/pinact.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Verify if pairs of commit SHA and version are correct.", "loc": ["treefmt", "config", "programs", "pinact", "verify"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.prettier.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable prettier.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "prettier", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.prettier.settings.arrowParens": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Include parentheses around a sole arrow function parameter.", "example": {"_type": "literalExpression", "text": "\"always\""}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "arrowParens"], "readOnly": false, "type": "null or one of \"always\", \"avoid\""}, "treefmt.config.programs.prettier.settings.bracketSameLine": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Put > of opening tags on the last line instead of on a new line.\n", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "bracketSameLine"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.prettier.settings.bracketSpacing": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Print spaces between brackets", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "bracketSpacing"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.prettier.settings.cursorOffset": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Print (to stderr) where a cursor at the given position would move to\nafter formatting. This option cannot be used with --range-start and\n--range-end.\n", "example": {"_type": "literalExpression", "text": "-1"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "cursorOffset"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.prettier.settings.editorconfig": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether parse the .editorconfig file in your project and convert its\nproperties to the corresponding Prettier configuration. This\nconfiguration will be overridden by .prettierrc, etc.\n", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "editorconfig"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.prettier.settings.embeddedLanguageFormatting": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Control how Prettier formats quoted code embedded in the file.\n", "example": {"_type": "literalExpression", "text": "\"auto\""}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "embeddedLanguageFormatting"], "readOnly": false, "type": "null or one of \"auto\", \"off\""}, "treefmt.config.programs.prettier.settings.endOfLine": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Which end of line characters to apply.", "example": {"_type": "literalExpression", "text": "\"lf\""}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "endOfLine"], "readOnly": false, "type": "null or one of \"lf\", \"crlf\", \"cr\", \"auto\""}, "treefmt.config.programs.prettier.settings.filepath": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Specify the input filepath. This will be used to do parser inference.\n", "example": {"_type": "literalExpression", "text": "\"example.js\""}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "filepath"], "readOnly": false, "type": "null or string"}, "treefmt.config.programs.prettier.settings.htmlWhitespaceSensitivity": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "How to handle whitespaces in HTML.", "example": {"_type": "literalExpression", "text": "\"css\""}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "htmlWhitespaceSensitivity"], "readOnly": false, "type": "null or one of \"css\", \"strict\", \"ignore\""}, "treefmt.config.programs.prettier.settings.insertPragma": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Insert @format pragma into file's first docblock commentypes.\n", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "insertPragma"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.prettier.settings.jsxSingleQuote": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Use single quotes in JSX", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "jsxSingleQuote"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.prettier.settings.overrides": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Provide a list of patterns to override prettier configuration.\n", "example": {"_type": "literalExpression", "text": "{\n files = [\n \"*.html\"\n \"legacy/**/*.js\"\n ];\n options = {\n tabwidth = 4;\n };\n}"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "overrides"], "readOnly": false, "type": "null or (list of (attribute set))"}, "treefmt.config.programs.prettier.settings.parser": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Which parser to use.", "example": {"_type": "literalExpression", "text": "\"typescript\""}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "parser"], "readOnly": false, "type": "null or one of \"flow\", \"babel\", \"babel-flow\", \"babel-ts\", \"typescript\", \"acorn\", \"espree\", \"meriyah\", \"css\", \"less\", \"scss\", \"json\", \"json5\", \"json-stringify\", \"graphql\", \"markdown\", \"mdx\", \"vue\", \"yaml\", \"glimmer\", \"html\", \"angular\", \"lwc\" or string"}, "treefmt.config.programs.prettier.settings.pluginSearchDirs": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Custom directory that contains prettier plugins in node_modules\nsubdirectory. Overrides default behavior when plugins are searched\nrelatively to the location of Prettier.\\nMultiple values are accepted.\n", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "pluginSearchDirs"], "readOnly": false, "type": "null or (list of string) or value false (singular enum)"}, "treefmt.config.programs.prettier.settings.plugins": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Add a plugin. Multiple plugins can be passed as separate `--plugin`s.\n", "example": {"_type": "literalExpression", "text": "[\n \"@prettier/plugin-xml\"\n]"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "plugins"], "readOnly": false, "type": "null or (list of string)"}, "treefmt.config.programs.prettier.settings.printWidth": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The line length where Prettier will try wrap.", "example": {"_type": "literalExpression", "text": "80"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "printWidth"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.prettier.settings.proseWrap": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "How to wrap prose.", "example": {"_type": "literalExpression", "text": "\"preserve\""}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "proseWrap"], "readOnly": false, "type": "null or one of \"always\", \"never\", \"preserve\""}, "treefmt.config.programs.prettier.settings.quoteProps": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Change when properties in objects are quoted", "example": {"_type": "literalExpression", "text": "\"as-needed\""}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "quoteProps"], "readOnly": false, "type": "null or one of \"as-needed\", \"consistent\", \"preserve\""}, "treefmt.config.programs.prettier.settings.rangeEnd": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Format code ending at a given character offset (exclusive). The range\nwill extend forwards to the end of the selected statementypes. This\noption cannot be used with --cursor-offsetypes.\n", "example": {"_type": "literalExpression", "text": "0"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "rangeEnd"], "readOnly": false, "type": "null or string"}, "treefmt.config.programs.prettier.settings.rangeStart": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Format code starting at a given character offsetypes. The range will\nextend backwards to the start of the first line containing the selected\nstatementypes. his option cannot be used with --cursor-offsetypes.\n", "example": {"_type": "literalExpression", "text": "0"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "rangeStart"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.prettier.settings.requirePragma": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Require either '@prettier' or '@format' to be present in the file's\nfirst docblock comment\\nin order for it to be formatted.\n", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "requirePragma"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.prettier.settings.semi": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Print semicolons.", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "semi"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.prettier.settings.singleAttributePerLine": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Enforce single attribute per line in HTML, Vue and JSX.", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "singleAttributePerLine"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.prettier.settings.singleQuote": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Use single quotes instead of double quotes.", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "singleQuote"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.prettier.settings.tabWidth": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Number of spaces per indentation level.", "example": {"_type": "literalExpression", "text": "2"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "tabWidth"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.prettier.settings.trailingComma": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Print trailing commas wherever possible when multi-line.", "example": {"_type": "literalExpression", "text": "\"es5\""}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "trailingComma"], "readOnly": false, "type": "null or one of \"es5\", \"none\", \"all\""}, "treefmt.config.programs.prettier.settings.useTabs": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Indent with tabs instead of spaces", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "useTabs"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.prettier.settings.vueIndentScriptAndStyle": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Indent script and style tags in Vue files.", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "vueIndentScriptAndStyle"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.protolint.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/protolint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/protolint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable protolint.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "protolint", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.qmlformat.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/qmlformat.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/qmlformat.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable qmlformat.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "qmlformat", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.rstfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/rstfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/rstfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable rstfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "rstfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.rstfmt.line_length": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/rstfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/rstfmt.nix"}], "default": {"_type": "literalExpression", "text": "72"}, "description": "Sets the line length.\n", "example": {"_type": "literalExpression", "text": "80"}, "loc": ["treefmt", "config", "programs", "rstfmt", "line_length"], "readOnly": false, "type": "signed integer"}, "treefmt.config.programs.rubocop.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/rubocop.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/rubocop.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable rubocop.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "rubocop", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.ruff-check.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/ruff-check.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/ruff-check.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable ruff-check.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "ruff-check", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.ruff-check.extendSelect": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/ruff-check.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/ruff-check.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "--extend-select options\n", "example": {"_type": "literalExpression", "text": "[\n \"I\"\n]"}, "loc": ["treefmt", "config", "programs", "ruff-check", "extendSelect"], "readOnly": false, "type": "list of string"}, "treefmt.config.programs.ruff-format.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/ruff-format.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/ruff-format.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable ruff-format.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "ruff-format", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.ruff-format.lineLength": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/ruff-format.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/ruff-format.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Set the line-length.\n", "example": {"_type": "literalExpression", "text": "79"}, "loc": ["treefmt", "config", "programs", "ruff-format", "lineLength"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.rufo.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/rufo.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/rufo.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable rufo.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "rufo", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.rumdl-check.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/rumdl-check.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/rumdl-check.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable rumdl-check.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "rumdl-check", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.rumdl-format.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/rumdl-format.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/rumdl-format.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable rumdl-format.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "rumdl-format", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.rustfmt.edition": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/rustfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/rustfmt.nix"}], "default": {"_type": "literalExpression", "text": "\"2024\""}, "description": "Rust edition to target when formatting\n", "loc": ["treefmt", "config", "programs", "rustfmt", "edition"], "readOnly": false, "type": "string"}, "treefmt.config.programs.rustfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/rustfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/rustfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable rustfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "rustfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.scalafmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/scalafmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/scalafmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable scalafmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "scalafmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.shellcheck.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/shellcheck.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/shellcheck.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable shellcheck.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "shellcheck", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.shellcheck.external-sources": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/shellcheck.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/shellcheck.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Allow sources outside of `includes`.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "shellcheck", "external-sources"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.shellcheck.extra-checks": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/shellcheck.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/shellcheck.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of optional checks to enable (or \"all\")\n", "example": {"_type": "literalExpression", "text": "[\n \"all\"\n]"}, "loc": ["treefmt", "config", "programs", "shellcheck", "extra-checks"], "readOnly": false, "type": "list of string"}, "treefmt.config.programs.shellcheck.severity": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/shellcheck.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/shellcheck.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Minimum severity of errors to consider (\"error\", \"warning\", \"info\", \"style\")\n", "loc": ["treefmt", "config", "programs", "shellcheck", "severity"], "readOnly": false, "type": "null or string"}, "treefmt.config.programs.shellcheck.source-path": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/shellcheck.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/shellcheck.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Specify path when looking for sourced files (\"SCRIPTDIR\" for script's dir)\n", "loc": ["treefmt", "config", "programs", "shellcheck", "source-path"], "readOnly": false, "type": "null or string"}, "treefmt.config.programs.shfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/shfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/shfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable shfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "shfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.shfmt.indent_size": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/shfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/shfmt.nix"}], "default": {"_type": "literalExpression", "text": "2"}, "description": "Sets the number of spaces to be used in indentation. Uses tabs if set to\nzero.\n", "example": {"_type": "literalExpression", "text": "4"}, "loc": ["treefmt", "config", "programs", "shfmt", "indent_size"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.shfmt.simplify": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/shfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/shfmt.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Enables the `-s` (`--simplify`) flag, which simplifies code where possible.\n", "loc": ["treefmt", "config", "programs", "shfmt", "simplify"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.shfmt.useEditorConfig": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/shfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/shfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Use .editorconfig file for\nformatting. This is mutually exlusive with all other settings. See [shfmt\ndocs](https://github.com/mvdan/sh/blob/v3.12.0/cmd/shfmt/shfmt.1.scd?plain=1#L20-L21).\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "shfmt", "useEditorConfig"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.sizelint.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/sizelint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/sizelint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable sizelint.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "sizelint", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.sizelint.failOnWarn": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/sizelint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/sizelint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable fail-on-warn.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "sizelint", "failOnWarn"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.sizelint.settings": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/sizelint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/sizelint.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Configuration to generate sizelint.toml with", "loc": ["treefmt", "config", "programs", "sizelint", "settings"], "readOnly": false, "type": "open submodule of (TOML value)"}, "treefmt.config.programs.sql-formatter.dialect": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/sql-formatter.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/sql-formatter.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The sql dialect to use for formatting", "example": {"_type": "literalExpression", "text": "\"postgresql\""}, "loc": ["treefmt", "config", "programs", "sql-formatter", "dialect"], "readOnly": false, "type": "null or one of \"bigquery\", \"db2\", \"db2i\", \"hive\", \"mariadb\", \"mysql\", \"n1ql\", \"plsql\", \"postgresql\", \"redshift\", \"spark\", \"sqlite\", \"sql\", \"tidb\", \"trino\", \"transactsql\", \"tsql\", \"singlestoredb\", \"snowflake\""}, "treefmt.config.programs.sql-formatter.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/sql-formatter.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/sql-formatter.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable sql-formatter.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "sql-formatter", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.sqlfluff-lint.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/sqlfluff-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/sqlfluff-lint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable sqlfluff-lint.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "sqlfluff-lint", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.sqlfluff.dialect": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/sqlfluff.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/sqlfluff.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The sql dialect to use for formatting", "example": {"_type": "literalExpression", "text": "\"sqlite\""}, "loc": ["treefmt", "config", "programs", "sqlfluff", "dialect"], "readOnly": false, "type": "null or one of \"db2\", \"ansi\", \"soql\", \"tsql\", \"hive\", \"trino\", \"mysql\", \"oracle\", \"sqlite\", \"duckdb\", \"exasol\", \"athena\", \"mariadb\", \"vertica\", \"teradata\", \"redshift\", \"sparksql\", \"bigquery\", \"postgres\", \"greenplum\", \"snowflake\", \"materializ\", \"clickhouse\", \"databricks\""}, "treefmt.config.programs.sqlfluff.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/sqlfluff.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/sqlfluff.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable sqlfluff.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "sqlfluff", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.sqruff.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/sqruff.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/sqruff.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable sqruff.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "sqruff", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.statix.disabled-lints": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/statix.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/statix.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of ignored lints. Run `statix list` to see all available lints.\n", "example": {"_type": "literalExpression", "text": "[\n \"empty_pattern\"\n]"}, "loc": ["treefmt", "config", "programs", "statix", "disabled-lints"], "readOnly": false, "type": "list of string"}, "treefmt.config.programs.statix.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/statix.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/statix.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable statix.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "statix", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.stylish-haskell.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylish-haskell.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylish-haskell.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable stylish-haskell.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "stylish-haskell", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.stylua.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable stylua.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "stylua", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.stylua.settings.call_parentheses": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether parentheses should be applied on\nfunction calls with a single string/table\nargument. `Always` applies parentheses in\nall cases. `NoSingleString` omits\nparentheses on calls with a single string\nargument. Similarly, `NoSingleTable` omits\nparentheses on calls with a single table\nargument. `None` omits parentheses in both\ncases.\n\nNote: parentheses are still kept in situations\nwhere removal can lead to obscurity\n(e.g. `foo \"bar\".setup -> foo(\"bar\").setup`,\nsince the index is on the call result, not the string).\n\n`Input` removes all automation and preserves\nparentheses only if they were present in input code:\nconsistency is not enforced.\n", "example": {"_type": "literalExpression", "text": "\"Always\""}, "loc": ["treefmt", "config", "programs", "stylua", "settings", "call_parentheses"], "readOnly": false, "type": "null or one of \"Always\", \"NoSingleString\", \"NoSingleTable\", \"None\", \"Input\""}, "treefmt.config.programs.stylua.settings.collapse_simple_statement": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Specify whether to collapse simple statements.\n", "example": {"_type": "literalExpression", "text": "\"Never\""}, "loc": ["treefmt", "config", "programs", "stylua", "settings", "collapse_simple_statement"], "readOnly": false, "type": "null or one of \"Never\", \"FunctionOnly\", \"ConditionalOnly\", \"Always\""}, "treefmt.config.programs.stylua.settings.column_width": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Approximate line length for printing.\n\nUsed as a guide for line wrapping -\nthis is not a hard requirement:\nlines may fall under or over the limit.\n", "example": {"_type": "literalExpression", "text": "120"}, "loc": ["treefmt", "config", "programs", "stylua", "settings", "column_width"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.stylua.settings.indent_type": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Indent type.\n", "example": {"_type": "literalExpression", "text": "\"Tabs\""}, "loc": ["treefmt", "config", "programs", "stylua", "settings", "indent_type"], "readOnly": false, "type": "null or one of \"Tabs\", \"Spaces\""}, "treefmt.config.programs.stylua.settings.indent_width": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Character size of single indentation.\n\nIf `indent_type` is set to `Tabs`,\nthis option is used as a heuristic to\ndetermine column width only.\n", "example": {"_type": "literalExpression", "text": "4"}, "loc": ["treefmt", "config", "programs", "stylua", "settings", "indent_width"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.stylua.settings.line_endings": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Line endings type.\n", "example": {"_type": "literalExpression", "text": "\"Unix\""}, "loc": ["treefmt", "config", "programs", "stylua", "settings", "line_endings"], "readOnly": false, "type": "null or one of \"Unix\", \"Windows\""}, "treefmt.config.programs.stylua.settings.quote_style": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Quote style for string literals.\n\n`AutoPrefer` styles will prefer the\nspecified quote style, but fall back to\nthe alternative if it has fewer string\nescapes. `Force` styles always use the\nspecified style regardless of escapes.\n", "example": {"_type": "literalExpression", "text": "\"AutoPreferDouble\""}, "loc": ["treefmt", "config", "programs", "stylua", "settings", "quote_style"], "readOnly": false, "type": "null or one of \"AutoPreferDouble\", \"AutoPreferSingle\", \"ForceDouble\", \"ForceSingle\""}, "treefmt.config.programs.stylua.settings.sort_requires.enabled": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "StyLua has built-in support for sorting\nrequire statements. We group consecutive\nrequire statements into a single \"block\",\nand then requires are sorted only within\nthat block. Blocks of requires do not\nmove around the file.\n\nWe only include requires of the form\n`local NAME = require(EXPR)`, and sort\nlexicographically based on `NAME`.\n(We also sort Roblox services of the form\n`local NAME = game:GetService(EXPR)`)\n", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "stylua", "settings", "sort_requires", "enabled"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.swift-format.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/swift-format.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/swift-format.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable swift-format.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "swift-format", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.taplo.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/taplo.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/taplo.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable taplo.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "taplo", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.taplo.settings": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/taplo.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/taplo.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Configuration to generate taplo.toml with", "loc": ["treefmt", "config", "programs", "taplo", "settings"], "readOnly": false, "type": "open submodule of (TOML value)"}, "treefmt.config.programs.templ.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/templ.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/templ.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable templ.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "templ", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.terraform.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/terraform.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/terraform.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable terraform.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "terraform", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.texfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/texfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/texfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable texfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "texfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.tilt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/tilt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/tilt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tilt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "tilt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.toml-sort.all": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/toml-sort.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/toml-sort.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable sort ALL keys.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "toml-sort", "all"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.toml-sort.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/toml-sort.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/toml-sort.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable toml-sort.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "toml-sort", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.typos.binary": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Search binary files", "loc": ["treefmt", "config", "programs", "typos", "binary"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.typos.configFile": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Custom config file", "example": {"_type": "literalExpression", "text": "\"typos.toml\""}, "loc": ["treefmt", "config", "programs", "typos", "configFile"], "readOnly": false, "type": "null or string"}, "treefmt.config.programs.typos.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable typos.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "typos", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.typos.hidden": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Search hidden files and directories", "loc": ["treefmt", "config", "programs", "typos", "hidden"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.typos.isolated": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Ignore implicit configuration files", "loc": ["treefmt", "config", "programs", "typos", "isolated"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.typos.locale": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Language locale to suggest corrections for [possible values: en, en-us, en-gb, en-ca, en-au]", "loc": ["treefmt", "config", "programs", "typos", "locale"], "readOnly": false, "type": "null or one of \"en\", \"en-us\", \"en-gb\", \"en-ca\", \"en-au\""}, "treefmt.config.programs.typos.noCheckFilenames": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Skip verifying spelling in file names", "loc": ["treefmt", "config", "programs", "typos", "noCheckFilenames"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.typos.noCheckFiles": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Skip verifying spelling in files", "loc": ["treefmt", "config", "programs", "typos", "noCheckFiles"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.typos.noIgnore": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Don't respect ignore files", "loc": ["treefmt", "config", "programs", "typos", "noIgnore"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.typos.noIgnoreDot": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Don't respect .ignore files", "loc": ["treefmt", "config", "programs", "typos", "noIgnoreDot"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.typos.noIgnoreGlobal": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Don't respect global ignore files", "loc": ["treefmt", "config", "programs", "typos", "noIgnoreGlobal"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.typos.noIgnoreParent": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Don't respect ignore files in parent directories", "loc": ["treefmt", "config", "programs", "typos", "noIgnoreParent"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.typos.noIgnoreVCS": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Don't respect ignore files in vsc directories", "loc": ["treefmt", "config", "programs", "typos", "noIgnoreVCS"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.typos.noUnicode": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Only allow ASCII characters in identifiers", "loc": ["treefmt", "config", "programs", "typos", "noUnicode"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.typos.sort": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Sort results", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "typos", "sort"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.typos.threads": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The approximate number of threads to use [default: 0]", "example": {"_type": "literalExpression", "text": "2"}, "loc": ["treefmt", "config", "programs", "typos", "threads"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.typstyle.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typstyle.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typstyle.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable typstyle.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "typstyle", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.typstyle.indentWidth": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typstyle.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typstyle.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Number of spaces per indent level (default: 2).\n", "example": {"_type": "literalExpression", "text": "4"}, "loc": ["treefmt", "config", "programs", "typstyle", "indentWidth"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.typstyle.lineWidth": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typstyle.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typstyle.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Maximum line width in characters (default: 80).\n", "example": {"_type": "literalExpression", "text": "100"}, "loc": ["treefmt", "config", "programs", "typstyle", "lineWidth"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.typstyle.wrapText": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typstyle.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typstyle.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable line wrapping of markup text.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "typstyle", "wrapText"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.wgslfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/wgslfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/wgslfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable wgslfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "wgslfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.wgslfmt.tabs": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/wgslfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/wgslfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Use tabs for indentation (instead of spaces).", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "wgslfmt", "tabs"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.xmllint.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/xmllint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/xmllint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable xmllint.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "xmllint", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.yamlfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/yamlfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/yamlfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable yamlfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "yamlfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.yamlfmt.settings": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/yamlfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/yamlfmt.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Configuration for yamlfmt, see\n\nfor supported values.\n", "loc": ["treefmt", "config", "programs", "yamlfmt", "settings"], "readOnly": false, "type": "open submodule of (YAML 1.1 value)"}, "treefmt.config.programs.yamllint.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/yamllint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/yamllint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable yamllint.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "yamllint", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.yamllint.settings": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/yamllint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/yamllint.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Configuration for yamllint, see\n\nfor supported values.\n", "loc": ["treefmt", "config", "programs", "yamllint", "settings"], "readOnly": false, "type": "open submodule of (YAML 1.1 value)"}, "treefmt.config.programs.yapf.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/yapf.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/yapf.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable yapf.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "yapf", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.zig.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/zig.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/zig.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable zig.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "zig", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.zizmor.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/zizmor.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/zizmor.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable zizmor.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "zizmor", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.zprint.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/zprint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/zprint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable zprint.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "zprint", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.zprint.zprintOpts": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/zprint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/zprint.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Clojure map containing zprint options.\n", "example": {"_type": "literalExpression", "text": "\"{:width 90}\""}, "loc": ["treefmt", "config", "programs", "zprint", "zprintOpts"], "readOnly": false, "type": "null or string"}, "treefmt.config.projectRootFile": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "default": {"_type": "literalExpression", "text": "\".git/config\""}, "description": "File to look for to determine the root of the project in the\nbuild.wrapper.\nSet to null to let treefmt use its native detection.\n", "loc": ["treefmt", "config", "projectRootFile"], "readOnly": false, "type": "null or string"}, "treefmt.config.settings": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "The contents of treefmt.toml", "loc": ["treefmt", "config", "settings"], "readOnly": false, "type": "open submodule of (TOML value)"}, "treefmt.config.settings.excludes": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "A global list of paths to exclude. Supports glob.", "example": {"_type": "literalExpression", "text": "[\n \"node_modules/*\"\n]"}, "loc": ["treefmt", "config", "settings", "excludes"], "readOnly": false, "type": "list of string"}, "treefmt.config.settings.formatter": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Set of formatters to use", "loc": ["treefmt", "config", "settings", "formatter"], "readOnly": false, "type": "attribute set of (open submodule of (TOML value))"}, "treefmt.config.settings.formatter..command": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "description": "Executable obeying the treefmt formatter spec", "loc": ["treefmt", "config", "settings", "formatter", "", "command"], "readOnly": false, "type": "Path to executable"}, "treefmt.config.settings.formatter..excludes": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of files to exclude for formatting. Supports globbing. Takes precedence over the includes.", "loc": ["treefmt", "config", "settings", "formatter", "", "excludes"], "readOnly": false, "type": "list of string"}, "treefmt.config.settings.formatter..includes": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "description": "List of files to include for formatting. Supports globbing.", "loc": ["treefmt", "config", "settings", "formatter", "", "includes"], "readOnly": false, "type": "list of string"}, "treefmt.config.settings.formatter..options": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of arguments to pass to the command", "loc": ["treefmt", "config", "settings", "formatter", "", "options"], "readOnly": false, "type": "list of string"}, "treefmt.config.settings.on-unmatched": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Log paths that did not match any formatters at the specified log level.", "loc": ["treefmt", "config", "settings", "on-unmatched"], "readOnly": false, "type": "null or one of \"debug\", \"info\", \"warn\", \"error\", \"fatal\""}, "treefmt.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/treefmt.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/treefmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable treefmt integration (through treefmt-nix).", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "enable"], "readOnly": false, "type": "boolean"}, "unsetEnvVars": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"HOST_PATH\"\n \"NIX_BUILD_CORES\"\n \"__structuredAttrs\"\n \"buildInputs\"\n \"buildPhase\"\n \"builder\"\n \"depsBuildBuild\"\n \"depsBuildBuildPropagated\"\n \"depsBuildTarget\"\n \"depsBuildTargetPropagated\"\n \"depsHostHost\"\n \"depsHostHostPropagated\"\n \"depsTargetTarget\"\n \"depsTargetTargetPropagated\"\n \"dontAddDisableDepTrack\"\n \"doCheck\"\n \"doInstallCheck\"\n \"nativeBuildInputs\"\n \"out\"\n \"outputs\"\n \"patches\"\n \"phases\"\n \"preferLocalBuild\"\n \"propagatedBuildInputs\"\n \"propagatedNativeBuildInputs\"\n \"shell\"\n \"shellHook\"\n \"stdenv\"\n \"strictDeps\"\n]"}, "description": "A list of removed environment variables to make the shell/direnv more lean.", "loc": ["unsetEnvVars"], "readOnly": false, "type": "list of string"}} \ No newline at end of file +{"android.abis": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"arm64-v8a\"\n \"x86_64\"\n]"}, "description": "The Android ABIs to install.\nBy default, the arm64-v8a and x86_64 ABIs are installed.\n", "loc": ["android", "abis"], "readOnly": false, "type": "list of string"}, "android.android-studio.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable the installation of Android Studio.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["android", "android-studio", "enable"], "readOnly": false, "type": "boolean"}, "android.android-studio.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.android-studio"}, "description": "The Android Studio package to use.\nBy default, the Android Studio package from nixpkgs is used.\n", "loc": ["android", "android-studio", "package"], "readOnly": false, "type": "package"}, "android.buildTools.version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"34.0.0\"\n]"}, "description": "The version of the Android build tools to install.\nBy default, version 30.0.3 is installed or [ \"35.0.0\" \"33.0.2\" \"30.0.3\" ] if flutter is enabled.\n", "loc": ["android", "buildTools", "version"], "readOnly": false, "type": "list of string"}, "android.cmake.version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"3.22.1\"\n]"}, "description": "The CMake versions to install for Android.\nBy default, version 3.22.1 is installed.\n", "loc": ["android", "cmake", "version"], "readOnly": false, "type": "list of string"}, "android.cmdLineTools.version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "\"11.0\""}, "description": "The version of the Android command line tools to install.\nBy default, version 11.0 is installed or 8.0 if flutter is enabled.\n", "loc": ["android", "cmdLineTools", "version"], "readOnly": false, "type": "string"}, "android.emulator.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to include the Android Emulator.\nBy default, the emulator is included.\n", "loc": ["android", "emulator", "enable"], "readOnly": false, "type": "boolean"}, "android.emulator.version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalMD", "text": "Latest version in nixpkgs"}, "description": "The version of the Android Emulator to install.\nAvailable versions depend on the nixpkgs version.\nTo see available versions, try building with an invalid version; the error message will list all available options.\n", "loc": ["android", "emulator", "version"], "readOnly": false, "type": "string"}, "android.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Android Development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["android", "enable"], "readOnly": false, "type": "boolean"}, "android.extraLicenses": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"android-sdk-preview-license\"\n \"android-googletv-license\"\n \"android-sdk-arm-dbt-license\"\n \"google-gdk-license\"\n \"intel-android-extra-license\"\n \"intel-android-sysimage-license\"\n \"mips-android-sysimage-license\"\n]"}, "description": "The additional Android licenses to accept.\nBy default, several standard licenses are accepted.\n", "loc": ["android", "extraLicenses"], "readOnly": false, "type": "list of string"}, "android.extras": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"extras;google;gcm\"\n]"}, "description": "The Android extras to install.\nBy default, the Google Cloud Messaging (GCM) extra is installed.\n", "loc": ["android", "extras"], "readOnly": false, "type": "list of string"}, "android.flutter.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to include the Flutter tools.\n", "loc": ["android", "flutter", "enable"], "readOnly": false, "type": "boolean"}, "android.flutter.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.flutter"}, "description": "The Flutter package to use.\nBy default, the Flutter package from nixpkgs is used.\n", "loc": ["android", "flutter", "package"], "readOnly": false, "type": "package"}, "android.googleAPIs.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to use the Google APIs.\nBy default, the Google APIs are used.\n", "loc": ["android", "googleAPIs", "enable"], "readOnly": false, "type": "boolean"}, "android.googleTVAddOns.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to use the Google TV Add-Ons.\nBy default, the Google TV Add-Ons are used.\n", "loc": ["android", "googleTVAddOns", "enable"], "readOnly": false, "type": "boolean"}, "android.ndk.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to include the Android NDK (Native Development Kit).\nBy default, the NDK is included.\n", "loc": ["android", "ndk", "enable"], "readOnly": false, "type": "boolean"}, "android.ndk.version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"26.1.10909125\"\n]"}, "description": "The version of the Android NDK (Native Development Kit) to install.\nBy default, version 26.1.10909125 is installed or for flutter version 28.2.13676358.\n", "loc": ["android", "ndk", "version"], "readOnly": false, "type": "list of string"}, "android.platformTools.version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalMD", "text": "Latest version in nixpkgs"}, "description": "The version of the Android platform tools to install.\nAvailable versions depend on the nixpkgs version.\nTo see available versions, try building with an invalid version; the error message will list all available options.\n", "loc": ["android", "platformTools", "version"], "readOnly": false, "type": "string"}, "android.platforms.version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"32\"\n \"34\"\n \"36\"\n]"}, "description": "The Android platform versions to install.\nBy default, versions 32, 34 and 36 are installed.\n", "loc": ["android", "platforms", "version"], "readOnly": false, "type": "list of string"}, "android.reactNative.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to include the React Native tools.\n", "loc": ["android", "reactNative", "enable"], "readOnly": false, "type": "boolean"}, "android.sources.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to include the Android sources.\nBy default, the sources are not included.\n", "loc": ["android", "sources", "enable"], "readOnly": false, "type": "boolean"}, "android.systemImageTypes": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"google_apis_playstore\"\n]"}, "description": "The Android system image types to install.\nBy default, the google_apis_playstore system image is installed.\n", "loc": ["android", "systemImageTypes"], "readOnly": false, "type": "list of string"}, "android.systemImages.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to include the Android system images.\nBy default, the system images are included.\n", "loc": ["android", "systemImages", "enable"], "readOnly": false, "type": "boolean"}, "android.tools.version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/android.nix"}], "default": {"_type": "literalExpression", "text": "\"26.1.1\""}, "description": "The version of the Android SDK tools to install.\nBy default, version 26.1.1 is installed.\n", "loc": ["android", "tools", "version"], "readOnly": false, "type": "string"}, "apple.sdk": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix"}], "default": {"_type": "literalExpression", "text": "if pkgs.stdenv.hostPlatform.isDarwin then pkgs.apple-sdk else null"}, "description": "The Apple SDK to add to the developer environment on macOS.\n\nIf set to `null`, the system SDK can be used if the shell allows access to external environment variables.\n", "example": {"_type": "literalExpression", "text": "pkgs.apple-sdk_15"}, "loc": ["apple", "sdk"], "readOnly": false, "type": "null or package"}, "aws-vault.awscliWrapper": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix"}], "default": {"_type": "literalExpression", "text": "pkgs"}, "description": "Attribute set of packages including awscli2", "loc": ["aws-vault", "awscliWrapper"], "readOnly": false, "type": "submodule"}, "aws-vault.awscliWrapper.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Wraps awscli2 binary as `aws-vault exec -- aws `.\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["aws-vault", "awscliWrapper", "enable"], "readOnly": false, "type": "boolean"}, "aws-vault.awscliWrapper.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.awscli2"}, "description": "The awscli2 package to use.", "loc": ["aws-vault", "awscliWrapper", "package"], "readOnly": false, "type": "package"}, "aws-vault.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable aws-vault integration.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["aws-vault", "enable"], "readOnly": false, "type": "boolean"}, "aws-vault.opentofuWrapper": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix"}], "default": {"_type": "literalExpression", "text": "pkgs"}, "description": "Attribute set of packages including opentofu", "loc": ["aws-vault", "opentofuWrapper"], "readOnly": false, "type": "submodule"}, "aws-vault.opentofuWrapper.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Wraps opentofu binary as `aws-vault exec -- opentofu `.\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["aws-vault", "opentofuWrapper", "enable"], "readOnly": false, "type": "boolean"}, "aws-vault.opentofuWrapper.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.opentofu"}, "description": "The opentofu package to use.", "loc": ["aws-vault", "opentofuWrapper", "package"], "readOnly": false, "type": "package"}, "aws-vault.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.aws-vault"}, "description": "The aws-vault package to use.", "loc": ["aws-vault", "package"], "readOnly": false, "type": "package"}, "aws-vault.profile": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix"}], "description": "The profile name passed to `aws-vault exec`.\n", "loc": ["aws-vault", "profile"], "readOnly": false, "type": "string"}, "aws-vault.terraformWrapper": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix"}], "default": {"_type": "literalExpression", "text": "pkgs"}, "description": "Attribute set of packages including terraform", "loc": ["aws-vault", "terraformWrapper"], "readOnly": false, "type": "submodule"}, "aws-vault.terraformWrapper.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Wraps terraform binary as `aws-vault exec -- terraform `.\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["aws-vault", "terraformWrapper", "enable"], "readOnly": false, "type": "boolean"}, "aws-vault.terraformWrapper.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/aws-vault.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.terraform"}, "description": "The terraform package to use.", "loc": ["aws-vault", "terraformWrapper", "package"], "readOnly": false, "type": "package"}, "cachix.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/cachix.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/cachix.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Cachix integration.", "loc": ["cachix", "enable"], "readOnly": false, "type": "boolean"}, "cachix.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/cachix.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/cachix.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.cachix"}, "description": "The cachix package to use.", "loc": ["cachix", "package"], "readOnly": false, "type": "package"}, "cachix.pull": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/cachix.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/cachix.nix"}], "default": {"_type": "literalExpression", "text": "[ \"devenv\" ]"}, "description": "Which Cachix caches to pull from.", "loc": ["cachix", "pull"], "readOnly": false, "type": "list of string"}, "cachix.push": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/cachix.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/cachix.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Which Cachix cache to push to. This cache is also added to `cachix.pull`.", "loc": ["cachix", "push"], "readOnly": false, "type": "null or string"}, "certFile": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/mkcert.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/mkcert.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Custom certificate file name, uses mkcert default if unset", "example": {"_type": "literalExpression", "text": "\"mycert.pem\""}, "loc": ["certFile"], "readOnly": false, "type": "null or string"}, "certificates": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/mkcert.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/mkcert.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of domains to generate certificates for.", "example": {"_type": "literalExpression", "text": "[\n \"example.com\"\n \"*.example.com\"\n]"}, "loc": ["certificates"], "readOnly": false, "type": "list of string"}, "changelogs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/changelogs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/changelogs.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of changelog entries for this module.", "loc": ["changelogs"], "readOnly": false, "type": "list of (submodule)"}, "changelogs.*.date": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/changelogs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/changelogs.nix"}], "description": "Date of the changelog entry in YYYY-MM-DD format.", "example": {"_type": "literalExpression", "text": "\"2025-01-15\""}, "loc": ["changelogs", "*", "date"], "readOnly": false, "type": "string matching the pattern ^[0-9]{4}-[0-9]{2}-[0-9]{2}$"}, "changelogs.*.description": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/changelogs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/changelogs.nix"}], "description": "Markdown description of the change.", "loc": ["changelogs", "*", "description"], "readOnly": false, "type": "string"}, "changelogs.*.title": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/changelogs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/changelogs.nix"}], "description": "Title of the changelog entry.", "example": {"_type": "literalExpression", "text": "\"git-hooks.package is now pkgs.prek\""}, "loc": ["changelogs", "*", "title"], "readOnly": false, "type": "string"}, "changelogs.*.when": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/changelogs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/changelogs.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to include this changelog entry (useful for conditional changelogs).", "loc": ["changelogs", "*", "when"], "readOnly": false, "type": "boolean"}, "claude.code.agent": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The agent to use as Claude Code's primary agent.", "loc": ["claude", "code", "agent"], "readOnly": false, "type": "null or string"}, "claude.code.agents": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Custom Claude Code sub-agents to create in the project.\nSub-agents are specialized AI assistants that handle specific tasks\nwith their own context window and can be invoked automatically or explicitly.\n\nFor more details, see: https://docs.anthropic.com/en/docs/claude-code/sub-agents\n", "example": {"_type": "literalExpression", "text": "{\n code-reviewer = {\n description = \"Expert code review specialist that checks for quality, security, and best practices. Use proactively after code changes.\";\n model = \"opus\";\n tools = [ \"Read\" \"Grep\" \"TodoWrite\" ];\n permissionMode = \"plan\";\n prompt = ''\n You are an expert code reviewer. When reviewing code, check for:\n - Code readability and maintainability\n - Proper error handling\n - Security vulnerabilities\n - Performance issues\n - Adherence to project conventions\n\n Provide constructive feedback with specific suggestions for improvement.\n '';\n };\n\n test-writer = {\n description = \"Specialized in writing comprehensive test suites\";\n tools = [ \"Read\" \"Write\" \"Edit\" \"Bash\" ];\n prompt = ''\n You are a test writing specialist. Create comprehensive test suites that:\n - Cover edge cases and error conditions\n - Follow the project's testing conventions\n - Include unit, integration, and property-based tests where appropriate\n - Have clear test names that describe what is being tested\n '';\n };\n}\n"}, "loc": ["claude", "code", "agents"], "readOnly": false, "type": "attribute set of (submodule)"}, "claude.code.agents..description": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "description": "What the sub-agent does", "loc": ["claude", "code", "agents", "", "description"], "readOnly": false, "type": "string"}, "claude.code.agents..effort": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Override the effort level for this agent.", "loc": ["claude", "code", "agents", "", "effort"], "readOnly": false, "type": "null or one of \"low\", \"medium\", \"high\", \"xhigh\", \"max\""}, "claude.code.agents..model": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Override the model for this agent.\nAccepts an alias (`sonnet`, `opus`, `haiku`, `fable`), a full model ID (e.g. `claude-opus-5`), or `inherit`.\n", "example": {"_type": "literalExpression", "text": "\"opus\""}, "loc": ["claude", "code", "agents", "", "model"], "readOnly": false, "type": "null or string"}, "claude.code.agents..permissionMode": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Permission mode for this specific sub-agent.\n`manual` is an alias for `default`.\n", "loc": ["claude", "code", "agents", "", "permissionMode"], "readOnly": false, "type": "null or one of \"default\", \"manual\", \"acceptEdits\", \"plan\", \"auto\", \"dontAsk\", \"bypassPermissions\""}, "claude.code.agents..prompt": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "description": "The system prompt for the sub-agent", "loc": ["claude", "code", "agents", "", "prompt"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "claude.code.agents..tools": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of allowed tools for this sub-agent", "loc": ["claude", "code", "agents", "", "tools"], "readOnly": false, "type": "list of string"}, "claude.code.apiKeyHelper": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Custom script for generating authentication tokens.\nThe script should output the API key to stdout.\n", "example": {"_type": "literalExpression", "text": "\"aws secretsmanager get-secret-value --secret-id claude-api-key | jq -r .SecretString\""}, "loc": ["claude", "code", "apiKeyHelper"], "readOnly": false, "type": "null or string"}, "claude.code.cleanupPeriodDays": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Retention period for chat transcripts in days.\n", "example": {"_type": "literalExpression", "text": "30"}, "loc": ["claude", "code", "cleanupPeriodDays"], "readOnly": false, "type": "null or signed integer"}, "claude.code.commands": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Custom Claude Code slash commands to create in the project.\nCommands are invoked with `/command-name` in Claude Code.\n", "example": {"_type": "literalExpression", "text": "{\n test = ''\n Run all tests in the project\n\n ```bash\n cargo test\n ```\n '';\n fmt = ''\n Format all code in the project\n\n ```bash\n cargo fmt\n nixfmt **/*.nix\n ```\n '';\n}\n"}, "loc": ["claude", "code", "commands"], "readOnly": false, "type": "attribute set of string"}, "claude.code.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Claude Code integration with automatic hooks and commands setup.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["claude", "code", "enable"], "readOnly": false, "type": "boolean"}, "claude.code.env": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Custom environment variables for Claude Code sessions.\n", "example": {"_type": "literalExpression", "text": "{\n NODE_ENV = \"development\";\n PYTHONPATH = \"/custom/python/path\";\n}"}, "loc": ["claude", "code", "env"], "readOnly": false, "type": "attribute set of string"}, "claude.code.forceLoginMethod": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Restrict the login method.\n- claudeai: only claude.ai accounts\n- console: only Claude Console (API key) accounts\n- gateway: only a cloud gateway\n", "example": {"_type": "literalExpression", "text": "\"claudeai\""}, "loc": ["claude", "code", "forceLoginMethod"], "readOnly": false, "type": "null or one of \"claudeai\", \"console\", \"gateway\""}, "claude.code.hooks": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Hooks that run at different points in Claude Code's workflow.\n", "example": {"_type": "literalExpression", "text": "{\n protect-secrets = {\n enable = true;\n name = \"Protect sensitive files\";\n hookType = \"PreToolUse\";\n matcher = \"^(Edit|MultiEdit|Write)$\";\n command = ''\n json=$(cat);\n file_path = $(echo \"$json\" | jq - r '.file_path // empty');\n grep -q 'SECRET\\\\|PASSWORD\\\\|API_KEY' \"$file_path\" && echo 'Blocked: sensitive data detected' && exit 1 || exit 0\n '';\n };\n run-tests = {\n enable = true;\n name = \"Run tests after edit\";\n hookType = \"PostToolUse\";\n matcher = \"^(Edit|MultiEdit|Write)$\";\n command = \"cargo test\";\n };\n log-completion = {\n enable = true;\n name = \"Log when Claude finishes\";\n hookType = \"Stop\";\n command = \"echo 'Claude finished responding' >> claude.log\";\n };\n}\n"}, "loc": ["claude", "code", "hooks"], "readOnly": false, "type": "open submodule of attribute set of (submodule)"}, "claude.code.hooks..command": {"declarations": [], "description": "The command to execute.", "loc": ["claude", "code", "hooks", "", "command"], "readOnly": false, "type": "string"}, "claude.code.hooks..enable": {"declarations": [], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable this hook.", "loc": ["claude", "code", "hooks", "", "enable"], "readOnly": false, "type": "boolean"}, "claude.code.hooks..hookType": {"declarations": [], "default": {"_type": "literalExpression", "text": "\"PostToolUse\""}, "description": "The type of hook:\n- PreToolUse: Runs before tool calls (can block them)\n- PostToolUse: Runs after tool calls complete\n- PostToolUseFailure: Runs after a tool call fails\n- Notification: Runs when Claude Code sends notifications\n- UserPromptSubmit: Runs when user submits a prompt\n- SessionStart: Runs when a Claude Code session starts\n- SessionEnd: Runs when a Claude Code session ends\n- Stop: Runs when Claude Code finishes responding\n- SubagentStart: Runs when a subagent task starts\n- SubagentStop: Runs when subagent tasks complete\n- PreCompact: Runs before message compaction\n- PermissionRequest: Runs when a permission is requested\n- WorktreeCreate: Runs when a new worktree is created\n- WorktreeRemove: Runs when a worktree is removed\n- TeammateIdle: Runs when a teammate agent becomes idle\n- TaskCompleted: Runs when a task is completed\n- ConfigChange: Runs when configuration changes\n", "loc": ["claude", "code", "hooks", "", "hookType"], "readOnly": false, "type": "one of \"PreToolUse\", \"PostToolUse\", \"PostToolUseFailure\", \"Notification\", \"UserPromptSubmit\", \"SessionStart\", \"SessionEnd\", \"Stop\", \"SubagentStart\", \"SubagentStop\", \"PreCompact\", \"PermissionRequest\", \"WorktreeCreate\", \"WorktreeRemove\", \"TeammateIdle\", \"TaskCompleted\", \"ConfigChange\""}, "claude.code.hooks..matcher": {"declarations": [], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Regex pattern to match against tool names (for PreToolUse/PostToolUse hooks).", "loc": ["claude", "code", "hooks", "", "matcher"], "readOnly": false, "type": "string"}, "claude.code.hooks..name": {"declarations": [], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "The name of the hook (appears in logs).", "loc": ["claude", "code", "hooks", "", "name"], "readOnly": false, "type": "string"}, "claude.code.hooks.git-hooks-run": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "{\n enable = config.git-hooks.enable;\n name = \"Run git-hooks\";\n hookType = \"PostToolUse\";\n matcher = \"^(Edit|MultiEdit|Write)$\";\n command = \"cd \\\"$DEVENV_ROOT\\\" && \\${config.git-hooks.package.meta.mainProgram} run\";\n}\n"}, "description": "Automatically runs git-hooks after Claude edits files.\nEnabled by default when `git-hooks.enable` is true.\n", "loc": ["claude", "code", "hooks", "git-hooks-run"], "readOnly": false, "type": "submodule"}, "claude.code.hooks.git-hooks-run.command": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "description": "The command to execute.", "loc": ["claude", "code", "hooks", "git-hooks-run", "command"], "readOnly": false, "type": "string"}, "claude.code.hooks.git-hooks-run.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable this hook.", "loc": ["claude", "code", "hooks", "git-hooks-run", "enable"], "readOnly": false, "type": "boolean"}, "claude.code.hooks.git-hooks-run.hookType": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "\"PostToolUse\""}, "description": "The type of hook:\n- PreToolUse: Runs before tool calls (can block them)\n- PostToolUse: Runs after tool calls complete\n- PostToolUseFailure: Runs after a tool call fails\n- Notification: Runs when Claude Code sends notifications\n- UserPromptSubmit: Runs when user submits a prompt\n- SessionStart: Runs when a Claude Code session starts\n- SessionEnd: Runs when a Claude Code session ends\n- Stop: Runs when Claude Code finishes responding\n- SubagentStart: Runs when a subagent task starts\n- SubagentStop: Runs when subagent tasks complete\n- PreCompact: Runs before message compaction\n- PermissionRequest: Runs when a permission is requested\n- WorktreeCreate: Runs when a new worktree is created\n- WorktreeRemove: Runs when a worktree is removed\n- TeammateIdle: Runs when a teammate agent becomes idle\n- TaskCompleted: Runs when a task is completed\n- ConfigChange: Runs when configuration changes\n", "loc": ["claude", "code", "hooks", "git-hooks-run", "hookType"], "readOnly": false, "type": "one of \"PreToolUse\", \"PostToolUse\", \"PostToolUseFailure\", \"Notification\", \"UserPromptSubmit\", \"SessionStart\", \"SessionEnd\", \"Stop\", \"SubagentStart\", \"SubagentStop\", \"PreCompact\", \"PermissionRequest\", \"WorktreeCreate\", \"WorktreeRemove\", \"TeammateIdle\", \"TaskCompleted\", \"ConfigChange\""}, "claude.code.hooks.git-hooks-run.matcher": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Regex pattern to match against tool names (for PreToolUse/PostToolUse hooks).", "loc": ["claude", "code", "hooks", "git-hooks-run", "matcher"], "readOnly": false, "type": "string"}, "claude.code.hooks.git-hooks-run.name": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "The name of the hook (appears in logs).", "loc": ["claude", "code", "hooks", "git-hooks-run", "name"], "readOnly": false, "type": "string"}, "claude.code.mcpServers": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "{\n \"mcp.devenv.sh\" = {\n type = \"http\";\n url = \"https://mcp.devenv.sh\";\n };\n}"}, "description": "MCP (Model Context Protocol) servers to configure.\nThese servers provide additional capabilities and context to Claude Code.\n", "example": {"_type": "literalExpression", "text": "{\n awslabs-iam-mcp-server = {\n type = \"stdio\";\n command = lib.getExe pkgs.awslabs-iam-mcp-server;\n args = [ ];\n env = { };\n };\n github = {\n type = \"http\";\n url = \"https://api.githubcopilot.com/mcp/\";\n headers = {\n Authorization = \"Bearer GITHUB_PAT\";\n };\n };\n linear = {\n type = \"http\";\n url = \"https://mcp.linear.app/mcp\";\n };\n devenv = {\n type = \"stdio\";\n command = \"devenv\";\n args = [ \"mcp\" ];\n env = {\n DEVENV_ROOT = config.devenv.root;\n };\n };\n}\n"}, "loc": ["claude", "code", "mcpServers"], "readOnly": false, "type": "attribute set of (submodule)"}, "claude.code.mcpServers..args": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Arguments to pass to the command for stdio MCP servers.", "loc": ["claude", "code", "mcpServers", "", "args"], "readOnly": false, "type": "list of string"}, "claude.code.mcpServers..command": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Command to execute for stdio MCP servers.", "loc": ["claude", "code", "mcpServers", "", "command"], "readOnly": false, "type": "null or string"}, "claude.code.mcpServers..env": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Environment variables for stdio MCP servers.", "loc": ["claude", "code", "mcpServers", "", "env"], "readOnly": false, "type": "attribute set of string"}, "claude.code.mcpServers..headers": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "HTTP headers for HTTP MCP servers (e.g., for authentication).", "loc": ["claude", "code", "mcpServers", "", "headers"], "readOnly": false, "type": "attribute set of string"}, "claude.code.mcpServers..type": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "description": "Type of MCP server connection.", "loc": ["claude", "code", "mcpServers", "", "type"], "readOnly": false, "type": "one of \"stdio\", \"http\""}, "claude.code.mcpServers..url": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "URL for HTTP MCP servers.", "loc": ["claude", "code", "mcpServers", "", "url"], "readOnly": false, "type": "null or string"}, "claude.code.model": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Override the default Claude model.\n", "example": {"_type": "literalExpression", "text": "\"claude-3-opus-20240229\""}, "loc": ["claude", "code", "model"], "readOnly": false, "type": "null or string"}, "claude.code.permissions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Fine-grained permissions for tool usage.\nSupports global settings and per-tool allow/ask/deny rules.\nTool rules can be placed under `rules` or directly (backward compatible).\n", "example": {"_type": "literalExpression", "text": "{\n defaultMode = \"acceptEdits\";\n disableBypassPermissionsMode = true;\n additionalDirectories = [ \"/shared/libs\" ];\n rules = {\n Edit = {\n deny = [ \"*.secret\" \"*.env\" ];\n };\n Bash = {\n allow = [ \"ls:*\" \"cat:*\" ];\n ask = [ \"git:*\" \"npm:*\" ];\n deny = [ \"rm -rf:*\" \"sudo:*\" ];\n };\n # Use an empty string to emit a bare tool entry for tools\n # without a matcher format (e.g. WebSearch, AskUserQuestion).\n WebSearch.allow = [ \"\" ];\n AskUserQuestion.deny = [ \"\" ];\n };\n}\n"}, "loc": ["claude", "code", "permissions"], "readOnly": false, "type": "open submodule of attribute set of (submodule)"}, "claude.code.permissions..allow": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of allowed patterns. An empty string emits a bare tool entry\n(e.g. `WebSearch` rather than `WebSearch(pattern)`), matching the\ntool regardless of input. Use this for tools without a matcher\nformat such as `WebSearch` or `AskUserQuestion`.\n", "loc": ["claude", "code", "permissions", "", "allow"], "readOnly": false, "type": "list of string"}, "claude.code.permissions..ask": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of patterns that require user approval. An empty string emits\na bare tool entry (e.g. `WebSearch` rather than `WebSearch(pattern)`).\n", "loc": ["claude", "code", "permissions", "", "ask"], "readOnly": false, "type": "list of string"}, "claude.code.permissions..deny": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of denied patterns. An empty string emits a bare tool entry\n(e.g. `AskUserQuestion` rather than `AskUserQuestion(pattern)`),\nwhich is required to deny tools without a matcher format outright.\n", "loc": ["claude", "code", "permissions", "", "deny"], "readOnly": false, "type": "list of string"}, "claude.code.permissions.additionalDirectories": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Allow Claude Code to access directories outside the project root.\n", "example": {"_type": "literalExpression", "text": "[\n \"/shared/libs\"\n \"/common/configs\"\n]"}, "loc": ["claude", "code", "permissions", "additionalDirectories"], "readOnly": false, "type": "list of string"}, "claude.code.permissions.defaultMode": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Global permission mode for Claude Code.\n- default: Prompts on first use of each tool (`manual` is an alias)\n- acceptEdits: Auto-accepts file edits\n- plan: Read-only mode\n- auto: Auto-approves tool calls with background safety checks\n- dontAsk: Auto-denies unless pre-approved via permissions\n- bypassPermissions: Skips all permission prompts\n", "example": {"_type": "literalExpression", "text": "\"acceptEdits\""}, "loc": ["claude", "code", "permissions", "defaultMode"], "readOnly": false, "type": "null or one of \"default\", \"manual\", \"acceptEdits\", \"plan\", \"auto\", \"dontAsk\", \"bypassPermissions\""}, "claude.code.permissions.disableBypassPermissionsMode": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Security option to prevent the dangerous bypassPermissions mode.\nWritten to `settings.json` as `\"disableBypassPermissionsMode\": \"disable\"`.\n", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["claude", "code", "permissions", "disableBypassPermissionsMode"], "readOnly": false, "type": "null or boolean"}, "claude.code.permissions.rules": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Per-tool permission rules. Preferred location for tool permissions.\n", "loc": ["claude", "code", "permissions", "rules"], "readOnly": false, "type": "attribute set of (submodule)"}, "claude.code.permissions.rules..allow": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of allowed patterns. An empty string emits a bare tool entry\n(e.g. `WebSearch` rather than `WebSearch(pattern)`), matching the\ntool regardless of input. Use this for tools without a matcher\nformat such as `WebSearch` or `AskUserQuestion`.\n", "loc": ["claude", "code", "permissions", "rules", "", "allow"], "readOnly": false, "type": "list of string"}, "claude.code.permissions.rules..ask": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of patterns that require user approval. An empty string emits\na bare tool entry (e.g. `WebSearch` rather than `WebSearch(pattern)`).\n", "loc": ["claude", "code", "permissions", "rules", "", "ask"], "readOnly": false, "type": "list of string"}, "claude.code.permissions.rules..deny": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of denied patterns. An empty string emits a bare tool entry\n(e.g. `AskUserQuestion` rather than `AskUserQuestion(pattern)`),\nwhich is required to deny tools without a matcher format outright.\n", "loc": ["claude", "code", "permissions", "rules", "", "deny"], "readOnly": false, "type": "list of string"}, "claude.code.skills": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Custom Claude Code skills to create in the project.\nA skill is a folder of instructions Claude loads on demand when its\ndescription matches the task, keeping specialised knowledge out of the\nalways-on context.\n\nFor more details, see: https://docs.anthropic.com/en/docs/claude-code/skills\n", "example": {"_type": "literalExpression", "text": "{\n database-migrations = {\n description = \"How to write and run migrations in this project. Use when adding, editing or rolling back a migration.\";\n content = ''\n Migrations live in `migrations/` and are applied with `diesel migration run`.\n\n - One logical change per migration; never edit an applied migration.\n - Always write the matching `down.sql`.\n - Run `devenv tasks run db:reset` before opening a pull request.\n '';\n };\n\n api-conventions = {\n description = \"REST conventions for this codebase. Use when adding or changing an HTTP endpoint.\";\n allowedTools = [ \"Read\" \"Grep\" ];\n resources = {\n \"references/error-codes.md\" = ./docs/error-codes.md;\n };\n content = ''\n Endpoints are versioned under `/v1`.\n Read references/error-codes.md before inventing a new error code.\n '';\n };\n}\n"}, "loc": ["claude", "code", "skills"], "readOnly": false, "type": "attribute set of (submodule)"}, "claude.code.skills..agent": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Which subagent type to use when `context = \"fork\"` is set, such as one of\n`claude.code.agents`.\n", "example": {"_type": "literalExpression", "text": "\"code-reviewer\""}, "loc": ["claude", "code", "skills", "", "agent"], "readOnly": false, "type": "null or string"}, "claude.code.skills..allowedTools": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Tools Claude can use without asking permission during the turn that invokes\nthis skill. The grant clears when you send your next message.\n\nThis pre-approves tools rather than restricting them; use `disallowedTools`\nto take tools away.\n", "example": {"_type": "literalExpression", "text": "[\n \"Read\"\n \"Grep\"\n \"Bash(git status:*)\"\n]"}, "loc": ["claude", "code", "skills", "", "allowedTools"], "readOnly": false, "type": "list of string"}, "claude.code.skills..argumentHint": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Hint shown during autocomplete to indicate the expected arguments.", "example": {"_type": "literalExpression", "text": "\"[issue-number]\""}, "loc": ["claude", "code", "skills", "", "argumentHint"], "readOnly": false, "type": "null or string"}, "claude.code.skills..arguments": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Named positional arguments, substituted into `content` as `$name`. Names map\nto argument positions in order.\n", "example": {"_type": "literalExpression", "text": "[\n \"issue\"\n \"branch\"\n]"}, "loc": ["claude", "code", "skills", "", "arguments"], "readOnly": false, "type": "list of string"}, "claude.code.skills..background": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Only applies with `context = \"fork\"`. Set to false to wait for the forked\nsubagent's result in the turn that invoked the skill, instead of letting it\nrun in the background.\n", "loc": ["claude", "code", "skills", "", "background"], "readOnly": false, "type": "null or boolean"}, "claude.code.skills..content": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "description": "The body of SKILL.md, loaded when the skill triggers.", "loc": ["claude", "code", "skills", "", "content"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "claude.code.skills..context": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Set to `fork` to run the skill in a forked subagent context.\n", "loc": ["claude", "code", "skills", "", "context"], "readOnly": false, "type": "null or value \"fork\" (singular enum)"}, "claude.code.skills..copyMode": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "\"symlink\""}, "description": "How to materialise the skill's files, as in `files..copyMode`.\nUse `seed` to hand-edit a skill after devenv writes it once.\n", "loc": ["claude", "code", "skills", "", "copyMode"], "readOnly": false, "type": "one of \"symlink\", \"seed\", \"copy\""}, "claude.code.skills..description": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "description": "What the skill covers and when Claude should load it.\nDescriptions are the only part of a skill kept in context at all\ntimes, so this is what decides whether the skill ever triggers.\n", "loc": ["claude", "code", "skills", "", "description"], "readOnly": false, "type": "string"}, "claude.code.skills..disableModelInvocation": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Prevent Claude from automatically loading this skill. Use for workflows you\nwant to trigger manually with `/\u2039name\u203a`.\n", "loc": ["claude", "code", "skills", "", "disableModelInvocation"], "readOnly": false, "type": "boolean"}, "claude.code.skills..disallowedTools": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Tools removed from Claude's available pool while this skill is active; the\nrestriction clears when you send your next message. Use it for a skill that\nshould never call a given tool, such as an autonomous loop that must not stop\nto ask a question.\n", "example": {"_type": "literalExpression", "text": "[\n \"AskUserQuestion\"\n]"}, "loc": ["claude", "code", "skills", "", "disallowedTools"], "readOnly": false, "type": "list of string"}, "claude.code.skills..effort": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Override the effort level while this skill is active.\nWhich levels are available depends on the model.\n", "loc": ["claude", "code", "skills", "", "effort"], "readOnly": false, "type": "null or one of \"low\", \"medium\", \"high\", \"xhigh\", \"max\""}, "claude.code.skills..model": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Model to use while this skill is active, for the rest of the current turn.\nAccepts an alias (`sonnet`, `opus`, `haiku`, `fable`), a full model ID\n(e.g. `claude-opus-5`), or `inherit`. With `context = \"fork\"` it sets the\nforked subagent's model instead.\n", "example": {"_type": "literalExpression", "text": "\"opus\""}, "loc": ["claude", "code", "skills", "", "model"], "readOnly": false, "type": "null or string"}, "claude.code.skills..resources": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Files placed alongside SKILL.md, keyed by path relative to the\nskill directory. Claude reads these on demand, so bulky reference\nmaterial belongs here rather than in `content`.\n", "example": {"_type": "literalExpression", "text": "{\n \"references/api.md\" = ./api.md;\n \"scripts/check.sh\" = { source = ./check.sh; executable = true; };\n}\n"}, "loc": ["claude", "code", "skills", "", "resources"], "readOnly": false, "type": "attribute set of ((submodule) or absolute path convertible to it)"}, "claude.code.skills..resources..executable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Make the file executable", "loc": ["claude", "code", "skills", "", "resources", "", "executable"], "readOnly": false, "type": "boolean"}, "claude.code.skills..resources..ini": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "ini contents", "loc": ["claude", "code", "skills", "", "resources", "", "ini"], "readOnly": false, "type": "null or (attribute set of section of an INI file (attrs of INI atom (null, bool, int, float or string)))"}, "claude.code.skills..resources..json": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "json contents", "loc": ["claude", "code", "skills", "", "resources", "", "json"], "readOnly": false, "type": "null or JSON value"}, "claude.code.skills..resources..source": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "source contents", "loc": ["claude", "code", "skills", "", "resources", "", "source"], "readOnly": false, "type": "null or absolute path"}, "claude.code.skills..resources..text": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "text contents", "loc": ["claude", "code", "skills", "", "resources", "", "text"], "readOnly": false, "type": "null or string"}, "claude.code.skills..resources..toml": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "toml contents", "loc": ["claude", "code", "skills", "", "resources", "", "toml"], "readOnly": false, "type": "null or TOML value"}, "claude.code.skills..resources..yaml": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "yaml contents", "loc": ["claude", "code", "skills", "", "resources", "", "yaml"], "readOnly": false, "type": "null or YAML 1.1 value"}, "claude.code.skills..userInvocable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether you can invoke the skill yourself with `/\u2039name\u203a`. Set to false when\nonly Claude should invoke it, for background knowledge rather than a command.\n", "loc": ["claude", "code", "skills", "", "userInvocable"], "readOnly": false, "type": "boolean"}, "claude.code.skills..whenToUse": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/claude.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Additional context for when Claude should invoke the skill, such as trigger\nphrases or example requests. Appended to `description` in the skill listing\nand counts toward the 1536-character cap.\n", "example": {"_type": "literalExpression", "text": "\"Use when the user mentions migrations, schema changes or rollbacks.\""}, "loc": ["claude", "code", "skills", "", "whenToUse"], "readOnly": false, "type": "null or string"}, "container.isBuilding": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Devenv set it to true when the environment is a container.\n\nExample:\n```nix\n{ pkgs, config, lib, ... }:\n{\n packages = [ pkgs.openssl ]\n ++ lib.optionals (!config.container.isBuilding) [ pkgs.git ];\n}\n```\n", "loc": ["container", "isBuilding"], "readOnly": false, "type": "boolean"}, "containers": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Container specifications that can be built, copied and ran using `devenv container`.", "loc": ["containers"], "readOnly": false, "type": "attribute set of (submodule)"}, "containers..copyToRoot": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "self"}, "description": "Add a path to the container. Defaults to the whole git repo.", "loc": ["containers", "", "copyToRoot"], "readOnly": false, "type": "absolute path or list of absolute path"}, "containers..defaultCopyArgs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Default arguments to pass to `skopeo copy`.\nYou can override them by passing arguments to the script.\n", "loc": ["containers", "", "defaultCopyArgs"], "readOnly": false, "type": "list of string"}, "containers..enableLayerDeduplication": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable layer deduplication using the approach described at https://blog.eigenvalue.net/2023-nix2container-everything-once/\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["containers", "", "enableLayerDeduplication"], "readOnly": false, "type": "boolean"}, "containers..entrypoint": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "[ entrypoint ]"}, "description": "Entrypoint of the container.", "loc": ["containers", "", "entrypoint"], "readOnly": false, "type": "list of anything"}, "containers..fromImage": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "An existing OCI base image to build on top of, built with nix2container's pullImage.", "loc": ["containers", "", "fromImage"], "readOnly": false, "type": "null or package"}, "containers..isBuilding": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Set to true when the environment is building this container.", "loc": ["containers", "", "isBuilding"], "readOnly": false, "type": "boolean"}, "containers..layers": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "The layers to create.", "loc": ["containers", "", "layers"], "readOnly": false, "type": "list of (submodule)"}, "containers..layers.*.copyToRoot": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "A list of derivations copied to the image root directory.\n\nStore path prefixes ``/nix/store/hash-path`` are removed in order to relocate them to the image ``/``.\n", "loc": ["containers", "", "layers", "*", "copyToRoot"], "readOnly": false, "type": "list of package"}, "containers..layers.*.deps": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "A list of store paths to include in the layer.", "loc": ["containers", "", "layers", "*", "deps"], "readOnly": false, "type": "list of package"}, "containers..layers.*.ignore": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "A store path to ignore when building the layer. This is mainly useful to ignore the configuration file from the container layer.\n", "loc": ["containers", "", "layers", "*", "ignore"], "readOnly": false, "type": "null or path in the Nix store"}, "containers..layers.*.maxLayers": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "1"}, "description": "The maximum number of layers to create.", "loc": ["containers", "", "layers", "*", "maxLayers"], "readOnly": false, "type": "signed integer"}, "containers..layers.*.perms": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "A list of file permissions which are set when the tar layer is created.\n\nThese permissions are not written to the Nix store.\n", "loc": ["containers", "", "layers", "*", "perms"], "readOnly": false, "type": "list of (submodule)"}, "containers..layers.*.perms.*.gid": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The group ID to apply to all of the files matched by the ``regex``.", "example": {"_type": "literalExpression", "text": "\"1000\""}, "loc": ["containers", "", "layers", "*", "perms", "*", "gid"], "readOnly": false, "type": "null or signed integer"}, "containers..layers.*.perms.*.gname": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The group name to apply to all of the files matched by the ``regex``.", "example": {"_type": "literalExpression", "text": "\"root\""}, "loc": ["containers", "", "layers", "*", "perms", "*", "gname"], "readOnly": false, "type": "null or string"}, "containers..layers.*.perms.*.mode": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The numeric permissions mode to apply to all of the files matched by the ``regex``.", "example": {"_type": "literalExpression", "text": "\"644\""}, "loc": ["containers", "", "layers", "*", "perms", "*", "mode"], "readOnly": false, "type": "null or string"}, "containers..layers.*.perms.*.path": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "description": "A store path.", "loc": ["containers", "", "layers", "*", "perms", "*", "path"], "readOnly": false, "type": "path in the Nix store"}, "containers..layers.*.perms.*.regex": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "A regex pattern to select files or directories to apply the ``mode`` to.", "example": {"_type": "literalExpression", "text": "\".*\""}, "loc": ["containers", "", "layers", "*", "perms", "*", "regex"], "readOnly": false, "type": "null or string"}, "containers..layers.*.perms.*.uid": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The user ID to apply to all of the files matched by the ``regex``.", "example": {"_type": "literalExpression", "text": "\"1000\""}, "loc": ["containers", "", "layers", "*", "perms", "*", "uid"], "readOnly": false, "type": "null or signed integer"}, "containers..layers.*.perms.*.uname": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The user name to apply to all of the files matched by the ``regex``.", "example": {"_type": "literalExpression", "text": "\"root\""}, "loc": ["containers", "", "layers", "*", "perms", "*", "uname"], "readOnly": false, "type": "null or string"}, "containers..layers.*.reproducible": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether the layer should be reproducible.", "loc": ["containers", "", "layers", "*", "reproducible"], "readOnly": false, "type": "boolean"}, "containers..maxLayers": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "1"}, "description": "Maximum number of container layers created.", "loc": ["containers", "", "maxLayers"], "readOnly": false, "type": "null or signed integer"}, "containers..name": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "\"top-level name or containers.mycontainer.name\""}, "description": "Name of the container.", "loc": ["containers", "", "name"], "readOnly": false, "type": "null or string"}, "containers..registry": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "\"docker-daemon:\""}, "description": "Registry to push the container to.", "loc": ["containers", "", "registry"], "readOnly": false, "type": "null or string"}, "containers..startupCommand": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Command to run in the container.\n\nCan be a string, a package, or a list of strings for individual arguments.\nUse a list when your entrypoint expects separate arguments, e.g.:\n`startupCommand = [ \"-f\" \"/var/lib/haproxy/haproxy.cfg\" ];`\n", "loc": ["containers", "", "startupCommand"], "readOnly": false, "type": "null or string or package or list of string"}, "containers..version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "\"latest\""}, "description": "Version/tag of the container.", "loc": ["containers", "", "version"], "readOnly": false, "type": "null or string"}, "containers..workingDir": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/containers.nix"}], "default": {"_type": "literalExpression", "text": "\"/env\""}, "description": "Working directory of the container.", "loc": ["containers", "", "workingDir"], "readOnly": false, "type": "string"}, "delta.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/delta.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/delta.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Integrate delta into git: https://dandavison.github.io/delta/.", "loc": ["delta", "enable"], "readOnly": false, "type": "boolean"}, "devcontainer.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable generation .devcontainer.json for devenv integration.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["devcontainer", "enable"], "readOnly": false, "type": "boolean"}, "devcontainer.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Devcontainer settings.\n", "loc": ["devcontainer", "settings"], "readOnly": false, "type": "open submodule of (JSON value)"}, "devcontainer.settings.customizations.vscode.extensions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"mkhl.direnv\"\n]"}, "description": "A list of pre-installed VS Code extensions.\n", "loc": ["devcontainer", "settings", "customizations", "vscode", "extensions"], "readOnly": false, "type": "list of string"}, "devcontainer.settings.customizations.zed.extensions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "A list of pre-installed Zed extensions.\n", "loc": ["devcontainer", "settings", "customizations", "zed", "extensions"], "readOnly": false, "type": "list of string"}, "devcontainer.settings.image": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix"}], "default": {"_type": "literalExpression", "text": "\"ghcr.io/cachix/devenv/devcontainer:latest\""}, "description": "The name of an image in a container registry.\n", "loc": ["devcontainer", "settings", "image"], "readOnly": false, "type": "string"}, "devcontainer.settings.overrideCommand": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Override the default command.\n", "loc": ["devcontainer", "settings", "overrideCommand"], "readOnly": false, "type": "anything"}, "devcontainer.settings.updateContentCommand": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/devcontainer.nix"}], "default": {"_type": "literalExpression", "text": "\"devenv test\""}, "description": "A command to run after the container is created.\n", "loc": ["devcontainer", "settings", "updateContentCommand"], "readOnly": false, "type": "anything"}, "devenv.cliVersion": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/update-check.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/update-check.nix"}], "description": "Alias of {option}`devenv.cli.version`.", "loc": ["devenv", "cliVersion"], "readOnly": false, "type": "null or string"}, "devenv.debug": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/debug.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/debug.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable debug mode of devenv enterShell script.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["devenv", "debug"], "readOnly": false, "type": "boolean"}, "devenv.flakesIntegration": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/update-check.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/update-check.nix"}], "default": {"_type": "literalMD", "text": "`true` when devenv is invoked via the flake integration; `false` otherwise."}, "description": "Tells if devenv is being imported by a flake.nix file\n", "loc": ["devenv", "flakesIntegration"], "readOnly": false, "type": "boolean"}, "devenv.isTesting": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tests.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tests.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether the environment is being used for testing.", "loc": ["devenv", "isTesting"], "readOnly": false, "type": "boolean"}, "devenv.latestVersion": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/update-check.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/update-check.nix"}], "default": {"_type": "literalExpression", "text": "\"2.4.0\""}, "description": "The latest version of devenv.\n", "loc": ["devenv", "latestVersion"], "readOnly": false, "type": "string"}, "devenv.warnOnNewVersion": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/update-check.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/update-check.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to warn when a new version of either devenv or the direnv integration is available.\n", "loc": ["devenv", "warnOnNewVersion"], "readOnly": false, "type": "boolean"}, "difftastic.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/difftastic.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/difftastic.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Integrate difftastic into git: https://difftastic.wilfred.me.uk/.", "loc": ["difftastic", "enable"], "readOnly": false, "type": "boolean"}, "dotenv.disableHint": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/dotenv.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/dotenv.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Disable the hint printed when a dotenv file is present but the integration is not enabled.", "loc": ["dotenv", "disableHint"], "readOnly": false, "type": "boolean"}, "dotenv.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/dotenv.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/dotenv.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable .env integration.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["dotenv", "enable"], "readOnly": false, "type": "boolean"}, "dotenv.filename": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/dotenv.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/dotenv.nix"}], "default": {"_type": "literalExpression", "text": "\".env\""}, "description": "The path of the dotenv file to load, or a list of dotenv files to load in order of precedence.", "loc": ["dotenv", "filename"], "readOnly": false, "type": "string or list of string"}, "dotenv.substitution": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/dotenv.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/dotenv.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to expand variable references such as `$NAME`, `${NAME}`, and\n`${NAME:-default}` in dotenv values. Disabled by default so dollar signs\nin passwords, hashes, and tokens remain literal.\n", "loc": ["dotenv", "substitution"], "readOnly": false, "type": "boolean"}, "enterShell": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Bash code to execute when entering the shell.", "loc": ["enterShell"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "enterTest": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tests.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tests.nix"}], "description": "Bash code to execute to run the test.", "loc": ["enterTest"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "env": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Environment variables to be exposed inside the developer environment.", "loc": ["env"], "readOnly": false, "type": "open submodule of lazy attribute set of anything"}, "files": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "A set of files that will be linked into devenv root.", "loc": ["files"], "readOnly": false, "type": "attribute set of (submodule)"}, "files..copyMode": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix"}], "default": {"_type": "literalExpression", "text": "\"symlink\""}, "description": "How to materialize the file in the project root:\n\n- `symlink` (default): symlink to the read-only file in the Nix store. Edits are not possible; devenv keeps the link pointed at the current contents.\n- `seed`: copy the file into place once, only if it does not already exist, and make it writable. Existing files are left untouched, so your edits are preserved. Useful for seeding configuration from templates the user then edits.\n- `copy`: copy the file into place as a writable file, overwriting it with fresh contents on every shell entry. The file is replaced atomically, so tools that walk the project never see it missing. Useful when a tool must write to the file in place but devenv should remain the source of truth.\n", "loc": ["files", "", "copyMode"], "readOnly": false, "type": "one of \"symlink\", \"seed\", \"copy\""}, "files..executable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Make the file executable", "loc": ["files", "", "executable"], "readOnly": false, "type": "boolean"}, "files..ini": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "ini contents", "loc": ["files", "", "ini"], "readOnly": false, "type": "null or (attribute set of section of an INI file (attrs of INI atom (null, bool, int, float or string)))"}, "files..json": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "json contents", "loc": ["files", "", "json"], "readOnly": false, "type": "null or JSON value"}, "files..source": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "source contents", "loc": ["files", "", "source"], "readOnly": false, "type": "null or absolute path"}, "files..text": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "text contents", "loc": ["files", "", "text"], "readOnly": false, "type": "null or string"}, "files..toml": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "toml contents", "loc": ["files", "", "toml"], "readOnly": false, "type": "null or TOML value"}, "files..yaml": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/files.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "yaml contents", "loc": ["files", "", "yaml"], "readOnly": false, "type": "null or YAML 1.1 value"}, "git-hooks": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/git-hooks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/git-hooks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Integration with https://github.com/cachix/git-hooks.nix", "loc": ["git-hooks"], "readOnly": false, "type": "submodule"}, "git-hooks.addGcRoot": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to add the generated pre-commit config to the garbage collector roots.\nThis prevents Nix from garbage-collecting the tools used by hooks.\n", "loc": ["git-hooks", "addGcRoot"], "readOnly": false, "type": "boolean"}, "git-hooks.configFile": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "The pre-commit configuration file.\n", "loc": ["git-hooks", "configFile"], "readOnly": true, "type": "package"}, "git-hooks.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "default": {"_type": "literalExpression", "text": "\".pre-commit-config.yaml\""}, "description": "The path where to generate the pre-commit configuration file.\n\nThis path is relative to the root of the project. By default,\nthis is set to \".pre-commit-config.yaml\", which is the standard\nlocation expected by pre-commit.\n", "loc": ["git-hooks", "configPath"], "readOnly": false, "type": "string"}, "git-hooks.default_stages": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"pre-commit\"\n]"}, "description": "A configuration wide option for the stages property.\nInstalls hooks to the defined stages.\nSee [https://pre-commit.com/#confining-hooks-to-run-at-certain-stages](https://pre-commit.com/#confining-hooks-to-run-at-certain-stages).\n", "loc": ["git-hooks", "default_stages"], "readOnly": false, "type": "list of (one of \"commit-msg\", \"post-checkout\", \"post-commit\", \"post-merge\", \"post-rewrite\", \"pre-commit\", \"pre-merge-commit\", \"pre-push\", \"pre-rebase\", \"prepare-commit-msg\", \"manual\", \"commit\", \"push\", \"merge-commit\")"}, "git-hooks.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable the pre-commit hooks module.\n\nWhen set to false, this disables the entire module.\n", "loc": ["git-hooks", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.enabledPackages": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "All packages provided by hooks that are enabled.\n\nUseful for including into the developer environment.\n", "loc": ["git-hooks", "enabledPackages"], "readOnly": false, "type": "list of unspecified value"}, "git-hooks.excludes": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Exclude files that were matched by these patterns.\n", "loc": ["git-hooks", "excludes"], "readOnly": false, "type": "list of string"}, "git-hooks.gitPackage": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.gitMinimal"}, "description": "The `git` package to use.\n", "loc": ["git-hooks", "gitPackage"], "readOnly": false, "type": "package"}, "git-hooks.hooks": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}, {"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "The hook definitions.\n\nYou can both specify your own hooks here and you can enable predefined hooks.\n\nExample of enabling a predefined hook:\n\n```nix\nhooks.nixpkgs-fmt.enable = true;\n```\n\nExample of a custom hook:\n\n```nix\nhooks.my-tool = {\n enable = true;\n name = \"my-tool\";\n description = \"Run MyTool on all files in the project\";\n files = \"\\\\.mtl$\";\n entry = \"${pkgs.my-tool}/bin/mytoolctl\";\n};\n```\n\nThe predefined hooks are:\n\n**`action-validator`**\n\nTool to validate GitHub Action and Workflow YAML files\n\n\n**`actionlint`**\n\nStatic checker for GitHub Actions workflow files\n\n\n**`alejandra`**\n\nThe Uncompromising Nix Code Formatter\n\n\n**`annex`**\n\nRuns the git-annex hook for large file support\n\n\n**`ansible-lint`**\n\nAnsible linter\n\n\n**`autoflake`**\n\nRemove unused imports and variables from Python code\n\n\n**`bats`**\n\nRun bash unit tests\n\n\n**`beautysh`**\n\nFormat shell files\n\n\n**`biome`**\n\nA toolchain for web projects, aimed to provide functionalities to maintain them\n\n\n**`black`**\n\nThe uncompromising Python code formatter\n\n\n**`cabal-fmt`**\n\nFormat Cabal files\n\n\n**`cabal-gild`**\n\nFormat Cabal files\n\n\n**`cabal2nix`**\n\nRun `cabal2nix` on all `*.cabal` files to generate corresponding `.nix` files\n\n\n**`cargo-check`**\n\nCheck the cargo package for errors\n\n\n**`chart-testing`**\n\nCLI tool for linting and testing Helm charts\n\n\n**`check-added-large-files`**\n\nPrevent very large files to be committed (e.g. binaries).\n\n\n**`check-builtin-literals`**\n\nRequire literal syntax when initializing empty or zero builtin types in Python.\n\n\n**`check-case-conflicts`**\n\nCheck for files that would conflict in case-insensitive filesystems.\n\n\n**`check-docstring-first`**\n\nCheck that all docstrings appear above the code.\n\n\n**`check-executables-have-shebangs`**\n\nEnsure that all non-binary executables have shebangs.\n\n\n**`check-json`**\n\nCheck syntax of JSON files.\n\n\n**`check-merge-conflicts`**\n\nCheck for files that contain merge conflict strings.\n\n\n**`check-python`**\n\nCheck syntax of Python file by parsing Python abstract syntax tree.\n\n\n**`check-shebang-scripts-are-executable`**\n\nEnsure that all (non-binary) files with a shebang are executable.\n\n\n**`check-symlinks`**\n\nFind broken symlinks.\n\n\n**`check-toml`**\n\nCheck syntax of TOML files.\n\n\n**`check-vcs-permalinks`**\n\nEnsure that links to VCS websites are permalinks.\n\n\n**`check-xml`**\n\nCheck syntax of XML files.\n\n\n**`check-yaml`**\n\nCheck syntax of YAML files.\n\n\n**`checkmake`**\n\nExperimental linter/analyzer for Makefiles\n\n\n**`chktex`**\n\nLaTeX semantic checker\n\n\n**`circleci`**\n\nValidate CircleCI config files.\n\n\n**`clang-format`**\n\nFormat your code using `clang-format`.\n\n\n**`clang-tidy`**\n\nStatic analyzer for C++ code.\n\n\n**`clippy`**\n\nLint Rust code.\n\n\n**`cljfmt`**\n\nA tool for formatting Clojure code.\n\n\n**`cmake-format`**\n\nA tool for formatting CMake-files.\n\n\n**`commitizen`**\n\nCheck whether the current commit message follows committing rules.\n\n\n\n**`comrak`**\n\nA 100% CommonMark-compatible GitHub Flavored Markdown formatter\n\n\n**`conform`**\n\nPolicy enforcement for commits.\n\n\n**`convco`**\n\n\n\n\n**`credo`**\n\nRuns a static code analysis using Credo\n\n\n**`crystal`**\n\nA tool that automatically formats Crystal source code\n\n\n**`cspell`**\n\nA Spell Checker for Code\n\n\n**`cue-fmt`**\n\nFormat CUE files\n\n\n**`dart-analyze`**\n\nDart analyzer\n\n\n**`dart-format`**\n\nDart formatter\n\n\n**`deadnix`**\n\nScan Nix files for dead code (unused variable bindings).\n\n\n**`denofmt`**\n\nAuto-format JavaScript, TypeScript, Markdown, and JSON files.\n\n\n**`denolint`**\n\nLint JavaScript/TypeScript source code.\n\n\n**`detect-aws-credentials`**\n\nDetect AWS credentials from the AWS cli credentials file.\n\n\n**`detect-private-keys`**\n\nDetect the presence of private keys.\n\n\n**`dhall-format`**\n\nDhall code formatter.\n\n\n**`dialyzer`**\n\nRuns a static code analysis using Dialyzer\n\n\n**`dune-fmt`**\n\nRuns Dune's formatters on the code tree.\n\n\n**`dune-opam-sync`**\n\nCheck that Dune-generated OPAM files are in sync.\n\n\n**`eclint`**\n\nEditorConfig linter written in Go.\n\n\n**`editorconfig-checker`**\n\nVerify that the files are in harmony with the `.editorconfig`.\n\n\n**`elm-format`**\n\nFormat Elm files.\n\n\n**`elm-review`**\n\nAnalyzes Elm projects, to help find mistakes before your users find them.\n\n\n**`elm-test`**\n\nRun unit tests and fuzz tests for Elm code.\n\n\n**`end-of-file-fixer`**\n\nEnsures that a file is either empty, or ends with a single newline.\n\n\n**`eslint`**\n\nFind and fix problems in your JavaScript code.\n\n\n**`fix-byte-order-marker`**\n\nRemove UTF-8 byte order marker.\n\n\n**`fix-encoding-pragma`**\n\nAdds # -*- coding: utf-8 -*- to the top of Python files.'\n\n\n**`flake-checker`**\n\nRun health checks on your flake-powered Nix projects.\n\n\n**`flake8`**\n\nCheck the style and quality of Python files.\n\n\n**`flynt`**\n\nCLI tool to convert a python project's %-formatted strings to f-strings.\n\n\n**`forbid-new-submodules`**\n\nPrevent addition of new Git submodules.\n\n\n**`fourmolu`**\n\nHaskell code prettifier.\n\n\n**`fprettify`**\n\nAuto-formatter for modern Fortran code.\n\n\n**`gitlint`**\n\nLinting for your git commit messages\n\n\n**`gofmt`**\n\nA tool that automatically formats Go source code\n\n\n**`golangci-lint`**\n\nFast linters runner for Go.\n\n\n**`golines`**\n\nA golang formatter that fixes long lines\n\n\n**`gotest`**\n\nRun go tests\n\n\n**`govet`**\n\nChecks correctness of Go programs.\n\n\n**`gptcommit`**\n\nGenerate a commit message using GPT3.\n\n\n**`hadolint`**\n\nDockerfile linter, validate inline bash.\n\n\n**`headache`**\n\nLightweight tool for managing headers in source code files.\n\n\n**`hindent`**\n\nHaskell code prettifier.\n\n\n**`hledger-fmt`**\n\nOpinionated hledger's journal files formatter.\n\n\n**`hlint`**\n\nHLint gives suggestions on how to improve your source code.\n\n\n**`hpack`**\n\n`hpack` converts package definitions in the hpack format (`package.yaml`) to Cabal files.\n\n\n**`html-tidy`**\n\nHTML linter.\n\n\n**`hunspell`**\n\nSpell checker and morphological analyzer.\n\n\n**`isort`**\n\nA Python utility / library to sort imports.\n\n\n**`juliaformatter`**\n\nRun JuliaFormatter.jl against Julia source files\n\n\n**`keep-sorted`**\n\nLanguage-agnostic formatter that sorts lines between two markers in a larger file.\n\n\n**`lacheck`**\n\nA consistency checker for LaTeX documents.\n\n\n**`latexindent`**\n\nPerl script to add indentation to LaTeX files.\n\n\n**`lua-ls`**\n\nUses the lua-language-server CLI to statically type-check and lint Lua code.\n\n\n**`luacheck`**\n\nA tool for linting and static analysis of Lua code.\n\n\n**`lychee`**\n\nA fast, async, stream-based link checker that finds broken hyperlinks and mail addresses inside Markdown, HTML, reStructuredText, or any other text file or website.\n\n\n**`markdownlint`**\n\nStyle checker and linter for markdown files.\n\n\n**`mdformat`**\n\nCommonMark compliant Markdown formatter\n\n\n**`mdl`**\n\nA tool to check markdown files and flag style issues.\n\n\n**`mdsh`**\n\nMarkdown shell pre-processor.\n\n\n**`mix-format`**\n\nRuns the built-in Elixir syntax formatter\n\n\n**`mix-test`**\n\nRuns the built-in Elixir test framework\n\n\n**`mixed-line-endings`**\n\nResolve mixed line endings.\n\n\n**`mkdocs-linkcheck`**\n\nValidate links associated with markdown-based, statically generated websites.\n\n\n**`mypy`**\n\nStatic type checker for Python\n\n\n**`name-tests-test`**\n\nVerify that Python test files are named correctly.\n\n\n**`nbstripout`**\n\nStrip output from Jupyter notebooks\n\n\n**`nil`**\n\nIncremental analysis assistant for writing in Nix.\n\n\n**`nixf-diagnose`**\n\nwrapper for nixf-tidy.\n\n\n**`nixfmt`**\n\nOfficial Nix code formatter.\n\n\n**`nixfmt-classic`**\n\nNix code prettifier (classic).\n\n\n**`nixfmt-rfc-style`**\n\nNix code prettifier (RFC 166 style).\n\n\n**`nixpkgs-fmt`**\n\nNix code prettifier.\n\n\n**`no-commit-to-branch`**\n\nDisallow committing to certain branch/branches.\n\n\n**`ocp-indent`**\n\nA tool to indent OCaml code.\n\n\n**`opam-lint`**\n\nOCaml package manager configuration checker.\n\n\n**`openapi-spec-validator`**\n\nA tool to validate OpenAPI spec files\n\n\n**`ormolu`**\n\nHaskell code prettifier.\n\n\n**`php-cs-fixer`**\n\nLint PHP files.\n\n\n**`phpcbf`**\n\nLint PHP files.\n\n\n**`phpcs`**\n\nLint PHP files.\n\n\n**`phpstan`**\n\nStatic Analysis of PHP files.\n\n\n**`poetry-check`**\n\nCheck the Poetry config for errors\n\n\n**`poetry-lock`**\n\nUpdate the Poetry lock file\n\n\n**`pre-commit-hook-ensure-sops`**\n\n\n\n\n**`prettier`**\n\nOpinionated multi-language code formatter.\n\n\n**`pretty-format-json`**\n\nFormats JSON files.\n\n\n**`proselint`**\n\nA linter for prose.\n\n\n**`psalm`**\n\nStatic Analysis of PHP files.\n\n\n**`purs-tidy`**\n\nFormat purescript files.\n\n\n**`pylint`**\n\nLint Python files.\n\n\n**`pyright`**\n\nStatic type checker for Python\n\n\n**`python-debug-statements`**\n\nCheck for debugger imports and py37+ `breakpoint()` calls in python source.\n\n\n**`pyupgrade`**\n\nAutomatically upgrade syntax for newer versions.\n\n\n**`regal`**\n\nA linter for Rego policies\n\n\n**`reuse`**\n\nreuse is a tool for compliance with the REUSE recommendations.\n\n\n**`revive`**\n\nA linter for Go source code.\n\n\n**`ripsecrets`**\n\nPrevent committing secret keys into your source code\n\n\n**`rome`**\n\n\n\n\n**`ruff`**\n\nAn extremely fast Python linter, written in Rust.\n\n\n**`ruff-format`**\n\nAn extremely fast Python code formatter, written in Rust.\n\n\n**`rumdl`**\n\nStyle checker and linter for rumdl files.\n\n\n**`rustfmt`**\n\nFormat Rust code.\n\n\n**`selene`**\n\nA blazing-fast modern Lua linter written in Rust.\n\n\n**`shellcheck`**\n\nFormat shell files.\n\n\n**`shfmt`**\n\nFormat shell files.\n\n\n**`single-quoted-strings`**\n\nReplace double quoted strings with single quoted strings.\n\n\n**`sort-file-contents`**\n\nSort the lines in specified files (defaults to alphabetical).\n\n\n**`sort-requirements-txt`**\n\nSort requirements in requirements.txt and constraints.txt files.\n\n\n**`sort-simple-yaml`**\n\nSort simple YAML files which consist only of top-level keys, preserving comments and blocks.\n\n\n**`staticcheck`**\n\nState of the art linter for the Go programming language\n\n\n**`statix`**\n\nLints and suggestions for the Nix programming language.\n\n\n**`stylish-haskell`**\n\nA simple Haskell code prettifier\n\n\n**`stylua`**\n\nAn Opinionated Lua Code Formatter.\n\n\n**`tagref`**\n\nHave tagref check all references and tags.\n\n\n\n**`taplo`**\n\nFormat TOML files with taplo fmt\n\n\n**`terraform-format`**\n\nFormat Terraform (`.tf`) files.\n\n\n**`terraform-validate`**\n\nValidates terraform configuration files (`.tf`).\n\n\n**`tflint`**\n\nA Pluggable Terraform Linter.\n\n\n**`topiary`**\n\nA universal formatter engine within the Tree-sitter ecosystem, with support for many languages.\n\n\n**`treefmt`**\n\nOne CLI to format the code tree.\n\n\n**`trim-trailing-whitespace`**\n\nTrim trailing whitespace.\n\n\n**`trufflehog`**\n\nSecrets scanner\n\n\n**`typos`**\n\nSource code spell checker\n\n\n**`typstyle`**\n\nBeautiful and reliable typst code formatter\n\n\n**`uv-check`**\n\nCheck if uv's lockfile is up-to-date.\n\n\n**`uv-export`**\n\nExport uv's lockfile.\n\n\n**`uv-lock`**\n\nUpdate uv's lockfile.\n\n\n**`vale`**\n\nA markup-aware linter for prose built with speed and extensibility in mind.\n\n\n**`woodpecker-cli-lint`**\n\nCommand line client for the Woodpecker Continuous Integration server (lint only).\n\n\n**`yamlfmt`**\n\nFormatter for YAML files.\n\n\n**`yamllint`**\n\nLinter for YAML files.\n\n\n**`zizmor`**\n\nStatic analysis for GitHub Actions\n\n\n**`zprint`**\n\nBeautifully format Clojure and Clojurescript source code and s-expressions.\n\n\n", "loc": ["git-hooks", "hooks"], "readOnly": false, "type": "open submodule of attribute set of (submodule)"}, "git-hooks.hooks..after": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of hooks that should run before this hook.\n", "loc": ["git-hooks", "hooks", "", "after"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks..always_run": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "if true this hook will run even if there are no matching files.\n", "loc": ["git-hooks", "hooks", "", "always_run"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks..args": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of additional parameters to pass to the hook.\n", "loc": ["git-hooks", "hooks", "", "args"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks..before": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of hooks that should run after this hook.\n", "loc": ["git-hooks", "hooks", "", "before"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks..description": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Description of the hook. Used for metadata purposes only.\n", "loc": ["git-hooks", "hooks", "", "description"], "readOnly": false, "type": "string"}, "git-hooks.hooks..enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks..entry": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "description": "The entry point - the executable to run. {option}`entry` can also contain arguments that will not be overridden, such as `entry = \"autopep8 -i\";`.\n", "loc": ["git-hooks", "hooks", "", "entry"], "readOnly": false, "type": "string"}, "git-hooks.hooks..exclude_types": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of file types to exclude. See [Filtering files with types](https://pre-commit.com/#filtering-files-with-types).\n", "loc": ["git-hooks", "hooks", "", "exclude_types"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks..excludes": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Exclude files that were matched by these patterns.\n", "loc": ["git-hooks", "hooks", "", "excludes"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks..extraPackages": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Additional packages required to run the hook.\n\nThese are propagated to `enabledPackages` for constructing developer\nenvironments.\n", "loc": ["git-hooks", "hooks", "", "extraPackages"], "readOnly": false, "type": "list of package"}, "git-hooks.hooks..fail_fast": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "if true pre-commit will stop running hooks if this hook fails.\n", "loc": ["git-hooks", "hooks", "", "fail_fast"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks..files": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "The pattern of files to run on.\n", "loc": ["git-hooks", "hooks", "", "files"], "readOnly": false, "type": "string"}, "git-hooks.hooks..id": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "\"the attribute name the hook submodule is bound to\""}, "description": "The unique identifier for the hook.\n\nYou do not need to set or modify this value.\n\nThe `id` is used to reference a hook when using `pre-commit run `.\nIt can also be used to reference the hook in other hooks' `before` and `after` fields to define the order in which hooks run.\n\nThe `id` is set to the attribute name the hook submodule is bound to in the parent module.\nFor example, the `id` of following hook would be `my-hook`.\n\n```nix\n{\n hooks = {\n my-hook = {\n enable = true;\n entry = \"my-hook\";\n };\n }\n}\n```\n", "loc": ["git-hooks", "hooks", "", "id"], "readOnly": false, "type": "string"}, "git-hooks.hooks..language": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "\"system\" or \"unsupported\" depending on pre-commit version"}, "description": "The language of the hook - tells pre-commit how to install the hook.\n\nDefaults to `\"system\"`, or `\"unsupported\"` when using pre-commit >= 4.4.0.\n\nNote: `\"unsupported\"` does not mean deprecated.\nPre-commit >= 4.4.0 renamed `\"system\"` to `\"unsupported\"` because\nwhen using this language pre-commit does not provision the tools, and using externally\nmanaged tools (e.g. via Nix) is not an officially supported workflow.\nBoth values are functionally equivalent.\n", "loc": ["git-hooks", "hooks", "", "language"], "readOnly": false, "type": "string"}, "git-hooks.hooks..name": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "the attribute name the hook submodule is bound to, same as `id`"}, "description": "The name of the hook. Shown during hook execution.\n", "loc": ["git-hooks", "hooks", "", "name"], "readOnly": false, "type": "string"}, "git-hooks.hooks..package": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "An optional package that provides the hook.\n", "loc": ["git-hooks", "hooks", "", "package"], "readOnly": false, "type": "null or package"}, "git-hooks.hooks..pass_filenames": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to pass filenames as arguments to the entry point.\n", "loc": ["git-hooks", "hooks", "", "pass_filenames"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks..priority": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Defines the order in which the hooks are executed. Default priority is set by the order in the list of hooks.\nEvaluation goes from 0 and up.\nIf two hooks have the same priority, they\u2019ll run in parallel.\nThis works only if cfg.package is set to prek.\n", "loc": ["git-hooks", "hooks", "", "priority"], "readOnly": false, "type": "null or 32 bit unsigned integer; between 0 and 4294967295 (both inclusive)"}, "git-hooks.hooks..raw": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "description": "Raw fields of a pre-commit hook. This is mostly for internal use but\nexposed in case you need to work around something.\n\nDefault: taken from the other hook options.\n", "loc": ["git-hooks", "hooks", "", "raw"], "readOnly": false, "type": "attribute set of unspecified value"}, "git-hooks.hooks..require_serial": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "if true this hook will execute using a single process instead of in parallel.\n", "loc": ["git-hooks", "hooks", "", "require_serial"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks..stages": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "default_stages"}, "description": "Confines the hook to run at a particular stage.\n", "loc": ["git-hooks", "hooks", "", "stages"], "readOnly": false, "type": "list of (one of \"commit-msg\", \"post-checkout\", \"post-commit\", \"post-merge\", \"post-rewrite\", \"pre-commit\", \"pre-merge-commit\", \"pre-push\", \"pre-rebase\", \"prepare-commit-msg\", \"manual\", \"commit\", \"push\", \"merge-commit\")"}, "git-hooks.hooks..types": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"file\"\n]"}, "description": "List of file types to run on. See [Filtering files with types](https://pre-commit.com/#filtering-files-with-types).\n", "loc": ["git-hooks", "hooks", "", "types"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks..types_or": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of file types to run on, where only a single type needs to match.\n", "loc": ["git-hooks", "hooks", "", "types_or"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks..verbose": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "forces the output of the hook to be printed even when the hook passes.\n", "loc": ["git-hooks", "hooks", "", "verbose"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.alejandra": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "alejandra hook", "loc": ["git-hooks", "hooks", "alejandra"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.alejandra.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "alejandra", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.alejandra.settings.check": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Check if the input is already formatted and disable writing in-place the modified content", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["git-hooks", "hooks", "alejandra", "settings", "check"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.alejandra.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "(experimental) Path to the alejandra.toml configuration file.", "loc": ["git-hooks", "hooks", "alejandra", "settings", "configPath"], "readOnly": false, "type": "null or string or absolute path"}, "git-hooks.hooks.alejandra.settings.exclude": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Files or directories to exclude from formatting.", "example": {"_type": "literalExpression", "text": "[\n \"flake.nix\"\n \"./templates\"\n]"}, "loc": ["git-hooks", "hooks", "alejandra", "settings", "exclude"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.alejandra.settings.threads": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Number of formatting threads to spawn.", "example": {"_type": "literalExpression", "text": "8"}, "loc": ["git-hooks", "hooks", "alejandra", "settings", "threads"], "readOnly": false, "type": "null or signed integer"}, "git-hooks.hooks.alejandra.settings.verbosity": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"normal\""}, "description": "Whether informational messages or all messages should be hidden or not.", "example": {"_type": "literalExpression", "text": "\"quiet\""}, "loc": ["git-hooks", "hooks", "alejandra", "settings", "verbosity"], "readOnly": false, "type": "one of \"normal\", \"quiet\", \"silent\""}, "git-hooks.hooks.ansible-lint": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "ansible-lint hook", "loc": ["git-hooks", "hooks", "ansible-lint"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.ansible-lint.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "ansible-lint", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.ansible-lint.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to the YAML configuration file.", "loc": ["git-hooks", "hooks", "ansible-lint", "settings", "configPath"], "readOnly": false, "type": "string"}, "git-hooks.hooks.ansible-lint.settings.subdir": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to the Ansible subdirectory.", "loc": ["git-hooks", "hooks", "ansible-lint", "settings", "subdir"], "readOnly": false, "type": "string"}, "git-hooks.hooks.autoflake": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "autoflake hook", "loc": ["git-hooks", "hooks", "autoflake"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.autoflake.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "autoflake", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.autoflake.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"${tools.autoflake}/bin/autoflake\"\n"}, "description": "Path to autoflake binary.", "loc": ["git-hooks", "hooks", "autoflake", "settings", "binPath"], "readOnly": false, "type": "null or string"}, "git-hooks.hooks.autoflake.settings.flags": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"--in-place --expand-star-imports --remove-duplicate-keys --remove-unused-variables\""}, "description": "Flags passed to autoflake.", "loc": ["git-hooks", "hooks", "autoflake", "settings", "flags"], "readOnly": false, "type": "string"}, "git-hooks.hooks.biome": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "biome hook", "loc": ["git-hooks", "hooks", "biome"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.biome.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "biome", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.biome.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"${tools.biome}/bin/biome\"\n"}, "description": "`biome` binary path.\nFor example, if you want to use the `biome` binary from `node_modules`, use `\"./node_modules/.bin/biome\"`.\nUse a string instead of a path to avoid having to Git track the file in projects that use Nix flakes.\n", "example": {"_type": "literalExpression", "text": "\"./node_modules/.bin/biome\"\n"}, "loc": ["git-hooks", "hooks", "biome", "settings", "binPath"], "readOnly": false, "type": "null or string or absolute path"}, "git-hooks.hooks.biome.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to the configuration JSON file", "loc": ["git-hooks", "hooks", "biome", "settings", "configPath"], "readOnly": false, "type": "string"}, "git-hooks.hooks.biome.settings.write": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to edit files inplace.", "loc": ["git-hooks", "hooks", "biome", "settings", "write"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.black": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "black hook", "loc": ["git-hooks", "hooks", "black"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.black.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "black", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.black.settings.flags": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Flags passed to black. See all available [here](https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#command-line-options).", "example": {"_type": "literalExpression", "text": "\"--skip-magic-trailing-comma\""}, "loc": ["git-hooks", "hooks", "black", "settings", "flags"], "readOnly": false, "type": "string"}, "git-hooks.hooks.cabal2nix": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "cabal2nix hook", "loc": ["git-hooks", "hooks", "cabal2nix"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.cabal2nix.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "cabal2nix", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.cabal2nix.settings.outputFilename": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"default.nix\""}, "description": "The name of the output file generated after running `cabal2nix`.", "loc": ["git-hooks", "hooks", "cabal2nix", "settings", "outputFilename"], "readOnly": false, "type": "string"}, "git-hooks.hooks.clippy": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "clippy hook", "loc": ["git-hooks", "hooks", "clippy"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.clippy.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "clippy", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.clippy.packageOverrides.cargo": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "The cargo package to use", "loc": ["git-hooks", "hooks", "clippy", "packageOverrides", "cargo"], "readOnly": false, "type": "package"}, "git-hooks.hooks.clippy.packageOverrides.clippy": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "The clippy package to use", "loc": ["git-hooks", "hooks", "clippy", "packageOverrides", "clippy"], "readOnly": false, "type": "package"}, "git-hooks.hooks.clippy.settings.allFeatures": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Run clippy with --all-features", "loc": ["git-hooks", "hooks", "clippy", "settings", "allFeatures"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.clippy.settings.denyWarnings": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Fail when warnings are present", "loc": ["git-hooks", "hooks", "clippy", "settings", "denyWarnings"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.clippy.settings.extraArgs": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Additional arguments to pass to clippy", "loc": ["git-hooks", "hooks", "clippy", "settings", "extraArgs"], "readOnly": false, "type": "string"}, "git-hooks.hooks.clippy.settings.offline": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Run clippy offline", "loc": ["git-hooks", "hooks", "clippy", "settings", "offline"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.cmake-format": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "cmake-format hook", "loc": ["git-hooks", "hooks", "cmake-format"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.cmake-format.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "cmake-format", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.cmake-format.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to the configuration file (.json,.python,.yaml)", "example": {"_type": "literalExpression", "text": "\".cmake-format.json\""}, "loc": ["git-hooks", "hooks", "cmake-format", "settings", "configPath"], "readOnly": false, "type": "string"}, "git-hooks.hooks.convco": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "convco hook", "loc": ["git-hooks", "hooks", "convco"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.convco.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "convco", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.convco.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Path to the configuration file (YAML or JSON)", "loc": ["git-hooks", "hooks", "convco", "settings", "configPath"], "readOnly": false, "type": "null or string or absolute path"}, "git-hooks.hooks.credo": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "credo hook", "loc": ["git-hooks", "hooks", "credo"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.credo.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "credo", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.credo.settings.strict": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to auto-promote the changes.", "loc": ["git-hooks", "hooks", "credo", "settings", "strict"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.deadnix": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "deadnix hook", "loc": ["git-hooks", "hooks", "deadnix"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.deadnix.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "deadnix", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.deadnix.settings.edit": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Remove unused code and write to source file.", "loc": ["git-hooks", "hooks", "deadnix", "settings", "edit"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.deadnix.settings.exclude": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Files to exclude from analysis.", "loc": ["git-hooks", "hooks", "deadnix", "settings", "exclude"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.deadnix.settings.hidden": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Recurse into hidden subdirectories and process hidden .*.nix files.", "loc": ["git-hooks", "hooks", "deadnix", "settings", "hidden"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.deadnix.settings.noLambdaArg": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Don't check lambda parameter arguments.", "loc": ["git-hooks", "hooks", "deadnix", "settings", "noLambdaArg"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.deadnix.settings.noLambdaPatternNames": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Don't check lambda pattern names (don't break nixpkgs `callPackage`).", "loc": ["git-hooks", "hooks", "deadnix", "settings", "noLambdaPatternNames"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.deadnix.settings.noUnderscore": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Don't check any bindings that start with a `_`.", "loc": ["git-hooks", "hooks", "deadnix", "settings", "noUnderscore"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.deadnix.settings.quiet": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Don't print a dead code report.", "loc": ["git-hooks", "hooks", "deadnix", "settings", "quiet"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.denofmt": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "denofmt hook", "loc": ["git-hooks", "hooks", "denofmt"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.denofmt.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "denofmt", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.denofmt.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to the configuration JSON file", "loc": ["git-hooks", "hooks", "denofmt", "settings", "configPath"], "readOnly": false, "type": "string"}, "git-hooks.hooks.denofmt.settings.write": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to edit files inplace.", "loc": ["git-hooks", "hooks", "denofmt", "settings", "write"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.denolint": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "denolint hook", "loc": ["git-hooks", "hooks", "denolint"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.denolint.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "denolint", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.denolint.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to the configuration JSON file", "loc": ["git-hooks", "hooks", "denolint", "settings", "configPath"], "readOnly": false, "type": "string"}, "git-hooks.hooks.denolint.settings.format": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"default\""}, "description": "Output format.", "loc": ["git-hooks", "hooks", "denolint", "settings", "format"], "readOnly": false, "type": "one of \"default\", \"compact\", \"json\""}, "git-hooks.hooks.dune-fmt": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "dune-fmt hook", "loc": ["git-hooks", "hooks", "dune-fmt"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.dune-fmt.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "dune-fmt", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.dune-fmt.settings.auto-promote": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to auto-promote the changes.", "loc": ["git-hooks", "hooks", "dune-fmt", "settings", "auto-promote"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.dune-fmt.settings.extraRuntimeInputs": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Extra runtimeInputs to add to the environment, eg. `ocamlformat`.", "loc": ["git-hooks", "hooks", "dune-fmt", "settings", "extraRuntimeInputs"], "readOnly": false, "type": "list of package"}, "git-hooks.hooks.eclint": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "eclint hook", "loc": ["git-hooks", "hooks", "eclint"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.eclint.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "eclint", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.eclint.settings.color": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"auto\""}, "description": "When to generate colored output.", "loc": ["git-hooks", "hooks", "eclint", "settings", "color"], "readOnly": false, "type": "one of \"auto\", \"always\", \"never\""}, "git-hooks.hooks.eclint.settings.exclude": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Filter to exclude files.", "loc": ["git-hooks", "hooks", "eclint", "settings", "exclude"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.eclint.settings.fix": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Modify files in place rather than showing the errors.", "loc": ["git-hooks", "hooks", "eclint", "settings", "fix"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.eclint.settings.summary": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Only show number of errors per file.", "loc": ["git-hooks", "hooks", "eclint", "settings", "summary"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.eclint.settings.verbosity": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "0"}, "description": "Log level verbosity", "loc": ["git-hooks", "hooks", "eclint", "settings", "verbosity"], "readOnly": false, "type": "one of 0, 1, 2, 3, 4"}, "git-hooks.hooks.eslint": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "eslint hook", "loc": ["git-hooks", "hooks", "eslint"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.eslint.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "eslint", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.eslint.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"${tools.eslint}/bin/eslint\"\n"}, "description": "`eslint` binary path.\nFor example, if you want to use the `eslint` binary from `node_modules`, use `\"./node_modules/.bin/eslint\"`.\nUse a string instead of a path to avoid having to Git track the file in projects that use Nix flakes.\n", "example": {"_type": "literalExpression", "text": "\"./node_modules/.bin/eslint\"\n"}, "loc": ["git-hooks", "hooks", "eslint", "settings", "binPath"], "readOnly": false, "type": "null or string or absolute path"}, "git-hooks.hooks.eslint.settings.extensions": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\\\\.js$\""}, "description": "The pattern of files to run on, see [https://pre-commit.com/#hooks-files](https://pre-commit.com/#hooks-files).", "loc": ["git-hooks", "hooks", "eslint", "settings", "extensions"], "readOnly": false, "type": "string"}, "git-hooks.hooks.flake8": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "flake8 hook", "loc": ["git-hooks", "hooks", "flake8"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.flake8.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "flake8", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.flake8.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"${tools.flake8}/bin/flake8\"\n"}, "description": "flake8 binary path. Should be used to specify flake8 binary from your Python environment.", "loc": ["git-hooks", "hooks", "flake8", "settings", "binPath"], "readOnly": false, "type": "null or string"}, "git-hooks.hooks.flake8.settings.extendIgnore": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of additional ignore codes", "example": {"_type": "literalExpression", "text": "[\n \"E501\"\n]"}, "loc": ["git-hooks", "hooks", "flake8", "settings", "extendIgnore"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.flake8.settings.format": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"default\""}, "description": "Output format.", "loc": ["git-hooks", "hooks", "flake8", "settings", "format"], "readOnly": false, "type": "string"}, "git-hooks.hooks.flynt": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "flynt hook", "loc": ["git-hooks", "hooks", "flynt"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.flynt.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "flynt", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.flynt.settings.aggressive": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Include conversions with potentially changed behavior.", "loc": ["git-hooks", "hooks", "flynt", "settings", "aggressive"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.flynt.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "flynt binary path. Can be used to specify the flynt binary from an existing Python environment.", "loc": ["git-hooks", "hooks", "flynt", "settings", "binPath"], "readOnly": false, "type": "null or string"}, "git-hooks.hooks.flynt.settings.dry-run": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Do not change files in-place and print diff instead.", "loc": ["git-hooks", "hooks", "flynt", "settings", "dry-run"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.flynt.settings.exclude": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Ignore files with given strings in their absolute path.", "loc": ["git-hooks", "hooks", "flynt", "settings", "exclude"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.flynt.settings.fail-on-change": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Fail when diff is not empty (for linting purposes).", "loc": ["git-hooks", "hooks", "flynt", "settings", "fail-on-change"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.flynt.settings.line-length": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Convert expressions spanning multiple lines, only if the resulting single line will fit into this line length limit.", "loc": ["git-hooks", "hooks", "flynt", "settings", "line-length"], "readOnly": false, "type": "null or signed integer"}, "git-hooks.hooks.flynt.settings.no-multiline": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Convert only single line expressions.", "loc": ["git-hooks", "hooks", "flynt", "settings", "no-multiline"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.flynt.settings.quiet": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Run without output.", "loc": ["git-hooks", "hooks", "flynt", "settings", "quiet"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.flynt.settings.string": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Interpret the input as a Python code snippet and print the converted version.", "loc": ["git-hooks", "hooks", "flynt", "settings", "string"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.flynt.settings.transform-concats": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Replace string concatenations with f-strings.", "loc": ["git-hooks", "hooks", "flynt", "settings", "transform-concats"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.flynt.settings.verbose": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Run with verbose output.", "loc": ["git-hooks", "hooks", "flynt", "settings", "verbose"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.fourmolu": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "fourmolu hook", "loc": ["git-hooks", "hooks", "fourmolu"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.fourmolu.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "fourmolu", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.fourmolu.settings.defaultExtensions": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Haskell language extensions to enable.", "loc": ["git-hooks", "hooks", "fourmolu", "settings", "defaultExtensions"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.golines": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "golines hook", "loc": ["git-hooks", "hooks", "golines"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.golines.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "golines", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.golines.settings.flags": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Flags passed to golines. See all available [here](https://github.com/segmentio/golines?tab=readme-ov-file#options)", "example": {"_type": "literalExpression", "text": "\"-m 120\""}, "loc": ["git-hooks", "hooks", "golines", "settings", "flags"], "readOnly": false, "type": "string"}, "git-hooks.hooks.gotest": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "gotest hook", "loc": ["git-hooks", "hooks", "gotest"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.gotest.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "gotest", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.gotest.settings.flags": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Flags passed to gotest. See all available [here](https://pkg.go.dev/cmd/go#hdr-Test_packages).", "example": {"_type": "literalExpression", "text": "\"-tags integration\""}, "loc": ["git-hooks", "hooks", "gotest", "settings", "flags"], "readOnly": false, "type": "string"}, "git-hooks.hooks.headache": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "headache hook", "loc": ["git-hooks", "hooks", "headache"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.headache.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "headache", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.headache.settings.header-file": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\".header\""}, "description": "Path to the header file.", "loc": ["git-hooks", "hooks", "headache", "settings", "header-file"], "readOnly": false, "type": "string"}, "git-hooks.hooks.hledger-fmt": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "hledger-fmt hook", "loc": ["git-hooks", "hooks", "hledger-fmt"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.hledger-fmt.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "hledger-fmt", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.hledger-fmt.settings.fix": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Fix the files in place.", "loc": ["git-hooks", "hooks", "hledger-fmt", "settings", "fix"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.hlint": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "hlint hook", "loc": ["git-hooks", "hooks", "hlint"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.hlint.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "hlint", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.hlint.settings.hintFile": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Path to hlint.yaml. By default, hlint searches for .hlint.yaml in the project root.", "loc": ["git-hooks", "hooks", "hlint", "settings", "hintFile"], "readOnly": false, "type": "null or string or absolute path"}, "git-hooks.hooks.hpack": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "hpack hook", "loc": ["git-hooks", "hooks", "hpack"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.hpack.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "hpack", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.hpack.settings.silent": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether generation should be silent.", "loc": ["git-hooks", "hooks", "hpack", "settings", "silent"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.isort": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "isort hook", "loc": ["git-hooks", "hooks", "isort"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.isort.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "isort", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.isort.settings.flags": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Flags passed to isort. See all available [here](https://pycqa.github.io/isort/docs/configuration/options.html).", "loc": ["git-hooks", "hooks", "isort", "settings", "flags"], "readOnly": false, "type": "string"}, "git-hooks.hooks.isort.settings.profile": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Built-in profiles to allow easy interoperability with common projects and code styles.", "loc": ["git-hooks", "hooks", "isort", "settings", "profile"], "readOnly": false, "type": "one of \"\", \"black\", \"django\", \"pycharm\", \"google\", \"open_stack\", \"plone\", \"attrs\", \"hug\", \"wemake\", \"appnexus\""}, "git-hooks.hooks.lacheck": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "lacheck hook", "loc": ["git-hooks", "hooks", "lacheck"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.lacheck.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "lacheck", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.latexindent": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "latexindent hook", "loc": ["git-hooks", "hooks", "latexindent"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.latexindent.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "latexindent", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.latexindent.settings.flags": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"--local --silent --overwriteIfDifferent\""}, "description": "Flags passed to latexindent. See available flags [here](https://latexindentpl.readthedocs.io/en/latest/sec-how-to-use.html#from-the-command-line)", "loc": ["git-hooks", "hooks", "latexindent", "settings", "flags"], "readOnly": false, "type": "string"}, "git-hooks.hooks.lua-ls": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "lua-ls hook", "loc": ["git-hooks", "hooks", "lua-ls"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.lua-ls.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "lua-ls", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.lua-ls.settings.checklevel": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"Warning\""}, "description": "The diagnostic check level", "loc": ["git-hooks", "hooks", "lua-ls", "settings", "checklevel"], "readOnly": false, "type": "one of \"Error\", \"Warning\", \"Information\", \"Hint\""}, "git-hooks.hooks.lua-ls.settings.configuration": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "See https://github.com/LuaLS/lua-language-server/wiki/Configuration-File#luarcjson", "loc": ["git-hooks", "hooks", "lua-ls", "settings", "configuration"], "readOnly": false, "type": "attribute set"}, "git-hooks.hooks.lychee": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "lychee hook", "loc": ["git-hooks", "hooks", "lychee"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.lychee.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "lychee", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.lychee.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to the config file.", "loc": ["git-hooks", "hooks", "lychee", "settings", "configPath"], "readOnly": false, "type": "string"}, "git-hooks.hooks.lychee.settings.flags": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Flags passed to lychee. See all available [here](https://lychee.cli.rs/#/usage/cli).", "loc": ["git-hooks", "hooks", "lychee", "settings", "flags"], "readOnly": false, "type": "string"}, "git-hooks.hooks.markdownlint": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "markdownlint hook", "loc": ["git-hooks", "hooks", "markdownlint"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.markdownlint.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "markdownlint", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.markdownlint.settings.configuration": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "See https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.jsonc", "loc": ["git-hooks", "hooks", "markdownlint", "settings", "configuration"], "readOnly": false, "type": "attribute set"}, "git-hooks.hooks.mdl": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "mdl hook", "loc": ["git-hooks", "hooks", "mdl"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.mdl.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "mdl", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.mdl.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "The configuration file to use.", "loc": ["git-hooks", "hooks", "mdl", "settings", "configPath"], "readOnly": false, "type": "string"}, "git-hooks.hooks.mdl.settings.git-recurse": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Only process files known to git when given a directory.", "loc": ["git-hooks", "hooks", "mdl", "settings", "git-recurse"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.mdl.settings.ignore-front-matter": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Ignore YAML front matter.", "loc": ["git-hooks", "hooks", "mdl", "settings", "ignore-front-matter"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.mdl.settings.json": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Format output as JSON.", "loc": ["git-hooks", "hooks", "mdl", "settings", "json"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.mdl.settings.rules": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Markdown rules to use for linting. Per default all rules are processed.", "loc": ["git-hooks", "hooks", "mdl", "settings", "rules"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.mdl.settings.rulesets": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Specify additional ruleset files to load.", "loc": ["git-hooks", "hooks", "mdl", "settings", "rulesets"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.mdl.settings.show-aliases": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Show rule alias instead of rule ID when viewing rules.", "loc": ["git-hooks", "hooks", "mdl", "settings", "show-aliases"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.mdl.settings.skip-default-ruleset": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Do not load the default markdownlint ruleset. Use this option if you only want to load custom rulesets.", "loc": ["git-hooks", "hooks", "mdl", "settings", "skip-default-ruleset"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.mdl.settings.style": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"default\""}, "description": "Select which style mdl uses.", "loc": ["git-hooks", "hooks", "mdl", "settings", "style"], "readOnly": false, "type": "string"}, "git-hooks.hooks.mdl.settings.tags": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Markdown rules to use for linting containing the given tags. Per default all rules are processed.", "loc": ["git-hooks", "hooks", "mdl", "settings", "tags"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.mdl.settings.verbose": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Increase verbosity.", "loc": ["git-hooks", "hooks", "mdl", "settings", "verbose"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.mdl.settings.warnings": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Show Kramdown warnings.", "loc": ["git-hooks", "hooks", "mdl", "settings", "warnings"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.mkdocs-linkcheck": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "mkdocs-linkcheck hook", "loc": ["git-hooks", "hooks", "mkdocs-linkcheck"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.mkdocs-linkcheck.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "mkdocs-linkcheck", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.mkdocs-linkcheck.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"${tools.mkdocs-linkcheck}/bin/mkdocs-linkcheck\"\n"}, "description": "mkdocs-linkcheck binary path. Should be used to specify the mkdocs-linkcheck binary from your Python environment.", "loc": ["git-hooks", "hooks", "mkdocs-linkcheck", "settings", "binPath"], "readOnly": false, "type": "null or string or absolute path"}, "git-hooks.hooks.mkdocs-linkcheck.settings.extension": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "File extension to scan for.", "loc": ["git-hooks", "hooks", "mkdocs-linkcheck", "settings", "extension"], "readOnly": false, "type": "string"}, "git-hooks.hooks.mkdocs-linkcheck.settings.local-only": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to only check local links.", "loc": ["git-hooks", "hooks", "mkdocs-linkcheck", "settings", "local-only"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.mkdocs-linkcheck.settings.method": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"get\""}, "description": "HTTP method to use when checking external links.", "loc": ["git-hooks", "hooks", "mkdocs-linkcheck", "settings", "method"], "readOnly": false, "type": "one of \"get\", \"head\""}, "git-hooks.hooks.mkdocs-linkcheck.settings.path": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to check", "loc": ["git-hooks", "hooks", "mkdocs-linkcheck", "settings", "path"], "readOnly": false, "type": "string"}, "git-hooks.hooks.mkdocs-linkcheck.settings.recurse": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to recurse directories under path.", "loc": ["git-hooks", "hooks", "mkdocs-linkcheck", "settings", "recurse"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.mypy": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "mypy hook", "loc": ["git-hooks", "hooks", "mypy"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.mypy.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "mypy", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.mypy.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"${tools.mypy}/bin/mypy\"\n"}, "description": "Mypy binary path. Should be used to specify the mypy executable in an environment containing your typing stubs.", "loc": ["git-hooks", "hooks", "mypy", "settings", "binPath"], "readOnly": false, "type": "null or string"}, "git-hooks.hooks.nbstripout": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "nbstripout hook", "loc": ["git-hooks", "hooks", "nbstripout"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.nbstripout.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "nbstripout", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.nil": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "nil hook", "loc": ["git-hooks", "hooks", "nil"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.nil.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "nil", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.nil.settings.denyWarnings": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Treat warnings like errors and exit with non-zero code", "loc": ["git-hooks", "hooks", "nil", "settings", "denyWarnings"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.nixf-diagnose": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "nixf-diagnose hook", "loc": ["git-hooks", "hooks", "nixf-diagnose"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.nixf-diagnose.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "nixf-diagnose", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.nixfmt": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "nixfmt hook", "loc": ["git-hooks", "hooks", "nixfmt"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.nixfmt-classic": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "nixfmt (classic) hook", "loc": ["git-hooks", "hooks", "nixfmt-classic"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.nixfmt-classic.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "nixfmt-classic", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.nixfmt-classic.settings.width": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Line width.", "loc": ["git-hooks", "hooks", "nixfmt-classic", "settings", "width"], "readOnly": false, "type": "null or signed integer"}, "git-hooks.hooks.nixfmt-rfc-style": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "nixfmt (RFC 166 style) hook", "loc": ["git-hooks", "hooks", "nixfmt-rfc-style"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.nixfmt-rfc-style.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "nixfmt-rfc-style", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.nixfmt-rfc-style.settings.indent": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Number of spaces to use for indentation.", "loc": ["git-hooks", "hooks", "nixfmt-rfc-style", "settings", "indent"], "readOnly": false, "type": "null or signed integer"}, "git-hooks.hooks.nixfmt-rfc-style.settings.width": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Maximum width in characters.", "loc": ["git-hooks", "hooks", "nixfmt-rfc-style", "settings", "width"], "readOnly": false, "type": "null or signed integer"}, "git-hooks.hooks.nixfmt.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "nixfmt", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.nixfmt.settings.indent": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Number of spaces to use for indentation.", "loc": ["git-hooks", "hooks", "nixfmt", "settings", "indent"], "readOnly": false, "type": "null or signed integer"}, "git-hooks.hooks.nixfmt.settings.width": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Maximum width in characters.", "loc": ["git-hooks", "hooks", "nixfmt", "settings", "width"], "readOnly": false, "type": "null or signed integer"}, "git-hooks.hooks.no-commit-to-branch": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "no-commit-to-branch-hook", "loc": ["git-hooks", "hooks", "no-commit-to-branch"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.no-commit-to-branch.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "no-commit-to-branch", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.no-commit-to-branch.settings.branch": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"main\"\n]"}, "description": "Branches to disallow commits to.", "example": {"_type": "literalExpression", "text": "[\n \"main\"\n \"master\"\n]"}, "loc": ["git-hooks", "hooks", "no-commit-to-branch", "settings", "branch"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.no-commit-to-branch.settings.pattern": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "RegEx patterns for branch names to disallow commits to.", "example": {"_type": "literalExpression", "text": "[\n \"ma.*\"\n]"}, "loc": ["git-hooks", "hooks", "no-commit-to-branch", "settings", "pattern"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.ormolu": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "ormolu hook", "loc": ["git-hooks", "hooks", "ormolu"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.ormolu.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "ormolu", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.ormolu.settings.cabalDefaultExtensions": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Use `default-extensions` from `.cabal` files.", "loc": ["git-hooks", "hooks", "ormolu", "settings", "cabalDefaultExtensions"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.ormolu.settings.defaultExtensions": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Haskell language extensions to enable.", "loc": ["git-hooks", "hooks", "ormolu", "settings", "defaultExtensions"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.php-cs-fixer": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "php-cs-fixer hook", "loc": ["git-hooks", "hooks", "php-cs-fixer"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.php-cs-fixer.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "php-cs-fixer", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.php-cs-fixer.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"${tools.php-cs-fixer}/bin/php-cs-fixer\"\n"}, "description": "PHP-CS-Fixer binary path.", "loc": ["git-hooks", "hooks", "php-cs-fixer", "settings", "binPath"], "readOnly": false, "type": "null or string"}, "git-hooks.hooks.phpcbf": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "phpcbf hook", "loc": ["git-hooks", "hooks", "phpcbf"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.phpcbf.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "phpcbf", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.phpcbf.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"${tools.phpcbf}/bin/phpcbf\"\n"}, "description": "PHP_CodeSniffer binary path.", "loc": ["git-hooks", "hooks", "phpcbf", "settings", "binPath"], "readOnly": false, "type": "null or string"}, "git-hooks.hooks.phpcs": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "phpcs hook", "loc": ["git-hooks", "hooks", "phpcs"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.phpcs.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "phpcs", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.phpcs.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"${tools.phpcs}/bin/phpcs\"\n"}, "description": "PHP_CodeSniffer binary path.", "loc": ["git-hooks", "hooks", "phpcs", "settings", "binPath"], "readOnly": false, "type": "null or string"}, "git-hooks.hooks.phpstan": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "phpstan hook", "loc": ["git-hooks", "hooks", "phpstan"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.phpstan.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "phpstan", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.phpstan.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"${tools.phpstan}/bin/phpstan\"\n"}, "description": "PHPStan binary path.", "loc": ["git-hooks", "hooks", "phpstan", "settings", "binPath"], "readOnly": false, "type": "null or string"}, "git-hooks.hooks.prettier": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "prettier hook", "loc": ["git-hooks", "hooks", "prettier"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.prettier.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "prettier", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.allow-parens": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"always\""}, "description": "Include parentheses around a sole arrow function parameter.", "loc": ["git-hooks", "hooks", "prettier", "settings", "allow-parens"], "readOnly": false, "type": "one of \"always\", \"avoid\""}, "git-hooks.hooks.prettier.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"${tools.prettier}/bin/prettier\"\n"}, "description": "`prettier` binary path.\nFor example, if you want to use the `prettier` binary from `node_modules`, use `\"./node_modules/.bin/prettier\"`.\nUse a string instead of a path to avoid having to Git track the file in projects that use Nix flakes.\n", "example": {"_type": "literalExpression", "text": "\"./node_modules/.bin/prettier\"\n"}, "loc": ["git-hooks", "hooks", "prettier", "settings", "binPath"], "readOnly": false, "type": "null or string or absolute path"}, "git-hooks.hooks.prettier.settings.bracket-same-line": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Put > of opening tags on the last line instead of on a new line.", "loc": ["git-hooks", "hooks", "prettier", "settings", "bracket-same-line"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.cache": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Only format changed files.", "loc": ["git-hooks", "hooks", "prettier", "settings", "cache"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.cache-location": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"./node_modules/.cache/prettier/.prettier-cache\""}, "description": "Path to the cache file location used by `--cache` flag.", "loc": ["git-hooks", "hooks", "prettier", "settings", "cache-location"], "readOnly": false, "type": "string"}, "git-hooks.hooks.prettier.settings.cache-strategy": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Strategy for the cache to use for detecting changed files.", "loc": ["git-hooks", "hooks", "prettier", "settings", "cache-strategy"], "readOnly": false, "type": "null or one of \"metadata\", \"content\""}, "git-hooks.hooks.prettier.settings.check": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Output a human-friendly message and a list of unformatted files, if any.", "loc": ["git-hooks", "hooks", "prettier", "settings", "check"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.color": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Colorize error messages.", "loc": ["git-hooks", "hooks", "prettier", "settings", "color"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.config-precedence": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"cli-override\""}, "description": "Defines how config file should be evaluated in combination of CLI options.", "loc": ["git-hooks", "hooks", "prettier", "settings", "config-precedence"], "readOnly": false, "type": "one of \"cli-override\", \"file-override\", \"prefer-file\""}, "git-hooks.hooks.prettier.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to a Prettier configuration file (.prettierrc, package.json, prettier.config.js).", "loc": ["git-hooks", "hooks", "prettier", "settings", "configPath"], "readOnly": false, "type": "string"}, "git-hooks.hooks.prettier.settings.embedded-language-formatting": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"auto\""}, "description": "Control how Prettier formats quoted code embedded in the file.", "loc": ["git-hooks", "hooks", "prettier", "settings", "embedded-language-formatting"], "readOnly": false, "type": "one of \"auto\", \"off\""}, "git-hooks.hooks.prettier.settings.end-of-line": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"lf\""}, "description": "Which end of line characters to apply.", "loc": ["git-hooks", "hooks", "prettier", "settings", "end-of-line"], "readOnly": false, "type": "one of \"lf\", \"crlf\", \"cr\", \"auto\""}, "git-hooks.hooks.prettier.settings.html-whitespace-sensitivity": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"css\""}, "description": "How to handle whitespaces in HTML.", "loc": ["git-hooks", "hooks", "prettier", "settings", "html-whitespace-sensitivity"], "readOnly": false, "type": "one of \"css\", \"strict\", \"ignore\""}, "git-hooks.hooks.prettier.settings.ignore-path": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Path to a file containing patterns that describe files to ignore.\n By default, prettier looks for `./.gitignore` and `./.prettierignore`.\n Multiple values are accepted.", "loc": ["git-hooks", "hooks", "prettier", "settings", "ignore-path"], "readOnly": false, "type": "list of (string or absolute path)"}, "git-hooks.hooks.prettier.settings.ignore-unknown": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Ignore unknown files.", "loc": ["git-hooks", "hooks", "prettier", "settings", "ignore-unknown"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.insert-pragma": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Insert @format pragma into file's first docblock comment.", "loc": ["git-hooks", "hooks", "prettier", "settings", "insert-pragma"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.jsx-single-quote": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Use single quotes in JSX.", "loc": ["git-hooks", "hooks", "prettier", "settings", "jsx-single-quote"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.list-different": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Print the filenames of files that are different from Prettier formatting.", "loc": ["git-hooks", "hooks", "prettier", "settings", "list-different"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.log-level": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"log\""}, "description": "What level of logs to report.", "example": {"_type": "literalExpression", "text": "\"debug\""}, "loc": ["git-hooks", "hooks", "prettier", "settings", "log-level"], "readOnly": false, "type": "one of \"silent\", \"error\", \"warn\", \"log\", \"debug\""}, "git-hooks.hooks.prettier.settings.no-bracket-spacing": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Do not print spaces between brackets.", "loc": ["git-hooks", "hooks", "prettier", "settings", "no-bracket-spacing"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.no-config": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Do not look for a configuration file.", "loc": ["git-hooks", "hooks", "prettier", "settings", "no-config"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.no-editorconfig": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Don't take .editorconfig into account when parsing configuration.", "loc": ["git-hooks", "hooks", "prettier", "settings", "no-editorconfig"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.no-error-on-unmatched-pattern": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Prevent errors when pattern is unmatched.", "loc": ["git-hooks", "hooks", "prettier", "settings", "no-error-on-unmatched-pattern"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.no-semi": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Do not print semicolons, except at the beginning of lines which may need them.", "loc": ["git-hooks", "hooks", "prettier", "settings", "no-semi"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.parser": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Which parser to use.", "loc": ["git-hooks", "hooks", "prettier", "settings", "parser"], "readOnly": false, "type": "one of \"\", \"flow\", \"babel\", \"babel-flow\", \"babel-ts\", \"typescript\", \"acorn\", \"espree\", \"meriyah\", \"css\", \"less\", \"scss\", \"json\", \"json5\", \"json-stringify\", \"graphql\", \"markdown\", \"mdx\", \"vue\", \"yaml\", \"glimmer\", \"html\", \"angular\", \"lwc\""}, "git-hooks.hooks.prettier.settings.plugins": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Add plugins from paths.", "loc": ["git-hooks", "hooks", "prettier", "settings", "plugins"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.prettier.settings.print-width": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "80"}, "description": "Line length that the printer will wrap on.", "loc": ["git-hooks", "hooks", "prettier", "settings", "print-width"], "readOnly": false, "type": "signed integer"}, "git-hooks.hooks.prettier.settings.prose-wrap": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"preserve\""}, "description": "When to or if at all hard wrap prose to print width.", "loc": ["git-hooks", "hooks", "prettier", "settings", "prose-wrap"], "readOnly": false, "type": "one of \"always\", \"never\", \"preserve\""}, "git-hooks.hooks.prettier.settings.quote-props": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"as-needed\""}, "description": "Change when properties in objects are quoted.", "loc": ["git-hooks", "hooks", "prettier", "settings", "quote-props"], "readOnly": false, "type": "one of \"as-needed\", \"consistent\", \"preserve\""}, "git-hooks.hooks.prettier.settings.require-pragma": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Require either '@prettier' or '@format' to be present in the file's first docblock comment.", "loc": ["git-hooks", "hooks", "prettier", "settings", "require-pragma"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.single-attribute-per-line": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Enforce single attribute per line in HTML, Vue andJSX.", "loc": ["git-hooks", "hooks", "prettier", "settings", "single-attribute-per-line"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.single-quote": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Number of spaces per indentation-level.", "loc": ["git-hooks", "hooks", "prettier", "settings", "single-quote"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.tab-width": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "2"}, "description": "Line length that the printer will wrap on.", "loc": ["git-hooks", "hooks", "prettier", "settings", "tab-width"], "readOnly": false, "type": "signed integer"}, "git-hooks.hooks.prettier.settings.trailing-comma": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"all\""}, "description": "Print trailing commas wherever possible in multi-line comma-separated syntactic structures.", "loc": ["git-hooks", "hooks", "prettier", "settings", "trailing-comma"], "readOnly": false, "type": "one of \"all\", \"es5\", \"none\""}, "git-hooks.hooks.prettier.settings.use-tabs": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Indent with tabs instead of spaces.", "loc": ["git-hooks", "hooks", "prettier", "settings", "use-tabs"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.vue-indent-script-and-style": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Indent script and style tags in Vue files.", "loc": ["git-hooks", "hooks", "prettier", "settings", "vue-indent-script-and-style"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.with-node-modules": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Process files inside 'node_modules' directory.", "loc": ["git-hooks", "hooks", "prettier", "settings", "with-node-modules"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.prettier.settings.write": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Edit files in-place.", "loc": ["git-hooks", "hooks", "prettier", "settings", "write"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.pretty-format-json": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "pretty-format-json hook", "loc": ["git-hooks", "hooks", "pretty-format-json"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.pretty-format-json.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "pretty-format-json", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.pretty-format-json.settings.autofix": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Automatically format JSON files.", "loc": ["git-hooks", "hooks", "pretty-format-json", "settings", "autofix"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.pretty-format-json.settings.indent": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Control the indentation (either a number for a number of spaces or a string of whitespace). Defaults to 2 spaces.", "loc": ["git-hooks", "hooks", "pretty-format-json", "settings", "indent"], "readOnly": false, "type": "null or signed integer or string"}, "git-hooks.hooks.pretty-format-json.settings.no-ensure-ascii": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Preserve unicode characters instead of converting to escape sequences.", "loc": ["git-hooks", "hooks", "pretty-format-json", "settings", "no-ensure-ascii"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.pretty-format-json.settings.no-sort-keys": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "When autofixing, retain the original key ordering (instead of sorting the keys).", "loc": ["git-hooks", "hooks", "pretty-format-json", "settings", "no-sort-keys"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.pretty-format-json.settings.top-keys": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Keys to keep at the top of mappings.", "loc": ["git-hooks", "hooks", "pretty-format-json", "settings", "top-keys"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.proselint": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "proselint hook", "loc": ["git-hooks", "hooks", "proselint"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.proselint.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "proselint", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.proselint.settings.config": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Multiline-string configuration passed as config file.", "example": {"_type": "literalExpression", "text": "''\n {\n \"checks\": {\n \"typography.diacritical_marks\": false\n }\n }\n''"}, "loc": ["git-hooks", "hooks", "proselint", "settings", "config"], "readOnly": false, "type": "string"}, "git-hooks.hooks.proselint.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to the config file.", "loc": ["git-hooks", "hooks", "proselint", "settings", "configPath"], "readOnly": false, "type": "string"}, "git-hooks.hooks.proselint.settings.flags": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Flags passed to proselint.", "loc": ["git-hooks", "hooks", "proselint", "settings", "flags"], "readOnly": false, "type": "string"}, "git-hooks.hooks.psalm": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "psalm hook", "loc": ["git-hooks", "hooks", "psalm"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.psalm.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "psalm", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.psalm.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"${tools.psalm}/bin/psalm\"\n"}, "description": "Psalm binary path.", "loc": ["git-hooks", "hooks", "psalm", "settings", "binPath"], "readOnly": false, "type": "null or string"}, "git-hooks.hooks.pylint": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "pylint hook", "loc": ["git-hooks", "hooks", "pylint"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.pylint.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "pylint", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.pylint.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"${tools.pylint}/bin/pylint\"\n"}, "description": "Pylint binary path. Should be used to specify Pylint binary from your Python environment.", "loc": ["git-hooks", "hooks", "pylint", "settings", "binPath"], "readOnly": false, "type": "null or string"}, "git-hooks.hooks.pylint.settings.reports": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to display a full report.", "loc": ["git-hooks", "hooks", "pylint", "settings", "reports"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.pylint.settings.score": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to activate the evaluation score.", "loc": ["git-hooks", "hooks", "pylint", "settings", "score"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.pyright": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "pyright hook", "loc": ["git-hooks", "hooks", "pyright"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.pyright.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "pyright", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.pyright.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"${tools.pyright}/bin/pyright\"\n"}, "description": "Pyright binary path. Should be used to specify the pyright executable in an environment containing your typing stubs.", "loc": ["git-hooks", "hooks", "pyright", "settings", "binPath"], "readOnly": false, "type": "null or string"}, "git-hooks.hooks.pyupgrade": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "pyupgrade hook", "loc": ["git-hooks", "hooks", "pyupgrade"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.pyupgrade.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "pyupgrade", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.pyupgrade.settings.binPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"${tools.pyupgrade}/bin/pyupgrade\"\n"}, "description": "pyupgrade binary path. Should be used to specify the pyupgrade binary from your Python environment.", "loc": ["git-hooks", "hooks", "pyupgrade", "settings", "binPath"], "readOnly": false, "type": "null or string"}, "git-hooks.hooks.regal": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "regal hook", "loc": ["git-hooks", "hooks", "regal"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.regal.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "regal", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.regal.settings.flags": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Flags passed to regal. For available options run 'regal lint --help'", "example": {"_type": "literalExpression", "text": "\"--disable-category style\""}, "loc": ["git-hooks", "hooks", "regal", "settings", "flags"], "readOnly": false, "type": "string"}, "git-hooks.hooks.reuse": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "reuse hook", "loc": ["git-hooks", "hooks", "reuse"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.reuse.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "reuse", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.reuse.settings.flags": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Flags passed to reuse. For available options run 'reuse lint --help'", "example": {"_type": "literalExpression", "text": "\"--json\""}, "loc": ["git-hooks", "hooks", "reuse", "settings", "flags"], "readOnly": false, "type": "string"}, "git-hooks.hooks.revive": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "revive hook", "loc": ["git-hooks", "hooks", "revive"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.revive.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "revive", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.revive.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to the configuration TOML file.", "loc": ["git-hooks", "hooks", "revive", "settings", "configPath"], "readOnly": false, "type": "string"}, "git-hooks.hooks.ripsecrets": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "ripsecrets hook", "loc": ["git-hooks", "hooks", "ripsecrets"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.ripsecrets.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "ripsecrets", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.ripsecrets.settings.additionalPatterns": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Additional regex patterns used to find secrets. If there is a matching group in the regex the matched group will be tested for randomness before being reported as a secret.", "loc": ["git-hooks", "hooks", "ripsecrets", "settings", "additionalPatterns"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.rumdl": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "rumdl hook", "loc": ["git-hooks", "hooks", "rumdl"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.rumdl.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "rumdl", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.rumdl.settings.configuration": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "See https://github.com/rvben/rumdl?tab=readme-ov-file#configuration", "example": {"_type": "literalExpression", "text": "{\n configuration = {\n MD013 = {\n line-length = 100;\n };\n };\n}"}, "loc": ["git-hooks", "hooks", "rumdl", "settings", "configuration"], "readOnly": false, "type": "attribute set"}, "git-hooks.hooks.rustfmt": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "Additional rustfmt settings\n\nOverride the `rustfmt` and `cargo` packages by setting `hooks.rustfmt.packageOverrides`.\n\n```\nhooks.rustfmt.packageOverrides.cargo = pkgs.cargo;\nhooks.rustfmt.packageOverrides.rustfmt = pkgs.rustfmt;\n```\n", "loc": ["git-hooks", "hooks", "rustfmt"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.rustfmt.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "rustfmt", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.rustfmt.packageOverrides.cargo": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "The cargo package to use.", "loc": ["git-hooks", "hooks", "rustfmt", "packageOverrides", "cargo"], "readOnly": false, "type": "package"}, "git-hooks.hooks.rustfmt.packageOverrides.rustfmt": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "The rustfmt package to use.", "loc": ["git-hooks", "hooks", "rustfmt", "packageOverrides", "rustfmt"], "readOnly": false, "type": "package"}, "git-hooks.hooks.rustfmt.settings.all": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Format all packages, and also their local path-based dependencies", "loc": ["git-hooks", "hooks", "rustfmt", "settings", "all"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.rustfmt.settings.check": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Run rustfmt in check mode", "loc": ["git-hooks", "hooks", "rustfmt", "settings", "check"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.rustfmt.settings.color": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"always\""}, "description": "Coloring the output", "loc": ["git-hooks", "hooks", "rustfmt", "settings", "color"], "readOnly": false, "type": "one of \"auto\", \"always\", \"never\""}, "git-hooks.hooks.rustfmt.settings.config": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Override configuration values", "loc": ["git-hooks", "hooks", "rustfmt", "settings", "config"], "readOnly": false, "type": "attribute set"}, "git-hooks.hooks.rustfmt.settings.config-path": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Path to rustfmt.toml config file", "loc": ["git-hooks", "hooks", "rustfmt", "settings", "config-path"], "readOnly": false, "type": "null or string"}, "git-hooks.hooks.rustfmt.settings.emit": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "What data to emit and how", "loc": ["git-hooks", "hooks", "rustfmt", "settings", "emit"], "readOnly": false, "type": "null or one of \"files\", \"stdout\""}, "git-hooks.hooks.rustfmt.settings.files-with-diff": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "", "loc": ["git-hooks", "hooks", "rustfmt", "settings", "files-with-diff"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.rustfmt.settings.manifest-path": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Path to Cargo.toml", "loc": ["git-hooks", "hooks", "rustfmt", "settings", "manifest-path"], "readOnly": false, "type": "null or string"}, "git-hooks.hooks.rustfmt.settings.message-format": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The output format of diagnostic messages", "loc": ["git-hooks", "hooks", "rustfmt", "settings", "message-format"], "readOnly": false, "type": "null or one of \"human\", \"short\""}, "git-hooks.hooks.rustfmt.settings.package": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Package(s) to check", "loc": ["git-hooks", "hooks", "rustfmt", "settings", "package"], "readOnly": false, "type": "list of string matching the pattern [][*?!0-9A-Za-z_-]+"}, "git-hooks.hooks.rustfmt.settings.verbose": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Use verbose output", "loc": ["git-hooks", "hooks", "rustfmt", "settings", "verbose"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.shfmt": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "shfmt hook", "loc": ["git-hooks", "hooks", "shfmt"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.shfmt.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "shfmt", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.shfmt.settings.binary-next-line": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Binary ops like && and | may start a line.", "loc": ["git-hooks", "hooks", "shfmt", "settings", "binary-next-line"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.shfmt.settings.case-indent": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Switch cases will be indented.", "loc": ["git-hooks", "hooks", "shfmt", "settings", "case-indent"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.shfmt.settings.func-next-line": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Function opening braces are placed on a separate line.", "loc": ["git-hooks", "hooks", "shfmt", "settings", "func-next-line"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.shfmt.settings.indent": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "0 for tabs, >0 for number of spaces.", "loc": ["git-hooks", "hooks", "shfmt", "settings", "indent"], "readOnly": false, "type": "null or signed integer or string"}, "git-hooks.hooks.shfmt.settings.keep-padding": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Keep column alignment paddings.", "loc": ["git-hooks", "hooks", "shfmt", "settings", "keep-padding"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.shfmt.settings.language-dialect": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"auto\""}, "description": "Shell language dialect.", "loc": ["git-hooks", "hooks", "shfmt", "settings", "language-dialect"], "readOnly": false, "type": "null or one of \"auto\", \"bash\", \"posix\", \"mksh\", \"bats\""}, "git-hooks.hooks.shfmt.settings.simplify": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Simplify the code.", "loc": ["git-hooks", "hooks", "shfmt", "settings", "simplify"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.shfmt.settings.space-redirects": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Redirect operators will be followed by a space.", "loc": ["git-hooks", "hooks", "shfmt", "settings", "space-redirects"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.sort-file-contents": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "sort-file-contents-hook", "loc": ["git-hooks", "hooks", "sort-file-contents"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.sort-file-contents.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "sort-file-contents", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.sort-file-contents.settings.ignore-case": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Fold lower case to upper case characters.", "loc": ["git-hooks", "hooks", "sort-file-contents", "settings", "ignore-case"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.sort-file-contents.settings.unique": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Ensure each line is unique.", "loc": ["git-hooks", "hooks", "sort-file-contents", "settings", "unique"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.statix": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "statix hook", "loc": ["git-hooks", "hooks", "statix"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.statix.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "statix", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.statix.settings.config": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Path to statix.toml or its parent directory.", "loc": ["git-hooks", "hooks", "statix", "settings", "config"], "readOnly": false, "type": "null or string"}, "git-hooks.hooks.statix.settings.format": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"errfmt\""}, "description": "Error Output format.", "loc": ["git-hooks", "hooks", "statix", "settings", "format"], "readOnly": false, "type": "one of \"stderr\", \"errfmt\", \"json\""}, "git-hooks.hooks.statix.settings.ignore": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Globs of file patterns to skip.", "example": {"_type": "literalExpression", "text": "[\n \"flake.nix\"\n \"_*\"\n]"}, "loc": ["git-hooks", "hooks", "statix", "settings", "ignore"], "readOnly": false, "type": "null or (list of string)"}, "git-hooks.hooks.statix.settings.unrestricted": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Don't respect .gitignore files.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["git-hooks", "hooks", "statix", "settings", "unrestricted"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.treefmt": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "Treefmt hook.\n\nInclude any additional formatters configured by treefmt as `hooks.treefmt.settings.formatters`.\n\n```\nhooks.treefmt.settings.formatters = [\n pkgs.nixpkgs-fmt\n pkgs.black\n];\n```\n\nOverride `treefmt` itself by setting `hooks.treefmt.packageOverrides.treefmt`.\n\n```\nhooks.treefmt.packageOverrides.treefmt = pkgs.treefmt;\n```\n", "loc": ["git-hooks", "hooks", "treefmt"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.treefmt.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "treefmt", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.treefmt.packageOverrides.treefmt": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "The treefmt package to use", "loc": ["git-hooks", "hooks", "treefmt", "packageOverrides", "treefmt"], "readOnly": false, "type": "package"}, "git-hooks.hooks.treefmt.settings.fail-on-change": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Fail if some files require re-formatting.", "loc": ["git-hooks", "hooks", "treefmt", "settings", "fail-on-change"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.treefmt.settings.formatters": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "The formatter packages configured by treefmt", "loc": ["git-hooks", "hooks", "treefmt", "settings", "formatters"], "readOnly": false, "type": "list of package"}, "git-hooks.hooks.treefmt.settings.no-cache": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Ignore the evaluation cache entirely.", "loc": ["git-hooks", "hooks", "treefmt", "settings", "no-cache"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.typos": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "typos hook", "loc": ["git-hooks", "hooks", "typos"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.typos.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "typos", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.typos.settings.binary": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to search binary files.", "loc": ["git-hooks", "hooks", "typos", "settings", "binary"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.typos.settings.color": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"auto\""}, "description": "When to use generate output.", "loc": ["git-hooks", "hooks", "typos", "settings", "color"], "readOnly": false, "type": "one of \"auto\", \"always\", \"never\""}, "git-hooks.hooks.typos.settings.config": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Configuration as in https://github.com/crate-ci/typos/blob/master/docs/reference.md.", "example": {"_type": "literalExpression", "text": "{\n default = {\n binary = false;\n };\n files = {\n ignore-dot = true;\n };\n type = {\n py = {\n extend-glob = [ ];\n };\n };\n}"}, "loc": ["git-hooks", "hooks", "typos", "settings", "config"], "readOnly": false, "type": "TOML value"}, "git-hooks.hooks.typos.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to a custom config file. Ignored if `typos.settings.config` is set.", "example": {"_type": "literalExpression", "text": "\".typos.toml\""}, "loc": ["git-hooks", "hooks", "typos", "settings", "configPath"], "readOnly": false, "type": "string"}, "git-hooks.hooks.typos.settings.diff": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Print a diff of what would change.", "loc": ["git-hooks", "hooks", "typos", "settings", "diff"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.typos.settings.exclude": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Ignore files and directories matching one of the globs.", "example": {"_type": "literalExpression", "text": "[\n \"*.nix\"\n]"}, "loc": ["git-hooks", "hooks", "typos", "settings", "exclude"], "readOnly": false, "type": "(list of string) or string convertible to it"}, "git-hooks.hooks.typos.settings.force-exclude": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Respect excluded files even for paths passed explicitly.", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["git-hooks", "hooks", "typos", "settings", "force-exclude"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.typos.settings.format": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"long\""}, "description": "Output format to use.", "loc": ["git-hooks", "hooks", "typos", "settings", "format"], "readOnly": false, "type": "one of \"silent\", \"brief\", \"long\", \"json\""}, "git-hooks.hooks.typos.settings.hidden": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Search hidden files and directories.", "loc": ["git-hooks", "hooks", "typos", "settings", "hidden"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.typos.settings.ignored-words": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Spellings and words to ignore.", "example": {"_type": "literalExpression", "text": "[\n \"MQTT\"\n \"mosquitto\"\n]"}, "loc": ["git-hooks", "hooks", "typos", "settings", "ignored-words"], "readOnly": false, "type": "list of string"}, "git-hooks.hooks.typos.settings.locale": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"en\""}, "description": "Which language to use for spell checking.", "loc": ["git-hooks", "hooks", "typos", "settings", "locale"], "readOnly": false, "type": "one of \"en\", \"en-us\", \"en-gb\", \"en-ca\", \"en-au\""}, "git-hooks.hooks.typos.settings.no-check-filenames": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Skip verifying spelling in file names.", "loc": ["git-hooks", "hooks", "typos", "settings", "no-check-filenames"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.typos.settings.no-check-files": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Skip verifying spelling in files.", "loc": ["git-hooks", "hooks", "typos", "settings", "no-check-files"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.typos.settings.no-unicode": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Only allow ASCII characters in identifiers.", "loc": ["git-hooks", "hooks", "typos", "settings", "no-unicode"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.typos.settings.quiet": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Less output per occurrence.", "loc": ["git-hooks", "hooks", "typos", "settings", "quiet"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.typos.settings.verbose": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "More output per occurrence.", "loc": ["git-hooks", "hooks", "typos", "settings", "verbose"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.typos.settings.write": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Fix spelling in files by writing them. Cannot be used with `typos.settings.diff`.", "loc": ["git-hooks", "hooks", "typos", "settings", "write"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.uv-export": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "uv export hook", "loc": ["git-hooks", "hooks", "uv-export"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.uv-export.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "uv-export", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.uv-export.settings.flags": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Flags passed to `uv export`", "loc": ["git-hooks", "hooks", "uv-export", "settings", "flags"], "readOnly": false, "type": "string"}, "git-hooks.hooks.uv-export.settings.format": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"pylock.toml\""}, "description": "Output format of the project's lockfile.", "example": {"_type": "literalExpression", "text": "\"requirements.txt\""}, "loc": ["git-hooks", "hooks", "uv-export", "settings", "format"], "readOnly": false, "type": "one of \"requirements.txt\", \"pylock.toml\""}, "git-hooks.hooks.uv-export.settings.locked": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Assert that the `uv.lock` will remain unchanged.\nRequires that the lockfile is up-to-date. If the lockfile is missing or needs to be updated, uv will exit with an error.\n", "loc": ["git-hooks", "hooks", "uv-export", "settings", "locked"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.vale": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "vale hook", "loc": ["git-hooks", "hooks", "vale"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.vale.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "vale", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.vale.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to the config file.", "loc": ["git-hooks", "hooks", "vale", "settings", "configPath"], "readOnly": false, "type": "string"}, "git-hooks.hooks.vale.settings.configuration": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Multiline-string configuration passed as config file.", "example": {"_type": "literalExpression", "text": "''\n MinAlertLevel = suggestion\n [*]\n BasedOnStyles = Vale\n''"}, "loc": ["git-hooks", "hooks", "vale", "settings", "configuration"], "readOnly": false, "type": "string"}, "git-hooks.hooks.vale.settings.flags": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Flags passed to vale.", "loc": ["git-hooks", "hooks", "vale", "settings", "flags"], "readOnly": false, "type": "string"}, "git-hooks.hooks.woodpecker-cli-lint": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "`woodpecker-cli lint` hook", "loc": ["git-hooks", "hooks", "woodpecker-cli-lint"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.woodpecker-cli-lint.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "woodpecker-cli-lint", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.woodpecker-cli-lint.settings.pluginsPrivileged": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "List of plugins, allowed to run in privileged mode", "loc": ["git-hooks", "hooks", "woodpecker-cli-lint", "settings", "pluginsPrivileged"], "readOnly": false, "type": "strings concatenated with \",\""}, "git-hooks.hooks.woodpecker-cli-lint.settings.pluginsTrustedClone": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "List of plugins, that are trusted to handle Git credentials in cloning steps.\nIf not set, the program defaults to\n\"docker.io/woodpeckerci/plugin-git:2.6.3,docker.io/woodpeckerci/plugin-git,quay.io/woodpeckerci/plugin-git\".\n", "loc": ["git-hooks", "hooks", "woodpecker-cli-lint", "settings", "pluginsTrustedClone"], "readOnly": false, "type": "strings concatenated with \",\""}, "git-hooks.hooks.woodpecker-cli-lint.settings.strict": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to treat warnings as errors.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["git-hooks", "hooks", "woodpecker-cli-lint", "settings", "strict"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.woodpecker-cli-lint.settings.workflowPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to the workflow config file/directory. If not set, the program\nlooks for `.woodpecker.ya?ml` file or `.woodpecker` directory.\n", "example": {"_type": "literalExpression", "text": "\".woodpecker.yml\""}, "loc": ["git-hooks", "hooks", "woodpecker-cli-lint", "settings", "workflowPath"], "readOnly": false, "type": "string"}, "git-hooks.hooks.yamlfmt": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "yamlfmt hook", "loc": ["git-hooks", "hooks", "yamlfmt"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.yamlfmt.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "yamlfmt", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.yamlfmt.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to a custom configuration file.", "example": {"_type": "literalExpression", "text": "\".yamlfmt\""}, "loc": ["git-hooks", "hooks", "yamlfmt", "settings", "configPath"], "readOnly": false, "type": "string"}, "git-hooks.hooks.yamlfmt.settings.lint-only": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Only lint the files, do not format them in place.", "loc": ["git-hooks", "hooks", "yamlfmt", "settings", "lint-only"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.yamllint": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "description": "yamllint hook", "loc": ["git-hooks", "hooks", "yamllint"], "readOnly": false, "type": "submodule"}, "git-hooks.hooks.yamllint.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hook.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable this pre-commit hook.", "loc": ["git-hooks", "hooks", "yamllint", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.hooks.yamllint.settings.configData": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Serialized YAML object describing the configuration.", "example": {"_type": "literalExpression", "text": "\"{extends: relaxed, rules: {line-length: {max: 120}}}\""}, "loc": ["git-hooks", "hooks", "yamllint", "settings", "configData"], "readOnly": false, "type": "string"}, "git-hooks.hooks.yamllint.settings.configPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to a custom configuration file.", "loc": ["git-hooks", "hooks", "yamllint", "settings", "configPath"], "readOnly": false, "type": "string"}, "git-hooks.hooks.yamllint.settings.configuration": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Multiline-string configuration passed as config file. If set, configuration file set in `yamllint.settings.configPath` gets ignored.", "example": {"_type": "literalExpression", "text": "''\n ---\n \n extends: relaxed\n \n rules:\n indentation: enable\n''"}, "loc": ["git-hooks", "hooks", "yamllint", "settings", "configuration"], "readOnly": false, "type": "string"}, "git-hooks.hooks.yamllint.settings.format": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"auto\""}, "description": "Format for parsing output.", "loc": ["git-hooks", "hooks", "yamllint", "settings", "format"], "readOnly": false, "type": "one of \"parsable\", \"standard\", \"colored\", \"github\", \"auto\""}, "git-hooks.hooks.yamllint.settings.preset": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "\"default\""}, "description": "The configuration preset to use.", "loc": ["git-hooks", "hooks", "yamllint", "settings", "preset"], "readOnly": false, "type": "one of \"default\", \"relaxed\""}, "git-hooks.hooks.yamllint.settings.strict": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Return non-zero exit code on warnings as well as errors.", "loc": ["git-hooks", "hooks", "yamllint", "settings", "strict"], "readOnly": false, "type": "boolean"}, "git-hooks.install.enable": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable automatic installation of pre-commit hooks.\n\nWhen set to false, hooks will not be installed into the git repository,\nbut all other module functionality (like configuration generation) will still work.\n", "loc": ["git-hooks", "install", "enable"], "readOnly": false, "type": "boolean"}, "git-hooks.installStages": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "The stages to install the hooks to.\n", "loc": ["git-hooks", "installStages"], "readOnly": true, "type": "list of (string or anything)"}, "git-hooks.installationScript": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "description": "A bash snippet that installs the git hooks in the current repository.\n", "loc": ["git-hooks", "installationScript"], "readOnly": true, "type": "string"}, "git-hooks.package": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.pre-commit"}, "description": "The `pre-commit` package to use.\n", "example": {"_type": "literalExpression", "text": "pkgs.prek"}, "loc": ["git-hooks", "package"], "readOnly": false, "type": "package"}, "git-hooks.rootSrc": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "default": {"_type": "literalExpression", "text": "gitignoreSource config.src"}, "description": "The source of the project to be checked.\n\nThis is used in the derivation that performs the check.\n\nIf you use the `flakeModule`, the default is `self.outPath`; the whole flake\nsources.\n", "loc": ["git-hooks", "rootSrc"], "readOnly": false, "type": "absolute path"}, "git-hooks.run": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "default": {"_type": "literalExpression", "text": ""}, "description": "A derivation that tests whether the pre-commit hooks run cleanly on\nthe entire project.\n", "loc": ["git-hooks", "run"], "readOnly": false, "type": "package"}, "git-hooks.settings.rust.cargoManifestPath": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Path to Cargo.toml", "loc": ["git-hooks", "settings", "rust", "cargoManifestPath"], "readOnly": false, "type": "null or string"}, "git-hooks.settings.rust.check.cargoDeps": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/hooks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Cargo dependencies needed to run the checks.", "example": {"_type": "literalExpression", "text": "\"pkgs.rustPlatform.importCargoLock { lockFile = ./Cargo.lock; }\""}, "loc": ["git-hooks", "settings", "rust", "check", "cargoDeps"], "readOnly": false, "type": "null or (attribute set)"}, "git-hooks.shellHook": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "description": "A shell hook that sets up the git hooks in a development shell.\n\nPass to `mkShell` as `shellHook` to use.\n", "loc": ["git-hooks", "shellHook"], "readOnly": true, "type": "string"}, "git-hooks.src": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "description": "Root of the project. By default this will be filtered with the `gitignoreSource`\nfunction later, unless `rootSrc` is specified.\n\nIf you use the `flakeModule`, the default is `self.outPath`; the whole flake\nsources.\n", "loc": ["git-hooks", "src"], "readOnly": false, "type": "absolute path"}, "git-hooks.tools": {"declarations": [{"name": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix", "url": "https://github.com/cachix/git-hooks.nix/blob/master/modules/pre-commit.nix"}], "default": {"_type": "literalExpression", "text": "git-hooks.nix-pkgs.callPackage tools-dot-nix { inherit (pkgs) system; }\n"}, "description": "Tool set from which `nix-pre-commit-hooks` will pick binaries.\n\n`nix-pre-commit-hooks` comes with its own set of packages for this purpose.\n", "loc": ["git-hooks", "tools"], "readOnly": false, "type": "lazy attribute set of (null or package)"}, "git.root": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/git.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/git.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Git repository root path. This field is populated automatically in devenv 1.10 and newer.", "loc": ["git", "root"], "readOnly": false, "type": "null or string"}, "hosts": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/hostctl.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/hostctl.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "List of hosts entries.", "example": {"_type": "literalExpression", "text": "{\n \"another-example.com\" = [\n \"::1\"\n \"127.0.0.1\"\n ];\n \"example.com\" = \"127.0.0.1\";\n}"}, "loc": ["hosts"], "readOnly": false, "type": "attribute set of (string or list of string)"}, "hostsProfileName": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/hostctl.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/hostctl.nix"}], "default": {"_type": "literalExpression", "text": "\"devenv-\""}, "description": "Profile name to use.", "loc": ["hostsProfileName"], "readOnly": false, "type": "string"}, "infoSections": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/info.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/info.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Information about the environment", "loc": ["infoSections"], "readOnly": false, "type": "attribute set of list of string"}, "inputsFrom": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "A list of derivations whose build inputs will be merged into the shell environment.", "example": {"_type": "literalExpression", "text": "[\n pkgs.hello\n (pkgs.python3.withPackages (ps: [ ps.numpy ps.pandas ]))\n]\n"}, "loc": ["inputsFrom"], "readOnly": false, "type": "list of package"}, "integrations.gitnr": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/gitnr.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/gitnr.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Declarative generation of ignore files using gitnr templates.", "example": {"_type": "literalExpression", "text": "{\n \".gitignore\" = {\n enableDefaultTemplates = true;\n templates = [ \"tt:go\" \"tt:node\" ];\n content = [\n \"*.env\"\n ];\n };\n}\n"}, "loc": ["integrations", "gitnr"], "readOnly": false, "type": "attribute set of (submodule)"}, "integrations.gitnr..content": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/gitnr.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/gitnr.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Additional patterns to append to the generated ignore file.\nThese patterns will be added after the templates are processed.\n", "example": {"_type": "literalExpression", "text": "[\n \"*.log\"\n \"dist/\"\n]"}, "loc": ["integrations", "gitnr", "", "content"], "readOnly": false, "type": "list of string"}, "integrations.gitnr..enableDefaultTemplates": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/gitnr.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/gitnr.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Prepend a sensible default set of TopTal templates.", "loc": ["integrations", "gitnr", "", "enableDefaultTemplates"], "readOnly": false, "type": "boolean"}, "integrations.gitnr..package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/gitnr.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/gitnr.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.gitnr"}, "description": "The gitnr package to use for generating templates.", "loc": ["integrations", "gitnr", "", "package"], "readOnly": false, "type": "package"}, "integrations.gitnr..templates": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/gitnr.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/gitnr.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of templates to include in the ignore file.\n\nTemplate strings are passed directly to `gitnr create`.\n", "example": {"_type": "literalExpression", "text": "[\n \"tt:linux\"\n \"tt:macos\"\n \"tt:windows\"\n]"}, "loc": ["integrations", "gitnr", "", "templates"], "readOnly": false, "type": "list of string"}, "keyFile": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/mkcert.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/mkcert.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Custom key file name, uses mkcert default if unset", "example": {"_type": "literalExpression", "text": "\"mykey.pem\""}, "loc": ["keyFile"], "readOnly": false, "type": "null or string"}, "languages.ansible.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ansible.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ansible.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Ansible development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "ansible", "enable"], "readOnly": false, "type": "boolean"}, "languages.ansible.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ansible.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ansible.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Ansible Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "ansible", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.ansible.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ansible.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ansible.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.ansible-language-server"}, "description": "The Ansible language server package to use.", "loc": ["languages", "ansible", "lsp", "package"], "readOnly": false, "type": "null or package"}, "languages.ansible.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ansible.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ansible.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.ansible"}, "description": "The Ansible package to use.", "loc": ["languages", "ansible", "package"], "readOnly": false, "type": "package"}, "languages.c.debugger": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/c.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/c.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.gdb"}, "description": "An optional debugger package to use with c.\nThe default is `lldb` on macOS, `gdb` on Linux (if supported), or `null` otherwise.\n", "loc": ["languages", "c", "debugger"], "readOnly": false, "type": "null or package"}, "languages.c.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/c.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/c.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for C development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "c", "enable"], "readOnly": false, "type": "boolean"}, "languages.c.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/c.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/c.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable C Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "c", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.c.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/c.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/c.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.ccls"}, "description": "The C language server package to use.", "loc": ["languages", "c", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.clojure.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/clojure.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/clojure.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Clojure development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "clojure", "enable"], "readOnly": false, "type": "boolean"}, "languages.clojure.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/clojure.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/clojure.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Clojure Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "clojure", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.clojure.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/clojure.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/clojure.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.clojure-lsp"}, "description": "The Clojure language server package to use.", "loc": ["languages", "clojure", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.cplusplus.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/cplusplus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/cplusplus.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for C++ development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "cplusplus", "enable"], "readOnly": false, "type": "boolean"}, "languages.cplusplus.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/cplusplus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/cplusplus.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable C++ Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "cplusplus", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.cplusplus.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/cplusplus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/cplusplus.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.ccls"}, "description": "The C++ language server package to use.", "loc": ["languages", "cplusplus", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.crystal.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/crystal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/crystal.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Enable tools for Crystal development..", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "crystal", "enable"], "readOnly": false, "type": "boolean"}, "languages.crystal.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/crystal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/crystal.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Crystal Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "crystal", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.crystal.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/crystal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/crystal.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.crystalline"}, "description": "The Crystal language server package to use.", "loc": ["languages", "crystal", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.crystal.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/crystal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/crystal.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.crystal"}, "description": "The Crystal package to use.", "loc": ["languages", "crystal", "package"], "readOnly": false, "type": "package"}, "languages.crystal.shards": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/crystal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/crystal.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Configuration for shards", "loc": ["languages", "crystal", "shards"], "readOnly": false, "type": "submodule"}, "languages.crystal.shards.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/crystal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/crystal.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.shards"}, "description": "The Shards package to use.", "loc": ["languages", "crystal", "shards", "package"], "readOnly": false, "type": "package"}, "languages.cue.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/cue.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/cue.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Cue development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "cue", "enable"], "readOnly": false, "type": "boolean"}, "languages.cue.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/cue.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/cue.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable CUE Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "cue", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.cue.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/cue.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/cue.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.cuelsp"}, "description": "The CUE language server package to use.", "loc": ["languages", "cue", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.cue.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/cue.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/cue.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.cue"}, "description": "The CUE package to use.", "loc": ["languages", "cue", "package"], "readOnly": false, "type": "package"}, "languages.dart.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/dart.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/dart.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Dart development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "dart", "enable"], "readOnly": false, "type": "boolean"}, "languages.dart.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/dart.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/dart.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.dart"}, "description": "The Dart package to use.", "loc": ["languages", "dart", "package"], "readOnly": false, "type": "package"}, "languages.deno.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/deno.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/deno.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Deno development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "deno", "enable"], "readOnly": false, "type": "boolean"}, "languages.deno.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/deno.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/deno.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.deno"}, "description": "Which package of Deno to use.", "loc": ["languages", "deno", "package"], "readOnly": false, "type": "package"}, "languages.dotnet.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/dotnet.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/dotnet.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for .NET development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "dotnet", "enable"], "readOnly": false, "type": "boolean"}, "languages.dotnet.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/dotnet.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/dotnet.nix"}], "default": {"_type": "literalMD", "text": "`true` if csharp-ls is available on the host platform, `false` otherwise"}, "description": "Whether to enable .NET Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "dotnet", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.dotnet.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/dotnet.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/dotnet.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.csharp-ls"}, "description": "The .NET language server package to use.", "loc": ["languages", "dotnet", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.dotnet.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/dotnet.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/dotnet.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.dotnet-sdk"}, "description": "The .NET SDK package to use.", "loc": ["languages", "dotnet", "package"], "readOnly": false, "type": "package"}, "languages.elixir.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/elixir.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/elixir.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Elixir development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "elixir", "enable"], "readOnly": false, "type": "boolean"}, "languages.elixir.erlang.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/elixir.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/elixir.nix"}], "default": {"_type": "literalExpression", "text": "the Erlang runtime used to build languages.elixir.package"}, "description": "The Erlang runtime to include in the environment alongside Elixir.\nDefaults to the runtime used to build the selected Elixir package.\nSet this explicitly for custom packages that do not expose their Erlang dependency.\n", "loc": ["languages", "elixir", "erlang", "package"], "readOnly": false, "type": "package"}, "languages.elixir.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/elixir.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/elixir.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Elixir Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "elixir", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.elixir.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/elixir.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/elixir.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.beamPackages.elixir-ls"}, "description": "The Elixir language server package to use.", "loc": ["languages", "elixir", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.elixir.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/elixir.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/elixir.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.beamPackages.elixir"}, "description": "Which Elixir package to use.", "loc": ["languages", "elixir", "package"], "readOnly": false, "type": "package"}, "languages.elm.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/elm.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/elm.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Elm development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "elm", "enable"], "readOnly": false, "type": "boolean"}, "languages.elm.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/elm.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/elm.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Elm Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "elm", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.elm.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/elm.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/elm.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.elmPackages.elm-language-server"}, "description": "The Elm language server package to use.", "loc": ["languages", "elm", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.erlang.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/erlang.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/erlang.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Erlang development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "erlang", "enable"], "readOnly": false, "type": "boolean"}, "languages.erlang.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/erlang.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/erlang.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Erlang Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "erlang", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.erlang.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/erlang.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/erlang.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.erlang-language-platform"}, "description": "The Erlang language server package to use.", "loc": ["languages", "erlang", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.erlang.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/erlang.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/erlang.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.beamPackages.erlang"}, "description": "Which Erlang package to use.", "loc": ["languages", "erlang", "package"], "readOnly": false, "type": "package"}, "languages.fortran.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/fortran.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/fortran.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Fortran Development..", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "fortran", "enable"], "readOnly": false, "type": "boolean"}, "languages.fortran.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/fortran.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/fortran.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Fortran Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "fortran", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.fortran.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/fortran.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/fortran.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.fortls"}, "description": "The Fortran language server package to use.", "loc": ["languages", "fortran", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.fortran.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/fortran.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/fortran.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.gfortran"}, "description": "The Fortran package to use.", "loc": ["languages", "fortran", "package"], "readOnly": false, "type": "package"}, "languages.gawk.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/gawk.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/gawk.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for GNU Awk development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "gawk", "enable"], "readOnly": false, "type": "boolean"}, "languages.gleam.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/gleam.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/gleam.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Gleam development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "gleam", "enable"], "readOnly": false, "type": "boolean"}, "languages.gleam.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/gleam.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/gleam.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.gleam"}, "description": "The Gleam package to use.", "loc": ["languages", "gleam", "package"], "readOnly": false, "type": "package"}, "languages.go.delve.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Delve debugger.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "go", "delve", "enable"], "readOnly": false, "type": "boolean"}, "languages.go.delve.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.delve"}, "description": "The Delve package to use. Override this to customize the build, e.g. to disable tests.", "loc": ["languages", "go", "delve", "package"], "readOnly": false, "type": "package"}, "languages.go.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Go development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "go", "enable"], "readOnly": false, "type": "boolean"}, "languages.go.enableHardeningWorkaround": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Enable hardening workaround required for Delve debugger (https://github.com/go-delve/delve/issues/3085)", "loc": ["languages", "go", "enableHardeningWorkaround"], "readOnly": false, "type": "boolean"}, "languages.go.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Go Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "go", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.go.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.gopls"}, "description": "The Go language server package to use.", "loc": ["languages", "go", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.go.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.go"}, "description": "The Go package to use.", "loc": ["languages", "go", "package"], "readOnly": false, "type": "package"}, "languages.go.version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/go.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The Go version to use.\nThis automatically sets the `languages.go.package` using [go-overlay](https://github.com/purpleclay/go-overlay).\n", "example": {"_type": "literalExpression", "text": "\"1.22.0\""}, "loc": ["languages", "go", "version"], "readOnly": false, "type": "null or string"}, "languages.hare.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/hare.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/hare.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Hare development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "hare", "enable"], "readOnly": false, "type": "boolean"}, "languages.haskell.cabal.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Cabal.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "haskell", "cabal", "enable"], "readOnly": false, "type": "boolean"}, "languages.haskell.cabal.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.cabal-install"}, "description": "Cabal package to use.\n", "loc": ["languages", "haskell", "cabal", "package"], "readOnly": false, "type": "package"}, "languages.haskell.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Haskell development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "haskell", "enable"], "readOnly": false, "type": "boolean"}, "languages.haskell.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Haskell Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "haskell", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.haskell.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.haskell-language-server"}, "description": "The Haskell language server package to use.", "loc": ["languages", "haskell", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.haskell.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.ghc"}, "description": "Haskell compiler to use.\n", "loc": ["languages", "haskell", "package"], "readOnly": false, "type": "package"}, "languages.haskell.stack.args": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix"}], "default": {"_type": "literalExpression", "text": "[ \"--no-nix\" \"--system-ghc\" \"--no-install-ghc\" ]"}, "description": "Additional arguments to pass to stack.\nBy default, stack is configured to use devenv's GHC installation.\n", "loc": ["languages", "haskell", "stack", "args"], "readOnly": false, "type": "list of string"}, "languages.haskell.stack.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Stack.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "haskell", "stack", "enable"], "readOnly": false, "type": "boolean"}, "languages.haskell.stack.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/haskell.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.stack"}, "description": "Haskell stack package to use.\n", "loc": ["languages", "haskell", "stack", "package"], "readOnly": false, "type": "package"}, "languages.helm.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/helm.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/helm.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Helm development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "helm", "enable"], "readOnly": false, "type": "boolean"}, "languages.helm.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/helm.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/helm.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Helm Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "helm", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.helm.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/helm.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/helm.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.helm-ls"}, "description": "The Helm language server package to use.", "loc": ["languages", "helm", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.helm.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/helm.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/helm.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.kubernetes-helm"}, "description": "The Helm package to use.", "loc": ["languages", "helm", "package"], "readOnly": false, "type": "package"}, "languages.helm.plugins": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/helm.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/helm.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of Helm plugin names to include from pkgs.kubernetes-helmPlugins.\n\nThey will be symlinked into one directory and exposed via HELM_PLUGINS.\n", "example": {"_type": "literalExpression", "text": "[\n \"helm-secrets\"\n \"helm-diff\"\n \"helm-unittest\"\n]"}, "loc": ["languages", "helm", "plugins"], "readOnly": false, "type": "list of string"}, "languages.idris.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/idris.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/idris.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Idris development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "idris", "enable"], "readOnly": false, "type": "boolean"}, "languages.idris.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/idris.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/idris.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Idris Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "idris", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.idris.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/idris.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/idris.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.idris2Packages.idris2Lsp"}, "description": "The Idris language server package to use.", "loc": ["languages", "idris", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.idris.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/idris.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/idris.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.idris2"}, "description": "The Idris package to use.\n", "example": {"_type": "literalExpression", "text": "pkgs.idris"}, "loc": ["languages", "idris", "package"], "readOnly": false, "type": "package"}, "languages.java.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Java development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "java", "enable"], "readOnly": false, "type": "boolean"}, "languages.java.gradle.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable gradle.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "java", "gradle", "enable"], "readOnly": false, "type": "boolean"}, "languages.java.gradle.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.gradle.override { java = cfg.jdk.package; }"}, "description": "The Gradle package to use.\nThe Gradle package by default inherits the JDK from `languages.java.jdk.package`.\n", "loc": ["languages", "java", "gradle", "package"], "readOnly": false, "type": "package"}, "languages.java.jdk.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.jdk"}, "description": "The JDK package to use.\nThis will also become available as `JAVA_HOME`.\n", "example": {"_type": "literalExpression", "text": "pkgs.jdk8"}, "loc": ["languages", "java", "jdk", "package"], "readOnly": false, "type": "package"}, "languages.java.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Java Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "java", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.java.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.jdt-language-server.override { jdk = cfg.jdk.package; }"}, "description": "The Java language server package to use.\nThe Java language server package by default inherits the JDK from `languages.java.jdk.package`.\n", "loc": ["languages", "java", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.java.maven.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable maven.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "java", "maven", "enable"], "readOnly": false, "type": "boolean"}, "languages.java.maven.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/java.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.maven.override { jdk_headless = cfg.jdk.package; }"}, "description": "The Maven package to use.\nThe Maven package by default inherits the JDK from `languages.java.jdk.package`.\n", "loc": ["languages", "java", "maven", "package"], "readOnly": false, "type": "package"}, "languages.javascript.bun.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable install bun.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "javascript", "bun", "enable"], "readOnly": false, "type": "boolean"}, "languages.javascript.bun.install.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable bun install during devenv initialisation.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "javascript", "bun", "install", "enable"], "readOnly": false, "type": "boolean"}, "languages.javascript.bun.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.bun"}, "description": "The bun package to use.", "loc": ["languages", "javascript", "bun", "package"], "readOnly": false, "type": "package"}, "languages.javascript.corepack.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable wrappers for npm, pnpm and Yarn via Node.js Corepack.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "javascript", "corepack", "enable"], "readOnly": false, "type": "boolean"}, "languages.javascript.directory": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "config.devenv.root"}, "description": "The JavaScript project's root directory. Defaults to the root of the devenv project.\nCan be an absolute path or one relative to the root of the devenv project.\n", "example": {"_type": "literalExpression", "text": "\"./directory\""}, "loc": ["languages", "javascript", "directory"], "readOnly": false, "type": "string"}, "languages.javascript.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for JavaScript development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "javascript", "enable"], "readOnly": false, "type": "boolean"}, "languages.javascript.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable TypeScript Language Server for JavaScript.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "javascript", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.javascript.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.typescript-language-server"}, "description": "The TypeScript/JavaScript language server package to use.", "loc": ["languages", "javascript", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.javascript.nodejs.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Node.js runtime.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "javascript", "nodejs", "enable"], "readOnly": false, "type": "boolean"}, "languages.javascript.npm.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable install npm.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "javascript", "npm", "enable"], "readOnly": false, "type": "boolean"}, "languages.javascript.npm.install.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable npm install during devenv initialisation.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "javascript", "npm", "install", "enable"], "readOnly": false, "type": "boolean"}, "languages.javascript.npm.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "languages.javascript.package"}, "description": "The npm package to use. Defaults to the npm output of the javascript package.", "loc": ["languages", "javascript", "npm", "package"], "readOnly": false, "type": "package"}, "languages.javascript.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.nodejs-slim"}, "description": "The Node.js package to use.", "loc": ["languages", "javascript", "package"], "readOnly": false, "type": "package"}, "languages.javascript.pnpm.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable install pnpm.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "javascript", "pnpm", "enable"], "readOnly": false, "type": "boolean"}, "languages.javascript.pnpm.install.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable pnpm install during devenv initialisation.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "javascript", "pnpm", "install", "enable"], "readOnly": false, "type": "boolean"}, "languages.javascript.pnpm.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.pnpm"}, "description": "The pnpm package to use.", "loc": ["languages", "javascript", "pnpm", "package"], "readOnly": false, "type": "package"}, "languages.javascript.yarn.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable install yarn.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "javascript", "yarn", "enable"], "readOnly": false, "type": "boolean"}, "languages.javascript.yarn.install.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable yarn install during devenv initialisation.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "javascript", "yarn", "install", "enable"], "readOnly": false, "type": "boolean"}, "languages.javascript.yarn.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/javascript.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.yarn"}, "description": "The yarn package to use.", "loc": ["languages", "javascript", "yarn", "package"], "readOnly": false, "type": "package"}, "languages.jsonnet.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/jsonnet.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/jsonnet.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for jsonnet development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "jsonnet", "enable"], "readOnly": false, "type": "boolean"}, "languages.jsonnet.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/jsonnet.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/jsonnet.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Jsonnet Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "jsonnet", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.jsonnet.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/jsonnet.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/jsonnet.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.jsonnet-language-server"}, "description": "The Jsonnet language server package to use.", "loc": ["languages", "jsonnet", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.julia.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/julia.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/julia.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Julia development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "julia", "enable"], "readOnly": false, "type": "boolean"}, "languages.julia.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/julia.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/julia.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.julia-bin"}, "description": "The Julia package to use.", "loc": ["languages", "julia", "package"], "readOnly": false, "type": "package"}, "languages.kotlin.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/kotlin.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/kotlin.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Kotlin development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "kotlin", "enable"], "readOnly": false, "type": "boolean"}, "languages.kotlin.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/kotlin.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/kotlin.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Kotlin Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "kotlin", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.kotlin.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/kotlin.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/kotlin.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.kotlin-language-server"}, "description": "The Kotlin language server package to use.", "loc": ["languages", "kotlin", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.lean4.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lean4.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lean4.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for lean4 development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "lean4", "enable"], "readOnly": false, "type": "boolean"}, "languages.lean4.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lean4.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lean4.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.lean4"}, "description": "The lean4 package to use.\n", "loc": ["languages", "lean4", "package"], "readOnly": false, "type": "package"}, "languages.lobster.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lobster.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lobster.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Lobster development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "lobster", "enable"], "readOnly": false, "type": "boolean"}, "languages.lobster.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lobster.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lobster.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.lobster"}, "description": "Which Lobster package to use.", "loc": ["languages", "lobster", "package"], "readOnly": false, "type": "package"}, "languages.lua.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lua.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lua.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Lua development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "lua", "enable"], "readOnly": false, "type": "boolean"}, "languages.lua.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lua.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lua.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Lua Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "lua", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.lua.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lua.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lua.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.lua-language-server"}, "description": "The Lua language server package to use.", "loc": ["languages", "lua", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.lua.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lua.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/lua.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.lua"}, "description": "The Lua package to use.", "loc": ["languages", "lua", "package"], "readOnly": false, "type": "package"}, "languages.nim.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/nim.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/nim.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Nim development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "nim", "enable"], "readOnly": false, "type": "boolean"}, "languages.nim.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/nim.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/nim.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Nim Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "nim", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.nim.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/nim.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/nim.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.nimlangserver"}, "description": "The Nim language server package to use.", "loc": ["languages", "nim", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.nim.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/nim.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/nim.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.nim"}, "description": "The Nim package to use.", "loc": ["languages", "nim", "package"], "readOnly": false, "type": "package"}, "languages.nix.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/nix.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/nix.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Nix development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "nix", "enable"], "readOnly": false, "type": "boolean"}, "languages.nix.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/nix.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/nix.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Nix Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "nix", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.nix.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/nix.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/nix.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.nixd"}, "description": "The Nix language server package to use.", "loc": ["languages", "nix", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.ocaml.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ocaml.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ocaml.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for OCaml development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "ocaml", "enable"], "readOnly": false, "type": "boolean"}, "languages.ocaml.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ocaml.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ocaml.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable OCaml Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "ocaml", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.ocaml.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ocaml.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ocaml.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.ocamlPackages.ocaml-lsp"}, "description": "The OCaml language server package to use.", "loc": ["languages", "ocaml", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.ocaml.packages": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ocaml.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ocaml.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.ocaml-ng.ocamlPackages_4_12"}, "description": "The package set of OCaml to use", "loc": ["languages", "ocaml", "packages"], "readOnly": false, "type": "attribute set"}, "languages.odin.debugger": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/odin.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/odin.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.gdb"}, "description": "An optional debugger package to use with odin.\nThe default is `gdb`, if supported on the current system.\n", "loc": ["languages", "odin", "debugger"], "readOnly": false, "type": "null or package"}, "languages.odin.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/odin.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/odin.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Odin Language.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "odin", "enable"], "readOnly": false, "type": "boolean"}, "languages.odin.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/odin.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/odin.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Odin Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "odin", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.odin.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/odin.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/odin.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.ols"}, "description": "The Odin language server package to use.", "loc": ["languages", "odin", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.odin.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/odin.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/odin.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.odin"}, "description": "The odin package to use.", "loc": ["languages", "odin", "package"], "readOnly": false, "type": "package"}, "languages.opentofu.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/opentofu.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/opentofu.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for OpenTofu development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "opentofu", "enable"], "readOnly": false, "type": "boolean"}, "languages.opentofu.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/opentofu.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/opentofu.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable OpenTofu Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "opentofu", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.opentofu.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/opentofu.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/opentofu.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.tofu-ls"}, "description": "The OpenTofu language server package to use.", "loc": ["languages", "opentofu", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.opentofu.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/opentofu.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/opentofu.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.opentofu"}, "description": "The OpenTofu package to use.", "loc": ["languages", "opentofu", "package"], "readOnly": false, "type": "package"}, "languages.pascal.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/pascal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/pascal.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Pascal development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "pascal", "enable"], "readOnly": false, "type": "boolean"}, "languages.pascal.lazarus.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/pascal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/pascal.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable lazarus graphical IDE for the FreePascal language.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "pascal", "lazarus", "enable"], "readOnly": false, "type": "boolean"}, "languages.perl.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/perl.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/perl.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Perl development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "perl", "enable"], "readOnly": false, "type": "boolean"}, "languages.perl.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/perl.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/perl.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Perl Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "perl", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.perl.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/perl.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/perl.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.perlnavigator"}, "description": "The Perl language server package to use.", "loc": ["languages", "perl", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.perl.packages": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/perl.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/perl.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Perl packages to include", "example": {"_type": "literalExpression", "text": "[\n \"Mojolicious\"\n]"}, "loc": ["languages", "perl", "packages"], "readOnly": false, "type": "list of string"}, "languages.php.disableExtensions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "PHP extensions to disable.\n", "loc": ["languages", "php", "disableExtensions"], "readOnly": false, "type": "list of string"}, "languages.php.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for PHP development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "php", "enable"], "readOnly": false, "type": "boolean"}, "languages.php.extensions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "PHP extensions to enable.\n", "loc": ["languages", "php", "extensions"], "readOnly": false, "type": "list of string"}, "languages.php.fpm.extraConfig": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Extra configuration that should be put in the global section of\nthe PHP-FPM configuration file. Do not specify the options\n`error_log` or `daemonize` here, since they are generated by\nNixOS.\n", "loc": ["languages", "php", "fpm", "extraConfig"], "readOnly": false, "type": "null or strings concatenated with \"\\n\""}, "languages.php.fpm.phpOptions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Options appended to the PHP configuration file `php.ini`.\n", "example": {"_type": "literalExpression", "text": "''\n date.timezone = \"CET\"\n''"}, "loc": ["languages", "php", "fpm", "phpOptions"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "languages.php.fpm.pools": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "PHP-FPM pools. If no pools are defined, the PHP-FPM\nservice is disabled.\n", "example": {"_type": "literalExpression", "text": "{\n mypool = {\n user = \"php\";\n group = \"php\";\n phpPackage = pkgs.php;\n settings = {\n \"pm\" = \"dynamic\";\n \"pm.max_children\" = 75;\n \"pm.start_servers\" = 10;\n \"pm.min_spare_servers\" = 5;\n \"pm.max_spare_servers\" = 20;\n \"pm.max_requests\" = 500;\n };\n }\n}"}, "loc": ["languages", "php", "fpm", "pools"], "readOnly": false, "type": "attribute set of (submodule)"}, "languages.php.fpm.pools..extraConfig": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Extra lines that go into the pool configuration.\nSee the documentation on `php-fpm.conf` for\ndetails on configuration directives.\n", "loc": ["languages", "php", "fpm", "pools", "", "extraConfig"], "readOnly": false, "type": "null or strings concatenated with \"\\n\""}, "languages.php.fpm.pools..listen": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "The address on which to accept FastCGI requests.\n", "example": {"_type": "literalExpression", "text": "\"/path/to/unix/socket\""}, "loc": ["languages", "php", "fpm", "pools", "", "listen"], "readOnly": false, "type": "string"}, "languages.php.fpm.pools..phpEnv": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Environment variables used for this PHP-FPM pool.\n", "example": {"_type": "literalExpression", "text": "{\n HOSTNAME = \"$HOSTNAME\";\n TMP = \"/tmp\";\n TMPDIR = \"/tmp\";\n TEMP = \"/tmp\";\n}\n"}, "loc": ["languages", "php", "fpm", "pools", "", "phpEnv"], "readOnly": false, "type": "attribute set of string"}, "languages.php.fpm.pools..phpOptions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "description": "Options appended to the PHP configuration file `php.ini` used for this PHP-FPM pool.\n", "loc": ["languages", "php", "fpm", "pools", "", "phpOptions"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "languages.php.fpm.pools..phpPackage": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "phpfpm.phpPackage"}, "description": "The PHP package to use for running this PHP-FPM pool.\n", "loc": ["languages", "php", "fpm", "pools", "", "phpPackage"], "readOnly": false, "type": "package"}, "languages.php.fpm.pools..settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "PHP-FPM pool directives. Refer to the \"List of pool directives\" section of\n\nthe manual for details. Note that settings names must be\nenclosed in quotes (e.g. `\"pm.max_children\"` instead of\n`pm.max_children`).\n", "example": {"_type": "literalExpression", "text": "{\n \"pm\" = \"dynamic\";\n \"pm.max_children\" = 75;\n \"pm.start_servers\" = 10;\n \"pm.min_spare_servers\" = 5;\n \"pm.max_spare_servers\" = 20;\n \"pm.max_requests\" = 500;\n}\n"}, "loc": ["languages", "php", "fpm", "pools", "", "settings"], "readOnly": false, "type": "attribute set of (string or signed integer or boolean)"}, "languages.php.fpm.pools..socket": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "description": "Path to the Unix socket file on which to accept FastCGI requests.\n\nThis option is read-only and managed by NixOS.\n", "example": {"_type": "literalExpression", "text": "config.env.DEVENV_STATE + \"/php-fpm/.sock\""}, "loc": ["languages", "php", "fpm", "pools", "", "socket"], "readOnly": true, "type": "string"}, "languages.php.fpm.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "{\n error_log = config.env.DEVENV_STATE + \"/php-fpm/php-fpm.log\";\n}\n"}, "description": "PHP-FPM global directives. \n\nRefer to the \"List of global php-fpm.conf directives\" section of\n\nfor details. \n\nNote that settings names must be enclosed in\nquotes (e.g. `\"pm.max_children\"` instead of `pm.max_children`). \n\nYou need not specify the options `error_log` or `daemonize` here, since\nthey are already set.\n", "loc": ["languages", "php", "fpm", "settings"], "readOnly": false, "type": "attribute set of (string or signed integer or boolean)"}, "languages.php.ini": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "PHP.ini directives. Refer to the \"List of php.ini directives\" of PHP's\n", "loc": ["languages", "php", "ini"], "readOnly": false, "type": "null or strings concatenated with \"\\n\""}, "languages.php.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable PHP Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "php", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.php.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.phpactor"}, "description": "The PHP language server package to use.", "loc": ["languages", "php", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.php.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.php"}, "description": "Allows you to [override the default used package](https://nixos.org/manual/nixpkgs/stable/#ssec-php-user-guide)\nto adjust the settings or add more extensions. You can find the\nextensions using `devenv search 'php extensions'`\n", "example": {"_type": "literalExpression", "text": "pkgs.php.buildEnv {\n extensions = { all, enabled }: with all; enabled ++ [ xdebug ];\n extraConfig = ''\n memory_limit=1G\n '';\n};\n"}, "loc": ["languages", "php", "package"], "readOnly": false, "type": "package"}, "languages.php.packages": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "pkgs"}, "description": "Attribute set of packages including composer", "loc": ["languages", "php", "packages"], "readOnly": false, "type": "submodule"}, "languages.php.packages.composer": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.phpPackages.composer"}, "description": "composer package", "loc": ["languages", "php", "packages", "composer"], "readOnly": false, "type": "null or package"}, "languages.php.version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/php.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "The PHP version to use.", "loc": ["languages", "php", "version"], "readOnly": false, "type": "string"}, "languages.pkl.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/pkl.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/pkl.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Pkl development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "pkl", "enable"], "readOnly": false, "type": "boolean"}, "languages.pkl.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/pkl.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/pkl.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Pkl Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "pkl", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.pkl.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/pkl.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/pkl.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.pkl-lsp"}, "description": "The Pkl language server package to use.", "loc": ["languages", "pkl", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.pkl.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/pkl.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/pkl.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.pkl"}, "description": "The Pkl package to use.", "loc": ["languages", "pkl", "package"], "readOnly": false, "type": "package"}, "languages.purescript.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/purescript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/purescript.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for PureScript development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "purescript", "enable"], "readOnly": false, "type": "boolean"}, "languages.purescript.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/purescript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/purescript.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable PureScript Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "purescript", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.purescript.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/purescript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/purescript.nix"}], "default": {"_type": "literalExpression", "text": "purescript-overlay.packages.${pkgs.stdenv.system}.purescript-language-server"}, "description": "The PureScript language server package to use.\nUses [purescript-overlay](https://github.com/thomashoneyman/purescript-overlay) by default.\n", "loc": ["languages", "purescript", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.purescript.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/purescript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/purescript.nix"}], "default": {"_type": "literalExpression", "text": "purescript-overlay.packages.${pkgs.stdenv.system}.purs"}, "description": "The PureScript compiler package to use.\nUses [purescript-overlay](https://github.com/thomashoneyman/purescript-overlay) by default.\n", "loc": ["languages", "purescript", "package"], "readOnly": false, "type": "package"}, "languages.purescript.spago.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/purescript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/purescript.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Spago package manager.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "purescript", "spago", "enable"], "readOnly": false, "type": "boolean"}, "languages.purescript.spago.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/purescript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/purescript.nix"}], "default": {"_type": "literalExpression", "text": "purescript-overlay.packages.${pkgs.stdenv.system}.spago"}, "description": "The Spago package manager to use.\nUses [purescript-overlay](https://github.com/thomashoneyman/purescript-overlay) by default.\n", "loc": ["languages", "purescript", "spago", "package"], "readOnly": false, "type": "package"}, "languages.python.directory": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "config.devenv.root"}, "description": "The Python project's root directory. Defaults to the root of the devenv project.\nCan be an absolute path or one relative to the root of the devenv project.\n", "example": {"_type": "literalExpression", "text": "\"./directory\""}, "loc": ["languages", "python", "directory"], "readOnly": false, "type": "string"}, "languages.python.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Python development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "python", "enable"], "readOnly": false, "type": "boolean"}, "languages.python.import": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "description": "Import a Python project using uv2nix.\n\nThis function takes a path to a directory containing a pyproject.toml file\nand returns a derivation that builds the Python project using uv2nix.\n\nExample usage:\n```nix\nlet\n mypackage = config.languages.python.import ./path/to/python/project {};\nin {\n languages.python.enable = true;\n packages = [ mypackage ];\n}\n```\n", "loc": ["languages", "python", "import"], "readOnly": false, "type": "function that evaluates to a(n) function that evaluates to a(n) package"}, "languages.python.libraries": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "[ \"${config.devenv.dotfile}/profile\" ]\n"}, "description": "Additional libraries to make available to the Python interpreter.\n\nThis is useful when you want to use Python wheels that depend on native libraries.\n", "loc": ["languages", "python", "libraries"], "readOnly": false, "type": "list of absolute path"}, "languages.python.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Python Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "python", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.python.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "pkgs.pyright"}, "description": "The Python language server package to use.", "loc": ["languages", "python", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.python.manylinux.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to install manylinux2014 libraries.\n\nEnabled by default on linux;\n\nThis is useful when you want to use Python wheels that depend on manylinux2014 libraries.\n", "loc": ["languages", "python", "manylinux", "enable"], "readOnly": false, "type": "boolean"}, "languages.python.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "pkgs.python3"}, "description": "The Python package to use.", "loc": ["languages", "python", "package"], "readOnly": false, "type": "package"}, "languages.python.patches.buildEnv.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to apply fixes to Python's `buildEnv` for correct runtime initialization:\n- Executables use `--inherit-argv0` and `--resolve-argv0` to ensure Python initializes with correct `sys.prefix` and `sys.base_prefix`\n- Python package scripts are unwrapped to invoke the environment's interpreter directly\n\nWithout these fixes, Python may not initialize with the correct prefix paths.\n\nEnabled by default.\nNewer nixpkgs releases may include upstream fixes that make this patch obsolete.\n", "loc": ["languages", "python", "patches", "buildEnv", "enable"], "readOnly": false, "type": "boolean"}, "languages.python.poetry.activate.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to activate the poetry virtual environment automatically.", "loc": ["languages", "python", "poetry", "activate", "enable"], "readOnly": false, "type": "boolean"}, "languages.python.poetry.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable poetry.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "python", "poetry", "enable"], "readOnly": false, "type": "boolean"}, "languages.python.poetry.install.allExtras": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to install all extras. See `--all-extras`.", "loc": ["languages", "python", "poetry", "install", "allExtras"], "readOnly": false, "type": "boolean"}, "languages.python.poetry.install.allGroups": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to install all groups. See `--all-groups`.", "loc": ["languages", "python", "poetry", "install", "allGroups"], "readOnly": false, "type": "boolean"}, "languages.python.poetry.install.compile": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether `poetry install` should compile Python source files to bytecode.", "loc": ["languages", "python", "poetry", "install", "compile"], "readOnly": false, "type": "boolean"}, "languages.python.poetry.install.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable poetry install during devenv initialisation.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "python", "poetry", "install", "enable"], "readOnly": false, "type": "boolean"}, "languages.python.poetry.install.extras": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Which extras to install. See `--extras`.", "loc": ["languages", "python", "poetry", "install", "extras"], "readOnly": false, "type": "list of string"}, "languages.python.poetry.install.groups": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Which dependency groups to install. See `--with`.", "loc": ["languages", "python", "poetry", "install", "groups"], "readOnly": false, "type": "list of string"}, "languages.python.poetry.install.ignoredGroups": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Which dependency groups to ignore. See `--without`.", "loc": ["languages", "python", "poetry", "install", "ignoredGroups"], "readOnly": false, "type": "list of string"}, "languages.python.poetry.install.installRootPackage": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether the root package (your project) should be installed. See `--no-root`", "loc": ["languages", "python", "poetry", "install", "installRootPackage"], "readOnly": false, "type": "boolean"}, "languages.python.poetry.install.onlyGroups": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Which dependency groups to exclusively install. See `--only`.", "loc": ["languages", "python", "poetry", "install", "onlyGroups"], "readOnly": false, "type": "list of string"}, "languages.python.poetry.install.onlyInstallRootPackage": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to only install the root package (your project) should be installed, but no dependencies. See `--only-root`", "loc": ["languages", "python", "poetry", "install", "onlyInstallRootPackage"], "readOnly": false, "type": "boolean"}, "languages.python.poetry.install.quiet": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether `poetry install` should avoid outputting messages during devenv initialisation.", "loc": ["languages", "python", "poetry", "install", "quiet"], "readOnly": false, "type": "boolean"}, "languages.python.poetry.install.verbosity": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "\"no\""}, "description": "What level of verbosity the output of `poetry install` should have.", "loc": ["languages", "python", "poetry", "install", "verbosity"], "readOnly": false, "type": "one of \"no\", \"little\", \"more\", \"debug\""}, "languages.python.poetry.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "pkgs.poetry"}, "description": "The Poetry package to use.", "loc": ["languages", "python", "poetry", "package"], "readOnly": false, "type": "package"}, "languages.python.uv.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable uv.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "python", "uv", "enable"], "readOnly": false, "type": "boolean"}, "languages.python.uv.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "pkgs.uv"}, "description": "The uv package to use.", "loc": ["languages", "python", "uv", "package"], "readOnly": false, "type": "package"}, "languages.python.uv.sync.allExtras": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to install all extras. See `--all-extras`.", "loc": ["languages", "python", "uv", "sync", "allExtras"], "readOnly": false, "type": "boolean"}, "languages.python.uv.sync.allGroups": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to install all groups. See `--all-groups`.", "loc": ["languages", "python", "uv", "sync", "allGroups"], "readOnly": false, "type": "boolean"}, "languages.python.uv.sync.allPackages": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Sync all packages in the workspace. See `--all-packages`.", "loc": ["languages", "python", "uv", "sync", "allPackages"], "readOnly": false, "type": "boolean"}, "languages.python.uv.sync.arguments": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Command line arguments pass to `uv sync` during devenv initialisation.", "loc": ["languages", "python", "uv", "sync", "arguments"], "readOnly": false, "type": "list of string"}, "languages.python.uv.sync.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable uv sync during devenv initialisation.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "python", "uv", "sync", "enable"], "readOnly": false, "type": "boolean"}, "languages.python.uv.sync.extras": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Which extras to install. See `--extra`.", "loc": ["languages", "python", "uv", "sync", "extras"], "readOnly": false, "type": "list of string"}, "languages.python.uv.sync.groups": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Which dependency groups to install. See `--group`.", "loc": ["languages", "python", "uv", "sync", "groups"], "readOnly": false, "type": "list of string"}, "languages.python.uv.sync.packages": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Sync for specific packages in the workspace. See `--package`.", "loc": ["languages", "python", "uv", "sync", "packages"], "readOnly": false, "type": "list of string"}, "languages.python.venv.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Python virtual environment.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "python", "venv", "enable"], "readOnly": false, "type": "boolean"}, "languages.python.venv.quiet": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether `pip install` should avoid outputting messages during devenv initialisation.", "loc": ["languages", "python", "venv", "quiet"], "readOnly": false, "type": "boolean"}, "languages.python.venv.requirements": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Contents of pip requirements.txt file.\nThis is passed to `pip install -r` during `devenv shell` initialisation.\n", "loc": ["languages", "python", "venv", "requirements"], "readOnly": false, "type": "null or strings concatenated with \"\\n\" or absolute path"}, "languages.python.version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/python"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The Python version to use.\nThis automatically sets the `languages.python.package` using [nixpkgs-python](https://github.com/cachix/nixpkgs-python).\n", "example": {"_type": "literalExpression", "text": "\"3.11 or 3.11.2\""}, "loc": ["languages", "python", "version"], "readOnly": false, "type": "null or string"}, "languages.r.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/r.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/r.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for R development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "r", "enable"], "readOnly": false, "type": "boolean"}, "languages.r.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/r.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/r.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable R Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "r", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.r.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/r.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/r.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.rPackages.languageserver"}, "description": "The R language server package to use.", "loc": ["languages", "r", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.r.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/r.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/r.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.R"}, "description": "The R package to use.", "loc": ["languages", "r", "package"], "readOnly": false, "type": "package"}, "languages.r.radian.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/r.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/r.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable a 21 century R console.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "r", "radian", "enable"], "readOnly": false, "type": "boolean"}, "languages.r.radian.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/r.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/r.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.radianWrapper"}, "description": "The radian package to use.", "loc": ["languages", "r", "radian", "package"], "readOnly": false, "type": "package"}, "languages.racket.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/racket.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/racket.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Racket development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "racket", "enable"], "readOnly": false, "type": "boolean"}, "languages.racket.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/racket.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/racket.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.racket-minimal"}, "description": "The Racket package to use.", "loc": ["languages", "racket", "package"], "readOnly": false, "type": "package"}, "languages.raku.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/raku.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/raku.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Raku development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "raku", "enable"], "readOnly": false, "type": "boolean"}, "languages.robotframework.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/robotframework.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/robotframework.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Robot Framework development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "robotframework", "enable"], "readOnly": false, "type": "boolean"}, "languages.robotframework.python": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/robotframework.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/robotframework.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.python3"}, "description": "The Python package to use.", "loc": ["languages", "robotframework", "python"], "readOnly": false, "type": "package"}, "languages.ruby.bundler.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable bundler.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "ruby", "bundler", "enable"], "readOnly": false, "type": "boolean"}, "languages.ruby.bundler.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.bundler.override { ruby = cfg.package; }"}, "description": "The bundler package to use.", "loc": ["languages", "ruby", "bundler", "package"], "readOnly": false, "type": "package"}, "languages.ruby.documentation.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable documentation support for Ruby packages.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "ruby", "documentation", "enable"], "readOnly": false, "type": "boolean"}, "languages.ruby.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Ruby development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "ruby", "enable"], "readOnly": false, "type": "boolean"}, "languages.ruby.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Ruby Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "ruby", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.ruby.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.solargraph.override { ruby = cfg.package; }"}, "description": "The Ruby language server package to use.", "loc": ["languages", "ruby", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.ruby.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.ruby"}, "description": "The Ruby package to use.", "loc": ["languages", "ruby", "package"], "readOnly": false, "type": "package"}, "languages.ruby.version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The Ruby version to use.\nThis automatically sets the `languages.ruby.package` using [nixpkgs-ruby](https://github.com/bobvanderlinden/nixpkgs-ruby).\n", "example": {"_type": "literalExpression", "text": "\"3.2.1\""}, "loc": ["languages", "ruby", "version"], "readOnly": false, "type": "null or string"}, "languages.ruby.versionFile": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/ruby.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The .ruby-version file path to extract the Ruby version from.\nThis automatically sets the `languages.ruby.package` using [nixpkgs-ruby](https://github.com/bobvanderlinden/nixpkgs-ruby).\nWhen the `.ruby-version` file exists in the same directory as the devenv configuration, you can use:\n\n```nix\nlanguages.ruby.versionFile = ./.ruby-version;\n```\n", "example": {"_type": "literalExpression", "text": "./.ruby-version\n"}, "loc": ["languages", "ruby", "versionFile"], "readOnly": false, "type": "null or absolute path"}, "languages.rust.channel": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "\"nixpkgs\""}, "description": "The rustup toolchain to install.", "loc": ["languages", "rust", "channel"], "readOnly": false, "type": "one of \"nixpkgs\", \"stable\", \"beta\", \"nightly\""}, "languages.rust.clangLinker.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.stdenv.hostPlatform.isLinux"}, "description": "Use Clang as the Rust linker driver on Linux.\n\nThis avoids GCC's `collect2` wrapper, which can hit `Argument list too long`\nin large Nix development environments before the final linker receives\nRust's response file.\n\nOn x86_64 Linux (glibc), Clang uses LLD unless another linker is enabled.\n", "loc": ["languages", "rust", "clangLinker", "enable"], "readOnly": false, "type": "boolean"}, "languages.rust.components": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "[ \"rustc\" \"cargo\" \"clippy\" \"rustfmt\" \"rust-analyzer\" ]"}, "description": "List of [Rustup components](https://rust-lang.github.io/rustup/concepts/components.html)\nto install. Defaults to those available in `nixpkgs`.\n", "loc": ["languages", "rust", "components"], "readOnly": false, "type": "list of string"}, "languages.rust.cranelift.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Use [Cranelift](https://cranelift.dev/) as the codegen backend for dev builds.\n\nCranelift compiles significantly faster than LLVM at the cost of less optimized output.\nRequires the nightly channel.\n", "loc": ["languages", "rust", "cranelift", "enable"], "readOnly": false, "type": "boolean"}, "languages.rust.cranelift.excludePackages": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of crate names that should use the LLVM backend instead of Cranelift.\n\nGenerates per-package overrides in `.cargo/config.toml`.\n", "example": {"_type": "literalExpression", "text": "[\n \"aws-lc-sys\"\n \"aws-lc-rs\"\n \"rustls\"\n]"}, "loc": ["languages", "rust", "cranelift", "excludePackages"], "readOnly": false, "type": "list of string"}, "languages.rust.cranelift.forceBuildScriptsLlvm": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Force build scripts and proc macros to use the LLVM backend.\n\nSome build scripts may not work with Cranelift. Enable this to fall back to\nLLVM for build scripts while keeping Cranelift for regular code.\n", "loc": ["languages", "rust", "cranelift", "forceBuildScriptsLlvm"], "readOnly": false, "type": "boolean"}, "languages.rust.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Rust development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "rust", "enable"], "readOnly": false, "type": "boolean"}, "languages.rust.import": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "description": "Import a Cargo project using crate2nix.\n\nThis function takes a path to a directory containing a Cargo.toml file\nand returns a derivation that builds the Rust project using crate2nix.\n\nExample usage:\n```nix\nlet\nmypackage = config.languages.rust.import ./path/to/cargo/project {};\nin {\nlanguages.rust.enable = true;\npackages = [ mypackage ];\n}\n```\n", "loc": ["languages", "rust", "import"], "readOnly": false, "type": "function that evaluates to a(n) function that evaluates to a(n) package"}, "languages.rust.lld.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Use [lld](https://lld.llvm.org/) as the linker.\n\nlld is LLVM's linker and is the recommended fast linker for Darwin.\nWorks on both Linux and macOS.\n", "loc": ["languages", "rust", "lld", "enable"], "readOnly": false, "type": "boolean"}, "languages.rust.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Rust Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "rust", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.rust.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalMD", "text": "Depends on the configured toolchain:\n- `nixpkgs` channel: `pkgs.rust-analyzer`.\n- non-nixpkgs channel: the `rust-analyzer` component from the rust-overlay toolchain, with a fallback to `pkgs.rust-analyzer` if not present in the manifest.\n- `toolchainFile`: the aggregated toolchain package derived from the file.\n"}, "description": "The Rust language server package to use.", "loc": ["languages", "rust", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.rust.mold.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Use [mold](https://github.com/rui314/mold) as the linker.\n\nmold is a faster drop-in replacement for existing Unix linkers.\nIt is several times quicker than the LLVM lld linker.\n", "loc": ["languages", "rust", "mold", "enable"], "readOnly": false, "type": "boolean"}, "languages.rust.rustdocflags": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Extra flags to pass to Rustdoc.", "loc": ["languages", "rust", "rustdocflags"], "readOnly": false, "type": "string"}, "languages.rust.rustflags": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Extra flags to pass to the Rust compiler.", "loc": ["languages", "rust", "rustflags"], "readOnly": false, "type": "string"}, "languages.rust.targets": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of extra [targets](https://doc.rust-lang.org/nightly/rustc/platform-support.html)\nto install. Defaults to only the native target.\n", "loc": ["languages", "rust", "targets"], "readOnly": false, "type": "list of string"}, "languages.rust.toolchain": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "nixpkgs"}, "description": "Rust component packages. May optionally define additional components, for example `miri`.", "loc": ["languages", "rust", "toolchain"], "readOnly": false, "type": "open submodule of attribute set of package"}, "languages.rust.toolchain.cargo": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.cargo"}, "description": "cargo package", "loc": ["languages", "rust", "toolchain", "cargo"], "readOnly": false, "type": "null or package"}, "languages.rust.toolchain.clippy": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.clippy"}, "description": "clippy package", "loc": ["languages", "rust", "toolchain", "clippy"], "readOnly": false, "type": "null or package"}, "languages.rust.toolchain.rust-analyzer": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.rust-analyzer"}, "description": "rust-analyzer package", "loc": ["languages", "rust", "toolchain", "rust-analyzer"], "readOnly": false, "type": "null or package"}, "languages.rust.toolchain.rustc": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.rustc"}, "description": "rustc package", "loc": ["languages", "rust", "toolchain", "rustc"], "readOnly": false, "type": "null or package"}, "languages.rust.toolchain.rustfmt": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.rustfmt"}, "description": "rustfmt package", "loc": ["languages", "rust", "toolchain", "rustfmt"], "readOnly": false, "type": "null or package"}, "languages.rust.toolchainFile": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Path to a `rust-toolchain` or `rust-toolchain.toml` file for automatic toolchain configuration.\n\nWhen set, devenv will use rust-overlay's `fromRustupToolchainFile` to automatically\nconfigure the toolchain based on the file contents (channel, components, targets, profile).\n\nThis follows the standard Rust toolchain file format documented at:\nhttps://rust-lang.github.io/rustup/overrides.html#the-toolchain-file\n\nCannot be used together with manual `channel` or `version` configuration.\n\nExample:\n```nix\nlanguages.rust.toolchainFile = ./rust-toolchain.toml;\n```\n", "example": {"_type": "literalExpression", "text": "./rust-toolchain.toml"}, "loc": ["languages", "rust", "toolchainFile"], "readOnly": false, "type": "null or absolute path"}, "languages.rust.toolchainPackage": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "description": "The aggregated toolchain package, which includes the configured components and targets.\nThis is automatically set based on the channel and components configuration.\n", "loc": ["languages", "rust", "toolchainPackage"], "readOnly": false, "type": "package"}, "languages.rust.version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "\"latest\""}, "description": "Which version of rust to use, this value could be `latest`,`1.81.0`, `2021-01-01`.\nOnly works when languages.rust.channel is NOT nixpkgs.\n", "loc": ["languages", "rust", "version"], "readOnly": false, "type": "string"}, "languages.rust.wild.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/rust.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Use [wild](https://github.com/wild-linker/wild) as the linker.\n\nwild is a very fast linker for Linux.\n", "loc": ["languages", "rust", "wild", "enable"], "readOnly": false, "type": "boolean"}, "languages.scala.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Scala development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "scala", "enable"], "readOnly": false, "type": "boolean"}, "languages.scala.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Scala Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "scala", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.scala.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.metals"}, "description": "The Scala language server package to use.", "loc": ["languages", "scala", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.scala.mill.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable mill, a simplified, fast build tool for Scala.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "scala", "mill", "enable"], "readOnly": false, "type": "boolean"}, "languages.scala.mill.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.mill"}, "description": "The mill package to use.", "loc": ["languages", "scala", "mill", "package"], "readOnly": false, "type": "package"}, "languages.scala.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.scala_3"}, "description": "The Scala package to use.\n", "loc": ["languages", "scala", "package"], "readOnly": false, "type": "package"}, "languages.scala.sbt.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable sbt, the standard build tool for Scala.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "scala", "sbt", "enable"], "readOnly": false, "type": "boolean"}, "languages.scala.sbt.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/scala.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.sbt"}, "description": "The sbt package to use.", "example": {"_type": "literalExpression", "text": "sbt-with-scala-native"}, "loc": ["languages", "scala", "sbt", "package"], "readOnly": false, "type": "package"}, "languages.shell.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/shell.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/shell.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for shell development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "shell", "enable"], "readOnly": false, "type": "boolean"}, "languages.shell.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/shell.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/shell.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Shell Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "shell", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.shell.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/shell.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/shell.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.bash-language-server"}, "description": "The Shell language server package to use.", "loc": ["languages", "shell", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.solidity.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/solidity.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/solidity.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Solidity development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "solidity", "enable"], "readOnly": false, "type": "boolean"}, "languages.solidity.foundry.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/solidity.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/solidity.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable install Foundry.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "solidity", "foundry", "enable"], "readOnly": false, "type": "boolean"}, "languages.solidity.foundry.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/solidity.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/solidity.nix"}], "default": {"_type": "literalExpression", "text": "foundry.defaultPackage.$${pkgs.stdenv.system}"}, "description": "Which Foundry package to use.", "loc": ["languages", "solidity", "foundry", "package"], "readOnly": false, "type": "package"}, "languages.solidity.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/solidity.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/solidity.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.solc"}, "description": "Which compiler of Solidity to use.", "loc": ["languages", "solidity", "package"], "readOnly": false, "type": "package"}, "languages.standardml.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/standardml.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/standardml.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Standard ML development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "standardml", "enable"], "readOnly": false, "type": "boolean"}, "languages.standardml.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/standardml.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/standardml.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Standard ML Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "standardml", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.standardml.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/standardml.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/standardml.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.millet"}, "description": "The Standard ML language server package to use.", "loc": ["languages", "standardml", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.standardml.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/standardml.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/standardml.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.mlton"}, "description": "The Standard ML package to use.\n", "loc": ["languages", "standardml", "package"], "readOnly": false, "type": "package"}, "languages.swift.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/swift.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/swift.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Swift development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "swift", "enable"], "readOnly": false, "type": "boolean"}, "languages.swift.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/swift.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/swift.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Swift Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "swift", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.swift.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/swift.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/swift.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.sourcekit-lsp"}, "description": "The Swift language server package to use.", "loc": ["languages", "swift", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.swift.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/swift.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/swift.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.swift"}, "description": "The Swift package to use.\n", "loc": ["languages", "swift", "package"], "readOnly": false, "type": "package"}, "languages.terraform.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/terraform.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/terraform.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Terraform development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "terraform", "enable"], "readOnly": false, "type": "boolean"}, "languages.terraform.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/terraform.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/terraform.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Terraform Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "terraform", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.terraform.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/terraform.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/terraform.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.terraform-ls"}, "description": "The Terraform language server package to use.", "loc": ["languages", "terraform", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.terraform.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/terraform.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/terraform.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.terraform"}, "description": "The Terraform package to use.", "loc": ["languages", "terraform", "package"], "readOnly": false, "type": "package"}, "languages.terraform.version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/terraform.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/terraform.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The Terraform version to use.\nThis automatically sets the `languages.terraform.package` using [nixpkgs-terraform](https://github.com/stackbuilders/nixpkgs-terraform).\n", "example": {"_type": "literalExpression", "text": "\"1.5.0 or 1.6.2\""}, "loc": ["languages", "terraform", "version"], "readOnly": false, "type": "null or string"}, "languages.texlive.base": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/texlive.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/texlive.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.texliveSmall"}, "description": "TeX Live package set to use", "example": {"_type": "literalExpression", "text": "pkgs.texliveBasic"}, "loc": ["languages", "texlive", "base"], "readOnly": false, "type": "unspecified value"}, "languages.texlive.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/texlive.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/texlive.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable TeX Live.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "texlive", "enable"], "readOnly": false, "type": "boolean"}, "languages.texlive.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/texlive.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/texlive.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable TeX Live Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "texlive", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.texlive.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/texlive.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/texlive.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.texlab"}, "description": "The TeX Live language server package to use.", "loc": ["languages", "texlive", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.texlive.packages": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/texlive.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/texlive.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Extra packages to add to the base TeX Live set", "example": {"_type": "literalExpression", "text": "[\n \"algorithms\"\n \"latexmk\"\n]"}, "loc": ["languages", "texlive", "packages"], "readOnly": false, "type": "list of string"}, "languages.typescript.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typescript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typescript.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for TypeScript development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "typescript", "enable"], "readOnly": false, "type": "boolean"}, "languages.typescript.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typescript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typescript.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable TypeScript Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "typescript", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.typescript.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typescript.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typescript.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.typescript-language-server"}, "description": "The TypeScript language server package to use.", "loc": ["languages", "typescript", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.typst.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typst.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typst.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Typst development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "typst", "enable"], "readOnly": false, "type": "boolean"}, "languages.typst.fontPaths": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typst.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typst.nix"}], "default": {"_type": "literalExpression", "text": "[]"}, "description": "Directories to be searched for fonts.", "example": {"_type": "literalExpression", "text": "[ \"${pkgs.roboto}/share/fonts/truetype\" ]"}, "loc": ["languages", "typst", "fontPaths"], "readOnly": false, "type": "list of string"}, "languages.typst.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typst.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typst.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Typst Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "typst", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.typst.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typst.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typst.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.tinymist"}, "description": "The Typst language server package to use.", "loc": ["languages", "typst", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.typst.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typst.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/typst.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.typst"}, "description": "Which package of Typst to use.", "loc": ["languages", "typst", "package"], "readOnly": false, "type": "package"}, "languages.unison.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/unison.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/unison.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Unison development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "unison", "enable"], "readOnly": false, "type": "boolean"}, "languages.unison.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/unison.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/unison.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.unison-ucm"}, "description": "Which package of Unison to use", "loc": ["languages", "unison", "package"], "readOnly": false, "type": "package"}, "languages.v.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/v.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/v.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for V development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "v", "enable"], "readOnly": false, "type": "boolean"}, "languages.v.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/v.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/v.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.vlang"}, "description": "The V package to use.", "loc": ["languages", "v", "package"], "readOnly": false, "type": "package"}, "languages.vala.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/vala.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/vala.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Vala development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "vala", "enable"], "readOnly": false, "type": "boolean"}, "languages.vala.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/vala.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/vala.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Vala Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "vala", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.vala.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/vala.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/vala.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.vala-language-server"}, "description": "The Vala language server package to use.", "loc": ["languages", "vala", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.vala.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/vala.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/vala.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.vala"}, "description": "The Vala package to use.", "example": {"_type": "literalExpression", "text": "pkgs.vala_0_54"}, "loc": ["languages", "vala", "package"], "readOnly": false, "type": "package"}, "languages.zig.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/zig.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/zig.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tools for Zig development.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "zig", "enable"], "readOnly": false, "type": "boolean"}, "languages.zig.lsp.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/zig.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/zig.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable Zig Language Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["languages", "zig", "lsp", "enable"], "readOnly": false, "type": "boolean"}, "languages.zig.lsp.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/zig.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/zig.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.zls"}, "description": "The Zig language server package to use.", "loc": ["languages", "zig", "lsp", "package"], "readOnly": false, "type": "package"}, "languages.zig.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/zig.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/zig.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.zig"}, "description": "Which package of Zig to use.", "loc": ["languages", "zig", "package"], "readOnly": false, "type": "package"}, "languages.zig.version": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/languages/zig.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/languages/zig.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The Zig version to use.\nThis sets `languages.zig.package` using [zig-overlay](https://github.com/mitchellh/zig-overlay)\nand `languages.zig.lsp.package` using the matching [ZLS](https://github.com/zigtools/zls) release.\n", "example": {"_type": "literalExpression", "text": "\"0.15.1\""}, "loc": ["languages", "zig", "version"], "readOnly": false, "type": "null or string"}, "machines": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Machines for NixOS, home-manager, and nix-darwin.", "loc": ["machines"], "readOnly": false, "type": "attribute set of (submodule)"}, "machines..deploy.healthCheck": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "\"true\""}, "description": "Root shell commands run on the target after transactional NixOS activation.\nA nonzero exit or failure to finish before `deploy.rollbackTimeout`\nprevents confirmation and triggers rollback at the deadline.\nUse absolute store paths for required tools.\n", "loc": ["machines", "", "deploy", "healthCheck"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "machines..deploy.rollbackTimeout": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "300"}, "description": "Seconds allowed for transactional activation, health checks and SSH\nconfirmation together. A target-side watchdog restores the previous\nsystem if this deadline expires without confirmation.\n", "loc": ["machines", "", "deploy", "rollbackTimeout"], "readOnly": false, "type": "integer between 30 and 600 (both inclusive)"}, "machines..hardware": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Hardware detection settings for this machine.", "loc": ["machines", "", "hardware"], "readOnly": false, "type": "submodule"}, "machines..hardware.facter": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "\".machines/${name}/facter.json\""}, "description": "Path to the [nixos-facter](https://github.com/nix-community/nixos-facter) hardware report for this machine.\n\nAccepts either a Nix path literal or a string path relative to the devenv project root.\nDefaults to `.machines//facter.json`, which `devenv machines install` generates\non first run by probing the target over SSH. The report must be committed to git so that\nteammates and CI can build the machine closure without reaching the target.\n\nSet to `null` to opt this machine out of facter, for example when it carries a hand written\n`hardware-configuration.nix` instead. Only applies to machines with a `nixos` module set;\n`nix-darwin` and `home-manager` entries ignore this option.\n", "example": {"_type": "literalExpression", "text": "./hardware/web1.json"}, "loc": ["machines", "", "hardware", "facter"], "readOnly": false, "type": "null or absolute path or string"}, "machines..home-manager": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Home Manager configuration for the machine.", "example": {"_type": "literalExpression", "text": "{\n home.username = \"jdoe\";\n home.homeDirectory = \"/home/jdoe\";\n programs.git.enable = true;\n}\n"}, "loc": ["machines", "", "home-manager"], "readOnly": false, "type": "null or unspecified value"}, "machines..install": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Install-time settings for `devenv machines install`.", "loc": ["machines", "", "install"], "readOnly": false, "type": "submodule"}, "machines..install.copyHostKeys": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Copy `/etc/ssh/ssh_host_*` from the live installer into the\ninstalled system before reboot. This keeps the SSH identity\nstable between the post-kexec installer and the first boot, so\nthat identity's `known_hosts` entry keeps working.\n", "loc": ["machines", "", "install", "copyHostKeys"], "readOnly": false, "type": "boolean"}, "machines..install.encryptionKeys": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Keyfiles dropped onto the installer **before disko runs**, so LUKS\nlayouts with `passwordFile = \"/tmp/luks.key\"` can unlock. Attribute\nnames are absolute target paths on the installer; values are local\nsource paths (string, absolute or relative to the devenv project root)\non the host running `devenv machines install`. Strings \u2014 not Nix path\nliterals \u2014 so LUKS keys never enter `/nix/store`.\n", "example": {"_type": "literalExpression", "text": "{\n \"/tmp/luks.key\" = \"secrets/luks.key\";\n}\n"}, "loc": ["machines", "", "install", "encryptionKeys"], "readOnly": false, "type": "attribute set of string"}, "machines..install.extraFiles": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Files to copy onto the installed system after `nixos-install` but\nbefore reboot. Attribute names are absolute target paths (e.g.\n`\"/var/lib/secret-age-key\"`). Use this for age/sops master keys,\nSSH host keys, or `/var/lib/*` seeds that need to exist on first boot.\nMatches nixos-anywhere's `--extra-files` and `--chown`.\n", "example": {"_type": "literalExpression", "text": "{\n \"/var/lib/secret-age-key\" = {\n source = \"secrets/age.key\";\n owner = \"0:0\";\n mode = \"0600\";\n };\n}\n"}, "loc": ["machines", "", "install", "extraFiles"], "readOnly": false, "type": "attribute set of (submodule)"}, "machines..install.extraFiles..mode": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "\"0644\""}, "description": "File mode applied via chmod on the target.", "loc": ["machines", "", "install", "extraFiles", "", "mode"], "readOnly": false, "type": "string"}, "machines..install.extraFiles..owner": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "\"0:0\""}, "description": "Numeric owner in `uid:gid` format applied via chown on the target.", "loc": ["machines", "", "install", "extraFiles", "", "owner"], "readOnly": false, "type": "string"}, "machines..install.extraFiles..source": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "description": "Local path to the file to copy onto the installed system.\nAccepts an absolute path or a path relative to the devenv project root.\nMust be a string (not a Nix path literal) so secrets stay on the host\nrunning `devenv machines install` and never enter `/nix/store`.\n", "loc": ["machines", "", "install", "extraFiles", "", "source"], "readOnly": false, "type": "string"}, "machines..install.kexec": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Kexec override settings for `devenv machines install`.", "loc": ["machines", "", "install", "kexec"], "readOnly": false, "type": "submodule"}, "machines..install.kexec.image": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Override the default nixos-images kexec tarball URL. Set this for\ncustom installer images, non-standard architectures, or VPN-enabled\ninstallers. Must be an HTTP(S) URL fetched on the remote target.\n", "example": {"_type": "literalExpression", "text": "\"https://example.com/custom-kexec-aarch64.tar.gz\""}, "loc": ["machines", "", "install", "kexec", "image"], "readOnly": false, "type": "null or string"}, "machines..install.kexec.postSshPort": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "SSH port to reconnect to after kexec lands in the installer. Set\nthis when the live sshd on the target listens on a non-22 port. All\nsubsequent install phases (facter, disko, nixos-install) use this\nport.\n", "example": {"_type": "literalExpression", "text": "2222"}, "loc": ["machines", "", "install", "kexec", "postSshPort"], "readOnly": false, "type": "null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "machines..install.secrets": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Bootstrap files populated from the active SecretSpec profile\nafter `nixos-install` and before reboot. Attribute names are\nabsolute paths in the installed system. Local execution streams\nvalues over strictly authenticated SSH; target execution sends\nonly a self-contained declaration manifest and fetches values\non the installer.\nBoth modes atomically install files without placing values in\n`/nix/store`.\n\nLocal execution requires SecretSpec to be enabled in\n`devenv.yaml`; use the global `--secretspec-provider` and\n`--secretspec-profile` flags to select its source. Target\nexecution only requires `secretspec.toml` and leaves provider\nand profile selection to the target unless explicitly overridden\nby `install.secretspec`.\n", "example": {"_type": "literalExpression", "text": "{\n \"/var/lib/sops-nix/key.txt\" = {\n secret = \"WEB1_AGE_KEY\";\n owner = \"0:0\";\n mode = \"0600\";\n };\n}\n"}, "loc": ["machines", "", "install", "secrets"], "readOnly": false, "type": "attribute set of (submodule)"}, "machines..install.secrets..mode": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "\"0600\""}, "description": "File mode applied via chmod on the target. Special and\nexecute bits, group write, and every permission for\nother users are rejected. Modes such as 0400, 0600, and\n0640 are accepted.\n", "loc": ["machines", "", "install", "secrets", "", "mode"], "readOnly": false, "type": "string"}, "machines..install.secrets..owner": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "\"0:0\""}, "description": "Numeric owner in `uid:gid` format applied via chown on the target.", "loc": ["machines", "", "install", "secrets", "", "owner"], "readOnly": false, "type": "string"}, "machines..install.secrets..secret": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "description": "Name of the secret in the active SecretSpec profile. The\nvalue is resolved at install time according to\n`install.secretspec.execution` and is never included in\nmachine metadata or a Nix store path.\n", "example": {"_type": "literalExpression", "text": "\"WEB1_AGE_KEY\""}, "loc": ["machines", "", "install", "secrets", "", "secret"], "readOnly": false, "type": "string"}, "machines..install.secretspec": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "How install-time SecretSpec bootstrap values are resolved.", "loc": ["machines", "", "install", "secretspec"], "readOnly": false, "type": "submodule"}, "machines..install.secretspec.execution": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "\"local\""}, "description": "Where SecretSpec resolves bootstrap values. `local`\nresolves on the workstation and streams values over SSH.\n`target` sends only a self-contained SecretSpec manifest and\nresolves through the provider on the installer machine.\n", "loc": ["machines", "", "install", "secretspec", "execution"], "readOnly": false, "type": "one of \"local\", \"target\""}, "machines..install.secretspec.extraPackages": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "_targetPkgs: [ ]"}, "description": "Function selecting additional target-architecture packages\nrequired by the chosen SecretSpec providers, such as `sops`\nor `pass`. These packages are included in a private resolver\nruntime for target execution, not the system-wide command\nnamespace.\n", "example": {"_type": "literalExpression", "text": "targetPkgs: [ targetPkgs.sops targetPkgs.pass ]"}, "loc": ["machines", "", "install", "secretspec", "extraPackages"], "readOnly": false, "type": "function that evaluates to a(n) list of package"}, "machines..install.secretspec.profile": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Explicit target-side profile override. When unset, devenv\ndoes not pass `--profile`; SecretSpec selects the profile\nfrom the target environment or target-global configuration,\nfalling back to `default`. The workstation profile is never\ninherited.\n", "loc": ["machines", "", "install", "secretspec", "profile"], "readOnly": false, "type": "null or string"}, "machines..install.secretspec.provider": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Explicit target-side provider override. When unset, devenv\ndoes not pass `--provider`; SecretSpec selects providers\nfrom the manifest, target environment, and target-global\nconfiguration. The workstation provider is never inherited.\nProvider credentials must be available independently on the\ninstaller and are never forwarded by devenv. This option is\nnon-secret metadata and must not contain credentials; use a\nprovider alias or target-global configuration instead.\n", "loc": ["machines", "", "install", "secretspec", "provider"], "readOnly": false, "type": "null or string"}, "machines..nix-darwin": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "nix-darwin configuration for the machine.", "example": {"_type": "literalExpression", "text": "{ pkgs, ... }: {\n environment.systemPackages = [\n pkgs.vim\n ];\n services.nix-daemon.enable = true;\n}\n"}, "loc": ["machines", "", "nix-darwin"], "readOnly": false, "type": "null or unspecified value"}, "machines..nixos": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "NixOS configuration for the machine.", "example": {"_type": "literalExpression", "text": "{\n fileSystems.\"/\".device = \"/dev/sda1\";\n boot.loader.systemd-boot.enable = true;\n services.openssh.enable = true;\n}\n"}, "loc": ["machines", "", "nixos"], "readOnly": false, "type": "null or unspecified value"}, "machines..system": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.stdenv.system"}, "description": "System architecture for the machine.", "example": {"_type": "literalExpression", "text": "\"x86_64-linux\""}, "loc": ["machines", "", "system"], "readOnly": false, "type": "string"}, "machines..target": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "SSH destination for install and deploy. See the `target.host` and `target.sshOpts` suboptions.", "loc": ["machines", "", "target"], "readOnly": false, "type": "submodule"}, "machines..target.host": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "SSH destination used by `devenv machines install` and `devenv machines deploy`.\nAccepts `user@host`, `user@host:port`, or a full `ssh://user@host:port` URI.\nLeave unset to activate in process on the current host; this is only valid for `home-manager`.\nSetting it to `\"localhost\"` is not the same as omitting it: `\"localhost\"` still routes through SSH.\n", "example": {"_type": "literalExpression", "text": "\"root@laptop.local\""}, "loc": ["machines", "", "target", "host"], "readOnly": false, "type": "null or string"}, "machines..target.sshOpts": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/machines.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Extra `ssh -o` options applied before devenv's defaults\n(`StrictHostKeyChecking=accept-new` and a bounded `ConnectTimeout`).\nOpenSSH keeps the first value for most settings, so this list\noverrides the defaults. Installs that transmit SecretSpec bootstrap\nvalues, encryption keys, or extra files force stricter\nnon-overridable SSH settings.\n", "example": {"_type": "literalExpression", "text": "[ \"-o\" \"IdentitiesOnly=yes\" \"-o\" \"ConnectTimeout=10\" ]"}, "loc": ["machines", "", "target", "sshOpts"], "readOnly": false, "type": "list of string"}, "name": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix"}], "default": {"_type": "literalExpression", "text": "\"devenv-shell\""}, "description": "Name of the project.", "loc": ["name"], "readOnly": false, "type": "null or string"}, "opencode.agents": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Custom agents (placed in .opencode/agents/).\n\nThis option can either be:\n- an attribute set of agents, or\n- a path to a directory containing agent files.\n", "example": {"_type": "literalExpression", "text": "{\n \"code-reviewer\" = ''\n # Code Review Agent\n Review code for best practices and potential issues.\n '';\n \"documentation-writer\" = ./agents/doc-writer.md;\n}\n"}, "loc": ["opencode", "agents"], "readOnly": false, "type": "(attribute set of (strings concatenated with \"\\n\" or absolute path)) or absolute path"}, "opencode.commands": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Custom slash commands (placed in .opencode/commands/).\n\nThis option can either be:\n- an attribute set of commands, or\n- a path to a directory containing command files.\n", "example": {"_type": "literalExpression", "text": "{\n \"fix-tests\" = ''\n # Fix Tests Command\n Analyze failing tests and suggest fixes.\n '';\n \"review-pr\" = ./commands/review-pr.md;\n}\n"}, "loc": ["opencode", "commands"], "readOnly": false, "type": "(attribute set of (strings concatenated with \"\\n\" or absolute path)) or absolute path"}, "opencode.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable OpenCode configuration.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["opencode", "enable"], "readOnly": false, "type": "boolean"}, "opencode.mcp": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "MCP servers written to `opencode.jsonc` under `mcp`.\n\nThis option mirrors OpenCode's MCP configuration shape directly\n(`local`/`remote`, `command`, `environment`, `url`, `headers`,\n`oauth`, `enabled`, `timeout`, etc.).\n\nValues from `opencode.settings.mcp` take precedence over this option\nwhen both define the same MCP server name.\n", "example": {"_type": "literalExpression", "text": "{\n my-local = {\n type = \"local\";\n command = [ \"devenv\" \"mcp\" ];\n environment = {\n DEVENV_ROOT = \"{env:DEVENV_ROOT}\";\n };\n };\n\n context7 = {\n type = \"remote\";\n url = \"https://mcp.example.com\";\n headers = {\n Authorization = \"Bearer TOKEN\";\n };\n };\n}\n"}, "loc": ["opencode", "mcp"], "readOnly": false, "type": "attribute set of anything"}, "opencode.rules": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Global custom instructions (placed in .opencode/AGENTS.md).", "example": {"_type": "literalExpression", "text": "# Custom Development Rules\n- Always write tests\n- Use conventional commits\n- Document public APIs\n"}, "loc": ["opencode", "rules"], "readOnly": false, "type": "strings concatenated with \"\\n\" or absolute path"}, "opencode.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Attributes written to opencode.jsonc.", "example": {"_type": "literalExpression", "text": "{\n editor = \"nvim\";\n theme = \"dark\";\n features = {\n autocomplete = true;\n git_integration = true;\n };\n}\n"}, "loc": ["opencode", "settings"], "readOnly": false, "type": "attribute set of anything"}, "opencode.skills": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Custom skills for opencode.\n\nThis option can either be:\n- an attribute set defining skills, or\n- a path to a directory containing skill folders.\n\nIf an attribute set is used, each value can be:\n- inline content (creates `.opencode/skills//SKILL.md`)\n- a path to a file (creates `.opencode/skills//SKILL.md`)\n- a path to a directory (creates `.opencode/skills//`)\n", "example": {"_type": "literalExpression", "text": "{\n \"debug-helper\" = ''\n # Debug Helper Skill\n Helps diagnose and fix bugs systematically.\n '';\n \"api-generator\" = ./skills/api-generator.md;\n \"full-stack-skill\" = ./skills/full-stack;\n}\n"}, "loc": ["opencode", "skills"], "readOnly": false, "type": "(attribute set of (strings concatenated with \"\\n\" or absolute path or string)) or absolute path"}, "opencode.themes": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Custom themes for opencode.\n\nThis option can either be:\n- an attribute set defining themes, or\n- a path to a directory containing theme files.\n", "example": {"_type": "literalExpression", "text": "{\n my-theme = {\n colors = {\n background = \"#0f1115\";\n foreground = \"#d6d9e0\";\n };\n };\n custom = ./themes/custom.json;\n}\n"}, "loc": ["opencode", "themes"], "readOnly": false, "type": "(attribute set of ((attribute set of anything) or absolute path)) or absolute path"}, "opencode.tools": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Custom tools for opencode.\n\nThis option can either be:\n- an attribute set defining tools, or\n- a path to a directory containing tool files.\n", "example": {"_type": "literalExpression", "text": "{\n sample = \"export default { name: \\\"sample-tool\\\"; };\";\n lint = ./tools/lint.ts;\n}\n"}, "loc": ["opencode", "tools"], "readOnly": false, "type": "(attribute set of (strings concatenated with \"\\n\" or absolute path)) or absolute path"}, "opencode.web.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable opencode web service.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["opencode", "web", "enable"], "readOnly": false, "type": "boolean"}, "opencode.web.extraArgs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/opencode.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Extra arguments to pass to `opencode web`.\n\nThese arguments override web server options in the configuration file.\n", "example": {"_type": "literalExpression", "text": "[\n \"--hostname\"\n \"127.0.0.1\"\n \"--port\"\n \"4096\"\n]"}, "loc": ["opencode", "web", "extraArgs"], "readOnly": false, "type": "list of string"}, "outputs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/outputs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/outputs.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Nix outputs for `devenv build` consumption.\n", "example": {"_type": "literalExpression", "text": "{\n git = pkgs.git;\n foo = {\n ncdu = pkgs.ncdu;\n };\n}\n"}, "loc": ["outputs"], "readOnly": false, "type": "outputOf (attribute set)"}, "overlays": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of overlays to apply to pkgs. Each overlay is a function that takes two arguments: final and prev. Supported by devenv 1.4.2 or newer.", "example": {"_type": "literalExpression", "text": "[\n (final: prev: {\n hello = prev.hello.overrideAttrs (oldAttrs: {\n patches = (oldAttrs.patches or []) ++ [ ./hello-fix.patch ];\n });\n })\n]\n"}, "loc": ["overlays"], "readOnly": false, "type": "list of function that evaluates to a(n) function that evaluates to a(n) (attribute set)"}, "packages": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "A list of packages to expose inside the developer environment. Search available packages using ``devenv search NAME``.", "loc": ["packages"], "readOnly": false, "type": "list of package"}, "process.manager.adapter.client": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "description": "Client protocol used for attach, readiness, and individual process control.", "loc": ["process", "manager", "adapter", "client"], "readOnly": false, "type": "one of \"none\", \"native-api\""}, "process.manager.adapter.stop": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "description": "Adapter used to stop the running manager.", "loc": ["process", "manager", "adapter", "stop"], "readOnly": false, "type": "one of \"native-api\", \"command\", \"process-scope\""}, "process.manager.adapter.terminal": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "description": "Terminal required by the manager launcher.", "loc": ["process", "manager", "adapter", "terminal"], "readOnly": false, "type": "one of \"none\", \"controlling\""}, "process.manager.after": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Bash code to execute after stopping processes.", "loc": ["process", "manager", "after"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "process.manager.args": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "description": "Additional arguments to pass to the process manager.\n", "loc": ["process", "manager", "args"], "readOnly": false, "type": "attribute set"}, "process.manager.before": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Bash code to execute before starting processes.", "loc": ["process", "manager", "before"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "process.manager.capabilities.background_start": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "description": "Whether the manager can remain running after the launching client exits.", "loc": ["process", "manager", "capabilities", "background_start"], "readOnly": false, "type": "boolean"}, "process.manager.capabilities.cold_start_subset": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "description": "Whether the manager can initially start a named subset of processes.", "loc": ["process", "manager", "capabilities", "cold_start_subset"], "readOnly": false, "type": "boolean"}, "process.manager.capabilities.devenv_attach": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "description": "Whether devenv can attach its interactive client to an existing manager.", "loc": ["process", "manager", "capabilities", "devenv_attach"], "readOnly": false, "type": "boolean"}, "process.manager.capabilities.individual_control": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "description": "Whether devenv can start, stop, and restart individual processes through the manager.", "loc": ["process", "manager", "capabilities", "individual_control"], "readOnly": false, "type": "boolean"}, "process.manager.capabilities.wait_ready": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "description": "Whether devenv can wait for process readiness through the manager.", "loc": ["process", "manager", "capabilities", "wait_ready"], "readOnly": false, "type": "boolean"}, "process.manager.implementation": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalMD", "text": "`native` for devenv 2.0+, `process-compose` otherwise"}, "description": "The process manager to use when running processes with ``devenv up``.", "example": {"_type": "literalExpression", "text": "\"process-compose\""}, "loc": ["process", "manager", "implementation"], "readOnly": false, "type": "one of \"hivemind\", \"honcho\", \"mprocs\", \"native\", \"overmind\", \"process-compose\""}, "process.managers.hivemind.adapter.client": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix"}], "description": "Client protocol used for attach, readiness, and individual process control.", "loc": ["process", "managers", "hivemind", "adapter", "client"], "readOnly": false, "type": "one of \"none\", \"native-api\""}, "process.managers.hivemind.adapter.stop": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix"}], "description": "Adapter used to stop the running manager.", "loc": ["process", "managers", "hivemind", "adapter", "stop"], "readOnly": false, "type": "one of \"native-api\", \"command\", \"process-scope\""}, "process.managers.hivemind.adapter.terminal": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix"}], "description": "Terminal required by the manager launcher.", "loc": ["process", "managers", "hivemind", "adapter", "terminal"], "readOnly": false, "type": "one of \"none\", \"controlling\""}, "process.managers.hivemind.capabilities.background_start": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix"}], "description": "Whether the manager can remain running after the launching client exits.", "loc": ["process", "managers", "hivemind", "capabilities", "background_start"], "readOnly": false, "type": "boolean"}, "process.managers.hivemind.capabilities.cold_start_subset": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix"}], "description": "Whether the manager can initially start a named subset of processes.", "loc": ["process", "managers", "hivemind", "capabilities", "cold_start_subset"], "readOnly": false, "type": "boolean"}, "process.managers.hivemind.capabilities.devenv_attach": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix"}], "description": "Whether devenv can attach its interactive client to an existing manager.", "loc": ["process", "managers", "hivemind", "capabilities", "devenv_attach"], "readOnly": false, "type": "boolean"}, "process.managers.hivemind.capabilities.individual_control": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix"}], "description": "Whether devenv can start, stop, and restart individual processes through the manager.", "loc": ["process", "managers", "hivemind", "capabilities", "individual_control"], "readOnly": false, "type": "boolean"}, "process.managers.hivemind.capabilities.wait_ready": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix"}], "description": "Whether devenv can wait for process readiness through the manager.", "loc": ["process", "managers", "hivemind", "capabilities", "wait_ready"], "readOnly": false, "type": "boolean"}, "process.managers.hivemind.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/hivemind.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.hivemind"}, "description": "The hivemind package to use.", "loc": ["process", "managers", "hivemind", "package"], "readOnly": false, "type": "package"}, "process.managers.honcho.adapter.client": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix"}], "description": "Client protocol used for attach, readiness, and individual process control.", "loc": ["process", "managers", "honcho", "adapter", "client"], "readOnly": false, "type": "one of \"none\", \"native-api\""}, "process.managers.honcho.adapter.stop": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix"}], "description": "Adapter used to stop the running manager.", "loc": ["process", "managers", "honcho", "adapter", "stop"], "readOnly": false, "type": "one of \"native-api\", \"command\", \"process-scope\""}, "process.managers.honcho.adapter.terminal": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix"}], "description": "Terminal required by the manager launcher.", "loc": ["process", "managers", "honcho", "adapter", "terminal"], "readOnly": false, "type": "one of \"none\", \"controlling\""}, "process.managers.honcho.capabilities.background_start": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix"}], "description": "Whether the manager can remain running after the launching client exits.", "loc": ["process", "managers", "honcho", "capabilities", "background_start"], "readOnly": false, "type": "boolean"}, "process.managers.honcho.capabilities.cold_start_subset": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix"}], "description": "Whether the manager can initially start a named subset of processes.", "loc": ["process", "managers", "honcho", "capabilities", "cold_start_subset"], "readOnly": false, "type": "boolean"}, "process.managers.honcho.capabilities.devenv_attach": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix"}], "description": "Whether devenv can attach its interactive client to an existing manager.", "loc": ["process", "managers", "honcho", "capabilities", "devenv_attach"], "readOnly": false, "type": "boolean"}, "process.managers.honcho.capabilities.individual_control": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix"}], "description": "Whether devenv can start, stop, and restart individual processes through the manager.", "loc": ["process", "managers", "honcho", "capabilities", "individual_control"], "readOnly": false, "type": "boolean"}, "process.managers.honcho.capabilities.wait_ready": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix"}], "description": "Whether devenv can wait for process readiness through the manager.", "loc": ["process", "managers", "honcho", "capabilities", "wait_ready"], "readOnly": false, "type": "boolean"}, "process.managers.honcho.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/honcho.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.honcho"}, "description": "The honcho package to use.", "loc": ["process", "managers", "honcho", "package"], "readOnly": false, "type": "package"}, "process.managers.mprocs.adapter.client": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix"}], "description": "Client protocol used for attach, readiness, and individual process control.", "loc": ["process", "managers", "mprocs", "adapter", "client"], "readOnly": false, "type": "one of \"none\", \"native-api\""}, "process.managers.mprocs.adapter.stop": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix"}], "description": "Adapter used to stop the running manager.", "loc": ["process", "managers", "mprocs", "adapter", "stop"], "readOnly": false, "type": "one of \"native-api\", \"command\", \"process-scope\""}, "process.managers.mprocs.adapter.terminal": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix"}], "description": "Terminal required by the manager launcher.", "loc": ["process", "managers", "mprocs", "adapter", "terminal"], "readOnly": false, "type": "one of \"none\", \"controlling\""}, "process.managers.mprocs.capabilities.background_start": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix"}], "description": "Whether the manager can remain running after the launching client exits.", "loc": ["process", "managers", "mprocs", "capabilities", "background_start"], "readOnly": false, "type": "boolean"}, "process.managers.mprocs.capabilities.cold_start_subset": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix"}], "description": "Whether the manager can initially start a named subset of processes.", "loc": ["process", "managers", "mprocs", "capabilities", "cold_start_subset"], "readOnly": false, "type": "boolean"}, "process.managers.mprocs.capabilities.devenv_attach": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix"}], "description": "Whether devenv can attach its interactive client to an existing manager.", "loc": ["process", "managers", "mprocs", "capabilities", "devenv_attach"], "readOnly": false, "type": "boolean"}, "process.managers.mprocs.capabilities.individual_control": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix"}], "description": "Whether devenv can start, stop, and restart individual processes through the manager.", "loc": ["process", "managers", "mprocs", "capabilities", "individual_control"], "readOnly": false, "type": "boolean"}, "process.managers.mprocs.capabilities.wait_ready": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix"}], "description": "Whether devenv can wait for process readiness through the manager.", "loc": ["process", "managers", "mprocs", "capabilities", "wait_ready"], "readOnly": false, "type": "boolean"}, "process.managers.mprocs.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.mprocs"}, "description": "The mprocs package to use.", "loc": ["process", "managers", "mprocs", "package"], "readOnly": false, "type": "package"}, "process.managers.mprocs.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/mprocs.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Top-level mprocs.yaml options\n\nhttps://github.com/pvolok/mprocs?tab=readme-ov-file#config\n", "loc": ["process", "managers", "mprocs", "settings"], "readOnly": false, "type": "YAML 1.1 value"}, "process.managers.native.adapter.client": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix"}], "description": "Client protocol used for attach, readiness, and individual process control.", "loc": ["process", "managers", "native", "adapter", "client"], "readOnly": false, "type": "one of \"none\", \"native-api\""}, "process.managers.native.adapter.stop": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix"}], "description": "Adapter used to stop the running manager.", "loc": ["process", "managers", "native", "adapter", "stop"], "readOnly": false, "type": "one of \"native-api\", \"command\", \"process-scope\""}, "process.managers.native.adapter.terminal": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix"}], "description": "Terminal required by the manager launcher.", "loc": ["process", "managers", "native", "adapter", "terminal"], "readOnly": false, "type": "one of \"none\", \"controlling\""}, "process.managers.native.capabilities.background_start": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix"}], "description": "Whether the manager can remain running after the launching client exits.", "loc": ["process", "managers", "native", "capabilities", "background_start"], "readOnly": false, "type": "boolean"}, "process.managers.native.capabilities.cold_start_subset": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix"}], "description": "Whether the manager can initially start a named subset of processes.", "loc": ["process", "managers", "native", "capabilities", "cold_start_subset"], "readOnly": false, "type": "boolean"}, "process.managers.native.capabilities.devenv_attach": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix"}], "description": "Whether devenv can attach its interactive client to an existing manager.", "loc": ["process", "managers", "native", "capabilities", "devenv_attach"], "readOnly": false, "type": "boolean"}, "process.managers.native.capabilities.individual_control": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix"}], "description": "Whether devenv can start, stop, and restart individual processes through the manager.", "loc": ["process", "managers", "native", "capabilities", "individual_control"], "readOnly": false, "type": "boolean"}, "process.managers.native.capabilities.wait_ready": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/native.nix"}], "description": "Whether devenv can wait for process readiness through the manager.", "loc": ["process", "managers", "native", "capabilities", "wait_ready"], "readOnly": false, "type": "boolean"}, "process.managers.overmind.adapter.client": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix"}], "description": "Client protocol used for attach, readiness, and individual process control.", "loc": ["process", "managers", "overmind", "adapter", "client"], "readOnly": false, "type": "one of \"none\", \"native-api\""}, "process.managers.overmind.adapter.stop": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix"}], "description": "Adapter used to stop the running manager.", "loc": ["process", "managers", "overmind", "adapter", "stop"], "readOnly": false, "type": "one of \"native-api\", \"command\", \"process-scope\""}, "process.managers.overmind.adapter.terminal": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix"}], "description": "Terminal required by the manager launcher.", "loc": ["process", "managers", "overmind", "adapter", "terminal"], "readOnly": false, "type": "one of \"none\", \"controlling\""}, "process.managers.overmind.capabilities.background_start": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix"}], "description": "Whether the manager can remain running after the launching client exits.", "loc": ["process", "managers", "overmind", "capabilities", "background_start"], "readOnly": false, "type": "boolean"}, "process.managers.overmind.capabilities.cold_start_subset": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix"}], "description": "Whether the manager can initially start a named subset of processes.", "loc": ["process", "managers", "overmind", "capabilities", "cold_start_subset"], "readOnly": false, "type": "boolean"}, "process.managers.overmind.capabilities.devenv_attach": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix"}], "description": "Whether devenv can attach its interactive client to an existing manager.", "loc": ["process", "managers", "overmind", "capabilities", "devenv_attach"], "readOnly": false, "type": "boolean"}, "process.managers.overmind.capabilities.individual_control": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix"}], "description": "Whether devenv can start, stop, and restart individual processes through the manager.", "loc": ["process", "managers", "overmind", "capabilities", "individual_control"], "readOnly": false, "type": "boolean"}, "process.managers.overmind.capabilities.wait_ready": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix"}], "description": "Whether devenv can wait for process readiness through the manager.", "loc": ["process", "managers", "overmind", "capabilities", "wait_ready"], "readOnly": false, "type": "boolean"}, "process.managers.overmind.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/overmind.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.overmind"}, "description": "The overmind package to use.", "loc": ["process", "managers", "overmind", "package"], "readOnly": false, "type": "package"}, "process.managers.process-compose.adapter.client": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix"}], "description": "Client protocol used for attach, readiness, and individual process control.", "loc": ["process", "managers", "process-compose", "adapter", "client"], "readOnly": false, "type": "one of \"none\", \"native-api\""}, "process.managers.process-compose.adapter.stop": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix"}], "description": "Adapter used to stop the running manager.", "loc": ["process", "managers", "process-compose", "adapter", "stop"], "readOnly": false, "type": "one of \"native-api\", \"command\", \"process-scope\""}, "process.managers.process-compose.adapter.terminal": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix"}], "description": "Terminal required by the manager launcher.", "loc": ["process", "managers", "process-compose", "adapter", "terminal"], "readOnly": false, "type": "one of \"none\", \"controlling\""}, "process.managers.process-compose.capabilities.background_start": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix"}], "description": "Whether the manager can remain running after the launching client exits.", "loc": ["process", "managers", "process-compose", "capabilities", "background_start"], "readOnly": false, "type": "boolean"}, "process.managers.process-compose.capabilities.cold_start_subset": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix"}], "description": "Whether the manager can initially start a named subset of processes.", "loc": ["process", "managers", "process-compose", "capabilities", "cold_start_subset"], "readOnly": false, "type": "boolean"}, "process.managers.process-compose.capabilities.devenv_attach": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix"}], "description": "Whether devenv can attach its interactive client to an existing manager.", "loc": ["process", "managers", "process-compose", "capabilities", "devenv_attach"], "readOnly": false, "type": "boolean"}, "process.managers.process-compose.capabilities.individual_control": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix"}], "description": "Whether devenv can start, stop, and restart individual processes through the manager.", "loc": ["process", "managers", "process-compose", "capabilities", "individual_control"], "readOnly": false, "type": "boolean"}, "process.managers.process-compose.capabilities.wait_ready": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix"}], "description": "Whether devenv can wait for process readiness through the manager.", "loc": ["process", "managers", "process-compose", "capabilities", "wait_ready"], "readOnly": false, "type": "boolean"}, "process.managers.process-compose.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.process-compose"}, "description": "The process-compose package to use.", "loc": ["process", "managers", "process-compose", "package"], "readOnly": false, "type": "package"}, "process.managers.process-compose.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix"}], "default": {"_type": "literalExpression", "text": "8080"}, "description": "The port to bind the process-compose server to.\n\nNot used when `unixSocket.enable` is true.\n", "loc": ["process", "managers", "process-compose", "port"], "readOnly": false, "type": "signed integer"}, "process.managers.process-compose.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Top-level process-compose.yaml options\n\nExample: https://github.com/F1bonacc1/process-compose/blob/main/process-compose.yaml\n", "example": {"_type": "literalExpression", "text": "{\n availability = {\n backoff_seconds = 2;\n max_restarts = 5;\n restart = \"on_failure\";\n };\n depends_on = {\n some-other-process = {\n condition = \"process_completed_successfully\";\n };\n };\n environment = [\n \"ENVVAR_FOR_THIS_PROCESS_ONLY=foobar\"\n ];\n}"}, "loc": ["process", "managers", "process-compose", "settings"], "readOnly": false, "type": "YAML 1.1 value"}, "process.managers.process-compose.tui.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Enable the TUI (Terminal User Interface)", "loc": ["process", "managers", "process-compose", "tui", "enable"], "readOnly": false, "type": "boolean"}, "process.managers.process-compose.unixSocket.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to enable running the process-compose server over unix domain sockets instead of tcp.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["process", "managers", "process-compose", "unixSocket", "enable"], "readOnly": false, "type": "boolean"}, "process.managers.process-compose.unixSocket.path": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/process-managers/process-compose.nix"}], "default": {"_type": "literalExpression", "text": "${config.devenv.runtime}/pc.sock"}, "description": "Override the path to the unix socket.", "loc": ["process", "managers", "process-compose", "unixSocket", "path"], "readOnly": false, "type": "string"}, "process.proxy.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/process-proxy.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/process-proxy.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable the shared HTTP proxy for friendly process URLs under ``.localhost``\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["process", "proxy", "enable"], "readOnly": false, "type": "boolean"}, "processes": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Processes can be started with ``devenv up`` and run in the foreground.", "loc": ["processes"], "readOnly": false, "type": "attribute set of (submodule)"}, "processes..after": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Tasks that must be ready before this process starts.\nUse task names like \"devenv:processes:postgres\" or \"myapp:setup\".\nSupports @started, @ready (default for processes), and @completed suffixes for process dependencies.\nSupports @started, @succeeded (default for tasks), and @completed suffixes for task dependencies.\n", "example": {"_type": "literalExpression", "text": "[\n \"devenv:processes:postgres\"\n \"myapp:migrations@succeeded\"\n]"}, "loc": ["processes", "", "after"], "readOnly": false, "type": "list of string"}, "processes..before": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Tasks that should start after this process is ready.\n", "example": {"_type": "literalExpression", "text": "[\n \"devenv:processes:nginx\"\n]"}, "loc": ["processes", "", "before"], "readOnly": false, "type": "list of string"}, "processes..cwd": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Working directory to run the process in. If not specified, the current working directory will be used.", "loc": ["processes", "", "cwd"], "readOnly": false, "type": "null or string"}, "processes..env": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Environment variables to set for this process.", "loc": ["processes", "", "env"], "readOnly": false, "type": "attribute set of string"}, "processes..exec": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "description": "Bash code to run the process.", "loc": ["processes", "", "exec"], "readOnly": false, "type": "string"}, "processes..linux": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Linux-specific process configuration.\n\nRequires devenv 2.0+.\n", "loc": ["processes", "", "linux"], "readOnly": false, "type": "submodule"}, "processes..linux.capabilities": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Linux capabilities to add as ambient capabilities for this process\n(e.g., \"net_bind_service\", \"net_admin\").\n\nSupported capabilities are net_bind_service, net_raw, net_admin,\nipc_lock, sys_nice, sys_resource, sys_admin, chown, dac_override,\nand fowner. Starting a process with capabilities requires sudo\nauthentication.\n\nRequires devenv 2.0+.\n", "example": {"_type": "literalExpression", "text": "[\n \"net_bind_service\"\n \"net_admin\"\n]"}, "loc": ["processes", "", "linux", "capabilities"], "readOnly": false, "type": "list of string"}, "processes..listen": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Socket activation configuration for systemd-style socket passing.\n\nRequires devenv 2.0+.\n", "example": {"_type": "literalExpression", "text": "[\n {\n address = \"127.0.0.1:8080\";\n kind = \"tcp\";\n name = \"http\";\n }\n {\n kind = \"unix_stream\";\n mode = 384;\n name = \"admin\";\n path = \"$DEVENV_STATE/admin.sock\";\n }\n]"}, "loc": ["processes", "", "listen"], "readOnly": false, "type": "list of (submodule)"}, "processes..listen.*.address": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "TCP address (e.g., '127.0.0.1:8080'). Required for TCP sockets.", "loc": ["processes", "", "listen", "*", "address"], "readOnly": false, "type": "null or string"}, "processes..listen.*.backlog": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "128"}, "description": "Listen backlog size", "loc": ["processes", "", "listen", "*", "backlog"], "readOnly": false, "type": "null or signed integer"}, "processes..listen.*.kind": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "description": "Type of socket (tcp or unix_stream)", "loc": ["processes", "", "listen", "*", "kind"], "readOnly": false, "type": "one of \"tcp\", \"unix_stream\""}, "processes..listen.*.mode": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Unix socket file permissions (e.g., 384 for 0o600). Only for unix_stream.", "loc": ["processes", "", "listen", "*", "mode"], "readOnly": false, "type": "null or signed integer"}, "processes..listen.*.name": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "description": "Name of the socket (e.g., 'http', 'admin')", "loc": ["processes", "", "listen", "*", "name"], "readOnly": false, "type": "string"}, "processes..listen.*.path": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Unix socket path. Required for unix_stream sockets.", "loc": ["processes", "", "listen", "*", "path"], "readOnly": false, "type": "null or string"}, "processes..ports": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Named ports with auto-allocation for this process.\n\nDefine ports with a base value and devenv will automatically find\na free port starting from that base, incrementing until available.\n\nThe resolved port is available via `config.processes..ports..value`.\n\nRequires devenv 2.0+.\n", "example": {"_type": "literalExpression", "text": "{\n http.allocate = 8080;\n admin.allocate = 9000;\n}\n"}, "loc": ["processes", "", "ports"], "readOnly": false, "type": "attribute set of (submodule)"}, "processes..ports..allocate": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "description": "Base port for auto-allocation (increments until free)", "example": {"_type": "literalExpression", "text": "8080"}, "loc": ["processes", "", "ports", "", "allocate"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "processes..ports..proxy": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Shared HTTP proxy configuration for this port.", "loc": ["processes", "", "ports", "", "proxy"], "readOnly": false, "type": "submodule"}, "processes..ports..proxy.hostname": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Full `.localhost` hostname to use for this port when\n`process.proxy.enable` is enabled.\n\nThis takes precedence over `processes..proxy.hostname`\nand the generated hostname.\n", "example": {"_type": "literalExpression", "text": "\"admin.localhost\""}, "loc": ["processes", "", "ports", "", "proxy", "hostname"], "readOnly": false, "type": "null or string"}, "processes..ports..value": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalMD", "text": "Allocated port based on `allocate`"}, "description": "Resolved port value (allocated by devenv)", "loc": ["processes", "", "ports", "", "value"], "readOnly": true, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "processes..process-compose": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "process-compose.yaml specific process attributes.\n\nExample: https://github.com/F1bonacc1/process-compose/blob/main/process-compose.yaml\n\nOnly used when using ``process.manager.implementation = \"process-compose\";``\n", "example": {"_type": "literalExpression", "text": "{\n availability = {\n backoff_seconds = 2;\n max_restarts = 5;\n restart = \"on_failure\";\n };\n depends_on = {\n some-other-process = {\n condition = \"process_completed_successfully\";\n };\n };\n environment = [\n \"ENVVAR_FOR_THIS_PROCESS_ONLY=foobar\"\n ];\n}"}, "loc": ["processes", "", "process-compose"], "readOnly": false, "type": "YAML 1.1 value"}, "processes..proxy": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Shared HTTP proxy configuration for this process.", "loc": ["processes", "", "proxy"], "readOnly": false, "type": "submodule"}, "processes..proxy.hostname": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Full `.localhost` hostname to use for this process when\n`process.proxy.enable` is enabled.\n\nBy default, devenv derives the hostname from the process and\nproject names. Named ports without their own hostname override\nare prefixed to this hostname.\n", "example": {"_type": "literalExpression", "text": "\"app.localhost\""}, "loc": ["processes", "", "proxy", "hostname"], "readOnly": false, "type": "null or string"}, "processes..proxy.https.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable HTTPS proxy URLs for this process using the project's mkcert certificate authority.\nHTTP URLs remain available. Requires `process.proxy.enable`\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["processes", "", "proxy", "https", "enable"], "readOnly": false, "type": "boolean"}, "processes..ready": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "How to determine if this process is ready to serve.\n\nRequires devenv 2.0+.\n", "loc": ["processes", "", "ready"], "readOnly": false, "type": "null or (submodule)"}, "processes..ready.exec": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Shell command to execute. Exit 0 = ready.", "example": {"_type": "literalExpression", "text": "\"pg_isready -d template1\""}, "loc": ["processes", "", "ready", "exec"], "readOnly": false, "type": "null or string"}, "processes..ready.failure_threshold": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "3"}, "description": "Consecutive failures before marking unhealthy.", "loc": ["processes", "", "ready", "failure_threshold"], "readOnly": false, "type": "signed integer"}, "processes..ready.http": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "HTTP readiness probe configuration.", "loc": ["processes", "", "ready", "http"], "readOnly": false, "type": "submodule"}, "processes..ready.http.get": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "HTTP GET readiness check.", "loc": ["processes", "", "ready", "http", "get"], "readOnly": false, "type": "null or (submodule)"}, "processes..ready.http.get.host": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "Host to connect to.", "loc": ["processes", "", "ready", "http", "get", "host"], "readOnly": false, "type": "string"}, "processes..ready.http.get.path": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "\"/\""}, "description": "HTTP path to request.", "loc": ["processes", "", "ready", "http", "get", "path"], "readOnly": false, "type": "string"}, "processes..ready.http.get.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "description": "Port to connect to.", "loc": ["processes", "", "ready", "http", "get", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "processes..ready.http.get.scheme": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "\"http\""}, "description": "URL scheme (http or https).", "loc": ["processes", "", "ready", "http", "get", "scheme"], "readOnly": false, "type": "string"}, "processes..ready.initial_delay": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "0"}, "description": "Seconds to wait before first probe.", "loc": ["processes", "", "ready", "initial_delay"], "readOnly": false, "type": "signed integer"}, "processes..ready.notify": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Enable systemd notify protocol for readiness signaling.\nThe process must send READY=1 to the NOTIFY_SOCKET.\n", "loc": ["processes", "", "ready", "notify"], "readOnly": false, "type": "boolean"}, "processes..ready.period": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "10"}, "description": "Seconds between probes.", "loc": ["processes", "", "ready", "period"], "readOnly": false, "type": "signed integer"}, "processes..ready.probe_timeout": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "1"}, "description": "Seconds before a single probe times out.", "loc": ["processes", "", "ready", "probe_timeout"], "readOnly": false, "type": "signed integer"}, "processes..ready.success_threshold": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "1"}, "description": "Consecutive successes needed to be considered ready.", "loc": ["processes", "", "ready", "success_threshold"], "readOnly": false, "type": "signed integer"}, "processes..ready.timeout": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Overall deadline in seconds for the process to become ready. null = no deadline.", "loc": ["processes", "", "ready", "timeout"], "readOnly": false, "type": "null or (unsigned integer, meaning >=0)"}, "processes..restart": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Process restart policy.", "loc": ["processes", "", "restart"], "readOnly": false, "type": "submodule"}, "processes..restart.max": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "5"}, "description": "Maximum restart attempts. null = unlimited.", "loc": ["processes", "", "restart", "max"], "readOnly": false, "type": "null or signed integer"}, "processes..restart.on": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "\"on_failure\""}, "description": "When to restart: never, always, or on_failure.", "loc": ["processes", "", "restart", "on"], "readOnly": false, "type": "one of \"never\", \"always\", \"on_failure\""}, "processes..restart.window": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Sliding window in seconds for restart rate limiting. null = lifetime limit.", "loc": ["processes", "", "restart", "window"], "readOnly": false, "type": "null or (unsigned integer, meaning >=0)"}, "processes..shutdown": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Graceful shutdown signal and timeout", "loc": ["processes", "", "shutdown"], "readOnly": false, "type": "submodule"}, "processes..shutdown.grace": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "5"}, "description": "Seconds before shutdown escalates to SIGKILL", "loc": ["processes", "", "shutdown", "grace"], "readOnly": false, "type": "unsigned integer, meaning >=0"}, "processes..shutdown.signal": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "15"}, "description": "Unix signal number used for graceful shutdown", "loc": ["processes", "", "shutdown", "signal"], "readOnly": false, "type": "integer between 1 and 31 (both inclusive)"}, "processes..start": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Auto-start configuration for this process.", "loc": ["processes", "", "start"], "readOnly": false, "type": "submodule"}, "processes..start.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to start this process automatically with `devenv up`.\n\nDisabled processes are still visible in the TUI as stopped\nand can be started manually by selecting them and pressing Enter.\nThey also run when pulled in as a task dependency, for example\n`after = [ \"devenv:processes:@completed\" ]`.\n", "loc": ["processes", "", "start", "enable"], "readOnly": false, "type": "boolean"}, "processes..watch": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "File watching configuration for automatic process restarts.\n\nRequires devenv 2.0+.\n", "example": {"_type": "literalExpression", "text": "{\n paths = [ ./src ];\n extensions = [ \"rs\" \"toml\" ];\n ignore = [ \"target\" ];\n}\n"}, "loc": ["processes", "", "watch"], "readOnly": false, "type": "submodule"}, "processes..watch.extensions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "File extensions to watch (e.g., \"rs\", \"js\", \"py\").\nIf empty, all file extensions are watched.\n\nRequires devenv 2.0+.\n", "example": {"_type": "literalExpression", "text": "[\n \"rs\"\n \"toml\"\n]"}, "loc": ["processes", "", "watch", "extensions"], "readOnly": false, "type": "list of string"}, "processes..watch.ignore": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Glob patterns to ignore (e.g., \".git\", \"target\", \"*.log\").\n\nRequires devenv 2.0+.\n", "example": {"_type": "literalExpression", "text": "[\n \"*.log\"\n \".git\"\n \"target\"\n]"}, "loc": ["processes", "", "watch", "ignore"], "readOnly": false, "type": "list of string"}, "processes..watch.paths": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Paths to watch for changes (files or directories).\nWhen files in these paths change, the process is restarted\n(or, for a one-shot command that exits immediately, re-run).\n\nPaths are resolved relative to the location of `devenv.nix`\n(the project root), not relative to the process's `cwd`. Use\npath literals such as `./src`; they are passed to the watcher\nas absolute paths.\n\nRequires devenv 2.0+.\n", "example": {"_type": "literalExpression", "text": "[ ./src ./config.yaml ]\n"}, "loc": ["processes", "", "watch", "paths"], "readOnly": false, "type": "list of absolute path"}, "processes..watchdog": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Systemd watchdog configuration.\n\nRequires devenv 2.0+.\n", "example": {"_type": "literalExpression", "text": "{\n usec = 30000000; # 30 seconds\n require_ready = true;\n}\n"}, "loc": ["processes", "", "watchdog"], "readOnly": false, "type": "null or (submodule)"}, "processes..watchdog.require_ready": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Require READY=1 notification before enforcing watchdog", "loc": ["processes", "", "watchdog", "require_ready"], "readOnly": false, "type": "boolean"}, "processes..watchdog.usec": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/processes.nix"}], "description": "Watchdog interval in microseconds", "loc": ["processes", "", "watchdog", "usec"], "readOnly": false, "type": "signed integer"}, "profiles": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/profiles.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/profiles.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Profile definitions that can be activated manually or automatically.", "example": {"_type": "literalExpression", "text": "{\n # Manual profiles (activated via --profile)\n \"base\" = {\n module = {\n languages.nix.enable = true;\n packages = [ pkgs.git ];\n };\n };\n \"python-3.14\" = {\n extends = [ \"base\" ];\n module = {\n languages.python.version = \"3.14\";\n };\n };\n \"backend\" = {\n extends = [ \"base\" ];\n module = {\n services.postgres.enable = true;\n services.redis.enable = true;\n };\n };\n \"fullstack\" = {\n extends = [ \"backend\" \"python-3.14\" ];\n module = {\n env.FULL_STACK = \"true\";\n };\n };\n # Automatic hostname-based profiles\n hostname.\"work-laptop\" = {\n extends = [ \"backend\" ];\n module = {\n env.WORK_ENV = \"true\";\n };\n };\n # Automatic user-based profiles\n user.\"alice\" = {\n extends = [ \"python-3.14\" ];\n module = {\n env.USER_ROLE = \"developer\";\n };\n };\n}\n"}, "loc": ["profiles"], "readOnly": false, "type": "open submodule of lazy attribute set of (submodule)"}, "profiles..extends": {"declarations": [], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of profile names to extend/inherit from.", "example": {"_type": "literalExpression", "text": "[\n \"base\"\n \"backend\"\n]"}, "loc": ["profiles", "", "extends"], "readOnly": false, "type": "list of string"}, "profiles..module": {"declarations": [], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Additional configuration to merge when this profile is active.", "loc": ["profiles", "", "module"], "readOnly": false, "type": "module"}, "profiles.hostname": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/profiles.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/profiles.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Profile definitions that are automatically activated based on the machine's hostname.", "loc": ["profiles", "hostname"], "readOnly": false, "type": "lazy attribute set of (submodule)"}, "profiles.hostname..extends": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/profiles.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/profiles.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of profile names to extend/inherit from.", "example": {"_type": "literalExpression", "text": "[\n \"base\"\n \"backend\"\n]"}, "loc": ["profiles", "hostname", "", "extends"], "readOnly": false, "type": "list of string"}, "profiles.hostname..module": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/profiles.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/profiles.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Additional configuration to merge when this profile is active.", "loc": ["profiles", "hostname", "", "module"], "readOnly": false, "type": "module"}, "profiles.user": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/profiles.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/profiles.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Profile definitions that are automatically activated based on the username.", "loc": ["profiles", "user"], "readOnly": false, "type": "lazy attribute set of (submodule)"}, "profiles.user..extends": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/profiles.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/profiles.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of profile names to extend/inherit from.", "example": {"_type": "literalExpression", "text": "[\n \"base\"\n \"backend\"\n]"}, "loc": ["profiles", "user", "", "extends"], "readOnly": false, "type": "list of string"}, "profiles.user..module": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/profiles.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/profiles.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Additional configuration to merge when this profile is active.", "loc": ["profiles", "user", "", "module"], "readOnly": false, "type": "module"}, "scripts": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "A set of scripts available when the environment is active.", "loc": ["scripts"], "readOnly": false, "type": "attribute set of (submodule)"}, "scripts..binary": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Override the binary name from the default `package.meta.mainProgram`", "loc": ["scripts", "", "binary"], "readOnly": false, "type": "null or string"}, "scripts..description": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Description of the script.", "loc": ["scripts", "", "description"], "readOnly": false, "type": "string"}, "scripts..exec": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix"}], "description": "Shell code to execute when the script is run, or path to a script file.", "loc": ["scripts", "", "exec"], "readOnly": false, "type": "string or absolute path"}, "scripts..package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.bash"}, "description": "The package to use to run the script.", "loc": ["scripts", "", "package"], "readOnly": false, "type": "package"}, "scripts..packages": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/scripts.nix"}], "default": {"_type": "literalExpression", "text": "[]"}, "description": "Packages to be available in PATH when the script runs.", "loc": ["scripts", "", "packages"], "readOnly": false, "type": "list of package"}, "secretspec.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/secretspec.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/secretspec.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether secretspec integration is enabled (automatically true when secrets are loaded)", "loc": ["secretspec", "enable"], "readOnly": true, "type": "boolean"}, "secretspec.profile": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/secretspec.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/secretspec.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The secretspec profile that was used to load secrets (read-only)", "loc": ["secretspec", "profile"], "readOnly": true, "type": "null or string"}, "secretspec.provider": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/secretspec.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/secretspec.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The explicit secretspec provider override selected through devenv, if any (read-only)", "loc": ["secretspec", "provider"], "readOnly": true, "type": "null or string"}, "secretspec.secrets": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/secretspec.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/secretspec.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Secrets loaded from secretspec.toml (read-only)", "loc": ["secretspec", "secrets"], "readOnly": true, "type": "attribute set of string"}, "services.adminer.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/adminer.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/adminer.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Adminer process.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "adminer", "enable"], "readOnly": false, "type": "boolean"}, "services.adminer.listen": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/adminer.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/adminer.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1:8080\""}, "description": "Listen address for the Adminer.", "loc": ["services", "adminer", "listen"], "readOnly": false, "type": "string"}, "services.adminer.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/adminer.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/adminer.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.adminer"}, "description": "Which package of Adminer to use.", "loc": ["services", "adminer", "package"], "readOnly": false, "type": "package"}, "services.blackfire.client-id": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Sets the client id used to authenticate with Blackfire.\nYou can find your personal client-id at .\n", "loc": ["services", "blackfire", "client-id"], "readOnly": false, "type": "string"}, "services.blackfire.client-token": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Sets the client token used to authenticate with Blackfire.\nYou can find your personal client-token at .\n", "loc": ["services", "blackfire", "client-token"], "readOnly": false, "type": "string"}, "services.blackfire.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Blackfire profiler agent\n\nIt automatically installs Blackfire PHP extension.\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "blackfire", "enable"], "readOnly": false, "type": "boolean"}, "services.blackfire.enableApm": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Enables application performance monitoring, requires special subscription.\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "blackfire", "enableApm"], "readOnly": false, "type": "boolean"}, "services.blackfire.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.blackfire"}, "description": "Which package of blackfire to use", "loc": ["services", "blackfire", "package"], "readOnly": false, "type": "package"}, "services.blackfire.server-id": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Sets the server id used to authenticate with Blackfire.\nYou can find your personal server-id at .\n", "loc": ["services", "blackfire", "server-id"], "readOnly": false, "type": "string"}, "services.blackfire.server-token": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Sets the server token used to authenticate with Blackfire.\nYou can find your personal server-token at .\n", "loc": ["services", "blackfire", "server-token"], "readOnly": false, "type": "string"}, "services.blackfire.socket": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/blackfire.nix"}], "default": {"_type": "literalExpression", "text": "\"tcp://127.0.0.1:8307\""}, "description": "Sets the server socket path\n", "loc": ["services", "blackfire", "socket"], "readOnly": false, "type": "string"}, "services.caddy.adapter": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix"}], "default": {"_type": "literalExpression", "text": "\"caddyfile\""}, "description": "Name of the config adapter to use.\nSee for the full list.\n", "example": {"_type": "literalExpression", "text": "\"nginx\""}, "loc": ["services", "caddy", "adapter"], "readOnly": false, "type": "string"}, "services.caddy.ca": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix"}], "default": {"_type": "literalExpression", "text": "\"https://acme-v02.api.letsencrypt.org/directory\""}, "description": "Certificate authority ACME server. The default (Let's Encrypt\nproduction server) should be fine for most people. Set it to null if\nyou don't want to include any authority (or if you want to write a more\nfine-graned configuration manually).\n", "example": {"_type": "literalExpression", "text": "\"https://acme-staging-v02.api.letsencrypt.org/directory\""}, "loc": ["services", "caddy", "ca"], "readOnly": false, "type": "null or string"}, "services.caddy.config": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Verbatim Caddyfile to use.\n\nRefer to [https://caddyserver.com/docs/caddyfile](https://caddyserver.com/docs/caddyfile)\nfor more information.\n\nCaddy v2 supports multiple config formats via adapters (see [`services.caddy.adapter`](#servicescaddyconfig)).\n", "example": {"_type": "literalExpression", "text": "''\n # Global options block\n {\n debug\n }\n \n # Site block\n example.com {\n encode gzip\n log\n root /srv/http\n }\n''"}, "loc": ["services", "caddy", "config"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.caddy.dataDir": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix"}], "default": {"_type": "literalExpression", "text": "\"${config.env.DEVENV_STATE}/caddy\""}, "description": "The data directory, for storing certificates. Before 17.09, this\nwould create a .caddy directory. With 17.09 the contents of the\n.caddy directory are in the specified data directory instead.\nCaddy v2 replaced CADDYPATH with XDG directories.\nSee .\n", "loc": ["services", "caddy", "dataDir"], "readOnly": false, "type": "absolute path"}, "services.caddy.email": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Email address (for Let's Encrypt certificate).", "loc": ["services", "caddy", "email"], "readOnly": false, "type": "string"}, "services.caddy.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Caddy web server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "caddy", "enable"], "readOnly": false, "type": "boolean"}, "services.caddy.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.caddy"}, "description": "Caddy package to use.\n", "loc": ["services", "caddy", "package"], "readOnly": false, "type": "package"}, "services.caddy.resume": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Use saved config, if any (and prefer over configuration passed with [`caddy.config`](#servicescaddyconfig)).\n", "loc": ["services", "caddy", "resume"], "readOnly": false, "type": "boolean"}, "services.caddy.virtualHosts": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Declarative vhost config.", "example": {"_type": "literalExpression", "text": "{\n \"hydra.example.com\" = {\n serverAliases = [ \"www.hydra.example.com\" ];\n extraConfig = ''''\n encode gzip\n log\n root /srv/http\n '''';\n };\n};\n"}, "loc": ["services", "caddy", "virtualHosts"], "readOnly": false, "type": "attribute set of (submodule)"}, "services.caddy.virtualHosts..extraConfig": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "These lines go into the vhost verbatim.\n", "loc": ["services", "caddy", "virtualHosts", "", "extraConfig"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.caddy.virtualHosts..serverAliases": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/caddy.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Additional names of virtual hosts served by this virtual host configuration.\n", "example": {"_type": "literalExpression", "text": "[\n \"www.example.org\"\n \"example.org\"\n]"}, "loc": ["services", "caddy", "virtualHosts", "", "serverAliases"], "readOnly": false, "type": "list of string"}, "services.cassandra.allowClients": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Enables or disables the native transport server (CQL binary protocol)\n", "loc": ["services", "cassandra", "allowClients"], "readOnly": false, "type": "boolean"}, "services.cassandra.clusterName": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix"}], "default": {"_type": "literalExpression", "text": "\"Test Cluster\""}, "description": "The name of the cluster", "loc": ["services", "cassandra", "clusterName"], "readOnly": false, "type": "string"}, "services.cassandra.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Add Cassandra process script..", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "cassandra", "enable"], "readOnly": false, "type": "boolean"}, "services.cassandra.extraConfig": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Extra options to be merged into `cassandra.yaml` as nix attribute set.\n", "example": {"_type": "literalExpression", "text": "{\n commitlog_sync_batch_window_in_ms = 3;\n}"}, "loc": ["services", "cassandra", "extraConfig"], "readOnly": false, "type": "attribute set"}, "services.cassandra.jvmOpts": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Options to pass to the JVM through the JVM_OPTS environment variable", "loc": ["services", "cassandra", "jvmOpts"], "readOnly": false, "type": "list of string"}, "services.cassandra.listenAddress": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "Listen address", "example": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "loc": ["services", "cassandra", "listenAddress"], "readOnly": false, "type": "string"}, "services.cassandra.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.cassandra_4"}, "description": "Which version of Cassandra to use", "example": {"_type": "literalExpression", "text": "pkgs.cassandra_4;"}, "loc": ["services", "cassandra", "package"], "readOnly": false, "type": "package"}, "services.cassandra.seedAddresses": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/cassandra.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"127.0.0.1\"\n]"}, "description": "The addresses of hosts designated as contact points of the cluster", "loc": ["services", "cassandra", "seedAddresses"], "readOnly": false, "type": "list of string"}, "services.clickhouse.config": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix"}], "description": "ClickHouse configuration in YAML.", "loc": ["services", "clickhouse", "config"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.clickhouse.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable clickhouse-server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "clickhouse", "enable"], "readOnly": false, "type": "boolean"}, "services.clickhouse.httpPort": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix"}], "default": {"_type": "literalExpression", "text": "8123"}, "description": "Which http port to run clickhouse on.", "loc": ["services", "clickhouse", "httpPort"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.clickhouse.keeper.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable keeper_server in ClickHouse.", "loc": ["services", "clickhouse", "keeper", "enable"], "readOnly": false, "type": "boolean"}, "services.clickhouse.keeper.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix"}], "default": {"_type": "literalExpression", "text": "9181"}, "description": "Which port to run clickhouse keeper service on.", "loc": ["services", "clickhouse", "keeper", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.clickhouse.keeper.raft.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix"}], "default": {"_type": "literalExpression", "text": "9234"}, "description": "Which http port to use clickhouse keeper for raft consensus.", "loc": ["services", "clickhouse", "keeper", "raft", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.clickhouse.macros.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable macros in ClickHouse.", "loc": ["services", "clickhouse", "macros", "enable"], "readOnly": false, "type": "boolean"}, "services.clickhouse.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.clickhouse"}, "description": "Which package of clickhouse to use", "loc": ["services", "clickhouse", "package"], "readOnly": false, "type": "package"}, "services.clickhouse.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix"}], "default": {"_type": "literalExpression", "text": "9000"}, "description": "Which port to run clickhouse on.", "loc": ["services", "clickhouse", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.clickhouse.remoteServers.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable remote_servers in ClickHouse.", "loc": ["services", "clickhouse", "remoteServers", "enable"], "readOnly": false, "type": "boolean"}, "services.clickhouse.timezone": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Which timezone to use for ClickHouse.", "loc": ["services", "clickhouse", "timezone"], "readOnly": false, "type": "null or string"}, "services.clickhouse.usersConfig": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Your `users.yaml` as a Nix attribute set.\nCheck the [documentation](https://clickhouse.com/docs/operations/configuration-files#user-settings)\nfor possible options.\n", "example": {"_type": "literalExpression", "text": "{\n profiles = {};\n\n users = {\n default = {\n profile = \"default\";\n password_sha256_hex = \"36dd292533174299fb0c34665df468bb881756ca9eaf9757d0cfde38f9ededa1\"; # `echo -n verysecret | sha256sum`\n };\n };\n}\n"}, "loc": ["services", "clickhouse", "usersConfig"], "readOnly": false, "type": "YAML 1.1 value"}, "services.cockroachdb.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/cockroachdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/cockroachdb.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Add CockroachDB process.\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "cockroachdb", "enable"], "readOnly": false, "type": "boolean"}, "services.cockroachdb.http_addr": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/cockroachdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/cockroachdb.nix"}], "default": {"_type": "literalExpression", "text": "\"localhost:8080\""}, "description": "The hostname or IP address to bind to for HTTP requests.\n", "loc": ["services", "cockroachdb", "http_addr"], "readOnly": false, "type": "string"}, "services.cockroachdb.listen_addr": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/cockroachdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/cockroachdb.nix"}], "default": {"_type": "literalExpression", "text": "\"localhost:26257\""}, "description": "The address/hostname and port to listen on.\n", "loc": ["services", "cockroachdb", "listen_addr"], "readOnly": false, "type": "string"}, "services.cockroachdb.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/cockroachdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/cockroachdb.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.cockroachdb"}, "description": "The CockroachDB package to use.", "loc": ["services", "cockroachdb", "package"], "readOnly": false, "type": "unspecified value"}, "services.couchdb.baseDir": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix"}], "default": {"_type": "literalExpression", "text": "config.env.DEVENV_STATE + \"/couchdb\""}, "description": "The directory where CouchDB will store its data.\n", "loc": ["services", "couchdb", "baseDir"], "readOnly": true, "type": "string"}, "services.couchdb.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable CouchDB process.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "couchdb", "enable"], "readOnly": false, "type": "boolean"}, "services.couchdb.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.couchdb3"}, "description": "Which version of CouchDB to use", "loc": ["services", "couchdb", "package"], "readOnly": false, "type": "package"}, "services.couchdb.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "CouchDB configuration.\nTo learn more about all settings, see the\n[CouchDB configuration reference](https://docs.couchdb.org/en/stable/config/couchdb.html).\n", "example": {"_type": "literalExpression", "text": "{\n couchdb = {\n database_dir = baseDir;\n single_node = true;\n view_index_dir = baseDir;\n uri_file = \"${config.services.couchdb.baseDir}/couchdb.uri\";\n };\n admins = {\n \"admin_username\" = \"pass\";\n };\n chttpd = {\n bind_address = \"127.0.0.1\";\n port = 5984;\n };\n}\n"}, "loc": ["services", "couchdb", "settings"], "readOnly": false, "type": "open submodule of attribute set of section of an INI file (attrs of INI atom (null, bool, int, float or string))"}, "services.couchdb.settings.chttpd.bind_address": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "Defines the IP address by which CouchDB will be accessible.\n", "loc": ["services", "couchdb", "settings", "chttpd", "bind_address"], "readOnly": false, "type": "string"}, "services.couchdb.settings.chttpd.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix"}], "default": {"_type": "literalExpression", "text": "5984"}, "description": "Defined the port number to listen.\n", "loc": ["services", "couchdb", "settings", "chttpd", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.couchdb.settings.couchdb.database_dir": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix"}], "default": {"_type": "literalExpression", "text": "config.env.DEVENV_STATE + \"/couchdb\""}, "description": "Specifies location of CouchDB database files (*.couch named). This\nlocation should be writable and readable for the user the CouchDB\nservice runs as (couchdb by default).\n", "loc": ["services", "couchdb", "settings", "couchdb", "database_dir"], "readOnly": false, "type": "absolute path"}, "services.couchdb.settings.couchdb.single_node": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "When this configuration setting is set to true, automatically create\nthe system databases on startup. Must be set false for a clustered\nCouchDB installation.\n", "loc": ["services", "couchdb", "settings", "couchdb", "single_node"], "readOnly": false, "type": "boolean"}, "services.couchdb.settings.couchdb.uri_file": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix"}], "default": {"_type": "literalExpression", "text": "config.env.DEVENV_STATE + \"/couchdb\"/couchdb.uri"}, "description": "This file contains the full URI that can be used to access this\ninstance of CouchDB. It is used to help discover the port CouchDB is\nrunning on (if it was set to 0 (e.g. automatically assigned any free\none). This file should be writable and readable for the user that\nruns the CouchDB service (couchdb by default).\n", "loc": ["services", "couchdb", "settings", "couchdb", "uri_file"], "readOnly": false, "type": "absolute path"}, "services.couchdb.settings.couchdb.view_index_dir": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/couchdb.nix"}], "default": {"_type": "literalExpression", "text": "config.env.DEVENV_STATE + \"/couchdb\""}, "description": "Specifies location of CouchDB view index files. This location should\nbe writable and readable for the user that runs the CouchDB service\n(couchdb by default).\n", "loc": ["services", "couchdb", "settings", "couchdb", "view_index_dir"], "readOnly": false, "type": "absolute path"}, "services.dynamodb-local.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/dynamodb-local.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/dynamodb-local.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable DynamoDB Local.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "dynamodb-local", "enable"], "readOnly": false, "type": "boolean"}, "services.dynamodb-local.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/dynamodb-local.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/dynamodb-local.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.dynamodb-local"}, "description": "Which package of DynamoDB to use.", "loc": ["services", "dynamodb-local", "package"], "readOnly": false, "type": "package"}, "services.dynamodb-local.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/dynamodb-local.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/dynamodb-local.nix"}], "default": {"_type": "literalExpression", "text": "8000"}, "description": "Listen port for DynamoDB Local.", "loc": ["services", "dynamodb-local", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.dynamodb-local.sharedDb": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/dynamodb-local.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/dynamodb-local.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "If true, enables the -sharedDb flag for DynamoDB Local.\nWhen enabled, DynamoDB Local creates a single database file named shared-local-instance.db.\nEvery program that connects to DynamoDB accesses this file. If you delete the file, you lose any data stored in it.\n", "loc": ["services", "dynamodb-local", "sharedDb"], "readOnly": false, "type": "boolean"}, "services.elasticmq.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticmq.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticmq.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable elasticmq-server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "elasticmq", "enable"], "readOnly": false, "type": "boolean"}, "services.elasticmq.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticmq.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticmq.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.elasticmq-server-bin"}, "description": "Which package of elasticmq-server-bin to use", "loc": ["services", "elasticmq", "package"], "readOnly": false, "type": "package"}, "services.elasticmq.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticmq.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticmq.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Configuration for elasticmq-server", "loc": ["services", "elasticmq", "settings"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.elasticsearch.cluster_name": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix"}], "default": {"_type": "literalExpression", "text": "\"elasticsearch\""}, "description": "Elasticsearch name that identifies your cluster for auto-discovery.", "loc": ["services", "elasticsearch", "cluster_name"], "readOnly": false, "type": "string"}, "services.elasticsearch.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable elasticsearch.", "loc": ["services", "elasticsearch", "enable"], "readOnly": false, "type": "boolean"}, "services.elasticsearch.extraCmdLineOptions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Extra command line options for the elasticsearch launcher.", "loc": ["services", "elasticsearch", "extraCmdLineOptions"], "readOnly": false, "type": "list of string"}, "services.elasticsearch.extraConf": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Extra configuration for elasticsearch.", "example": {"_type": "literalExpression", "text": "''\n node.name: \"elasticsearch\"\n node.master: true\n node.data: false\n''"}, "loc": ["services", "elasticsearch", "extraConf"], "readOnly": false, "type": "string"}, "services.elasticsearch.extraJavaOptions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Extra command line options for Java.", "example": {"_type": "literalExpression", "text": "[\n \"-Djava.net.preferIPv4Stack=true\"\n]"}, "loc": ["services", "elasticsearch", "extraJavaOptions"], "readOnly": false, "type": "list of string"}, "services.elasticsearch.listenAddress": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "Elasticsearch listen address.", "loc": ["services", "elasticsearch", "listenAddress"], "readOnly": false, "type": "string"}, "services.elasticsearch.logging": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix"}], "default": {"_type": "literalExpression", "text": "''\n logger.action.name = org.elasticsearch.action\n logger.action.level = info\n appender.console.type = Console\n appender.console.name = console\n appender.console.layout.type = PatternLayout\n appender.console.layout.pattern = [%d{ISO8601}][%-5p][%-25c{1.}] %marker%m%n\n rootLogger.level = info\n rootLogger.appenderRef.console.ref = console\n''"}, "description": "Elasticsearch logging configuration.", "loc": ["services", "elasticsearch", "logging"], "readOnly": false, "type": "string"}, "services.elasticsearch.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.elasticsearch7"}, "description": "Elasticsearch package to use.", "loc": ["services", "elasticsearch", "package"], "readOnly": false, "type": "package"}, "services.elasticsearch.plugins": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Extra elasticsearch plugins", "example": {"_type": "literalExpression", "text": "[ pkgs.elasticsearchPlugins.discovery-ec2 ]"}, "loc": ["services", "elasticsearch", "plugins"], "readOnly": false, "type": "list of package"}, "services.elasticsearch.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix"}], "default": {"_type": "literalExpression", "text": "9200"}, "description": "Elasticsearch port to listen for HTTP traffic.", "loc": ["services", "elasticsearch", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.elasticsearch.single_node": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Start a single-node cluster", "loc": ["services", "elasticsearch", "single_node"], "readOnly": false, "type": "boolean"}, "services.elasticsearch.tcp_port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/elasticsearch.nix"}], "default": {"_type": "literalExpression", "text": "9300"}, "description": "Elasticsearch port for the node to node communication.", "loc": ["services", "elasticsearch", "tcp_port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.garage.adminAddress": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1:3903\""}, "description": "IP address and port of the admin API.", "loc": ["services", "garage", "adminAddress"], "readOnly": false, "type": "string"}, "services.garage.adminToken": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix"}], "default": {"_type": "literalExpression", "text": "\"devtoken\""}, "description": "Admin API bearer token. Hard-coded for single-node dev; production\ndeployments override this with a real secret.\n", "loc": ["services", "garage", "adminToken"], "readOnly": false, "type": "string"}, "services.garage.afterStart": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Bash code to execute after the server is running and the cluster\nlayout is applied. The `garage` CLI in scope already points at the\nlocal instance via the generated config.\n", "example": {"_type": "literalExpression", "text": "''\n garage key new --name app-key\n garage bucket allow --read --write --owner my-bucket --key app-key\n''"}, "loc": ["services", "garage", "afterStart"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.garage.buckets": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of buckets to ensure exist on startup.", "loc": ["services", "garage", "buckets"], "readOnly": false, "type": "list of string"}, "services.garage.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Garage S3-compatible object storage.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "garage", "enable"], "readOnly": false, "type": "boolean"}, "services.garage.extraConfig": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Additional `garage.toml` snippet appended to the generated config.\n", "loc": ["services", "garage", "extraConfig"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.garage.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.garage_2"}, "description": "Garage package to use.", "loc": ["services", "garage", "package"], "readOnly": false, "type": "package"}, "services.garage.region": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix"}], "default": {"_type": "literalExpression", "text": "\"us-east-1\""}, "description": "S3 region label reported by the server. Defaults to AWS's canonical\n`us-east-1`.\n", "loc": ["services", "garage", "region"], "readOnly": false, "type": "string"}, "services.garage.replicationFactor": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix"}], "default": {"_type": "literalExpression", "text": "1"}, "description": "Cluster replication factor. Single-node devenv setups always use 1.\n", "loc": ["services", "garage", "replicationFactor"], "readOnly": false, "type": "signed integer"}, "services.garage.rpcSecret": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix"}], "default": {"_type": "literalExpression", "text": "\"0000000000000000000000000000000000000000000000000000000000000000\""}, "description": "RPC secret as 64 hex characters. Hard-coded for single-node dev;\nproduction deployments override this with a real secret.\n", "loc": ["services", "garage", "rpcSecret"], "readOnly": false, "type": "string"}, "services.garage.s3Address": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1:3900\""}, "description": "IP address and port of the S3 API.", "loc": ["services", "garage", "s3Address"], "readOnly": false, "type": "string"}, "services.garage.ui.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable a simple web UI.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "garage", "ui", "enable"], "readOnly": false, "type": "boolean"}, "services.garage.ui.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix"}], "default": {"_type": "literalExpression", "text": "3919"}, "description": "On which port the UI should run.\n", "example": {"_type": "literalExpression", "text": "3919"}, "loc": ["services", "garage", "ui", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.garage.ui.start": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/garage.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to start the web UI automatically. When false it can be\nstarted manually. Only applies when `ui.enable = true`.\n", "loc": ["services", "garage", "ui", "start"], "readOnly": false, "type": "boolean"}, "services.httpbin.bind": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/httpbin.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/httpbin.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"127.0.0.1:8080\"\n]"}, "description": "Addresses for httpbin to listen on.", "loc": ["services", "httpbin", "bind"], "readOnly": false, "type": "list of string"}, "services.httpbin.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/httpbin.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/httpbin.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable httpbin.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "httpbin", "enable"], "readOnly": false, "type": "boolean"}, "services.httpbin.extraArgs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/httpbin.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/httpbin.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Gunicorn CLI arguments for httpbin.", "loc": ["services", "httpbin", "extraArgs"], "readOnly": false, "type": "list of string"}, "services.influxdb.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/influxdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/influxdb.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable influxdb.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "influxdb", "enable"], "readOnly": false, "type": "boolean"}, "services.influxdb.extraArgs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/influxdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/influxdb.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Additional arguments passed to `influxd` during startup.", "example": {"_type": "literalExpression", "text": "[\n \"--flux-log-enabled\"\n]"}, "loc": ["services", "influxdb", "extraArgs"], "readOnly": false, "type": "list of string"}, "services.influxdb.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/influxdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/influxdb.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.influxdb2-server"}, "description": "Which package of InfluxDB server to use", "loc": ["services", "influxdb", "package"], "readOnly": false, "type": "package"}, "services.influxdb.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/influxdb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/influxdb.nix"}], "default": {"_type": "literalExpression", "text": "8086"}, "description": "The TCP port for the InfluxDB HTTP API.", "loc": ["services", "influxdb", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.kafka.configFiles.log4jProperties": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix"}], "default": {"_type": "literalExpression", "text": "\"pkgs.writeText \\\"log4j.properties\\\" cfg.log4jProperties\""}, "description": "Kafka log4j property configuration file path", "loc": ["services", "kafka", "configFiles", "log4jProperties"], "readOnly": false, "type": "absolute path"}, "services.kafka.configFiles.serverProperties": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix"}], "description": "Kafka server.properties configuration file path.\nDefaults to the rendered `settings`.\n", "loc": ["services", "kafka", "configFiles", "serverProperties"], "readOnly": false, "type": "absolute path"}, "services.kafka.connect.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Kafka Connect.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "kafka", "connect", "enable"], "readOnly": false, "type": "boolean"}, "services.kafka.connect.initialConnectors": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of Kafka Connect connectors to set up initially\n", "loc": ["services", "kafka", "connect", "initialConnectors"], "readOnly": false, "type": "list of (open submodule of lazy attribute set of (null or boolean or signed integer or string or list of (boolean or signed integer or string)))"}, "services.kafka.connect.initialConnectors.*.config": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix"}], "description": "Initial configuration for the connector\n", "loc": ["services", "kafka", "connect", "initialConnectors", "*", "config"], "readOnly": false, "type": "attribute set"}, "services.kafka.connect.initialConnectors.*.name": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix"}], "description": "Name of the connector\n", "loc": ["services", "kafka", "connect", "initialConnectors", "*", "name"], "readOnly": false, "type": "string"}, "services.kafka.connect.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "{file}`connect-standalone.properties`.\n\nNote that .properties files contain mappings from string to string.\nKeys with dots are NOT represented by nested attrs in these settings,\nbut instead as quoted strings (ie. `settings.\"broker.id\"`, NOT\n`settings.broker.id`).\n", "loc": ["services", "kafka", "connect", "settings"], "readOnly": false, "type": "open submodule of lazy attribute set of (null or boolean or signed integer or string or list of (boolean or signed integer or string))"}, "services.kafka.connect.settings.\"bootstrap.servers\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"localhost:9092\"\n]"}, "description": "A list of host/port pairs to use for establishing the initial connection to the Kafka cluster.\n", "loc": ["services", "kafka", "connect", "settings", "bootstrap.servers"], "readOnly": false, "type": "list of string"}, "services.kafka.connect.settings.\"key.converter\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix"}], "default": {"_type": "literalExpression", "text": "\"org.apache.kafka.connect.json.JsonConverter\""}, "description": "The key converter to use for the connector.\n", "loc": ["services", "kafka", "connect", "settings", "key.converter"], "readOnly": false, "type": "string"}, "services.kafka.connect.settings.\"key.converter.schemas.enable\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether the key converter should include schema information in the message.\n", "loc": ["services", "kafka", "connect", "settings", "key.converter.schemas.enable"], "readOnly": false, "type": "boolean"}, "services.kafka.connect.settings.\"offset.flush.interval.ms\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix"}], "default": {"_type": "literalExpression", "text": "10000"}, "description": "Interval at which to try committing offsets for tasks\n", "loc": ["services", "kafka", "connect", "settings", "offset.flush.interval.ms"], "readOnly": false, "type": "signed integer"}, "services.kafka.connect.settings.\"offset.storage.file.filename\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix"}], "default": {"_type": "literalExpression", "text": "${config.env.DEVENV_STATE}/kafka/connect/connect.offsets"}, "description": "The file to store connector offsets in. By storing offsets on disk, a standalone process can be stopped and started on a single node and resume where it previously left off.\n", "loc": ["services", "kafka", "connect", "settings", "offset.storage.file.filename"], "readOnly": false, "type": "string"}, "services.kafka.connect.settings.\"plugin.path\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The list should consist of top level directories that include any combination of:\na) directories immediately containing jars with plugins and their dependencies\nb) uber-jars with plugins and their dependencies\nc) directories immediately containing the package directory structure of classes of plugins and their dependencies\nNote: symlinks will be followed to discover dependencies or plugins.\n", "loc": ["services", "kafka", "connect", "settings", "plugin.path"], "readOnly": false, "type": "null or (list of (string or absolute path))"}, "services.kafka.connect.settings.\"value.converter\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix"}], "default": {"_type": "literalExpression", "text": "\"org.apache.kafka.connect.json.JsonConverter\""}, "description": "The value converter to use for the connector.\n", "loc": ["services", "kafka", "connect", "settings", "value.converter"], "readOnly": false, "type": "string"}, "services.kafka.connect.settings.\"value.converter.schemas.enable\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether the value converter should include schema information in the message.\n", "loc": ["services", "kafka", "connect", "settings", "value.converter.schemas.enable"], "readOnly": false, "type": "boolean"}, "services.kafka.connect.settings.listeners": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka-connect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "List of listeners for Kafka Connect\n(By default Kafka Connect listens on http://localhost:8083)\n", "example": {"_type": "literalExpression", "text": "[\n \"http://localhost:8080\"\n]"}, "loc": ["services", "kafka", "connect", "settings", "listeners"], "readOnly": false, "type": "null or (list of string)"}, "services.kafka.defaultMode": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix"}], "default": {"_type": "literalExpression", "text": "\"kraft\""}, "description": "Which defaults to set for the mode Kafka should run in\n- `kraft` (default): Run Kafka in KRaft mode, Which requires no extra configuration.\n- `zookeeper`: Run Kafka in Zookeeper mode, this requires more configuration.\n", "loc": ["services", "kafka", "defaultMode"], "readOnly": false, "type": "one of \"zookeeper\", \"kraft\""}, "services.kafka.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Apache Kafka.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "kafka", "enable"], "readOnly": false, "type": "boolean"}, "services.kafka.formatLogDirs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to format log dirs in KRaft mode if all log dirs are\nunformatted, ie. they contain no meta.properties.\n", "loc": ["services", "kafka", "formatLogDirs"], "readOnly": false, "type": "boolean"}, "services.kafka.formatLogDirsIgnoreFormatted": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to ignore already formatted log dirs when formatting log dirs,\ninstead of failing. Useful when replacing or adding disks.\n", "loc": ["services", "kafka", "formatLogDirsIgnoreFormatted"], "readOnly": false, "type": "boolean"}, "services.kafka.jre": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.apacheKafka.passthru.jre"}, "description": "The JRE with which to run Kafka", "loc": ["services", "kafka", "jre"], "readOnly": false, "type": "package"}, "services.kafka.jvmOptions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Extra command line options for the JVM running Kafka.", "example": {"_type": "literalExpression", "text": "[\n \"-Djava.net.preferIPv4Stack=true\"\n \"-Dcom.sun.management.jmxremote\"\n \"-Dcom.sun.management.jmxremote.local.only=true\"\n]"}, "loc": ["services", "kafka", "jvmOptions"], "readOnly": false, "type": "list of string"}, "services.kafka.log4jProperties": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix"}], "default": {"_type": "literalExpression", "text": "''\n log4j.rootLogger=INFO, stdout\n \n log4j.appender.stdout=org.apache.log4j.ConsoleAppender\n log4j.appender.stdout.layout=org.apache.log4j.PatternLayout\n log4j.appender.stdout.layout.ConversionPattern=[%d] %p %m (%c)%n\n''"}, "description": "Kafka log4j property configuration.", "loc": ["services", "kafka", "log4jProperties"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.kafka.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.apacheKafka"}, "description": "The apacheKafka package to use.", "loc": ["services", "kafka", "package"], "readOnly": false, "type": "package"}, "services.kafka.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "[Kafka broker configuration](https://kafka.apache.org/documentation.html#brokerconfigs)\n{file}`server.properties`.\n\nNote that .properties files contain mappings from string to string.\nKeys with dots are NOT represented by nested attrs in these settings,\nbut instead as quoted strings (ie. `settings.\"broker.id\"`, NOT\n`settings.broker.id`).\n", "loc": ["services", "kafka", "settings"], "readOnly": false, "type": "open submodule of lazy attribute set of (null or boolean or signed integer or string or list of (boolean or signed integer or string))"}, "services.kafka.settings.\"broker.id\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Broker ID. -1 or null to auto-allocate in zookeeper mode.", "loc": ["services", "kafka", "settings", "broker.id"], "readOnly": false, "type": "null or signed integer"}, "services.kafka.settings.\"log.dirs\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix"}], "default": {"_type": "literalExpression", "text": "[ \"${config.devenv.state + \"/kafka\"}/logs\" ]"}, "description": "Log file directories.", "loc": ["services", "kafka", "settings", "log.dirs"], "readOnly": false, "type": "list of absolute path"}, "services.kafka.settings.listeners": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/kafka.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"PLAINTEXT://localhost:9092\"\n]"}, "description": "Kafka Listener List.\nSee [listeners](https://kafka.apache.org/documentation/#brokerconfigs_listeners).\nIf you change this, you should also update the readiness probe.\n", "loc": ["services", "kafka", "settings", "listeners"], "readOnly": false, "type": "list of string"}, "services.keycloak.database.type": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "\"dev-file\""}, "description": "The type of database Keycloak should connect to.\nIf you use `dev-mem`, the realm export over script\n`keycloak-realm-export-*` does not work.\n", "example": {"_type": "literalExpression", "text": "\"dev-mem\""}, "loc": ["services", "keycloak", "database", "type"], "readOnly": false, "type": "one of \"dev-mem\", \"dev-file\""}, "services.keycloak.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable the Keycloak identity and access management\nserver.\n", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "keycloak", "enable"], "readOnly": false, "type": "boolean"}, "services.keycloak.initialAdminPassword": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "\"admin\""}, "description": "Initial password set for the temporary `admin` user.\nThe password is not stored safely and should be changed\nimmediately in the admin panel.\n\nSee [Admin bootstrap and recovery](https://www.keycloak.org/server/bootstrap-admin-recovery) for details.\n", "loc": ["services", "keycloak", "initialAdminPassword"], "readOnly": false, "type": "string"}, "services.keycloak.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.keycloak"}, "description": "The keycloak package to use.", "loc": ["services", "keycloak", "package"], "readOnly": false, "type": "package"}, "services.keycloak.plugins": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Keycloak plugin jar, ear files or derivations containing\nthem. Packaged plugins are available through\n`pkgs.keycloak.plugins`.\n", "loc": ["services", "keycloak", "plugins"], "readOnly": false, "type": "list of absolute path"}, "services.keycloak.processes.exportRealms": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Global toggle to enable/disable the realms export process `keycloak-realm-export-all`\nif any realms have `realms.\u00abname\u00bb.export == true`.\n", "loc": ["services", "keycloak", "processes", "exportRealms"], "readOnly": false, "type": "boolean"}, "services.keycloak.realms": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Specify the realms you want to import on start up and\nexport on a manual start of process/script 'keycloak-realm-export-all'.\n", "example": {"_type": "literalExpression", "text": "{\n myrealm = {\n path = \"./myfolder/export.json\";\n import = true; # default\n export = true;\n };\n}\n"}, "loc": ["services", "keycloak", "realms"], "readOnly": false, "type": "attribute set of (submodule)"}, "services.keycloak.realms..export": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "If you want to export that realm on process/script launch `keycloak-export-realms`.\n", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "keycloak", "realms", "", "export"], "readOnly": false, "type": "boolean"}, "services.keycloak.realms..import": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "If you want to import that realm on start up, if the realm does not yet exist.\n", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "keycloak", "realms", "", "import"], "readOnly": false, "type": "boolean"}, "services.keycloak.realms..path": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The path (string, relative to `DEVENV_ROOT`) where you want to import (or export) this realm \u00abname\u00bb to.\nIf not set and `import` is `true` this realm is not imported.\nIf not set and `export` is `true` its exported to `$DEVENV_STATE/keycloak/realm-export/\u00abname\u00bb.json`.\n", "example": {"_type": "literalExpression", "text": "\"./realms/a.json\""}, "loc": ["services", "keycloak", "realms", "", "path"], "readOnly": false, "type": "null or relative path not in the Nix store"}, "services.keycloak.scripts.exportRealm": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Global toggle to enable/disable the **single** realm export\nscript `keycloak-realm-export`.\n", "loc": ["services", "keycloak", "scripts", "exportRealm"], "readOnly": false, "type": "boolean"}, "services.keycloak.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "description": "Configuration options corresponding to parameters set in\n{file}`conf/keycloak.conf`.\n\nMost available options are documented at .\n\nOptions containing secret data should be set to an attribute\nset containing the attribute `_secret` - a\nstring pointing to a file containing the value the option\nshould be set to. See the example to get a better picture of\nthis: in the resulting\n{file}`conf/keycloak.conf` file, the\n`https-key-store-password` key will be set\nto the contents of the\n{file}`/run/keys/store_password` file.\n", "example": {"_type": "literalExpression", "text": "{\n hostname = \"localhost\";\n https-key-store-file = \"/path/to/file\";\n https-key-store-password = { _secret = \"/run/keys/store_password\"; };\n}\n"}, "loc": ["services", "keycloak", "settings"], "readOnly": false, "type": "open submodule of attribute set of (null or string or signed integer or boolean or attribute set of absolute path)"}, "services.keycloak.settings.hostname": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "\"localhost\""}, "description": "The hostname part of the public URL used as base for\nall frontend requests.\n\nSee \nfor more information about hostname configuration.\n", "example": {"_type": "literalExpression", "text": "\"localhost\""}, "loc": ["services", "keycloak", "settings", "hostname"], "readOnly": false, "type": "string"}, "services.keycloak.settings.http-host": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "\"::\""}, "description": "On which address Keycloak should accept new connections.\n", "example": {"_type": "literalExpression", "text": "\"::1\""}, "loc": ["services", "keycloak", "settings", "http-host"], "readOnly": false, "type": "string"}, "services.keycloak.settings.http-port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "8080"}, "description": "On which port Keycloak should listen for new HTTP connections.\n", "example": {"_type": "literalExpression", "text": "8080"}, "loc": ["services", "keycloak", "settings", "http-port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.keycloak.settings.http-relative-path": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "\"/\""}, "description": "The path relative to `/` for serving\nresources.\n\n::: {.note}\nIn versions of Keycloak using Wildfly (<17),\nthis defaulted to `/auth`. If\nupgrading from the Wildfly version of Keycloak,\ni.e. a NixOS version before 22.05, you'll likely\nwant to set this to `/auth` to\nkeep compatibility with your clients.\n\nSee \nfor more information on migrating from Wildfly to Quarkus.\n:::\n", "example": {"_type": "literalExpression", "text": "\"/auth\""}, "loc": ["services", "keycloak", "settings", "http-relative-path"], "readOnly": false, "type": "string"}, "services.keycloak.settings.https-port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "34429"}, "description": "On which port Keycloak should listen for new HTTPS connections.\nIf its not set, its disabled.\n", "example": {"_type": "literalExpression", "text": "34429"}, "loc": ["services", "keycloak", "settings", "https-port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.keycloak.sslCertificate": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The path to a PEM formatted certificate to use for TLS/SSL\nconnections.\n", "example": {"_type": "literalExpression", "text": "\"/run/keys/ssl_cert\""}, "loc": ["services", "keycloak", "sslCertificate"], "readOnly": false, "type": "null or relative path not in the Nix store"}, "services.keycloak.sslCertificateKey": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/keycloak.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The path to a PEM formatted private key to use for TLS/SSL\nconnections.\n", "example": {"_type": "literalExpression", "text": "\"/run/keys/ssl_key\""}, "loc": ["services", "keycloak", "sslCertificateKey"], "readOnly": false, "type": "null or relative path not in the Nix store"}, "services.mailhog.additionalArgs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Additional arguments passed to `mailhog`.\n", "example": {"_type": "literalExpression", "text": "[\n \"-invite-jim\"\n]"}, "loc": ["services", "mailhog", "additionalArgs"], "readOnly": false, "type": "list of strings concatenated with \"\\n\""}, "services.mailhog.apiListenAddress": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1:8025\""}, "description": "Listen address for API.", "loc": ["services", "mailhog", "apiListenAddress"], "readOnly": false, "type": "string"}, "services.mailhog.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable mailhog process.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "mailhog", "enable"], "readOnly": false, "type": "boolean"}, "services.mailhog.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.mailhog"}, "description": "Which package of mailhog to use", "loc": ["services", "mailhog", "package"], "readOnly": false, "type": "package"}, "services.mailhog.smtpListenAddress": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1:1025\""}, "description": "Listen address for SMTP.", "loc": ["services", "mailhog", "smtpListenAddress"], "readOnly": false, "type": "string"}, "services.mailhog.uiListenAddress": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailhog.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1:8025\""}, "description": "Listen address for UI.", "loc": ["services", "mailhog", "uiListenAddress"], "readOnly": false, "type": "string"}, "services.mailpit.additionalArgs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Additional arguments passed to `mailpit`.\n", "example": {"_type": "literalExpression", "text": "[\n \"--max=500\"\n]"}, "loc": ["services", "mailpit", "additionalArgs"], "readOnly": false, "type": "list of strings concatenated with \"\\n\""}, "services.mailpit.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable mailpit process.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "mailpit", "enable"], "readOnly": false, "type": "boolean"}, "services.mailpit.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.mailpit"}, "description": "Which package of mailpit to use", "loc": ["services", "mailpit", "package"], "readOnly": false, "type": "package"}, "services.mailpit.smtpListenAddress": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1:1025\""}, "description": "Listen address for SMTP.\n\nEither `:`, where the port is the base devenv allocates\nfrom, or a unix socket as `unix::`, which is passed\nto mailpit as given. Mailpit requires the permissions.\n", "example": {"_type": "literalExpression", "text": "\"unix:${config.env.DEVENV_RUNTIME}/mailpit-smtp.sock:660\""}, "loc": ["services", "mailpit", "smtpListenAddress"], "readOnly": false, "type": "string"}, "services.mailpit.uiListenAddress": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mailpit.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1:8025\""}, "description": "Listen address for UI.\n\nEither `:`, where the port is the base devenv allocates\nfrom, or a unix socket as `unix::`, which is passed\nto mailpit as given. Mailpit requires the permissions.\n", "example": {"_type": "literalExpression", "text": "\"unix:${config.env.DEVENV_RUNTIME}/mailpit-ui.sock:660\""}, "loc": ["services", "mailpit", "uiListenAddress"], "readOnly": false, "type": "string"}, "services.meilisearch.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Meilisearch.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "meilisearch", "enable"], "readOnly": false, "type": "boolean"}, "services.meilisearch.environment": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix"}], "default": {"_type": "literalExpression", "text": "\"development\""}, "description": "Defines the running environment of Meilisearch.", "loc": ["services", "meilisearch", "environment"], "readOnly": false, "type": "one of \"development\", \"production\""}, "services.meilisearch.listenAddress": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "Meilisearch listen address.", "loc": ["services", "meilisearch", "listenAddress"], "readOnly": false, "type": "string"}, "services.meilisearch.listenPort": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix"}], "default": {"_type": "literalExpression", "text": "7700"}, "description": "Meilisearch port to listen on.", "loc": ["services", "meilisearch", "listenPort"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.meilisearch.logLevel": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix"}], "default": {"_type": "literalExpression", "text": "\"INFO\""}, "description": "Defines how much detail should be present in Meilisearch's logs.\nMeilisearch currently supports four log levels, listed in order of increasing verbosity:\n- 'ERROR': only log unexpected events indicating Meilisearch is not functioning as expected\n- 'WARN:' log all unexpected events, regardless of their severity\n- 'INFO:' log all events. This is the default value\n- 'DEBUG': log all events and including detailed information on Meilisearch's internal processes.\n Useful when diagnosing issues and debugging\n", "loc": ["services", "meilisearch", "logLevel"], "readOnly": false, "type": "string"}, "services.meilisearch.maxIndexSize": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix"}], "default": {"_type": "literalExpression", "text": "\"107374182400\""}, "description": "Sets the maximum size of the index.\nValue must be given in bytes or explicitly stating a base unit.\nFor example, the default value can be written as 107374182400, '107.7Gb', or '107374 Mb'.\nDefault is 100 GiB\n", "loc": ["services", "meilisearch", "maxIndexSize"], "readOnly": false, "type": "string"}, "services.meilisearch.noAnalytics": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Deactivates analytics.\nAnalytics allow Meilisearch to know how many users are using Meilisearch,\nwhich versions and which platforms are used.\nThis process is entirely anonymous.\n", "loc": ["services", "meilisearch", "noAnalytics"], "readOnly": false, "type": "boolean"}, "services.meilisearch.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/meilisearch.nix"}], "default": {"_type": "literalExpression", "text": "\"pkgs.meilisearch\""}, "description": "Which Meilisearch package to use", "loc": ["services", "meilisearch", "package"], "readOnly": false, "type": "package"}, "services.memcached.bind": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/memcached.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/memcached.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "The IP interface to bind to.\n`null` means \"all interfaces\".\n", "example": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "loc": ["services", "memcached", "bind"], "readOnly": false, "type": "null or string"}, "services.memcached.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/memcached.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/memcached.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable memcached process.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "memcached", "enable"], "readOnly": false, "type": "boolean"}, "services.memcached.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/memcached.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/memcached.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.memcached"}, "description": "Which package of memcached to use", "loc": ["services", "memcached", "package"], "readOnly": false, "type": "package"}, "services.memcached.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/memcached.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/memcached.nix"}], "default": {"_type": "literalExpression", "text": "11211"}, "description": "The TCP port to accept connections.\nIf port 0 is specified memcached will not listen on a TCP socket.\n", "loc": ["services", "memcached", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.memcached.startArgs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/memcached.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/memcached.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Additional arguments passed to `memcached` during startup.\n", "example": {"_type": "literalExpression", "text": "[\n \"--memory-limit=100M\"\n]"}, "loc": ["services", "memcached", "startArgs"], "readOnly": false, "type": "list of strings concatenated with \"\\n\""}, "services.minio.accessKey": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix"}], "default": {"_type": "literalExpression", "text": "\"minioadmin\""}, "description": "Access key of 5 to 20 characters in length that clients use to access the server.\n", "loc": ["services", "minio", "accessKey"], "readOnly": false, "type": "string"}, "services.minio.afterStart": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Bash code to execute after minio is running.", "example": {"_type": "literalExpression", "text": "''\n mc anonymous set download local/mybucket\n''"}, "loc": ["services", "minio", "afterStart"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.minio.browser": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Enable or disable access to web UI.", "loc": ["services", "minio", "browser"], "readOnly": false, "type": "boolean"}, "services.minio.buckets": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of buckets to ensure exist on startup.\n", "loc": ["services", "minio", "buckets"], "readOnly": false, "type": "list of string"}, "services.minio.clientConfig": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix"}], "description": "Contents of the mc `config.json`, as a nix attribute set.\n\nBy default, `local` is configured to connect to the devenv minio service.\nUse `lib.mkForce null` to use your regular mc configuration from `$HOME/.mc` instead.\n", "loc": ["services", "minio", "clientConfig"], "readOnly": false, "type": "null or JSON value"}, "services.minio.clientPackage": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.minio-client"}, "description": "MinIO client package to use.", "loc": ["services", "minio", "clientPackage"], "readOnly": false, "type": "package"}, "services.minio.consoleAddress": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1:9001\""}, "description": "IP address and port of the web UI (console).", "loc": ["services", "minio", "consoleAddress"], "readOnly": false, "type": "string"}, "services.minio.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable MinIO Object Storage.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "minio", "enable"], "readOnly": false, "type": "boolean"}, "services.minio.listenAddress": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1:9000\""}, "description": "IP address and port of the server.", "loc": ["services", "minio", "listenAddress"], "readOnly": false, "type": "string"}, "services.minio.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.minio"}, "description": "MinIO package to use.", "loc": ["services", "minio", "package"], "readOnly": false, "type": "package"}, "services.minio.region": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix"}], "default": {"_type": "literalExpression", "text": "\"us-east-1\""}, "description": "The physical location of the server. By default it is set to us-east-1, which is same as AWS S3's and MinIO's default region.\n", "loc": ["services", "minio", "region"], "readOnly": false, "type": "string"}, "services.minio.secretKey": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/minio.nix"}], "default": {"_type": "literalExpression", "text": "\"minioadmin\""}, "description": "Specify the Secret key of 8 to 40 characters in length that clients use to access the server.\n", "loc": ["services", "minio", "secretKey"], "readOnly": false, "type": "string"}, "services.mongodb.additionalArgs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"--noauth\"\n]"}, "description": "Additional arguments passed to `mongod`.\n", "example": {"_type": "literalExpression", "text": "[\n \"--port\"\n \"27017\"\n \"--noauth\"\n]"}, "loc": ["services", "mongodb", "additionalArgs"], "readOnly": false, "type": "list of strings concatenated with \"\\n\""}, "services.mongodb.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable MongoDB process and expose utilities.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "mongodb", "enable"], "readOnly": false, "type": "boolean"}, "services.mongodb.initDatabasePassword": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "This used in conjunction with initDatabaseUsername, create a new user and set that user's password. This user is created in the admin authentication database and given the role of root, which is a \"superuser\" role.\n", "example": {"_type": "literalExpression", "text": "\"secret\""}, "loc": ["services", "mongodb", "initDatabasePassword"], "readOnly": false, "type": "string"}, "services.mongodb.initDatabaseUsername": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "This used in conjunction with initDatabasePassword, create a new user and set that user's password. This user is created in the admin authentication database and given the role of root, which is a \"superuser\" role.\n", "example": {"_type": "literalExpression", "text": "\"mongoadmin\""}, "loc": ["services", "mongodb", "initDatabaseUsername"], "readOnly": false, "type": "string"}, "services.mongodb.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.mongodb-ce"}, "description": "Which MongoDB package to use.", "loc": ["services", "mongodb", "package"], "readOnly": false, "type": "package"}, "services.mongodb.replication.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable MongoDB replication with a 1-node replica-set..", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "mongodb", "replication", "enable"], "readOnly": false, "type": "boolean"}, "services.mongodb.replication.replSet": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mongodb.nix"}], "default": {"_type": "literalExpression", "text": "\"rs0\""}, "description": "Replica-set name", "example": {"_type": "literalExpression", "text": "\"rs0\""}, "loc": ["services", "mongodb", "replication", "replSet"], "readOnly": false, "type": "string"}, "services.mosquitto.bind": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mosquitto.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mosquitto.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "The IP interface to bind to.\n`null` means \"all interfaces\".\n", "example": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "loc": ["services", "mosquitto", "bind"], "readOnly": false, "type": "null or string"}, "services.mosquitto.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mosquitto.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mosquitto.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable mosquitto MQTT broker.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "mosquitto", "enable"], "readOnly": false, "type": "boolean"}, "services.mosquitto.extraConfig": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mosquitto.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mosquitto.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Additional text to append to `mosquitto.conf`.", "example": {"_type": "literalExpression", "text": "''\n max_queued_messages 1000\n''"}, "loc": ["services", "mosquitto", "extraConfig"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.mosquitto.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mosquitto.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mosquitto.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.mosquitto"}, "description": "Which package of mosquitto to use", "loc": ["services", "mosquitto", "package"], "readOnly": false, "type": "package"}, "services.mosquitto.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mosquitto.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mosquitto.nix"}], "default": {"_type": "literalExpression", "text": "1883"}, "description": "The TCP port to accept MQTT connections.", "loc": ["services", "mosquitto", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.mysql.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable MySQL process and expose utilities.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "mysql", "enable"], "readOnly": false, "type": "boolean"}, "services.mysql.ensureUsers": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Ensures that the specified users exist and have at least the ensured permissions.\nThe MySQL users will be identified using Unix socket authentication. This authenticates the Unix user with the\nsame name only, and that without the need for a password.\nThis option will never delete existing users or remove permissions, especially not when the value of this\noption is changed. This means that users created and permissions assigned once through this option or\notherwise have to be removed manually.\n", "example": {"_type": "literalExpression", "text": "[\n {\n name = \"devenv\";\n ensurePermissions = {\n \"devenv.*\" = \"ALL PRIVILEGES\";\n };\n }\n]\n"}, "loc": ["services", "mysql", "ensureUsers"], "readOnly": false, "type": "list of (submodule)"}, "services.mysql.ensureUsers.*.ensurePermissions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Permissions to ensure for the user, specified as attribute set.\nThe attribute names specify the database and tables to grant the permissions for,\nseparated by a dot. You may use wildcards here.\nThe attribute values specfiy the permissions to grant.\nYou may specify one or multiple comma-separated SQL privileges here.\nFor more information on how to specify the target\nand on which privileges exist, see the\n[GRANT syntax](https://mariadb.com/kb/en/library/grant/).\nThe attributes are used as `GRANT ${attrName} ON ${attrValue}`.\n", "example": {"_type": "literalExpression", "text": "{\n \"database.*\" = \"ALL PRIVILEGES\";\n \"*.*\" = \"SELECT, LOCK TABLES\";\n}\n"}, "loc": ["services", "mysql", "ensureUsers", "*", "ensurePermissions"], "readOnly": false, "type": "attribute set of string"}, "services.mysql.ensureUsers.*.host": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix"}], "default": {"_type": "literalExpression", "text": "\"localhost\""}, "description": "Host of the user to ensure.\n", "loc": ["services", "mysql", "ensureUsers", "*", "host"], "readOnly": false, "type": "string"}, "services.mysql.ensureUsers.*.name": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix"}], "description": "Name of the user to ensure.\n", "loc": ["services", "mysql", "ensureUsers", "*", "name"], "readOnly": false, "type": "string"}, "services.mysql.ensureUsers.*.password": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Password of the user to ensure.\n", "loc": ["services", "mysql", "ensureUsers", "*", "password"], "readOnly": false, "type": "null or string"}, "services.mysql.importTimeZones": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to import tzdata on the first startup of the mysql server\n", "loc": ["services", "mysql", "importTimeZones"], "readOnly": false, "type": "null or boolean"}, "services.mysql.initialDatabases": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of database names and their initial schemas that should be used to create databases on the first startup\nof MySQL. The schema attribute is optional: If not specified, an empty database is created.\n", "example": {"_type": "literalExpression", "text": "[\n { name = \"foodatabase\"; schema = ./foodatabase.sql; }\n { name = \"bardatabase\"; }\n]\n"}, "loc": ["services", "mysql", "initialDatabases"], "readOnly": false, "type": "list of (submodule)"}, "services.mysql.initialDatabases.*.name": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix"}], "description": "The name of the database to create.\n", "loc": ["services", "mysql", "initialDatabases", "*", "name"], "readOnly": false, "type": "string"}, "services.mysql.initialDatabases.*.schema": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The initial schema of the database; if null (the default),\nan empty database is created.\n", "loc": ["services", "mysql", "initialDatabases", "*", "schema"], "readOnly": false, "type": "null or absolute path"}, "services.mysql.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.mariadb"}, "description": "Which package of MySQL to use", "loc": ["services", "mysql", "package"], "readOnly": false, "type": "package"}, "services.mysql.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "MySQL configuration.\n", "example": {"_type": "literalExpression", "text": "{\n mysqld = {\n key_buffer_size = \"6G\";\n table_cache = 1600;\n log-error = \"/var/log/mysql_err.log\";\n plugin-load-add = [ \"server_audit\" \"ed25519=auth_ed25519\" ];\n };\n mysqldump = {\n quick = true;\n max_allowed_packet = \"16M\";\n };\n}\n"}, "loc": ["services", "mysql", "settings"], "readOnly": false, "type": "lazy attribute set of lazy attribute set of anything"}, "services.mysql.useDefaultsExtraFile": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/mysql.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to use defaults-exta-file for the mysql command instead of defaults-file.\nThis is useful if you want to provide a config file on the command line.\nHowever this can problematic if you have MySQL installed globaly because its config might leak into your environment.\nThis option does not affect the mysqld command.\n", "loc": ["services", "mysql", "useDefaultsExtraFile"], "readOnly": false, "type": "boolean"}, "services.nats.authorization.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable authorization for client connections.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "nats", "authorization", "enable"], "readOnly": false, "type": "boolean"}, "services.nats.authorization.password": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Password required for client connections.\nOnly used if authorization is enabled.\nWarning: This will be visible in the Nix store.\n", "example": {"_type": "literalExpression", "text": "\"nats-pass\""}, "loc": ["services", "nats", "authorization", "password"], "readOnly": false, "type": "string"}, "services.nats.authorization.token": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Token required for client connections.\nAlternative to user/password authentication.\nWarning: This will be visible in the Nix store.\n", "example": {"_type": "literalExpression", "text": "\"my-secret-token\""}, "loc": ["services", "nats", "authorization", "token"], "readOnly": false, "type": "string"}, "services.nats.authorization.user": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Username required for client connections.\nOnly used if authorization is enabled.\n", "example": {"_type": "literalExpression", "text": "\"nats-user\""}, "loc": ["services", "nats", "authorization", "user"], "readOnly": false, "type": "string"}, "services.nats.clientAdvertise": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Client URL to advertise to other servers in a cluster.\nUseful when running behind NAT or in containers.\n", "example": {"_type": "literalExpression", "text": "\"localhost:4222\""}, "loc": ["services", "nats", "clientAdvertise"], "readOnly": false, "type": "string"}, "services.nats.debug": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Enable debug logging for troubleshooting.\n", "loc": ["services", "nats", "debug"], "readOnly": false, "type": "boolean"}, "services.nats.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable the NATS messaging server.\n\nNATS is a simple, secure and high performance messaging\nsystem for cloud native applications, IoT messaging,\nand microservices architectures.\n", "loc": ["services", "nats", "enable"], "readOnly": false, "type": "boolean"}, "services.nats.host": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "Network host to listen on for client connections.\nSet to \"0.0.0.0\" to listen on all interfaces.\nDefault is localhost for security.\n", "example": {"_type": "literalExpression", "text": "\"0.0.0.0\""}, "loc": ["services", "nats", "host"], "readOnly": false, "type": "string"}, "services.nats.jetstream.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable JetStream persistence layer for streaming and queues.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "nats", "jetstream", "enable"], "readOnly": false, "type": "boolean"}, "services.nats.jetstream.maxFileStore": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "\"10G\""}, "description": "Maximum disk space for file-based streams.\nUse suffixes: K, M, G, T for sizes.\n", "example": {"_type": "literalExpression", "text": "\"100G\""}, "loc": ["services", "nats", "jetstream", "maxFileStore"], "readOnly": false, "type": "string"}, "services.nats.jetstream.maxMemory": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "\"1G\""}, "description": "Maximum memory for in-memory streams.\nUse suffixes: K, M, G, T for sizes.\n", "example": {"_type": "literalExpression", "text": "\"512M\""}, "loc": ["services", "nats", "jetstream", "maxMemory"], "readOnly": false, "type": "string"}, "services.nats.logFile": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Path to log file. If empty, logs to stdout.\nStdout is recommended for devenv as logs are captured by process manager.\n", "example": {"_type": "literalExpression", "text": "\"/var/log/nats-server.log\""}, "loc": ["services", "nats", "logFile"], "readOnly": false, "type": "string"}, "services.nats.monitoring.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Enable HTTP monitoring endpoint.\nProvides /healthz, /varz, /connz, and other monitoring endpoints.\nHighly recommended for production deployments.\n", "loc": ["services", "nats", "monitoring", "enable"], "readOnly": false, "type": "boolean"}, "services.nats.monitoring.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "8222"}, "description": "Port for HTTP monitoring endpoint.\nAccess monitoring at `http://host:port/varz`\n", "loc": ["services", "nats", "monitoring", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.nats.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.nats-server"}, "description": "Which NATS server package to use.\n", "loc": ["services", "nats", "package"], "readOnly": false, "type": "package"}, "services.nats.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "4222"}, "description": "Port to listen on for client connections.\n", "loc": ["services", "nats", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.nats.serverName": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Server name for identification in clusters.\nIf empty, NATS will auto-generate a unique name.\n", "example": {"_type": "literalExpression", "text": "\"nats-dev-1\""}, "loc": ["services", "nats", "serverName"], "readOnly": false, "type": "string"}, "services.nats.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Additional NATS server configuration as a Nix attribute set.\nThis will be converted to NATS config file format.\n\nUse this for advanced features like:\n- TLS/SSL configuration\n- Clustering with routes\n- MQTT gateway\n- WebSocket support\n- Custom authorization\n\nSee https://docs.nats.io/running-a-nats-service/configuration\n", "example": {"_type": "literalExpression", "text": "{\n tls = {\n cert_file = \"/path/to/cert.pem\";\n key_file = \"/path/to/key.pem\";\n verify = true;\n };\n cluster = {\n name = \"my-cluster\";\n listen = \"0.0.0.0:6222\";\n routes = [\n \"nats://node1:6222\"\n \"nats://node2:6222\"\n ];\n };\n}\n"}, "loc": ["services", "nats", "settings"], "readOnly": false, "type": "attribute set"}, "services.nats.trace": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nats.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Enable protocol tracing for deep debugging.\nWarning: Very verbose output.\n", "loc": ["services", "nats", "trace"], "readOnly": false, "type": "boolean"}, "services.nginx.defaultMimeTypes": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nginx.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nginx.nix"}], "default": {"_type": "literalExpression", "text": "${pkgs.mailcap}/etc/nginx/mime.types"}, "description": "Default MIME types for NGINX, as MIME types definitions from NGINX are very incomplete,\nwe use by default the ones bundled in the mailcap package, used by most of the other\nLinux distributions.\n", "example": {"_type": "literalExpression", "text": "${pkgs.nginx}/conf/mime.types"}, "loc": ["services", "nginx", "defaultMimeTypes"], "readOnly": false, "type": "absolute path"}, "services.nginx.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nginx.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nginx.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable nginx.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "nginx", "enable"], "readOnly": false, "type": "boolean"}, "services.nginx.eventsConfig": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nginx.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nginx.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "The nginx events configuration.", "loc": ["services", "nginx", "eventsConfig"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.nginx.httpConfig": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nginx.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nginx.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "The nginx configuration.", "loc": ["services", "nginx", "httpConfig"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.nginx.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nginx.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nginx.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.nginx"}, "description": "The nginx package to use.", "loc": ["services", "nginx", "package"], "readOnly": false, "type": "package"}, "services.nixseparatedebuginfod.cache.directory": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nixseparatedebuginfod.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nixseparatedebuginfod.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Override the directory where files downloaded from the substituter are stored.\n\nDefault is `$XDG_CACHE_DIR/nixseparatedebuginfod2`.\n", "loc": ["services", "nixseparatedebuginfod", "cache", "directory"], "readOnly": false, "type": "null or string"}, "services.nixseparatedebuginfod.cache.expiration": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nixseparatedebuginfod.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nixseparatedebuginfod.nix"}], "default": {"_type": "literalExpression", "text": "\"1d\""}, "description": "How long to keep cache entries.\nA number followed by a unit.\n", "loc": ["services", "nixseparatedebuginfod", "cache", "expiration"], "readOnly": false, "type": "string"}, "services.nixseparatedebuginfod.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nixseparatedebuginfod.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nixseparatedebuginfod.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable nixseparatedebuginfod.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "nixseparatedebuginfod", "enable"], "readOnly": false, "type": "boolean"}, "services.nixseparatedebuginfod.host": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nixseparatedebuginfod.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nixseparatedebuginfod.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "IP address for nixseparatedebuginfod to listen on.", "loc": ["services", "nixseparatedebuginfod", "host"], "readOnly": false, "type": "string"}, "services.nixseparatedebuginfod.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nixseparatedebuginfod.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nixseparatedebuginfod.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.nixseparatedebuginfod2"}, "description": "nixseparatedebuginfod package to use.", "loc": ["services", "nixseparatedebuginfod", "package"], "readOnly": false, "type": "package"}, "services.nixseparatedebuginfod.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nixseparatedebuginfod.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nixseparatedebuginfod.nix"}], "default": {"_type": "literalExpression", "text": "1949"}, "description": "Port for nixseparatedebuginfod to listen on.", "loc": ["services", "nixseparatedebuginfod", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.nixseparatedebuginfod.substituters": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/nixseparatedebuginfod.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/nixseparatedebuginfod.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"local:\"\n \"https://cache.nixos.org\"\n]"}, "description": "Substituters to fetch debuginfo from.\n", "loc": ["services", "nixseparatedebuginfod", "substituters"], "readOnly": false, "type": "list of string"}, "services.opensearch.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable OpenSearch.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "opensearch", "enable"], "readOnly": false, "type": "boolean"}, "services.opensearch.extraCmdLineOptions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Extra command line options for the OpenSearch launcher.", "loc": ["services", "opensearch", "extraCmdLineOptions"], "readOnly": false, "type": "list of string"}, "services.opensearch.extraJavaOptions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Extra command line options for Java.", "example": {"_type": "literalExpression", "text": "[\n \"-Djava.net.preferIPv4Stack=true\"\n]"}, "loc": ["services", "opensearch", "extraJavaOptions"], "readOnly": false, "type": "list of string"}, "services.opensearch.logging": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix"}], "default": {"_type": "literalExpression", "text": "''\n logger.action.name = org.opensearch.action\n logger.action.level = info\n appender.console.type = Console\n appender.console.name = console\n appender.console.layout.type = PatternLayout\n appender.console.layout.pattern = [%d{ISO8601}][%-5p][%-25c{1.}] %marker%m%n\n rootLogger.level = info\n rootLogger.appenderRef.console.ref = console\n''"}, "description": "OpenSearch logging configuration.", "loc": ["services", "opensearch", "logging"], "readOnly": false, "type": "string"}, "services.opensearch.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.opensearch"}, "description": "The OpenSearch package to use.", "loc": ["services", "opensearch", "package"], "readOnly": false, "type": "package"}, "services.opensearch.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "OpenSearch configuration.\n", "loc": ["services", "opensearch", "settings"], "readOnly": false, "type": "open submodule of (YAML 1.1 value)"}, "services.opensearch.settings.\"cluster.name\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix"}], "default": {"_type": "literalExpression", "text": "\"opensearch\""}, "description": "The name of the cluster.\n", "loc": ["services", "opensearch", "settings", "cluster.name"], "readOnly": false, "type": "string"}, "services.opensearch.settings.\"discovery.type\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix"}], "default": {"_type": "literalExpression", "text": "\"single-node\""}, "description": "The type of discovery to use.\n", "loc": ["services", "opensearch", "settings", "discovery.type"], "readOnly": false, "type": "string"}, "services.opensearch.settings.\"http.port\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix"}], "default": {"_type": "literalExpression", "text": "9200"}, "description": "The port to listen on for HTTP traffic.\n", "loc": ["services", "opensearch", "settings", "http.port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.opensearch.settings.\"network.host\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "Which port this service should listen on.\n", "loc": ["services", "opensearch", "settings", "network.host"], "readOnly": false, "type": "string"}, "services.opensearch.settings.\"plugins.security.disabled\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to disable the security plugin. When set to false, SSL configuration is required.\nTo enable SSL, set `plugins.security.ssl.transport.keystore_filepath` or both\n`plugins.security.ssl.transport.server.pemcert_filepath` and\n`plugins.security.ssl.transport.client.pemcert_filepath`.\n", "loc": ["services", "opensearch", "settings", "plugins.security.disabled"], "readOnly": false, "type": "boolean"}, "services.opensearch.settings.\"transport.port\"": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opensearch.nix"}], "default": {"_type": "literalExpression", "text": "9300"}, "description": "The port to listen on for transport traffic.\n", "loc": ["services", "opensearch", "settings", "transport.port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.opentelemetry-collector.configFile": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opentelemetry-collector.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opentelemetry-collector.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Override the configuration file used by OpenTelemetry Collector.\nBy default, a configuration is generated from `services.opentelemetry-collector.settings`.\n\nIf overriding, enable the `health_check` extension to allow the readiness probe to check whether the Collector is ready.\nOtherwise, disable the readiness probe by setting `processes.opentelemetry-collector.ready = lib.mkForce null;`.\n", "example": {"_type": "literalExpression", "text": "pkgs.writeTextFile { name = \"otel-config.yaml\"; text = \"...\"; }\n"}, "loc": ["services", "opentelemetry-collector", "configFile"], "readOnly": false, "type": "null or absolute path"}, "services.opentelemetry-collector.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opentelemetry-collector.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opentelemetry-collector.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable opentelemetry-collector.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "opentelemetry-collector", "enable"], "readOnly": false, "type": "boolean"}, "services.opentelemetry-collector.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opentelemetry-collector.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opentelemetry-collector.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.opentelemetry-collector-contrib"}, "description": "The OpenTelemetry Collector package to use", "loc": ["services", "opentelemetry-collector", "package"], "readOnly": false, "type": "package"}, "services.opentelemetry-collector.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/opentelemetry-collector.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/opentelemetry-collector.nix"}], "default": {"_type": "literalExpression", "text": "defaultSettings"}, "description": "OpenTelemetry Collector configuration.\nRefer to https://opentelemetry.io/docs/collector/configuration/\nfor more information on how to configure the Collector.\n", "loc": ["services", "opentelemetry-collector", "settings"], "readOnly": false, "type": "open submodule of (YAML 1.1 value)"}, "services.postgres.createDatabase": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Create a database named like current user on startup. Only applies when initialDatabases is an empty list.\n", "loc": ["services", "postgres", "createDatabase"], "readOnly": false, "type": "boolean"}, "services.postgres.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Add PostgreSQL process.\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "postgres", "enable"], "readOnly": false, "type": "boolean"}, "services.postgres.extensions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Additional PostgreSQL extensions to install.\n\nThe available extensions are:\n\n- age\n- anonymizer\n- apache_datasketches\n- callPackage\n- citus\n- cstore_fdw\n- h3-pg\n- hypopg\n- ip4r\n- jsonb_deep_sum\n- lantern\n- omnigres\n- periods\n- pg-gvm\n- pg-semver\n- pg_auto_failover\n- pg_background\n- pg_bigm\n- pg_byteamagic\n- pg_cron\n- pg_csv\n- pg_ed25519\n- pg_embedding\n- pg_graphql\n- pg_hint_plan\n- pg_hll\n- pg_ivm\n- pg_libversion\n- pg_net\n- pg_partman\n- pg_rational\n- pg_relusage\n- pg_repack\n- pg_roaringbitmap\n- pg_safeupdate\n- pg_search\n- pg_similarity\n- pg_squeeze\n- pg_tle\n- pg_topn\n- pg_uuidv7\n- pgaudit\n- pgddl\n- pgjwt\n- pgmq\n- pgroonga\n- pgrouting\n- pgsodium\n- pgsql-http\n- pgtap\n- pgvecto-rs\n- pgvector\n- pgvectorscale\n- pgx_ulid\n- plperl\n- plpgsql_check\n- plpython3\n- plr\n- pltcl\n- plv8\n- pointcloud\n- postgis\n- repmgr\n- rum\n- smlar\n- sqlite_fdw\n- system_stats\n- tds_fdw\n- temporal_tables\n- timescaledb\n- timescaledb-apache\n- timescaledb_toolkit\n- tsja\n- vectorchord\n- wal2json\n\n", "example": {"_type": "literalExpression", "text": "extensions: [\n extensions.pg_cron\n extensions.postgis\n extensions.timescaledb\n];\n"}, "loc": ["services", "postgres", "extensions"], "readOnly": false, "type": "null or (function that evaluates to a(n) list of package)"}, "services.postgres.hbaConf": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The contents of a custom pg_hba.conf file to copy into the postgres installation.\nThis allows for custom connection rules that you want to establish on the server.\n", "example": {"_type": "literalExpression", "text": "builtins.readFile ./my-custom/directory/to/pg_hba.conf\n"}, "loc": ["services", "postgres", "hbaConf"], "readOnly": false, "type": "null or string"}, "services.postgres.initdbArgs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"--locale=C\"\n \"--encoding=UTF8\"\n]"}, "description": "Additional arguments passed to `initdb` during data dir\ninitialisation.\n", "example": {"_type": "literalExpression", "text": "[\n \"--data-checksums\"\n \"--allow-group-access\"\n]"}, "loc": ["services", "postgres", "initdbArgs"], "readOnly": false, "type": "list of strings concatenated with \"\\n\""}, "services.postgres.initialDatabases": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of database names and their initial schemas that should be used to create databases on the first startup\nof Postgres. The schema attribute is optional: If not specified, an empty database is created.\n", "example": {"_type": "literalExpression", "text": "[\n {\n name = \"foodatabase\";\n schema = ./foodatabase.sql;\n }\n { name = \"bardatabase\"; }\n]\n"}, "loc": ["services", "postgres", "initialDatabases"], "readOnly": false, "type": "list of (submodule)"}, "services.postgres.initialDatabases.*.initialSQL": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "SQL commands to run on this specific database during it's initialization.\nMultiple SQL expressions can be separated by semicolons.\n", "example": {"_type": "literalExpression", "text": "CREATE TABLE users (id SERIAL PRIMARY KEY, name TEXT);\nINSERT INTO users (name) VALUES ('admin');\nCREATE EXTENSION IF NOT EXISTS pg_uuidv7;\n"}, "loc": ["services", "postgres", "initialDatabases", "*", "initialSQL"], "readOnly": false, "type": "null or string"}, "services.postgres.initialDatabases.*.name": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "description": "The name of the database to create.\n", "loc": ["services", "postgres", "initialDatabases", "*", "name"], "readOnly": false, "type": "string"}, "services.postgres.initialDatabases.*.pass": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Password of the database owner role. Requires `user` to be set.\n", "loc": ["services", "postgres", "initialDatabases", "*", "pass"], "readOnly": false, "type": "null or string"}, "services.postgres.initialDatabases.*.schema": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The initial schema of the database; if null (the default),\nan empty database is created.\n", "loc": ["services", "postgres", "initialDatabases", "*", "schema"], "readOnly": false, "type": "null or absolute path"}, "services.postgres.initialDatabases.*.user": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Username of owner of the database. If set, a role with this name is created and the database is owned by it. If null, the default $USER is used.\n", "loc": ["services", "postgres", "initialDatabases", "*", "user"], "readOnly": false, "type": "null or string"}, "services.postgres.initialScript": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Initial SQL commands to run during database initialization. This can be multiple\nSQL expressions separated by a semi-colon.\nUse `initialScript` for server-wide setup, such as creating roles or configuring\nglobal settings. For database-specific initialization, use `initialSQL` within\n`initialDatabases`. `initialScript` is executed after the `initialDatabases`\nsetup is done.\n", "example": {"_type": "literalExpression", "text": "CREATE ROLE postgres SUPERUSER;\nCREATE ROLE bar;\n"}, "loc": ["services", "postgres", "initialScript"], "readOnly": false, "type": "null or string"}, "services.postgres.listen_addresses": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "A comma-separated list of TCP/IP address(es) on which the server should listen for connections.\n\nBy default, the server only accepts connections over unix sockets.\n\nThis option is parsed to set the `PGHOST` environment variable.\n\nSpecial values:\n - \\'*\\' to listen on all available network interfaces.\n - \\'0.0.0.0\\' to listen on all available IPv4 network interfaces.\n - \\'::\\' to listen on all available IPv6 network interfaces.\n - \\'localhost\\' to listen only on the loopback interface.\n - \\'\\' (empty string) disables TCP/IP connections and listens only on the unix socket.\n", "example": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "loc": ["services", "postgres", "listen_addresses"], "readOnly": false, "type": "string"}, "services.postgres.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.postgresql"}, "description": "The PostgreSQL package to use. Use this to override the default with a specific version.\n", "example": {"_type": "literalExpression", "text": "pkgs.postgresql_15\n"}, "loc": ["services", "postgres", "package"], "readOnly": false, "type": "package"}, "services.postgres.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "default": {"_type": "literalExpression", "text": "5432"}, "description": "The TCP port to accept connections.\n", "loc": ["services", "postgres", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.postgres.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/postgres.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "PostgreSQL configuration. Refer to\n\nfor an overview of `postgresql.conf`.\n\nString values will automatically be enclosed in single quotes. Single quotes will be\nescaped with two single quotes as described by the upstream documentation linked above.\n", "example": {"_type": "literalExpression", "text": "{\n log_connections = true;\n log_statement = \"all\";\n logging_collector = true\n log_disconnections = true\n log_destination = lib.mkForce \"syslog\";\n}\n"}, "loc": ["services", "postgres", "settings"], "readOnly": false, "type": "attribute set of (boolean or floating point number or signed integer or string)"}, "services.prometheus.advanced.storage": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Storage configuration", "loc": ["services", "prometheus", "advanced", "storage"], "readOnly": false, "type": "attribute set"}, "services.prometheus.advanced.tsdb": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "TSDB configuration", "loc": ["services", "prometheus", "advanced", "tsdb"], "readOnly": false, "type": "attribute set"}, "services.prometheus.alerting": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Alerting configuration", "loc": ["services", "prometheus", "alerting"], "readOnly": false, "type": "null or (attribute set)"}, "services.prometheus.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Prometheus monitoring system.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "prometheus", "enable"], "readOnly": false, "type": "boolean"}, "services.prometheus.experimentalFeatures.enableExemplars": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Enable exemplar storage", "loc": ["services", "prometheus", "experimentalFeatures", "enableExemplars"], "readOnly": false, "type": "boolean"}, "services.prometheus.experimentalFeatures.enableOTLP": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Enable OTLP receiver", "loc": ["services", "prometheus", "experimentalFeatures", "enableOTLP"], "readOnly": false, "type": "boolean"}, "services.prometheus.experimentalFeatures.enableTracing": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Enable tracing", "loc": ["services", "prometheus", "experimentalFeatures", "enableTracing"], "readOnly": false, "type": "boolean"}, "services.prometheus.extraArgs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Additional arguments to pass to Prometheus", "loc": ["services", "prometheus", "extraArgs"], "readOnly": false, "type": "string"}, "services.prometheus.globalConfig": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "{\n evaluation_interval = \"1m\";\n scrape_interval = \"1m\";\n scrape_timeout = \"10s\";\n}"}, "description": "Global Prometheus configuration", "loc": ["services", "prometheus", "globalConfig"], "readOnly": false, "type": "attribute set"}, "services.prometheus.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.prometheus"}, "description": "Which package of Prometheus to use", "loc": ["services", "prometheus", "package"], "readOnly": false, "type": "package"}, "services.prometheus.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "9090"}, "description": "Port for Prometheus web interface.", "loc": ["services", "prometheus", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.prometheus.remoteRead": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Remote read configurations", "loc": ["services", "prometheus", "remoteRead"], "readOnly": false, "type": "list of (attribute set)"}, "services.prometheus.remoteWrite": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Remote write configurations", "loc": ["services", "prometheus", "remoteWrite"], "readOnly": false, "type": "list of (attribute set)"}, "services.prometheus.ruleFiles": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of rule files to load", "loc": ["services", "prometheus", "ruleFiles"], "readOnly": false, "type": "list of string"}, "services.prometheus.scrapeConfigs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of scrape configurations", "loc": ["services", "prometheus", "scrapeConfigs"], "readOnly": false, "type": "list of (attribute set)"}, "services.prometheus.storage.path": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "${config.devenv.state}/prometheus"}, "description": "Path where Prometheus will store its database", "loc": ["services", "prometheus", "storage", "path"], "readOnly": false, "type": "string"}, "services.prometheus.storage.retentionTime": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/prometheus.nix"}], "default": {"_type": "literalExpression", "text": "\"15d\""}, "description": "How long to retain data", "loc": ["services", "prometheus", "storage", "retentionTime"], "readOnly": false, "type": "string"}, "services.rabbitmq.configItems": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Configuration options in RabbitMQ's new config file format,\nwhich is a simple key-value format that can not express nested\ndata structures. This is known as the `rabbitmq.conf` file,\nalthough outside NixOS that filename may have Erlang syntax, particularly\nprior to RabbitMQ 3.7.0.\nIf you do need to express nested data structures, you can use\n`config` option. Configuration from `config`\nwill be merged into these options by RabbitMQ at runtime to\nform the final configuration.\nSee \nFor the distinct formats, see \n", "example": {"_type": "literalExpression", "text": "{\n \"auth_backends.1.authn\" = \"rabbit_auth_backend_ldap\";\n \"auth_backends.1.authz\" = \"rabbit_auth_backend_internal\";\n}\n"}, "loc": ["services", "rabbitmq", "configItems"], "readOnly": false, "type": "attribute set of string"}, "services.rabbitmq.cookie": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Erlang cookie is a string of arbitrary length which must\nbe the same for several nodes to be allowed to communicate.\nLeave empty to generate automatically.\n", "loc": ["services", "rabbitmq", "cookie"], "readOnly": false, "type": "string"}, "services.rabbitmq.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable the RabbitMQ server, an Advanced Message\nQueuing Protocol (AMQP) broker.\n", "loc": ["services", "rabbitmq", "enable"], "readOnly": false, "type": "boolean"}, "services.rabbitmq.listenAddress": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "IP address on which RabbitMQ will listen for AMQP\nconnections. Set to the empty string to listen on all\ninterfaces. Note that RabbitMQ creates a user named\n`guest` with password\n`guest` by default, so you should delete\nthis user if you intend to allow external access.\nTogether with 'port' setting it's mostly an alias for\nconfigItems.\"listeners.tcp.1\" and it's left for backwards\ncompatibility with previous version of this module.\n", "example": {"_type": "literalExpression", "text": "\"\""}, "loc": ["services", "rabbitmq", "listenAddress"], "readOnly": false, "type": "string"}, "services.rabbitmq.managementPlugin.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable the management plugin.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "rabbitmq", "managementPlugin", "enable"], "readOnly": false, "type": "boolean"}, "services.rabbitmq.managementPlugin.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix"}], "default": {"_type": "literalExpression", "text": "15672"}, "description": "On which port to run the management plugin.\n", "loc": ["services", "rabbitmq", "managementPlugin", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.rabbitmq.nodeName": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix"}], "default": {"_type": "literalExpression", "text": "\"rabbit@localhost\""}, "description": "The name of the RabbitMQ node. This is used to identify\nthe node in a cluster. If you are running multiple\nRabbitMQ nodes on the same machine, you must give each\nnode a unique name. The name must be of the form\n`name@host`, where `name` is an arbitrary name and\n`host` is the domain name of the host.\n", "loc": ["services", "rabbitmq", "nodeName"], "readOnly": false, "type": "string"}, "services.rabbitmq.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.rabbitmq-server"}, "description": "Which rabbitmq package to use.\n", "loc": ["services", "rabbitmq", "package"], "readOnly": false, "type": "package"}, "services.rabbitmq.pluginDirs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "The list of directories containing external plugins", "loc": ["services", "rabbitmq", "pluginDirs"], "readOnly": false, "type": "list of absolute path"}, "services.rabbitmq.plugins": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "The names of plugins to enable", "loc": ["services", "rabbitmq", "plugins"], "readOnly": false, "type": "list of string"}, "services.rabbitmq.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rabbitmq.nix"}], "default": {"_type": "literalExpression", "text": "5672"}, "description": "Port on which RabbitMQ will listen for AMQP connections.\n", "loc": ["services", "rabbitmq", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.redis.bind": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/redis.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/redis.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "The IP interface to bind to.\n`null` means \"all interfaces\".\n", "example": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "loc": ["services", "redis", "bind"], "readOnly": false, "type": "null or string"}, "services.redis.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/redis.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/redis.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Redis process and expose utilities.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "redis", "enable"], "readOnly": false, "type": "boolean"}, "services.redis.extraConfig": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/redis.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/redis.nix"}], "default": {"_type": "literalExpression", "text": "\"locale-collate C\""}, "description": "Additional text to be appended to `redis.conf`.", "loc": ["services", "redis", "extraConfig"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.redis.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/redis.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/redis.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.redis"}, "description": "Which package of Redis to use", "loc": ["services", "redis", "package"], "readOnly": false, "type": "package"}, "services.redis.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/redis.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/redis.nix"}], "default": {"_type": "literalExpression", "text": "6379"}, "description": "The TCP port to accept connections.\nIf port 0 is specified, Redis will not listen on a TCP socket and a unix socket file will be found at $REDIS_UNIX_SOCKET.\n", "loc": ["services", "redis", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.rustfs.accessKey": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix"}], "default": {"_type": "literalExpression", "text": "\"rustfsadmin\""}, "description": "Access key for authentication (5 to 20 characters).", "loc": ["services", "rustfs", "accessKey"], "readOnly": false, "type": "string"}, "services.rustfs.bind": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "The IP interface to bind to.\n`null` means \"all interfaces\".\n", "loc": ["services", "rustfs", "bind"], "readOnly": false, "type": "null or string"}, "services.rustfs.consoleEnable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Enable or disable the web console.", "loc": ["services", "rustfs", "consoleEnable"], "readOnly": false, "type": "boolean"}, "services.rustfs.consolePort": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix"}], "default": {"_type": "literalExpression", "text": "9001"}, "description": "The TCP port for the web console.", "loc": ["services", "rustfs", "consolePort"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.rustfs.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable RustFS object storage.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "rustfs", "enable"], "readOnly": false, "type": "boolean"}, "services.rustfs.extraEnvironment": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Additional environment variables to pass to RustFS.\nSee the RustFS documentation for available options\n(e.g. `RUSTFS_CORS_ALLOWED_ORIGINS`, `RUSTFS_TLS_PATH`).\n", "example": {"_type": "literalExpression", "text": "{\n RUSTFS_OBJECT_CACHE_ENABLE = \"true\";\n RUSTFS_OBS_LOGGER_LEVEL = \"debug\";\n}"}, "loc": ["services", "rustfs", "extraEnvironment"], "readOnly": false, "type": "attribute set of string"}, "services.rustfs.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.rustfs"}, "description": "Which package of RustFS to use", "loc": ["services", "rustfs", "package"], "readOnly": false, "type": "package"}, "services.rustfs.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix"}], "default": {"_type": "literalExpression", "text": "9000"}, "description": "The TCP port for the S3 API.", "loc": ["services", "rustfs", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.rustfs.secretKey": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/rustfs.nix"}], "default": {"_type": "literalExpression", "text": "\"rustfsadmin\""}, "description": "Secret key for authentication (8 to 40 characters).", "loc": ["services", "rustfs", "secretKey"], "readOnly": false, "type": "string"}, "services.sqld.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/sqld.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/sqld.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable sqld.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "sqld", "enable"], "readOnly": false, "type": "boolean"}, "services.sqld.extraArgs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/sqld.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/sqld.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Add other sqld flags.", "loc": ["services", "sqld", "extraArgs"], "readOnly": false, "type": "list of string"}, "services.sqld.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/sqld.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/sqld.nix"}], "default": {"_type": "literalExpression", "text": "8080"}, "description": "Port number to listen on.", "loc": ["services", "sqld", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.tailscale.funnel.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/tailscale.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/tailscale.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Tailscale funnel.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "tailscale", "funnel", "enable"], "readOnly": false, "type": "boolean"}, "services.tailscale.funnel.target": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/tailscale.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/tailscale.nix"}], "description": "Target host or host:port for Tailscale funnel", "loc": ["services", "tailscale", "funnel", "target"], "readOnly": false, "type": "string"}, "services.temporal.dynamicConfig": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Dynamic configuration for the Temporal server.", "example": {"_type": "literalExpression", "text": "{\n \"frontend.namespacerps\" = \"2500\";\n \"frontend.rps\" = \"2500\";\n}"}, "loc": ["services", "temporal", "dynamicConfig"], "readOnly": false, "type": "attribute set of string"}, "services.temporal.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Temporal process.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "temporal", "enable"], "readOnly": false, "type": "boolean"}, "services.temporal.ip": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "IPv4 address to bind the frontend service to.", "loc": ["services", "temporal", "ip"], "readOnly": false, "type": "string"}, "services.temporal.namespaces": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Specify namespaces that should be pre-created (namespace \"default\" is always created).", "example": {"_type": "literalExpression", "text": "[\n \"my-namespace\"\n \"my-other-namespace\"\n]"}, "loc": ["services", "temporal", "namespaces"], "readOnly": false, "type": "list of string"}, "services.temporal.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.temporal-cli"}, "description": "Which package of Temporal to use.", "loc": ["services", "temporal", "package"], "readOnly": false, "type": "package"}, "services.temporal.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix"}], "default": {"_type": "literalExpression", "text": "7233"}, "description": "Port for the frontend gRPC service.", "loc": ["services", "temporal", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.temporal.state": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "State configuration.", "loc": ["services", "temporal", "state"], "readOnly": false, "type": "submodule"}, "services.temporal.state.ephemeral": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "When enabled, the Temporal state gets lost when the process exists.", "loc": ["services", "temporal", "state", "ephemeral"], "readOnly": false, "type": "boolean"}, "services.temporal.state.sqlite-pragma": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Sqlite pragma statements", "example": {"_type": "literalExpression", "text": "{\n journal_mode = \"wal\";\n synchronous = \"2\";\n}"}, "loc": ["services", "temporal", "state", "sqlite-pragma"], "readOnly": false, "type": "attribute set of string"}, "services.temporal.ui": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "UI configuration.", "loc": ["services", "temporal", "ui"], "readOnly": false, "type": "submodule"}, "services.temporal.ui.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Enable the Web UI.", "loc": ["services", "temporal", "ui", "enable"], "readOnly": false, "type": "boolean"}, "services.temporal.ui.ip": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "IPv4 address to bind the Web UI to.", "loc": ["services", "temporal", "ui", "ip"], "readOnly": false, "type": "string"}, "services.temporal.ui.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/temporal.nix"}], "default": {"_type": "literalExpression", "text": "8233"}, "description": "Port for the Web UI.", "loc": ["services", "temporal", "ui", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.tideways.apiKey": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/tideways.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/tideways.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Sets the API-Key for the Tideways Daemon.\n", "loc": ["services", "tideways", "apiKey"], "readOnly": false, "type": "string"}, "services.tideways.cliPackage": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/tideways.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/tideways.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.tideways-cli"}, "description": "Which package of tideways-cli to use", "loc": ["services", "tideways", "cliPackage"], "readOnly": false, "type": "package"}, "services.tideways.daemonPackage": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/tideways.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/tideways.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.tideways-daemon"}, "description": "Which package of tideways-daemon to use", "loc": ["services", "tideways", "daemonPackage"], "readOnly": false, "type": "package"}, "services.tideways.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/tideways.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/tideways.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Tideways profiler daemon\n\nIt automatically installs Tideways PHP extension.\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "tideways", "enable"], "readOnly": false, "type": "boolean"}, "services.tideways.environment": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/tideways.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/tideways.nix"}], "default": {"_type": "literalExpression", "text": "\"devenv\""}, "description": "Sets the Environment for Tideways Daemon.\n", "loc": ["services", "tideways", "environment"], "readOnly": false, "type": "string"}, "services.tideways.profilingSpace": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/tideways.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/tideways.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "When the profiling space is enabled, the default monitoring will be disabled.\n", "loc": ["services", "tideways", "profilingSpace"], "readOnly": false, "type": "boolean"}, "services.tideways.service": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/tideways.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/tideways.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Sets the Service name for Tideways Daemon.\n", "loc": ["services", "tideways", "service"], "readOnly": false, "type": "string"}, "services.trafficserver.cache": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Caching rules that overrule the origin's caching policy.\n\nConsult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/cache.config.en.html)\nfor more details.\n", "example": {"_type": "literalExpression", "text": "\"dest_domain=example.com suffix=js action=never-cache\""}, "loc": ["services", "trafficserver", "cache"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.trafficserver.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Apache Traffic Server.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "trafficserver", "enable"], "readOnly": false, "type": "boolean"}, "services.trafficserver.hosting": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Partition the cache according to origin server or domain\n\nConsult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/hosting.config.en.html)\nfor more details.\n", "example": {"_type": "literalExpression", "text": "\"domain=example.com volume=1\""}, "loc": ["services", "trafficserver", "hosting"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.trafficserver.ipAllow": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalMD", "text": "upstream defaults"}, "description": "Control client access to Traffic Server and Traffic Server connections\nto upstream servers.\n\nConsult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/ip_allow.yaml.en.html)\nfor more details.\n", "example": {"_type": "literalExpression", "text": "{\n ip_allow = [{\n apply = \"in\";\n ip_addrs = \"127.0.0.1\";\n action = \"allow\";\n methods = \"ALL\";\n }];\n}\n"}, "loc": ["services", "trafficserver", "ipAllow"], "readOnly": false, "type": "null or YAML 1.1 value"}, "services.trafficserver.logging": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalMD", "text": "upstream defaults"}, "description": "Configure logs.\n\nConsult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/logging.yaml.en.html)\nfor more details.\n", "example": {"_type": "literalExpression", "text": "{ }"}, "loc": ["services", "trafficserver", "logging"], "readOnly": false, "type": "null or YAML 1.1 value"}, "services.trafficserver.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalExpression", "text": "pkgs.trafficserver"}, "description": "Apache Traffic Server package", "loc": ["services", "trafficserver", "package"], "readOnly": false, "type": "package"}, "services.trafficserver.parent": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Identify the parent proxies used in an cache hierarchy.\n\nConsult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/parent.config.en.html)\nfor more details.\n", "example": {"_type": "literalExpression", "text": "''\n dest_domain=. method=get parent=\"p1.example:8080; p2.example:8080\" round_robin=true\n''"}, "loc": ["services", "trafficserver", "parent"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.trafficserver.plugins": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Controls run-time loadable plugins available to Traffic Server, as\nwell as their configuration.\n\nConsult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/plugin.config.en.html)\nfor more details.\n", "loc": ["services", "trafficserver", "plugins"], "readOnly": false, "type": "list of (submodule)"}, "services.trafficserver.plugins.*.arg": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "arguments to pass to the plugin", "example": {"_type": "literalExpression", "text": "\"--header=ATS-My-Debug\""}, "loc": ["services", "trafficserver", "plugins", "*", "arg"], "readOnly": false, "type": "string"}, "services.trafficserver.plugins.*.path": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "description": "Path to plugin. The path can either be absolute, or relative to\nthe plugin directory.\n", "example": {"_type": "literalExpression", "text": "\"xdebug.so\""}, "loc": ["services", "trafficserver", "plugins", "*", "path"], "readOnly": false, "type": "string"}, "services.trafficserver.records": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "List of configurable variables used by Traffic Server.\n\nConsult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/records.config.en.html)\nfor more details.\n\nWhen defining the values for the option `x.y`, a nested attribute should\nbe used. Using a flat attribute set with the attribute name `x.y` will\nresult in an error.\n\nIf options for both `x.y` and `x.y.z` needs to be set, you can set\n`x.y._` as `x.y`. This only applies to Traffic Server versions prior to\n10. Traffic Server 10 and onwards uses YAML configuration, which doesn't\nhave this kind of problem.\n", "example": {"_type": "literalExpression", "text": "{\n proxy = {\n config = {\n proxy_name = \"my_server\";\n };\n };\n}"}, "loc": ["services", "trafficserver", "records"], "readOnly": false, "type": "Traffic Server records value"}, "services.trafficserver.remap": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "URL remapping rules used by Traffic Server.\n\nConsult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/remap.config.en.html)\nfor more details.\n", "example": {"_type": "literalExpression", "text": "\"map http://from.example http://origin.example\""}, "loc": ["services", "trafficserver", "remap"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.trafficserver.runroot": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "description": "File layout used by Traffic Server", "loc": ["services", "trafficserver", "runroot"], "readOnly": true, "type": "unspecified value"}, "services.trafficserver.sni": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Configure aspects of TLS connection handling for both inbound and\noutbound connections.\n\nConsult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/sni.yaml.en.html)\nfor more details.\n", "example": {"_type": "literalExpression", "text": "{\n sni = [{\n fqdn = \"no-http2.example.com\";\n https = \"off\";\n }];\n}\n"}, "loc": ["services", "trafficserver", "sni"], "readOnly": false, "type": "null or YAML 1.1 value"}, "services.trafficserver.splitDns": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Specify the DNS server that Traffic Server should use under specific\nconditions.\n\nConsult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/splitdns.config.en.html)\nfor more details.\n", "example": {"_type": "literalExpression", "text": "''\n dest_domain=internal.corp.example named=\"255.255.255.255:212 255.255.255.254\" def_domain=corp.example search_list=\"corp.example corp1.example\"\n dest_domain=!internal.corp.example named=255.255.255.253\n''"}, "loc": ["services", "trafficserver", "splitDns"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.trafficserver.sslMulticert": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Configure SSL server certificates to terminate the SSL sessions.\n\nConsult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/ssl_multicert.config.en.html)\nfor more details.\n", "example": {"_type": "literalExpression", "text": "\"dest_ip=* ssl_cert_name=default.pem\""}, "loc": ["services", "trafficserver", "sslMulticert"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.trafficserver.storage": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalExpression", "text": "\"${config.services.traffic-server.runroot.cachedir} 256M\""}, "description": "List all the storage that make up the Traffic Server cache.\n\nConsult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/storage.config.en.html)\nfor more details.\n", "example": {"_type": "literalExpression", "text": "\"/dev/disk/by-id/XXXXX volume=1\""}, "loc": ["services", "trafficserver", "storage"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.trafficserver.strategies": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Specify the next hop proxies used in an cache hierarchy and the\nalgorithms used to select the next proxy.\n\nConsult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/strategies.yaml.en.html)\nfor more details.\n", "loc": ["services", "trafficserver", "strategies"], "readOnly": false, "type": "null or YAML 1.1 value"}, "services.trafficserver.volume": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/trafficserver"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Manage cache space more efficiently and restrict disk usage by\ncreating cache volumes of different sizes.\n\nConsult the [upstream documentation](https://docs.trafficserver.apache.org/en/latest/admin-guide/files/volume.config.en.html)\nfor more details.\n", "example": {"_type": "literalExpression", "text": "\"volume=1 scheme=http size=20%\""}, "loc": ["services", "trafficserver", "volume"], "readOnly": false, "type": "null or YAML 1.1 value"}, "services.typesense.additionalArgs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Additional arguments passed to `typesense`.\n", "example": {"_type": "literalExpression", "text": "[ ]"}, "loc": ["services", "typesense", "additionalArgs"], "readOnly": false, "type": "list of strings concatenated with \"\\n\""}, "services.typesense.apiKey": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix"}], "default": {"_type": "literalExpression", "text": "\"example\""}, "description": "API Key.", "loc": ["services", "typesense", "apiKey"], "readOnly": false, "type": "string"}, "services.typesense.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable typesense process.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "typesense", "enable"], "readOnly": false, "type": "boolean"}, "services.typesense.host": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "The HTTP host to accept connections.\n", "loc": ["services", "typesense", "host"], "readOnly": false, "type": "string"}, "services.typesense.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.typesense"}, "description": "Which package of typesense to use", "loc": ["services", "typesense", "package"], "readOnly": false, "type": "package"}, "services.typesense.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix"}], "default": {"_type": "literalExpression", "text": "8108"}, "description": "The HTTP port to accept connections.\n", "loc": ["services", "typesense", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.typesense.searchOnlyKey": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/typesense.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Search Only Key.", "loc": ["services", "typesense", "searchOnlyKey"], "readOnly": false, "type": "null or string"}, "services.varnish.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Varnish process and expose utilities.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "varnish", "enable"], "readOnly": false, "type": "boolean"}, "services.varnish.extraModules": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Varnish modules (except 'std').\n", "example": {"_type": "literalExpression", "text": "[ pkgs.varnish73Packages.modules ]"}, "loc": ["services", "varnish", "extraModules"], "readOnly": false, "type": "list of package"}, "services.varnish.listen": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1:6081\""}, "description": "Which address to listen on.", "loc": ["services", "varnish", "listen"], "readOnly": false, "type": "string"}, "services.varnish.memorySize": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix"}], "default": {"_type": "literalExpression", "text": "\"64M\""}, "description": "How much memory to allocate to Varnish.", "loc": ["services", "varnish", "memorySize"], "readOnly": false, "type": "string"}, "services.varnish.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.varnish"}, "description": "Which Varnish package to use.", "loc": ["services", "varnish", "package"], "readOnly": false, "type": "package"}, "services.varnish.vcl": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/varnish.nix"}], "default": {"_type": "literalExpression", "text": "''\n vcl 4.0;\n \n backend default {\n .host = \"127.0.0.1\";\n .port = \"80\";\n }\n''"}, "description": "Varnish VCL configuration.", "loc": ["services", "varnish", "vcl"], "readOnly": false, "type": "strings concatenated with \"\\n\""}, "services.vault.address": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1:8200\""}, "description": "Specifies the address to bind to for listening\n", "loc": ["services", "vault", "address"], "readOnly": false, "type": "string"}, "services.vault.disableClustering": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Specifies whether clustering features such as request forwarding are enabled\n", "loc": ["services", "vault", "disableClustering"], "readOnly": false, "type": "boolean"}, "services.vault.disableMlock": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Disables the server from executing the mlock syscall\n", "loc": ["services", "vault", "disableMlock"], "readOnly": false, "type": "boolean"}, "services.vault.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable vault process.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "vault", "enable"], "readOnly": false, "type": "boolean"}, "services.vault.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.vault-bin"}, "description": "Which package of Vault to use.", "loc": ["services", "vault", "package"], "readOnly": false, "type": "package"}, "services.vault.ui": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/vault.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Enables the built-in web UI\n", "loc": ["services", "vault", "ui"], "readOnly": false, "type": "boolean"}, "services.wiremock.disableBanner": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to disable print banner logo.\n", "loc": ["services", "wiremock", "disableBanner"], "readOnly": false, "type": "boolean"}, "services.wiremock.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable WireMock.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["services", "wiremock", "enable"], "readOnly": false, "type": "boolean"}, "services.wiremock.mappings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "The mappings to mock.\nSee the JSON examples on for more information.\n", "example": {"_type": "literalExpression", "text": "[\n {\n request = {\n method = \"GET\";\n url = \"/body\";\n };\n response = {\n body = \"Literal text to put in the body\";\n headers = {\n Content-Type = \"text/plain\";\n };\n status = 200;\n };\n }\n {\n request = {\n method = \"GET\";\n url = \"/json\";\n };\n response = {\n jsonBody = {\n someField = \"someValue\";\n };\n status = 200;\n };\n }\n]"}, "loc": ["services", "wiremock", "mappings"], "readOnly": false, "type": "JSON value"}, "services.wiremock.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.wiremock"}, "description": "Which package of WireMock to use.\n", "loc": ["services", "wiremock", "package"], "readOnly": false, "type": "package"}, "services.wiremock.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix"}], "default": {"_type": "literalExpression", "text": "8080"}, "description": "The port number for the HTTP server to listen on.\n", "loc": ["services", "wiremock", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "services.wiremock.rootDir": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Path to the WireMock root directory containing mappings and files.\nCannot be set together with `mappings`.\nSee for more information.\n", "loc": ["services", "wiremock", "rootDir"], "readOnly": false, "type": "null or absolute path"}, "services.wiremock.verbose": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/services/wiremock.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to log verbosely to stdout.\n", "loc": ["services", "wiremock", "verbose"], "readOnly": false, "type": "boolean"}, "starship.config.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/starship.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/starship.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Starship config override.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["starship", "config", "enable"], "readOnly": false, "type": "boolean"}, "starship.config.path": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/starship.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/starship.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The Starship configuration file to use.", "example": {"_type": "literalExpression", "text": "${config.env.DEVENV_ROOT}/starship.toml"}, "loc": ["starship", "config", "path"], "readOnly": false, "type": "null or absolute path"}, "starship.config.settings": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/starship.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/starship.nix"}], "default": {"_type": "literalExpression", "text": "{}"}, "description": "Starship configuration to use", "loc": ["starship", "config", "settings"], "readOnly": false, "type": "TOML value"}, "starship.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/starship.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/starship.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable the Starship.rs command prompt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["starship", "enable"], "readOnly": false, "type": "boolean"}, "starship.package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/starship.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/starship.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.starship"}, "description": "The Starship package to use.", "loc": ["starship", "package"], "readOnly": false, "type": "package"}, "stdenv": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.stdenv"}, "description": "The stdenv to use for the developer environment.", "loc": ["stdenv"], "readOnly": false, "type": "package"}, "tasks": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "description": "A set of tasks.", "loc": ["tasks"], "readOnly": false, "type": "attribute set of (submodule)"}, "tasks..after": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of tasks that must complete before this task runs.\n\nHere's a helpful mnemonic to remember: This task runs *after* these tasks.\n\nYou can append a suffix to control dependency behavior:\n- `task@started` - wait for task to begin execution\n- `task` or `task@ready` - wait for task to be ready/healthy (default for processes, processes only)\n- `task@succeeded` - wait for task to exit successfully (default for tasks, tasks only)\n- `task@completed` - wait for task to finish, regardless of exit code (soft dependency)\n\nExample: `after = [ \"pnpm:install@completed\" ];` allows this task to run\neven if pnpm:install fails.\n", "loc": ["tasks", "", "after"], "readOnly": false, "type": "list of string"}, "tasks..before": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of tasks that depend on this task completing first.\n\nHere's a helpful mnemonic to remember: This task runs *before* these tasks.\n\nYou can append a suffix to control dependency behavior:\n- `task@started` - the dependent waits for this task to begin execution\n- `task` or `task@ready` - the dependent waits for this task to be ready/healthy (default for processes, processes only)\n- `task@succeeded` - the dependent waits for this task to exit successfully (default for tasks, tasks only)\n- `task@completed` - the dependent waits for this task to finish (soft dependency)\n", "loc": ["tasks", "", "before"], "readOnly": false, "type": "list of string"}, "tasks..binary": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Override the binary name from the default `package.meta.mainProgram`.", "loc": ["tasks", "", "binary"], "readOnly": false, "type": "null or string"}, "tasks..cwd": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Working directory to run the task in. If not specified, the current working directory will be used.", "loc": ["tasks", "", "cwd"], "readOnly": false, "type": "null or string"}, "tasks..description": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "Description of the task.", "loc": ["tasks", "", "description"], "readOnly": false, "type": "string"}, "tasks..env": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Environment variables to set for this task.", "loc": ["tasks", "", "env"], "readOnly": false, "type": "attribute set of string"}, "tasks..exec": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Command to execute the task.", "loc": ["tasks", "", "exec"], "readOnly": false, "type": "null or string"}, "tasks..execIfModified": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Paths to files that should trigger a task execution if modified.", "loc": ["tasks", "", "execIfModified"], "readOnly": false, "type": "list of string"}, "tasks..exports": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of environment variables to export.", "loc": ["tasks", "", "exports"], "readOnly": false, "type": "list of string"}, "tasks..input": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Input values for the task, encoded as JSON.", "loc": ["tasks", "", "input"], "readOnly": false, "type": "attribute set of anything"}, "tasks..package": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.bash"}, "description": "Package to install for this task.", "loc": ["tasks", "", "package"], "readOnly": false, "type": "package"}, "tasks..process": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Process-specific configuration. Only used when type = \"process\".", "loc": ["tasks", "", "process"], "readOnly": false, "type": "submodule"}, "tasks..process.linux": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Linux-specific process configuration.\n\nRequires devenv 2.0+.\n", "loc": ["tasks", "", "process", "linux"], "readOnly": false, "type": "submodule"}, "tasks..process.linux.capabilities": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Linux capabilities to add as ambient capabilities for this process\n(e.g., \"net_bind_service\", \"net_admin\").\n\nSupported capabilities are net_bind_service, net_raw, net_admin,\nipc_lock, sys_nice, sys_resource, sys_admin, chown, dac_override,\nand fowner. Starting a process with capabilities requires sudo\nauthentication.\n\nRequires devenv 2.0+.\n", "example": {"_type": "literalExpression", "text": "[\n \"net_bind_service\"\n \"net_admin\"\n]"}, "loc": ["tasks", "", "process", "linux", "capabilities"], "readOnly": false, "type": "list of string"}, "tasks..process.listen": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Socket activation configuration for systemd-style socket passing.", "example": {"_type": "literalExpression", "text": "[\n {\n address = \"127.0.0.1:8080\";\n kind = \"tcp\";\n name = \"http\";\n }\n {\n kind = \"unix_stream\";\n mode = 384;\n name = \"admin\";\n path = \"$DEVENV_STATE/admin.sock\";\n }\n]"}, "loc": ["tasks", "", "process", "listen"], "readOnly": false, "type": "list of (submodule)"}, "tasks..process.listen.*.address": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "TCP address (e.g., '127.0.0.1:8080'). Required for TCP sockets.", "loc": ["tasks", "", "process", "listen", "*", "address"], "readOnly": false, "type": "null or string"}, "tasks..process.listen.*.backlog": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "128"}, "description": "Listen backlog size", "loc": ["tasks", "", "process", "listen", "*", "backlog"], "readOnly": false, "type": "null or signed integer"}, "tasks..process.listen.*.kind": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "description": "Type of socket (tcp or unix_stream)", "loc": ["tasks", "", "process", "listen", "*", "kind"], "readOnly": false, "type": "one of \"tcp\", \"unix_stream\""}, "tasks..process.listen.*.mode": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Unix socket file permissions (e.g., 384 for 0o600). Only for unix_stream.", "loc": ["tasks", "", "process", "listen", "*", "mode"], "readOnly": false, "type": "null or signed integer"}, "tasks..process.listen.*.name": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "description": "Name of the socket (e.g., 'http', 'admin')", "loc": ["tasks", "", "process", "listen", "*", "name"], "readOnly": false, "type": "string"}, "tasks..process.listen.*.path": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Unix socket path. Required for unix_stream sockets.", "loc": ["tasks", "", "process", "listen", "*", "path"], "readOnly": false, "type": "null or string"}, "tasks..process.ports": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Allocated ports for this process (name -> port number).\nPopulated automatically from process port allocation.\n", "loc": ["tasks", "", "process", "ports"], "readOnly": false, "type": "attribute set of 16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "tasks..process.proxy.hostname": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Full `.localhost` proxy hostname for this process.", "loc": ["tasks", "", "process", "proxy", "hostname"], "readOnly": false, "type": "null or string"}, "tasks..process.proxy.https.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable HTTPS proxy URLs for this process.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["tasks", "", "process", "proxy", "https", "enable"], "readOnly": false, "type": "boolean"}, "tasks..process.proxy.port_hostnames": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Full `.localhost` proxy hostnames keyed by port name.", "loc": ["tasks", "", "process", "proxy", "port_hostnames"], "readOnly": false, "type": "attribute set of string"}, "tasks..process.ready": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "How to determine if this process task is ready to serve.", "loc": ["tasks", "", "process", "ready"], "readOnly": false, "type": "null or (submodule)"}, "tasks..process.ready.exec": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Shell command to execute. Exit 0 = ready.", "example": {"_type": "literalExpression", "text": "\"pg_isready -d template1\""}, "loc": ["tasks", "", "process", "ready", "exec"], "readOnly": false, "type": "null or string"}, "tasks..process.ready.failure_threshold": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "3"}, "description": "Consecutive failures before marking unhealthy.", "loc": ["tasks", "", "process", "ready", "failure_threshold"], "readOnly": false, "type": "signed integer"}, "tasks..process.ready.http": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "HTTP readiness probe configuration.", "loc": ["tasks", "", "process", "ready", "http"], "readOnly": false, "type": "submodule"}, "tasks..process.ready.http.get": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "HTTP GET readiness check.", "loc": ["tasks", "", "process", "ready", "http", "get"], "readOnly": false, "type": "null or (submodule)"}, "tasks..process.ready.http.get.host": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "\"127.0.0.1\""}, "description": "Host to connect to.", "loc": ["tasks", "", "process", "ready", "http", "get", "host"], "readOnly": false, "type": "string"}, "tasks..process.ready.http.get.path": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "\"/\""}, "description": "HTTP path to request.", "loc": ["tasks", "", "process", "ready", "http", "get", "path"], "readOnly": false, "type": "string"}, "tasks..process.ready.http.get.port": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "description": "Port to connect to.", "loc": ["tasks", "", "process", "ready", "http", "get", "port"], "readOnly": false, "type": "16 bit unsigned integer; between 0 and 65535 (both inclusive)"}, "tasks..process.ready.http.get.scheme": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "\"http\""}, "description": "URL scheme (http or https).", "loc": ["tasks", "", "process", "ready", "http", "get", "scheme"], "readOnly": false, "type": "string"}, "tasks..process.ready.initial_delay": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "0"}, "description": "Seconds to wait before first probe.", "loc": ["tasks", "", "process", "ready", "initial_delay"], "readOnly": false, "type": "signed integer"}, "tasks..process.ready.notify": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Enable systemd notify protocol for readiness signaling.\nThe process must send READY=1 to the NOTIFY_SOCKET.\n", "loc": ["tasks", "", "process", "ready", "notify"], "readOnly": false, "type": "boolean"}, "tasks..process.ready.period": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "10"}, "description": "Seconds between probes.", "loc": ["tasks", "", "process", "ready", "period"], "readOnly": false, "type": "signed integer"}, "tasks..process.ready.probe_timeout": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "1"}, "description": "Seconds before a single probe times out.", "loc": ["tasks", "", "process", "ready", "probe_timeout"], "readOnly": false, "type": "signed integer"}, "tasks..process.ready.success_threshold": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "1"}, "description": "Consecutive successes needed to be considered ready.", "loc": ["tasks", "", "process", "ready", "success_threshold"], "readOnly": false, "type": "signed integer"}, "tasks..process.ready.timeout": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Overall deadline in seconds for the process to become ready. null = no deadline.", "loc": ["tasks", "", "process", "ready", "timeout"], "readOnly": false, "type": "null or (unsigned integer, meaning >=0)"}, "tasks..process.restart": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Process restart policy.", "loc": ["tasks", "", "process", "restart"], "readOnly": false, "type": "submodule"}, "tasks..process.restart.max": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "5"}, "description": "Maximum restart attempts. null = unlimited.", "loc": ["tasks", "", "process", "restart", "max"], "readOnly": false, "type": "null or signed integer"}, "tasks..process.restart.on": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "\"on_failure\""}, "description": "When to restart: never, always, or on_failure.", "loc": ["tasks", "", "process", "restart", "on"], "readOnly": false, "type": "one of \"never\", \"always\", \"on_failure\""}, "tasks..process.restart.window": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Sliding window in seconds for restart rate limiting. null = lifetime limit.", "loc": ["tasks", "", "process", "restart", "window"], "readOnly": false, "type": "null or (unsigned integer, meaning >=0)"}, "tasks..process.shutdown": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Graceful shutdown signal and timeout.", "loc": ["tasks", "", "process", "shutdown"], "readOnly": false, "type": "submodule"}, "tasks..process.shutdown.grace": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "5"}, "description": "Seconds before shutdown escalates to SIGKILL.", "loc": ["tasks", "", "process", "shutdown", "grace"], "readOnly": false, "type": "unsigned integer, meaning >=0"}, "tasks..process.shutdown.signal": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "15"}, "description": "Unix signal number used for graceful shutdown.", "loc": ["tasks", "", "process", "shutdown", "signal"], "readOnly": false, "type": "integer between 1 and 31 (both inclusive)"}, "tasks..process.start": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Auto-start configuration for this process.", "loc": ["tasks", "", "process", "start"], "readOnly": false, "type": "submodule"}, "tasks..process.start.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to start this process automatically with `devenv up`.\n\nDisabled processes still run when pulled in as a task\ndependency (for example via `@completed`).\n", "loc": ["tasks", "", "process", "start", "enable"], "readOnly": false, "type": "boolean"}, "tasks..process.watch": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "File watching configuration for automatic process restarts.", "loc": ["tasks", "", "process", "watch"], "readOnly": false, "type": "submodule"}, "tasks..process.watch.extensions": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "File extensions to watch (e.g., \"rs\", \"js\", \"py\").\nIf empty, all file extensions are watched.\n", "loc": ["tasks", "", "process", "watch", "extensions"], "readOnly": false, "type": "list of string"}, "tasks..process.watch.ignore": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Glob patterns to ignore (e.g., \".git\", \"target\", \"*.log\").\n", "loc": ["tasks", "", "process", "watch", "ignore"], "readOnly": false, "type": "list of string"}, "tasks..process.watch.paths": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Paths to watch for changes (files or directories).\nWhen files in these paths change, the process will be restarted.\n", "loc": ["tasks", "", "process", "watch", "paths"], "readOnly": false, "type": "list of string"}, "tasks..process.watchdog": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Systemd watchdog configuration.", "example": {"_type": "literalExpression", "text": "{\n usec = 30000000; # 30 seconds\n require_ready = true;\n}\n"}, "loc": ["tasks", "", "process", "watchdog"], "readOnly": false, "type": "null or (submodule)"}, "tasks..process.watchdog.require_ready": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Require READY=1 notification before enforcing watchdog", "loc": ["tasks", "", "process", "watchdog", "require_ready"], "readOnly": false, "type": "boolean"}, "tasks..process.watchdog.usec": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "description": "Watchdog interval in microseconds", "loc": ["tasks", "", "process", "watchdog", "usec"], "readOnly": false, "type": "signed integer"}, "tasks..showOutput": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Always show task output (stdout and stderr), regardless of whether the task succeeds or fails.", "loc": ["tasks", "", "showOutput"], "readOnly": false, "type": "boolean"}, "tasks..status": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Check if the command should be ran", "loc": ["tasks", "", "status"], "readOnly": false, "type": "null or string"}, "tasks..type": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "\"oneshot\""}, "description": "Type of task:\n- oneshot: Task runs once and completes (default)\n- process: Task is a long-running process\n", "loc": ["tasks", "", "type"], "readOnly": false, "type": "one of \"oneshot\", \"process\""}, "tasks..wantedBy": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/tasks.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Tasks that select this task when they run, like systemd's `wantedBy`.\n\nWhen unset, running a task also runs the tasks ordered after it\n(in `after` and `all` modes). Once set, only the listed tasks select\nthis task, and `after`/`before` only order it. It still runs when\nnamed directly or when a selected task runs after it.\nUse `[ ]` to opt out of being selected by ordering edges.\n\nThis does not order the tasks, so combine it with `after` or `before`.\n", "example": {"_type": "literalExpression", "text": "[\n \"devenv:enterShell\"\n]"}, "loc": ["tasks", "", "wantedBy"], "readOnly": false, "type": "null or (list of string)"}, "treefmt.config": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/treefmt.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/treefmt.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "treefmt configuration.", "loc": ["treefmt", "config"], "readOnly": false, "type": "submodule"}, "treefmt.config.build.check": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "default": {"_type": "literalMD", "text": "Default check implementation"}, "description": "Create a flake check to test that the given project tree is already\nformatted.\n\nInput argument is the path to the project tree (usually 'self').\n", "loc": ["treefmt", "config", "build", "check"], "readOnly": false, "type": "function that evaluates to a(n) package"}, "treefmt.config.build.configFile": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "description": "Contains the generated config file derived from the settings.\n", "loc": ["treefmt", "config", "build", "configFile"], "readOnly": false, "type": "absolute path"}, "treefmt.config.build.devShell": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "description": "The development shell with treefmt and its underlying programs", "loc": ["treefmt", "config", "build", "devShell"], "readOnly": true, "type": "package"}, "treefmt.config.build.programs": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "default": {"_type": "literalMD", "text": "Programs used in configuration"}, "description": "Attrset of formatter programs enabled in treefmt configuration.\n\nThe key of the attrset is the formatter name, with the value being the\npackage used to do the formatting.\n", "loc": ["treefmt", "config", "build", "programs"], "readOnly": false, "type": "attribute set of package"}, "treefmt.config.build.wrapper": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "default": {"_type": "literalMD", "text": "wrapped `treefmt` command"}, "description": "The treefmt package, wrapped with the config file.\n", "loc": ["treefmt", "config", "build", "wrapper"], "readOnly": false, "type": "package"}, "treefmt.config.enableDefaultExcludes": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Enable the default excludes in the treefmt configuration.\n", "loc": ["treefmt", "config", "enableDefaultExcludes"], "readOnly": false, "type": "boolean"}, "treefmt.config.package": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.treefmt"}, "description": "The treefmt package to use.", "loc": ["treefmt", "config", "package"], "readOnly": false, "type": "package"}, "treefmt.config.pkgs": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/treefmt.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/treefmt.nix"}], "description": "Nixpkgs to use in `treefmt`.\n", "loc": ["treefmt", "config", "pkgs"], "readOnly": false, "type": "lazy attribute set of raw value"}, "treefmt.config.programs.actionlint.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/actionlint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/actionlint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable actionlint.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "actionlint", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.aiken.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/aiken.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/aiken.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable aiken.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "aiken", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.alejandra.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/alejandra.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/alejandra.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable alejandra.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "alejandra", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.asmfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/asmfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/asmfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable asmfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "asmfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.autocorrect.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable autocorrect.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "autocorrect", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.autocorrect.settings.context": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Enable or disable in a specific context.", "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "context"], "readOnly": false, "type": "null or (submodule)"}, "treefmt.config.programs.autocorrect.settings.context.codeblock": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Enable or disable to format codeblock in Markdown or AsciiDoc etc.", "example": {"_type": "literalExpression", "text": "\"error\""}, "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "context", "codeblock"], "readOnly": false, "type": "null or one of \"off\", \"error\", \"warning\""}, "treefmt.config.programs.autocorrect.settings.fileTypes": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Configure the files associations, you config is higher priority than default.", "example": {"_type": "literalExpression", "text": "{\n \"*.js\" = \"javascript\";\n \".mdx\" = \"markdown\";\n Rakefile = \"ruby\";\n rb = \"ruby\";\n}"}, "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "fileTypes"], "readOnly": false, "type": "null or (attribute set of string)"}, "treefmt.config.programs.autocorrect.settings.rules": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Configure rules for autocorrect formatting.", "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "rules"], "readOnly": false, "type": "null or (submodule)"}, "treefmt.config.programs.autocorrect.settings.rules.fullwidth": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Convert to fullwidth.", "example": {"_type": "literalExpression", "text": "\"error\""}, "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "rules", "fullwidth"], "readOnly": false, "type": "null or one of \"off\", \"error\", \"warning\""}, "treefmt.config.programs.autocorrect.settings.rules.halfwidth-punctuation": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Fullwidth punctuations to halfwidth in english.", "example": {"_type": "literalExpression", "text": "\"error\""}, "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "rules", "halfwidth-punctuation"], "readOnly": false, "type": "null or one of \"off\", \"error\", \"warning\""}, "treefmt.config.programs.autocorrect.settings.rules.halfwidth-word": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Fullwidth alphanumeric characters to halfwidth.", "example": {"_type": "literalExpression", "text": "\"error\""}, "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "rules", "halfwidth-word"], "readOnly": false, "type": "null or one of \"off\", \"error\", \"warning\""}, "treefmt.config.programs.autocorrect.settings.rules.no-space-fullwidth": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Remove space near the fullwidth.", "example": {"_type": "literalExpression", "text": "\"error\""}, "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "rules", "no-space-fullwidth"], "readOnly": false, "type": "null or one of \"off\", \"error\", \"warning\""}, "treefmt.config.programs.autocorrect.settings.rules.space-backticks": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Add space between ``, when near the CJK.", "example": {"_type": "literalExpression", "text": "\"error\""}, "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "rules", "space-backticks"], "readOnly": false, "type": "null or one of \"off\", \"error\", \"warning\""}, "treefmt.config.programs.autocorrect.settings.rules.space-bracket": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Add space between brackets (), [] when near the CJK.", "example": {"_type": "literalExpression", "text": "\"error\""}, "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "rules", "space-bracket"], "readOnly": false, "type": "null or one of \"off\", \"error\", \"warning\""}, "treefmt.config.programs.autocorrect.settings.rules.space-dash": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Add space between dash `-`.", "example": {"_type": "literalExpression", "text": "\"off\""}, "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "rules", "space-dash"], "readOnly": false, "type": "null or one of \"off\", \"error\", \"warning\""}, "treefmt.config.programs.autocorrect.settings.rules.space-dollar": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Add space between dollar $ when near the CJK.", "example": {"_type": "literalExpression", "text": "\"off\""}, "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "rules", "space-dollar"], "readOnly": false, "type": "null or one of \"off\", \"error\", \"warning\""}, "treefmt.config.programs.autocorrect.settings.rules.space-punctuation": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Add space between some punctuations.", "example": {"_type": "literalExpression", "text": "\"error\""}, "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "rules", "space-punctuation"], "readOnly": false, "type": "null or one of \"off\", \"error\", \"warning\""}, "treefmt.config.programs.autocorrect.settings.rules.space-word": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Auto add spacing between CJK (Chinese, Japanese, Korean) and English words.", "example": {"_type": "literalExpression", "text": "\"off\""}, "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "rules", "space-word"], "readOnly": false, "type": "null or one of \"off\", \"error\", \"warning\""}, "treefmt.config.programs.autocorrect.settings.rules.spellcheck": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Spellcheck.", "example": {"_type": "literalExpression", "text": "\"warning\""}, "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "rules", "spellcheck"], "readOnly": false, "type": "null or one of \"off\", \"error\", \"warning\""}, "treefmt.config.programs.autocorrect.settings.spellcheck": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Spellcheck configuration.", "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "spellcheck"], "readOnly": false, "type": "null or (submodule)"}, "treefmt.config.programs.autocorrect.settings.spellcheck.words": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Correct Words (Case insensitive) for by Spellcheck.", "example": {"_type": "literalExpression", "text": "[\n \"GitHub\"\n \"App Store\"\n \"AppStore = App Store\"\n \"Git\"\n \"Node.js\"\n \"nodejs = Node.js\"\n \"VIM\"\n \"DNS\"\n \"HTTP\"\n \"SSL\"\n]"}, "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "spellcheck", "words"], "readOnly": false, "type": "null or (list of string)"}, "treefmt.config.programs.autocorrect.settings.textRules": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Configure special rules for some texts.", "example": {"_type": "literalExpression", "text": "{\n \"Hello\u4f60\u597d\" = \"warning\";\n \"Hi\u4f60\u597d\" = \"off\";\n}"}, "loc": ["treefmt", "config", "programs", "autocorrect", "settings", "textRules"], "readOnly": false, "type": "null or (attribute set of (null or one of \"off\", \"error\", \"warning\"))"}, "treefmt.config.programs.autocorrect.threads": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/autocorrect.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Number of threads, 0 - use number of CPU. [default: 0]", "example": {"_type": "literalExpression", "text": "2"}, "loc": ["treefmt", "config", "programs", "autocorrect", "threads"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.beautysh.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/beautysh.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/beautysh.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable beautysh.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "beautysh", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.beautysh.indent_size": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/beautysh.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/beautysh.nix"}], "default": {"_type": "literalExpression", "text": "2"}, "description": "Sets the number of spaces to be used in indentation.\n", "example": {"_type": "literalExpression", "text": "4"}, "loc": ["treefmt", "config", "programs", "beautysh", "indent_size"], "readOnly": false, "type": "signed integer"}, "treefmt.config.programs.biome.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/biome.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/biome.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable biome.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "biome", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.biome.formatCommand": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/biome.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/biome.nix"}], "default": {"_type": "literalExpression", "text": "\"check\""}, "description": "The command to run Biome with.", "example": {"_type": "literalExpression", "text": "\"format\""}, "loc": ["treefmt", "config", "programs", "biome", "formatCommand"], "readOnly": false, "type": "one of \"format\", \"lint\", \"check\""}, "treefmt.config.programs.biome.formatUnsafe": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/biome.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/biome.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Allows to format a document that has unsafe fixes.", "loc": ["treefmt", "config", "programs", "biome", "formatUnsafe"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.biome.settings": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/biome.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/biome.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Raw Biome configuration (must conform to Biome JSON schema)", "example": {"_type": "literalExpression", "text": "{\n formatter = {\n indentStyle = \"space\";\n lineWidth = 100;\n };\n javascript = {\n formatter = {\n lineWidth = 120;\n quoteStyle = \"single\";\n };\n };\n json = {\n formatter = {\n enabled = false;\n };\n };\n}"}, "loc": ["treefmt", "config", "programs", "biome", "settings"], "readOnly": false, "type": "JSON value"}, "treefmt.config.programs.biome.validate.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/biome.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/biome.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to validate `treefmt.config.programs.biome.settings`.", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "biome", "validate", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.biome.validate.schema": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/biome.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/biome.nix"}], "default": {"_type": "literalMD", "text": "Fetches `\"https://biomejs.dev/schemas/${biomeVersion}/schema.json\"` using `pkgs.fetchurl`.\n"}, "description": "The biome schema file to validate against", "example": {"_type": "literalExpression", "text": "pkgs.fetchurl {\n url = \"https://biomejs.dev/schemas/2.1.2/schema.json\"\n hash = \"sha256-n4Y16J7g34e0VdQzRItu/P7n5oppkY4Vm4P1pQxOILU=\";\n}\n"}, "loc": ["treefmt", "config", "programs", "biome", "validate", "schema"], "readOnly": false, "type": "absolute path"}, "treefmt.config.programs.black.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/black.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/black.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable black.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "black", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.buf.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/buf.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/buf.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable buf.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "buf", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.buildifier.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/buildifier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/buildifier.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable buildifier.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "buildifier", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.cabal-fmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/cabal-fmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/cabal-fmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable cabal-fmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "cabal-fmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.cabal-gild.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/cabal-gild.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/cabal-gild.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable cabal-gild.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "cabal-gild", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.clang-format.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/clang-format.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/clang-format.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable clang-format.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "clang-format", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.clang-tidy.compileCommandsPath": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/clang-tidy.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/clang-tidy.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "used to read a compile command database", "example": {"_type": "literalExpression", "text": "\"/my/cmake/build/directory\""}, "loc": ["treefmt", "config", "programs", "clang-tidy", "compileCommandsPath"], "readOnly": false, "type": "null or absolute path or string"}, "treefmt.config.programs.clang-tidy.configFile": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/clang-tidy.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/clang-tidy.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Specify the path of .clang-tidy or custom config file", "example": {"_type": "literalExpression", "text": "\"/some/path/myTidyConfigFile\""}, "loc": ["treefmt", "config", "programs", "clang-tidy", "configFile"], "readOnly": false, "type": "null or absolute path"}, "treefmt.config.programs.clang-tidy.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/clang-tidy.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/clang-tidy.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable clang-tidy.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "clang-tidy", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.clang-tidy.quiet": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/clang-tidy.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/clang-tidy.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Run clang-tidy in quiet mode", "loc": ["treefmt", "config", "programs", "clang-tidy", "quiet"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.cljfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/cljfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/cljfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable cljfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "cljfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.cmake-format.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/cmake-format.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/cmake-format.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable cmake-format.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "cmake-format", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.csharpier.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/csharpier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/csharpier.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable csharpier.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "csharpier", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.cue.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/cue.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/cue.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable cue.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "cue", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.d2.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/d2.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/d2.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable d2.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "d2", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.dart-format.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dart-format.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dart-format.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable dart-format.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "dart-format", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.deadnix.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/deadnix.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/deadnix.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable deadnix.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "deadnix", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.deadnix.no-lambda-arg": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/deadnix.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/deadnix.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Don't check lambda parameter arguments.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "deadnix", "no-lambda-arg"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.deadnix.no-lambda-pattern-names": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/deadnix.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/deadnix.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Don't check lambda attrset pattern names (don't break nixpkgs callPackage).", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "deadnix", "no-lambda-pattern-names"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.deadnix.no-underscore": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/deadnix.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/deadnix.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Don't check any bindings that start with a _.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "deadnix", "no-underscore"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.deno.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/deno.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/deno.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable deno.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "deno", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.detekt.buildUponDefaultConfig": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/detekt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/detekt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Preconfigures detekt with a bunch of rules and some opinionated defaults for you. Allows additional provided configurations to override the defaults.", "loc": ["treefmt", "config", "programs", "detekt", "buildUponDefaultConfig"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.detekt.configFile": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/detekt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/detekt.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Path to detekt configuration file", "example": {"_type": "literalExpression", "text": "\"./detekt-config.yml\""}, "loc": ["treefmt", "config", "programs", "detekt", "configFile"], "readOnly": false, "type": "null or absolute path"}, "treefmt.config.programs.detekt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/detekt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/detekt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable detekt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "detekt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.dfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable dfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "dfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.dhall.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dhall.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dhall.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable dhall.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "dhall", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.dhall.lint": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dhall.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dhall.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to lint in addition to formatting.", "loc": ["treefmt", "config", "programs", "dhall", "lint"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.djlint.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/djlint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/djlint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable djlint.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "djlint", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.djlint.ignoreRules": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/djlint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/djlint.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Which H-rules to ignore", "loc": ["treefmt", "config", "programs", "djlint", "ignoreRules"], "readOnly": false, "type": "list of string"}, "treefmt.config.programs.djlint.indent": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/djlint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/djlint.nix"}], "default": {"_type": "literalExpression", "text": "4"}, "description": "Default indentation depth in spaces", "loc": ["treefmt", "config", "programs", "djlint", "indent"], "readOnly": false, "type": "unsigned integer, meaning >=0"}, "treefmt.config.programs.djlint.lint": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/djlint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/djlint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to lint in addition to formatting.", "loc": ["treefmt", "config", "programs", "djlint", "lint"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.dnscontrol.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dnscontrol.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dnscontrol.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable dnscontrol.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "dnscontrol", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.dockerfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dockerfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dockerfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable dockerfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "dockerfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.dockfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dockfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dockfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable dockfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "dockfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.dos2unix.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dos2unix.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dos2unix.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable dos2unix.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "dos2unix", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.dprint.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable dprint.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "dprint", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.dprint.settings": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Configuration to generate dprint.json with", "loc": ["treefmt", "config", "programs", "dprint", "settings"], "readOnly": false, "type": "open submodule of (JSON value)"}, "treefmt.config.programs.dprint.settings.extends": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Configurations to extend.", "example": {"_type": "literalExpression", "text": "\"https://dprint.dev/path/to/config/file.v1.json\""}, "loc": ["treefmt", "config", "programs", "dprint", "settings", "extends"], "readOnly": false, "type": "null or string or list of string"}, "treefmt.config.programs.dprint.settings.incremental": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to format files only when they change.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "dprint", "settings", "incremental"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.dprint.settings.indentWidth": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The number of characters for an indent", "example": {"_type": "literalExpression", "text": "2"}, "loc": ["treefmt", "config", "programs", "dprint", "settings", "indentWidth"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.dprint.settings.lineWidth": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The width of a line the printer will try to stay under. Note that the\nprinter may exceed this width in certain cases.\n", "example": {"_type": "literalExpression", "text": "80"}, "loc": ["treefmt", "config", "programs", "dprint", "settings", "lineWidth"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.dprint.settings.newLineKind": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The kind of newline to use (one of: auto, crlf, lf, system).\n", "example": {"_type": "literalExpression", "text": "\"auto\""}, "loc": ["treefmt", "config", "programs", "dprint", "settings", "newLineKind"], "readOnly": false, "type": "null or string"}, "treefmt.config.programs.dprint.settings.plugins": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Array of plugin URLs to format files.", "example": {"_type": "literalExpression", "text": "# (recommended) using plugins from nixpkgs\n# plugins is the list of all available dprint plugins in nixpkgs\n(pkgs.dprint-plugins.getPluginList (\n plugins: with plugins; [\n dprint-plugin-toml\n dprint-plugin-dockerfile\n g-plane-pretty_yaml\n # (pkgs.callPackage ./dprint/plugins/sample.nix {})\n ]\n))\n# (not recommended) using url plugins\n# treefmt then only works outside the nix sandbox, so treefmt nix flake check will fail\n++ [\n \"https://plugins.dprint.dev/json-0.17.2.wasm\"\n \"https://plugins.dprint.dev/markdown-0.15.2.wasm\"\n \"https://plugins.dprint.dev/typescript-0.84.4.wasm\"\n]\n"}, "loc": ["treefmt", "config", "programs", "dprint", "settings", "plugins"], "readOnly": false, "type": "null or (list of string)"}, "treefmt.config.programs.dprint.settings.useTabs": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dprint.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to use tabs (true) or spaces (false) for indentation.\n", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "dprint", "settings", "useTabs"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.dscanner.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/dscanner.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/dscanner.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable dscanner.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "dscanner", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.efmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/efmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/efmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable efmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "efmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.elm-format.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/elm-format.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/elm-format.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable elm-format.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "elm-format", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.erlfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/erlfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/erlfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable erlfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "erlfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.erlfmt.print-width": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/erlfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/erlfmt.nix"}], "default": {"_type": "literalExpression", "text": "100"}, "description": "The line length that formatter would wrap on", "example": {"_type": "literalExpression", "text": "80"}, "loc": ["treefmt", "config", "programs", "erlfmt", "print-width"], "readOnly": false, "type": "signed integer"}, "treefmt.config.programs.fantomas.dotnet-sdk": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/fantomas.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/fantomas.nix"}], "default": {"_type": "literalExpression", "text": "pkgs.dotnet-sdk"}, "description": "The dotnet-sdk package to use.", "loc": ["treefmt", "config", "programs", "fantomas", "dotnet-sdk"], "readOnly": false, "type": "package"}, "treefmt.config.programs.fantomas.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/fantomas.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/fantomas.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable fantomas.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "fantomas", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.fish_indent.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/fish_indent.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/fish_indent.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable fish_indent.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "fish_indent", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.flake-edit.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/flake-edit.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/flake-edit.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable flake-edit.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "flake-edit", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.flake-edit.noLock": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/flake-edit.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/flake-edit.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Skip updating the lockfile after editing flake.nix", "loc": ["treefmt", "config", "programs", "flake-edit", "noLock"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.flake-edit.settings.follow.aliases": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/flake-edit.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/flake-edit.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Mapping of canonical input names to alternative names.\nAllows nested inputs like \"nixpkgs-lib\" to follow \"nixpkgs\".\n", "example": {"_type": "literalExpression", "text": "{\n nixpkgs = [\n \"nixpkgs-lib\"\n ];\n}"}, "loc": ["treefmt", "config", "programs", "flake-edit", "settings", "follow", "aliases"], "readOnly": false, "type": "attribute set of list of string"}, "treefmt.config.programs.flake-edit.settings.follow.ignore": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/flake-edit.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/flake-edit.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of inputs to ignore when following.\nSupports simple names (\"systems\") or full paths (\"crane.nixpkgs\").\n", "example": {"_type": "literalExpression", "text": "[\n \"systems\"\n \"crane.flake-utils\"\n]"}, "loc": ["treefmt", "config", "programs", "flake-edit", "settings", "follow", "ignore"], "readOnly": false, "type": "list of string"}, "treefmt.config.programs.fnlfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/fnlfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/fnlfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable fnlfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "fnlfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.formatjson5.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/formatjson5.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/formatjson5.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable formatjson5.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "formatjson5", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.formatjson5.indent": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/formatjson5.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/formatjson5.nix"}], "default": {"_type": "literalExpression", "text": "4"}, "description": "Indent by the given number of spaces", "loc": ["treefmt", "config", "programs", "formatjson5", "indent"], "readOnly": false, "type": "signed integer"}, "treefmt.config.programs.formatjson5.noTrailingCommas": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/formatjson5.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/formatjson5.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Suppress trailing commas (otherwise added by default)", "loc": ["treefmt", "config", "programs", "formatjson5", "noTrailingCommas"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.formatjson5.oneElementLines": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/formatjson5.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/formatjson5.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Objects or arrays with a single child should collapse to a single line", "loc": ["treefmt", "config", "programs", "formatjson5", "oneElementLines"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.formatjson5.sortArrays": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/formatjson5.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/formatjson5.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Sort arrays of primitive values (string, number, boolean, or null) lexicographically", "loc": ["treefmt", "config", "programs", "formatjson5", "sortArrays"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.fourmolu.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/fourmolu.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/fourmolu.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable fourmolu.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "fourmolu", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.fourmolu.ghcOpts": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/fourmolu.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/fourmolu.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"BangPatterns\"\n \"PatternSynonyms\"\n \"TypeApplications\"\n]"}, "description": "Which GHC language extensions to enable", "loc": ["treefmt", "config", "programs", "fourmolu", "ghcOpts"], "readOnly": false, "type": "unspecified value"}, "treefmt.config.programs.fprettify.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/fprettify.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/fprettify.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable fprettify.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "fprettify", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.gdformat.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/gdformat.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/gdformat.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable gdformat.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "gdformat", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.genemichaels.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable [`genemichaels`](https://github.com/andrewbaxter/genemichaels/blob/master/readme_genemichaels.md), a Rust code formatter.\n", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "genemichaels", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.genemichaels.settings.comment_errors_fatal": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "If reformatting comments results in an error, abort formatting the\ndocument.\n", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "genemichaels", "settings", "comment_errors_fatal"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.genemichaels.settings.comment_width": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix"}], "default": {"_type": "literalExpression", "text": "80"}, "description": "Maximum relative line length for comments (past the comment\nindentation level). Can be `null` to disable relative wrapping. If\ndisabled, still wraps at `max_width`.\n", "example": {"_type": "literalExpression", "text": "null"}, "loc": ["treefmt", "config", "programs", "genemichaels", "settings", "comment_width"], "readOnly": false, "type": "null or (positive integer, meaning >0)"}, "treefmt.config.programs.genemichaels.settings.keep_max_blank_lines": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix"}], "default": {"_type": "literalExpression", "text": "0"}, "description": "Genemichaels will replace line breaks with it's own deterministic\nline breaks. You can use this to keep extra line breaks (1 will keep\nup to 1 extra line break) during comment extraction. This is unused\nduring formatting.\n", "example": {"_type": "literalExpression", "text": "1"}, "loc": ["treefmt", "config", "programs", "genemichaels", "settings", "keep_max_blank_lines"], "readOnly": false, "type": "unsigned integer, meaning >=0"}, "treefmt.config.programs.genemichaels.settings.max_width": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix"}], "default": {"_type": "literalExpression", "text": "120"}, "description": "Ideal maximum line width. If there's an unbreakable element the line\nwon't be split.\n", "example": {"_type": "literalExpression", "text": "80"}, "loc": ["treefmt", "config", "programs", "genemichaels", "settings", "max_width"], "readOnly": false, "type": "positive integer, meaning >0"}, "treefmt.config.programs.genemichaels.settings.root_splits": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "When breaking a child element, also break all parent elements.\n", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "genemichaels", "settings", "root_splits"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.genemichaels.settings.split_attributes": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Break a `#[]` on a separate line before the element it's associated\nwith.\n", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "genemichaels", "settings", "split_attributes"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.genemichaels.settings.split_brace_threshold": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix"}], "default": {"_type": "literalExpression", "text": "1"}, "description": "Break a `()` or `{}` if it has greater than this number of children.\nSet to `null` to disable breaking due to high child counts.\n", "example": {"_type": "literalExpression", "text": "null"}, "loc": ["treefmt", "config", "programs", "genemichaels", "settings", "split_brace_threshold"], "readOnly": false, "type": "null or (positive integer, meaning >0)"}, "treefmt.config.programs.genemichaels.settings.split_where": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Put the `where` clause on a new line.\n", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "genemichaels", "settings", "split_where"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.genemichaels.settingsFile": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix"}], "default": {"_type": "literalMD", "text": "Generated JSON file from `treefmt.config.programs.genemichaels.settings`"}, "description": "The configuration file used by `genemichaels`.", "example": {"_type": "literalExpression", "text": "./.genemichaels.json"}, "loc": ["treefmt", "config", "programs", "genemichaels", "settingsFile"], "readOnly": false, "type": "absolute path"}, "treefmt.config.programs.genemichaels.threadCount": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/genemichaels.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "How many threads to use for formatting multiple files. Set to `null` to\ndefault to the number of cores on the system.\n", "example": {"_type": "literalExpression", "text": "1"}, "loc": ["treefmt", "config", "programs", "genemichaels", "threadCount"], "readOnly": false, "type": "null or (unsigned integer, meaning >=0)"}, "treefmt.config.programs.gleam.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/gleam.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/gleam.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable gleam.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "gleam", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.gofmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/gofmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/gofmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable gofmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "gofmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.gofumpt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/gofumpt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/gofumpt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable gofumpt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "gofumpt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.gofumpt.extra": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/gofumpt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/gofumpt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable extra rules.\n", "loc": ["treefmt", "config", "programs", "gofumpt", "extra"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.goimports.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/goimports.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/goimports.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable goimports.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "goimports", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.golangci-lint.buildTags": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Build tags to use during analysis", "example": {"_type": "literalExpression", "text": "[\n \"integration\"\n \"e2e\"\n]"}, "loc": ["treefmt", "config", "programs", "golangci-lint", "buildTags"], "readOnly": false, "type": "list of string"}, "treefmt.config.programs.golangci-lint.concurrency": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Number of CPUs to use (auto-configured by default)", "example": {"_type": "literalExpression", "text": "4"}, "loc": ["treefmt", "config", "programs", "golangci-lint", "concurrency"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.golangci-lint.configFile": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Path to golangci-lint configuration file", "example": {"_type": "literalExpression", "text": "\".golangci.yml\""}, "loc": ["treefmt", "config", "programs", "golangci-lint", "configFile"], "readOnly": false, "type": "null or string"}, "treefmt.config.programs.golangci-lint.disableLinters": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Disable specific linters", "example": {"_type": "literalExpression", "text": "[\n \"typecheck\"\n]"}, "loc": ["treefmt", "config", "programs", "golangci-lint", "disableLinters"], "readOnly": false, "type": "list of string"}, "treefmt.config.programs.golangci-lint.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable golangci-lint.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "golangci-lint", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.golangci-lint.enableLinters": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Enable specific linters", "example": {"_type": "literalExpression", "text": "[\n \"govet\"\n \"errcheck\"\n \"staticcheck\"\n]"}, "loc": ["treefmt", "config", "programs", "golangci-lint", "enableLinters"], "readOnly": false, "type": "list of string"}, "treefmt.config.programs.golangci-lint.enableOnly": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Override configuration to run only specific linter(s)", "example": {"_type": "literalExpression", "text": "[\n \"govet\"\n \"gofmt\"\n]"}, "loc": ["treefmt", "config", "programs", "golangci-lint", "enableOnly"], "readOnly": false, "type": "list of string"}, "treefmt.config.programs.golangci-lint.fastOnly": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Run only fast linters from enabled linters set", "loc": ["treefmt", "config", "programs", "golangci-lint", "fastOnly"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.golangci-lint.maxIssuesPerLinter": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Maximum issues per linter (default: 50)", "example": {"_type": "literalExpression", "text": "50"}, "loc": ["treefmt", "config", "programs", "golangci-lint", "maxIssuesPerLinter"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.golangci-lint.maxSameIssues": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Maximum count of same issues (default: 3)", "example": {"_type": "literalExpression", "text": "3"}, "loc": ["treefmt", "config", "programs", "golangci-lint", "maxSameIssues"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.golangci-lint.newFromRev": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Show only new issues created after git revision REV", "example": {"_type": "literalExpression", "text": "\"HEAD~1\""}, "loc": ["treefmt", "config", "programs", "golangci-lint", "newFromRev"], "readOnly": false, "type": "null or string"}, "treefmt.config.programs.golangci-lint.noConfig": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Don't read any configuration file", "loc": ["treefmt", "config", "programs", "golangci-lint", "noConfig"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.golangci-lint.tests": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Analyze test files", "loc": ["treefmt", "config", "programs", "golangci-lint", "tests"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.golangci-lint.timeout": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Timeout for total work (e.g., '5m', '1h', '10s')", "example": {"_type": "literalExpression", "text": "\"5m\""}, "loc": ["treefmt", "config", "programs", "golangci-lint", "timeout"], "readOnly": false, "type": "null or string"}, "treefmt.config.programs.golangci-lint.verbose": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golangci-lint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Enable verbose output", "loc": ["treefmt", "config", "programs", "golangci-lint", "verbose"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.golines.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golines.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golines.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable golines.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "golines", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.golines.maxLength": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golines.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golines.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Target maximum line length (default: 100)\n", "example": {"_type": "literalExpression", "text": "100"}, "loc": ["treefmt", "config", "programs", "golines", "maxLength"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.golines.tabLength": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/golines.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/golines.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Length of a tab (default: 4)\n", "example": {"_type": "literalExpression", "text": "4"}, "loc": ["treefmt", "config", "programs", "golines", "tabLength"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.google-java-format.aospStyle": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/google-java-format.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/google-java-format.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to use AOSP (Android Open Source Project) indentation.\nIn a few words, use 4-space indentation rather than the conventional\n2-space indentation width that Google uses.\n", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "google-java-format", "aospStyle"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.google-java-format.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/google-java-format.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/google-java-format.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable google-java-format.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "google-java-format", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.hclfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/hclfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/hclfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable hclfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "hclfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.hlint.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/hlint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/hlint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable hlint.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "hlint", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.hujsonfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/hujsonfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/hujsonfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable hujsonfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "hujsonfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.isort.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/isort.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/isort.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable isort.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "isort", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.isort.profile": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/isort.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/isort.nix"}], "default": {"_type": "literalExpression", "text": "\"\""}, "description": "The profile to use for isort.\n", "loc": ["treefmt", "config", "programs", "isort", "profile"], "readOnly": false, "type": "string"}, "treefmt.config.programs.json-sort-cli.autofix": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/json-sort-cli.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/json-sort-cli.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Update files with fixes instead of just reporting.\nDefaults to `false`.\n", "loc": ["treefmt", "config", "programs", "json-sort-cli", "autofix"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.json-sort-cli.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/json-sort-cli.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/json-sort-cli.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable json-sort-cli.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "json-sort-cli", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.json-sort-cli.end-of-line": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/json-sort-cli.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/json-sort-cli.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Specify the desired line ending for output.\nDefaults to system line ending.\nOverrides `.editorconfig` settings if an `.editorconfig` is found.\n", "loc": ["treefmt", "config", "programs", "json-sort-cli", "end-of-line"], "readOnly": false, "type": "null or one of \"lf\", \"crlf\", \"cr\", \"unset\""}, "treefmt.config.programs.json-sort-cli.indent-size": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/json-sort-cli.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/json-sort-cli.nix"}], "default": {"_type": "literalExpression", "text": "2"}, "description": "Number of spaces to indent, or the string \"tab\" to use tabs.\nDefaults to 2 spaces. Overrides `.editorconfig` settings if an `.editorconfig` is found.\n", "loc": ["treefmt", "config", "programs", "json-sort-cli", "indent-size"], "readOnly": false, "type": "signed integer"}, "treefmt.config.programs.json-sort-cli.indent-style": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/json-sort-cli.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/json-sort-cli.nix"}], "default": {"_type": "literalExpression", "text": "\"space\""}, "description": "Specify the desired indentation style for output.\nDefaults to `space`. Overrides `.editorconfig` settings if an `.editorconfig` is found.\n", "loc": ["treefmt", "config", "programs", "json-sort-cli", "indent-style"], "readOnly": false, "type": "one of \"space\", \"tab\""}, "treefmt.config.programs.json-sort-cli.insert-final-newline": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/json-sort-cli.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/json-sort-cli.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Insert a final newline after the sort. Defaults to `false`.\nOverrides `.editorconfig` settings if an `.editorconfig` is found.\n", "loc": ["treefmt", "config", "programs", "json-sort-cli", "insert-final-newline"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.jsonfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/jsonfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/jsonfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable jsonfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "jsonfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.jsonnet-lint.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/jsonnet-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/jsonnet-lint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable jsonnet-lint.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "jsonnet-lint", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.jsonnetfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/jsonnetfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/jsonnetfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable jsonnetfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "jsonnetfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.just.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/just.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/just.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable just.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "just", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.kdlfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/kdlfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/kdlfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable kdlfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "kdlfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.keep-sorted.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/keep-sorted.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/keep-sorted.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable keep-sorted.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "keep-sorted", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.ktfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/ktfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/ktfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable ktfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "ktfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.ktlint.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/ktlint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/ktlint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable ktlint.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "ktlint", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.latexindent.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/latexindent.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/latexindent.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable latexindent.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "latexindent", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.leptosfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/leptosfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/leptosfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable leptosfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "leptosfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.mbake.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable mbake.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "mbake", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.mbake.settings.auto_insert_phony_declarations": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to automatically insert .PHONY declarations for non-file targets", "loc": ["treefmt", "config", "programs", "mbake", "settings", "auto_insert_phony_declarations"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.mbake.settings.ensure_final_newline": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to ensure the file ends with a newline", "loc": ["treefmt", "config", "programs", "mbake", "settings", "ensure_final_newline"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.mbake.settings.fix_missing_recipe_tabs": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to fix recipe lines that are missing tabs", "loc": ["treefmt", "config", "programs", "mbake", "settings", "fix_missing_recipe_tabs"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.mbake.settings.group_phony_declarations": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to group all .PHONY declarations together", "loc": ["treefmt", "config", "programs", "mbake", "settings", "group_phony_declarations"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.mbake.settings.indent_nested_conditionals": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to indent nested conditional blocks (ifdef, ifndef, etc.)", "loc": ["treefmt", "config", "programs", "mbake", "settings", "indent_nested_conditionals"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.mbake.settings.max_consecutive_empty_lines": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Maximum number of consecutive empty lines allowed", "loc": ["treefmt", "config", "programs", "mbake", "settings", "max_consecutive_empty_lines"], "readOnly": false, "type": "null or (unsigned integer, meaning >=0)"}, "treefmt.config.programs.mbake.settings.max_line_length": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Maximum line length before wrapping", "loc": ["treefmt", "config", "programs", "mbake", "settings", "max_line_length"], "readOnly": false, "type": "null or (unsigned integer, meaning >=0)"}, "treefmt.config.programs.mbake.settings.normalize_empty_lines": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to normalize empty lines", "loc": ["treefmt", "config", "programs", "mbake", "settings", "normalize_empty_lines"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.mbake.settings.normalize_line_continuations": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to normalize line continuation backslashes", "loc": ["treefmt", "config", "programs", "mbake", "settings", "normalize_line_continuations"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.mbake.settings.phony_at_top": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to place .PHONY declarations at the top of the file", "loc": ["treefmt", "config", "programs", "mbake", "settings", "phony_at_top"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.mbake.settings.remove_trailing_whitespace": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to remove trailing whitespace from lines", "loc": ["treefmt", "config", "programs", "mbake", "settings", "remove_trailing_whitespace"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.mbake.settings.space_after_colon": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to add a space after colons in rules", "loc": ["treefmt", "config", "programs", "mbake", "settings", "space_after_colon"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.mbake.settings.space_around_assignment": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to add spaces around assignment operators (=, :=, etc.)", "loc": ["treefmt", "config", "programs", "mbake", "settings", "space_around_assignment"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.mbake.settings.space_before_colon": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to add a space before colons in rules", "loc": ["treefmt", "config", "programs", "mbake", "settings", "space_before_colon"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.mbake.settings.tab_width": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mbake.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Tab width in spaces for display purposes", "loc": ["treefmt", "config", "programs", "mbake", "settings", "tab_width"], "readOnly": false, "type": "null or (unsigned integer, meaning >=0)"}, "treefmt.config.programs.mdformat.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mdformat.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mdformat.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable mdformat.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "mdformat", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.mdformat.plugins": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mdformat.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mdformat.nix"}], "default": {"_type": "literalExpression", "text": "ps: [ ];\n"}, "description": "Plugins for mdformat that extend its functionality (for Markdown\nextensions, formatting code blocks, etc).\n\nSee [mdformat docs](https://mdformat.readthedocs.io/en/stable/users/plugins.html)\nfor a (non-exhaustive) list of plugins.\n", "example": {"_type": "literalExpression", "text": "ps: [\n ps.mdformat-footnote\n ps.mdformat-gfm\n];\n"}, "loc": ["treefmt", "config", "programs", "mdformat", "plugins"], "readOnly": false, "type": "function that evaluates to a(n) list of package"}, "treefmt.config.programs.mdformat.settings.end-of-line": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mdformat.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mdformat.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Output file line ending mode.\n", "example": {"_type": "literalExpression", "text": "\"lf\""}, "loc": ["treefmt", "config", "programs", "mdformat", "settings", "end-of-line"], "readOnly": false, "type": "null or one of \"crlf\", \"lf\", \"keep\""}, "treefmt.config.programs.mdformat.settings.number": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mdformat.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mdformat.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Apply consecutive numbering to ordered lists.\n", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "mdformat", "settings", "number"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.mdformat.settings.wrap": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mdformat.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mdformat.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Paragraph word wrap mode.\nSet to an INTEGER to wrap at that length.\n", "example": {"_type": "literalExpression", "text": "\"keep\""}, "loc": ["treefmt", "config", "programs", "mdformat", "settings", "wrap"], "readOnly": false, "type": "null or signed integer or one of \"keep\", \"no\""}, "treefmt.config.programs.mdsh.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mdsh.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mdsh.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable mdsh.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "mdsh", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.meson.editorconfig": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/meson.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/meson.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Try to read configuration from .editorconfig\n", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "meson", "editorconfig"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.meson.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/meson.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/meson.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable meson.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "meson", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.mix-format.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mix-format.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mix-format.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable mix-format.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "mix-format", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.muon.editorconfig": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/muon.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/muon.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Try to read configuration from .editorconfig\n", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "muon", "editorconfig"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.muon.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/muon.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/muon.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable muon.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "muon", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.mypy.directories": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mypy.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mypy.nix"}], "default": {"_type": "literalExpression", "text": "{\n \"\" = { };\n}"}, "description": "Directories to run mypy in", "example": {"_type": "literalExpression", "text": "{\n \"\" = {\n modules = [\n \"mymodule\"\n \"tests\"\n ];\n };\n subdir = { };\n}"}, "loc": ["treefmt", "config", "programs", "mypy", "directories"], "readOnly": false, "type": "attribute set of (submodule)"}, "treefmt.config.programs.mypy.directories..directory": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mypy.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mypy.nix"}], "default": {"_type": "literalExpression", "text": "\"\u2039name\u203a\""}, "description": "Directory to run mypy in", "loc": ["treefmt", "config", "programs", "mypy", "directories", "", "directory"], "readOnly": false, "type": "string"}, "treefmt.config.programs.mypy.directories..extraPythonPackages": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mypy.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mypy.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Extra packages to add to PYTHONPATH", "example": {"_type": "literalMD", "text": "[ pkgs.python3.pkgs.requests ]"}, "loc": ["treefmt", "config", "programs", "mypy", "directories", "", "extraPythonPackages"], "readOnly": false, "type": "list of package"}, "treefmt.config.programs.mypy.directories..extraPythonPaths": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mypy.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mypy.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Extra paths to add to PYTHONPATH.\nPaths are interpreted relative to the directory options and are added before extraPythonPackages.\n", "example": {"_type": "literalExpression", "text": "[\n \"path/to/my/module\"\n]"}, "loc": ["treefmt", "config", "programs", "mypy", "directories", "", "extraPythonPaths"], "readOnly": false, "type": "list of string"}, "treefmt.config.programs.mypy.directories..modules": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mypy.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mypy.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"\"\n]"}, "description": "Modules to check", "example": {"_type": "literalExpression", "text": "[\n \"mymodule\"\n \"tests\"\n]"}, "loc": ["treefmt", "config", "programs", "mypy", "directories", "", "modules"], "readOnly": false, "type": "list of string"}, "treefmt.config.programs.mypy.directories..options": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mypy.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mypy.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Options to pass to mypy", "example": {"_type": "literalExpression", "text": "[\n \"--ignore-missing-imports\"\n]"}, "loc": ["treefmt", "config", "programs", "mypy", "directories", "", "options"], "readOnly": false, "type": "list of string"}, "treefmt.config.programs.mypy.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/mypy.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/mypy.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable mypy.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "mypy", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.nbstripout.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/nbstripout.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/nbstripout.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable nbstripout.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "nbstripout", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.nickel.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/nickel.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/nickel.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable nickel.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "nickel", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.nimpretty.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/nimpretty.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/nimpretty.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable nimpretty.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "nimpretty", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.nixf-diagnose.autoFix": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixf-diagnose.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixf-diagnose.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Whether to automatically apply fixes to source files.", "loc": ["treefmt", "config", "programs", "nixf-diagnose", "autoFix"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.nixf-diagnose.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixf-diagnose.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixf-diagnose.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable nixf-diagnose.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "nixf-diagnose", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.nixf-diagnose.ignore": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixf-diagnose.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixf-diagnose.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "Diagnostics to ignore, specified by their ID.", "example": {"_type": "literalExpression", "text": "[\n \"sema-primop-overridden\"\n]"}, "loc": ["treefmt", "config", "programs", "nixf-diagnose", "ignore"], "readOnly": false, "type": "list of string"}, "treefmt.config.programs.nixf-diagnose.only": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixf-diagnose.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixf-diagnose.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Only run this diagnostic.", "example": {"_type": "literalExpression", "text": "\"sema-primop-overridden\""}, "loc": ["treefmt", "config", "programs", "nixf-diagnose", "only"], "readOnly": false, "type": "null or string"}, "treefmt.config.programs.nixf-diagnose.variableLookup": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixf-diagnose.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixf-diagnose.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether to enable variable lookup analysis.", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "nixf-diagnose", "variableLookup"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.nixfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable nixfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "nixfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.nixfmt.indent": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixfmt.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Number of spaces to use for indentation [default: 2]\n", "example": {"_type": "literalExpression", "text": "4"}, "loc": ["treefmt", "config", "programs", "nixfmt", "indent"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.nixfmt.strict": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Enable a stricter formatting mode that isn't influenced\nas much by how the input is formatted.\n", "loc": ["treefmt", "config", "programs", "nixfmt", "strict"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.nixfmt.width": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixfmt.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Maximum width in characters [default: 100]\n", "example": {"_type": "literalExpression", "text": "120"}, "loc": ["treefmt", "config", "programs", "nixfmt", "width"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.nixpkgs-fmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixpkgs-fmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/nixpkgs-fmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable nixpkgs-fmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "nixpkgs-fmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.ocamlformat.configFile": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/ocamlformat.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/ocamlformat.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Path to the .ocamlformat file. Used to pick the right version of ocamlformat if passed.", "loc": ["treefmt", "config", "programs", "ocamlformat", "configFile"], "readOnly": false, "type": "null or absolute path"}, "treefmt.config.programs.ocamlformat.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/ocamlformat.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/ocamlformat.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable ocamlformat.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "ocamlformat", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.ocamlformat.pkgs": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/ocamlformat.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/ocamlformat.nix"}], "default": {"_type": "literalMD", "text": "Nixpkgs from context"}, "description": "The package set used to get the ocamlformat package at a specific version.", "loc": ["treefmt", "config", "programs", "ocamlformat", "pkgs"], "readOnly": false, "type": "lazy attribute set of raw value"}, "treefmt.config.programs.odinfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/odinfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/odinfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable odinfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "odinfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.opa.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/opa.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/opa.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable opa.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "opa", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.ormolu.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/ormolu.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/ormolu.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable ormolu.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "ormolu", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.ormolu.ghcOpts": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/ormolu.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/ormolu.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"BangPatterns\"\n \"PatternSynonyms\"\n \"TypeApplications\"\n]"}, "description": "Which GHC language extensions to enable", "loc": ["treefmt", "config", "programs", "ormolu", "ghcOpts"], "readOnly": false, "type": "unspecified value"}, "treefmt.config.programs.oxfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/oxfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/oxfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable oxfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "oxfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.oxipng.alpha": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/oxipng.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/oxipng.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Perform additional optimization on images with an alpha channel.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "oxipng", "alpha"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.oxipng.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/oxipng.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/oxipng.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable oxipng.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "oxipng", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.oxipng.opt": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/oxipng.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/oxipng.nix"}], "default": {"_type": "literalExpression", "text": "\"2\""}, "description": "Set the optimization level preset", "example": {"_type": "literalExpression", "text": "\"max\""}, "loc": ["treefmt", "config", "programs", "oxipng", "opt"], "readOnly": false, "type": "string"}, "treefmt.config.programs.oxipng.scale16": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/oxipng.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/oxipng.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Forcibly reduce images with 16 bits per channel to 8 bits per channel.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "oxipng", "scale16"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.oxipng.strip": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/oxipng.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/oxipng.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Strip metadata chunks", "example": {"_type": "literalExpression", "text": "\"safe\""}, "loc": ["treefmt", "config", "programs", "oxipng", "strip"], "readOnly": false, "type": "null or string"}, "treefmt.config.programs.packer.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/packer.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/packer.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable packer.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "packer", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.perltidy.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/perltidy.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/perltidy.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable perltidy.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "perltidy", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.perltidy.perltidyrc": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/perltidy.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/perltidy.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "A path for perltidy's configuration file, usually named .perltidyrc", "loc": ["treefmt", "config", "programs", "perltidy", "perltidyrc"], "readOnly": false, "type": "null or absolute path"}, "treefmt.config.programs.php-cs-fixer.configFile": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/php-cs-fixer.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/php-cs-fixer.nix"}], "default": {"_type": "literalExpression", "text": "\"./.php-cs-fixer.php\""}, "description": "Path to php-cs-fixer config file.", "example": {"_type": "literalExpression", "text": "\"./.php-cs-fixer.dist.php\""}, "loc": ["treefmt", "config", "programs", "php-cs-fixer", "configFile"], "readOnly": false, "type": "string or absolute path"}, "treefmt.config.programs.php-cs-fixer.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/php-cs-fixer.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/php-cs-fixer.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable php-cs-fixer.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "php-cs-fixer", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.pinact.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/pinact.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/pinact.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable pinact.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "pinact", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.pinact.settings": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/pinact.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/pinact.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Configuration for pinact, see\n\nfor supported values.\n", "loc": ["treefmt", "config", "programs", "pinact", "settings"], "readOnly": false, "type": "open submodule of (YAML 1.1 value)"}, "treefmt.config.programs.pinact.update": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/pinact.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/pinact.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Update actions to latest versions.", "loc": ["treefmt", "config", "programs", "pinact", "update"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.pinact.verify": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/pinact.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/pinact.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Verify if pairs of commit SHA and version are correct.", "loc": ["treefmt", "config", "programs", "pinact", "verify"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.prettier.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable prettier.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "prettier", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.prettier.settings.arrowParens": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Include parentheses around a sole arrow function parameter.", "example": {"_type": "literalExpression", "text": "\"always\""}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "arrowParens"], "readOnly": false, "type": "null or one of \"always\", \"avoid\""}, "treefmt.config.programs.prettier.settings.bracketSameLine": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Put > of opening tags on the last line instead of on a new line.\n", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "bracketSameLine"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.prettier.settings.bracketSpacing": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Print spaces between brackets", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "bracketSpacing"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.prettier.settings.cursorOffset": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Print (to stderr) where a cursor at the given position would move to\nafter formatting. This option cannot be used with --range-start and\n--range-end.\n", "example": {"_type": "literalExpression", "text": "-1"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "cursorOffset"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.prettier.settings.editorconfig": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether parse the .editorconfig file in your project and convert its\nproperties to the corresponding Prettier configuration. This\nconfiguration will be overridden by .prettierrc, etc.\n", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "editorconfig"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.prettier.settings.embeddedLanguageFormatting": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Control how Prettier formats quoted code embedded in the file.\n", "example": {"_type": "literalExpression", "text": "\"auto\""}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "embeddedLanguageFormatting"], "readOnly": false, "type": "null or one of \"auto\", \"off\""}, "treefmt.config.programs.prettier.settings.endOfLine": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Which end of line characters to apply.", "example": {"_type": "literalExpression", "text": "\"lf\""}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "endOfLine"], "readOnly": false, "type": "null or one of \"lf\", \"crlf\", \"cr\", \"auto\""}, "treefmt.config.programs.prettier.settings.filepath": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Specify the input filepath. This will be used to do parser inference.\n", "example": {"_type": "literalExpression", "text": "\"example.js\""}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "filepath"], "readOnly": false, "type": "null or string"}, "treefmt.config.programs.prettier.settings.htmlWhitespaceSensitivity": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "How to handle whitespaces in HTML.", "example": {"_type": "literalExpression", "text": "\"css\""}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "htmlWhitespaceSensitivity"], "readOnly": false, "type": "null or one of \"css\", \"strict\", \"ignore\""}, "treefmt.config.programs.prettier.settings.insertPragma": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Insert @format pragma into file's first docblock commentypes.\n", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "insertPragma"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.prettier.settings.jsxSingleQuote": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Use single quotes in JSX", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "jsxSingleQuote"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.prettier.settings.overrides": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Provide a list of patterns to override prettier configuration.\n", "example": {"_type": "literalExpression", "text": "{\n files = [\n \"*.html\"\n \"legacy/**/*.js\"\n ];\n options = {\n tabwidth = 4;\n };\n}"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "overrides"], "readOnly": false, "type": "null or (list of (attribute set))"}, "treefmt.config.programs.prettier.settings.parser": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Which parser to use.", "example": {"_type": "literalExpression", "text": "\"typescript\""}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "parser"], "readOnly": false, "type": "null or one of \"flow\", \"babel\", \"babel-flow\", \"babel-ts\", \"typescript\", \"acorn\", \"espree\", \"meriyah\", \"css\", \"less\", \"scss\", \"json\", \"json5\", \"json-stringify\", \"graphql\", \"markdown\", \"mdx\", \"vue\", \"yaml\", \"glimmer\", \"html\", \"angular\", \"lwc\" or string"}, "treefmt.config.programs.prettier.settings.pluginSearchDirs": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Custom directory that contains prettier plugins in node_modules\nsubdirectory. Overrides default behavior when plugins are searched\nrelatively to the location of Prettier.\\nMultiple values are accepted.\n", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "pluginSearchDirs"], "readOnly": false, "type": "null or (list of string) or value false (singular enum)"}, "treefmt.config.programs.prettier.settings.plugins": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Add a plugin. Multiple plugins can be passed as separate `--plugin`s.\n", "example": {"_type": "literalExpression", "text": "[\n \"@prettier/plugin-xml\"\n]"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "plugins"], "readOnly": false, "type": "null or (list of string)"}, "treefmt.config.programs.prettier.settings.printWidth": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The line length where Prettier will try wrap.", "example": {"_type": "literalExpression", "text": "80"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "printWidth"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.prettier.settings.proseWrap": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "How to wrap prose.", "example": {"_type": "literalExpression", "text": "\"preserve\""}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "proseWrap"], "readOnly": false, "type": "null or one of \"always\", \"never\", \"preserve\""}, "treefmt.config.programs.prettier.settings.quoteProps": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Change when properties in objects are quoted", "example": {"_type": "literalExpression", "text": "\"as-needed\""}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "quoteProps"], "readOnly": false, "type": "null or one of \"as-needed\", \"consistent\", \"preserve\""}, "treefmt.config.programs.prettier.settings.rangeEnd": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Format code ending at a given character offset (exclusive). The range\nwill extend forwards to the end of the selected statementypes. This\noption cannot be used with --cursor-offsetypes.\n", "example": {"_type": "literalExpression", "text": "0"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "rangeEnd"], "readOnly": false, "type": "null or string"}, "treefmt.config.programs.prettier.settings.rangeStart": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Format code starting at a given character offsetypes. The range will\nextend backwards to the start of the first line containing the selected\nstatementypes. his option cannot be used with --cursor-offsetypes.\n", "example": {"_type": "literalExpression", "text": "0"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "rangeStart"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.prettier.settings.requirePragma": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Require either '@prettier' or '@format' to be present in the file's\nfirst docblock comment\\nin order for it to be formatted.\n", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "requirePragma"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.prettier.settings.semi": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Print semicolons.", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "semi"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.prettier.settings.singleAttributePerLine": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Enforce single attribute per line in HTML, Vue and JSX.", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "singleAttributePerLine"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.prettier.settings.singleQuote": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Use single quotes instead of double quotes.", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "singleQuote"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.prettier.settings.tabWidth": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Number of spaces per indentation level.", "example": {"_type": "literalExpression", "text": "2"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "tabWidth"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.prettier.settings.trailingComma": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Print trailing commas wherever possible when multi-line.", "example": {"_type": "literalExpression", "text": "\"es5\""}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "trailingComma"], "readOnly": false, "type": "null or one of \"es5\", \"none\", \"all\""}, "treefmt.config.programs.prettier.settings.useTabs": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Indent with tabs instead of spaces", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "useTabs"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.prettier.settings.vueIndentScriptAndStyle": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/prettier.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Indent script and style tags in Vue files.", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "prettier", "settings", "vueIndentScriptAndStyle"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.protolint.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/protolint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/protolint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable protolint.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "protolint", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.qmlformat.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/qmlformat.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/qmlformat.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable qmlformat.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "qmlformat", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.rstfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/rstfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/rstfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable rstfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "rstfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.rstfmt.line_length": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/rstfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/rstfmt.nix"}], "default": {"_type": "literalExpression", "text": "72"}, "description": "Sets the line length.\n", "example": {"_type": "literalExpression", "text": "80"}, "loc": ["treefmt", "config", "programs", "rstfmt", "line_length"], "readOnly": false, "type": "signed integer"}, "treefmt.config.programs.rubocop.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/rubocop.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/rubocop.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable rubocop.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "rubocop", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.ruff-check.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/ruff-check.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/ruff-check.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable ruff-check.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "ruff-check", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.ruff-check.extendSelect": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/ruff-check.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/ruff-check.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "--extend-select options\n", "example": {"_type": "literalExpression", "text": "[\n \"I\"\n]"}, "loc": ["treefmt", "config", "programs", "ruff-check", "extendSelect"], "readOnly": false, "type": "list of string"}, "treefmt.config.programs.ruff-format.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/ruff-format.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/ruff-format.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable ruff-format.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "ruff-format", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.ruff-format.lineLength": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/ruff-format.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/ruff-format.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Set the line-length.\n", "example": {"_type": "literalExpression", "text": "79"}, "loc": ["treefmt", "config", "programs", "ruff-format", "lineLength"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.rufo.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/rufo.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/rufo.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable rufo.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "rufo", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.rumdl-check.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/rumdl-check.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/rumdl-check.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable rumdl-check.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "rumdl-check", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.rumdl-format.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/rumdl-format.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/rumdl-format.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable rumdl-format.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "rumdl-format", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.rustfmt.edition": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/rustfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/rustfmt.nix"}], "default": {"_type": "literalExpression", "text": "\"2024\""}, "description": "Rust edition to target when formatting\n", "loc": ["treefmt", "config", "programs", "rustfmt", "edition"], "readOnly": false, "type": "string"}, "treefmt.config.programs.rustfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/rustfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/rustfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable rustfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "rustfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.scalafmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/scalafmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/scalafmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable scalafmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "scalafmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.shellcheck.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/shellcheck.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/shellcheck.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable shellcheck.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "shellcheck", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.shellcheck.external-sources": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/shellcheck.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/shellcheck.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Allow sources outside of `includes`.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "shellcheck", "external-sources"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.shellcheck.extra-checks": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/shellcheck.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/shellcheck.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of optional checks to enable (or \"all\")\n", "example": {"_type": "literalExpression", "text": "[\n \"all\"\n]"}, "loc": ["treefmt", "config", "programs", "shellcheck", "extra-checks"], "readOnly": false, "type": "list of string"}, "treefmt.config.programs.shellcheck.severity": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/shellcheck.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/shellcheck.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Minimum severity of errors to consider (\"error\", \"warning\", \"info\", \"style\")\n", "loc": ["treefmt", "config", "programs", "shellcheck", "severity"], "readOnly": false, "type": "null or string"}, "treefmt.config.programs.shellcheck.source-path": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/shellcheck.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/shellcheck.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Specify path when looking for sourced files (\"SCRIPTDIR\" for script's dir)\n", "loc": ["treefmt", "config", "programs", "shellcheck", "source-path"], "readOnly": false, "type": "null or string"}, "treefmt.config.programs.shfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/shfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/shfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable shfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "shfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.shfmt.indent_size": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/shfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/shfmt.nix"}], "default": {"_type": "literalExpression", "text": "2"}, "description": "Sets the number of spaces to be used in indentation. Uses tabs if set to\nzero.\n", "example": {"_type": "literalExpression", "text": "4"}, "loc": ["treefmt", "config", "programs", "shfmt", "indent_size"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.shfmt.simplify": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/shfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/shfmt.nix"}], "default": {"_type": "literalExpression", "text": "true"}, "description": "Enables the `-s` (`--simplify`) flag, which simplifies code where possible.\n", "loc": ["treefmt", "config", "programs", "shfmt", "simplify"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.shfmt.useEditorConfig": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/shfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/shfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Use .editorconfig file for\nformatting. This is mutually exlusive with all other settings. See [shfmt\ndocs](https://github.com/mvdan/sh/blob/v3.12.0/cmd/shfmt/shfmt.1.scd?plain=1#L20-L21).\n.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "shfmt", "useEditorConfig"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.sizelint.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/sizelint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/sizelint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable sizelint.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "sizelint", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.sizelint.failOnWarn": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/sizelint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/sizelint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable fail-on-warn.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "sizelint", "failOnWarn"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.sizelint.settings": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/sizelint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/sizelint.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Configuration to generate sizelint.toml with", "loc": ["treefmt", "config", "programs", "sizelint", "settings"], "readOnly": false, "type": "open submodule of (TOML value)"}, "treefmt.config.programs.sql-formatter.dialect": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/sql-formatter.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/sql-formatter.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The sql dialect to use for formatting", "example": {"_type": "literalExpression", "text": "\"postgresql\""}, "loc": ["treefmt", "config", "programs", "sql-formatter", "dialect"], "readOnly": false, "type": "null or one of \"bigquery\", \"db2\", \"db2i\", \"hive\", \"mariadb\", \"mysql\", \"n1ql\", \"plsql\", \"postgresql\", \"redshift\", \"spark\", \"sqlite\", \"sql\", \"tidb\", \"trino\", \"transactsql\", \"tsql\", \"singlestoredb\", \"snowflake\""}, "treefmt.config.programs.sql-formatter.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/sql-formatter.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/sql-formatter.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable sql-formatter.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "sql-formatter", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.sqlfluff-lint.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/sqlfluff-lint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/sqlfluff-lint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable sqlfluff-lint.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "sqlfluff-lint", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.sqlfluff.dialect": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/sqlfluff.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/sqlfluff.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The sql dialect to use for formatting", "example": {"_type": "literalExpression", "text": "\"sqlite\""}, "loc": ["treefmt", "config", "programs", "sqlfluff", "dialect"], "readOnly": false, "type": "null or one of \"db2\", \"ansi\", \"soql\", \"tsql\", \"hive\", \"trino\", \"mysql\", \"oracle\", \"sqlite\", \"duckdb\", \"exasol\", \"athena\", \"mariadb\", \"vertica\", \"teradata\", \"redshift\", \"sparksql\", \"bigquery\", \"postgres\", \"greenplum\", \"snowflake\", \"materializ\", \"clickhouse\", \"databricks\""}, "treefmt.config.programs.sqlfluff.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/sqlfluff.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/sqlfluff.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable sqlfluff.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "sqlfluff", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.sqruff.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/sqruff.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/sqruff.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable sqruff.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "sqruff", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.statix.disabled-lints": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/statix.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/statix.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of ignored lints. Run `statix list` to see all available lints.\n", "example": {"_type": "literalExpression", "text": "[\n \"empty_pattern\"\n]"}, "loc": ["treefmt", "config", "programs", "statix", "disabled-lints"], "readOnly": false, "type": "list of string"}, "treefmt.config.programs.statix.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/statix.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/statix.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable statix.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "statix", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.stylish-haskell.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylish-haskell.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylish-haskell.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable stylish-haskell.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "stylish-haskell", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.stylua.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable stylua.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "stylua", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.stylua.settings.call_parentheses": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Whether parentheses should be applied on\nfunction calls with a single string/table\nargument. `Always` applies parentheses in\nall cases. `NoSingleString` omits\nparentheses on calls with a single string\nargument. Similarly, `NoSingleTable` omits\nparentheses on calls with a single table\nargument. `None` omits parentheses in both\ncases.\n\nNote: parentheses are still kept in situations\nwhere removal can lead to obscurity\n(e.g. `foo \"bar\".setup -> foo(\"bar\").setup`,\nsince the index is on the call result, not the string).\n\n`Input` removes all automation and preserves\nparentheses only if they were present in input code:\nconsistency is not enforced.\n", "example": {"_type": "literalExpression", "text": "\"Always\""}, "loc": ["treefmt", "config", "programs", "stylua", "settings", "call_parentheses"], "readOnly": false, "type": "null or one of \"Always\", \"NoSingleString\", \"NoSingleTable\", \"None\", \"Input\""}, "treefmt.config.programs.stylua.settings.collapse_simple_statement": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Specify whether to collapse simple statements.\n", "example": {"_type": "literalExpression", "text": "\"Never\""}, "loc": ["treefmt", "config", "programs", "stylua", "settings", "collapse_simple_statement"], "readOnly": false, "type": "null or one of \"Never\", \"FunctionOnly\", \"ConditionalOnly\", \"Always\""}, "treefmt.config.programs.stylua.settings.column_width": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Approximate line length for printing.\n\nUsed as a guide for line wrapping -\nthis is not a hard requirement:\nlines may fall under or over the limit.\n", "example": {"_type": "literalExpression", "text": "120"}, "loc": ["treefmt", "config", "programs", "stylua", "settings", "column_width"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.stylua.settings.indent_type": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Indent type.\n", "example": {"_type": "literalExpression", "text": "\"Tabs\""}, "loc": ["treefmt", "config", "programs", "stylua", "settings", "indent_type"], "readOnly": false, "type": "null or one of \"Tabs\", \"Spaces\""}, "treefmt.config.programs.stylua.settings.indent_width": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Character size of single indentation.\n\nIf `indent_type` is set to `Tabs`,\nthis option is used as a heuristic to\ndetermine column width only.\n", "example": {"_type": "literalExpression", "text": "4"}, "loc": ["treefmt", "config", "programs", "stylua", "settings", "indent_width"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.stylua.settings.line_endings": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Line endings type.\n", "example": {"_type": "literalExpression", "text": "\"Unix\""}, "loc": ["treefmt", "config", "programs", "stylua", "settings", "line_endings"], "readOnly": false, "type": "null or one of \"Unix\", \"Windows\""}, "treefmt.config.programs.stylua.settings.quote_style": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Quote style for string literals.\n\n`AutoPrefer` styles will prefer the\nspecified quote style, but fall back to\nthe alternative if it has fewer string\nescapes. `Force` styles always use the\nspecified style regardless of escapes.\n", "example": {"_type": "literalExpression", "text": "\"AutoPreferDouble\""}, "loc": ["treefmt", "config", "programs", "stylua", "settings", "quote_style"], "readOnly": false, "type": "null or one of \"AutoPreferDouble\", \"AutoPreferSingle\", \"ForceDouble\", \"ForceSingle\""}, "treefmt.config.programs.stylua.settings.sort_requires.enabled": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/stylua.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "StyLua has built-in support for sorting\nrequire statements. We group consecutive\nrequire statements into a single \"block\",\nand then requires are sorted only within\nthat block. Blocks of requires do not\nmove around the file.\n\nWe only include requires of the form\n`local NAME = require(EXPR)`, and sort\nlexicographically based on `NAME`.\n(We also sort Roblox services of the form\n`local NAME = game:GetService(EXPR)`)\n", "example": {"_type": "literalExpression", "text": "false"}, "loc": ["treefmt", "config", "programs", "stylua", "settings", "sort_requires", "enabled"], "readOnly": false, "type": "null or boolean"}, "treefmt.config.programs.swift-format.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/swift-format.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/swift-format.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable swift-format.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "swift-format", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.taplo.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/taplo.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/taplo.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable taplo.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "taplo", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.taplo.settings": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/taplo.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/taplo.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Configuration to generate taplo.toml with", "loc": ["treefmt", "config", "programs", "taplo", "settings"], "readOnly": false, "type": "open submodule of (TOML value)"}, "treefmt.config.programs.templ.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/templ.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/templ.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable templ.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "templ", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.terraform.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/terraform.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/terraform.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable terraform.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "terraform", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.texfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/texfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/texfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable texfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "texfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.tilt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/tilt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/tilt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable tilt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "tilt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.toml-sort.all": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/toml-sort.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/toml-sort.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable sort ALL keys.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "toml-sort", "all"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.toml-sort.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/toml-sort.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/toml-sort.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable toml-sort.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "toml-sort", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.typos.binary": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Search binary files", "loc": ["treefmt", "config", "programs", "typos", "binary"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.typos.configFile": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Custom config file", "example": {"_type": "literalExpression", "text": "\"typos.toml\""}, "loc": ["treefmt", "config", "programs", "typos", "configFile"], "readOnly": false, "type": "null or string"}, "treefmt.config.programs.typos.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable typos.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "typos", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.typos.hidden": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Search hidden files and directories", "loc": ["treefmt", "config", "programs", "typos", "hidden"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.typos.isolated": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Ignore implicit configuration files", "loc": ["treefmt", "config", "programs", "typos", "isolated"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.typos.locale": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Language locale to suggest corrections for [possible values: en, en-us, en-gb, en-ca, en-au]", "loc": ["treefmt", "config", "programs", "typos", "locale"], "readOnly": false, "type": "null or one of \"en\", \"en-us\", \"en-gb\", \"en-ca\", \"en-au\""}, "treefmt.config.programs.typos.noCheckFilenames": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Skip verifying spelling in file names", "loc": ["treefmt", "config", "programs", "typos", "noCheckFilenames"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.typos.noCheckFiles": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Skip verifying spelling in files", "loc": ["treefmt", "config", "programs", "typos", "noCheckFiles"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.typos.noIgnore": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Don't respect ignore files", "loc": ["treefmt", "config", "programs", "typos", "noIgnore"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.typos.noIgnoreDot": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Don't respect .ignore files", "loc": ["treefmt", "config", "programs", "typos", "noIgnoreDot"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.typos.noIgnoreGlobal": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Don't respect global ignore files", "loc": ["treefmt", "config", "programs", "typos", "noIgnoreGlobal"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.typos.noIgnoreParent": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Don't respect ignore files in parent directories", "loc": ["treefmt", "config", "programs", "typos", "noIgnoreParent"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.typos.noIgnoreVCS": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Don't respect ignore files in vsc directories", "loc": ["treefmt", "config", "programs", "typos", "noIgnoreVCS"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.typos.noUnicode": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Only allow ASCII characters in identifiers", "loc": ["treefmt", "config", "programs", "typos", "noUnicode"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.typos.sort": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Sort results", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "typos", "sort"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.typos.threads": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typos.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "The approximate number of threads to use [default: 0]", "example": {"_type": "literalExpression", "text": "2"}, "loc": ["treefmt", "config", "programs", "typos", "threads"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.typstyle.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typstyle.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typstyle.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable typstyle.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "typstyle", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.typstyle.indentWidth": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typstyle.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typstyle.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Number of spaces per indent level (default: 2).\n", "example": {"_type": "literalExpression", "text": "4"}, "loc": ["treefmt", "config", "programs", "typstyle", "indentWidth"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.typstyle.lineWidth": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typstyle.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typstyle.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Maximum line width in characters (default: 80).\n", "example": {"_type": "literalExpression", "text": "100"}, "loc": ["treefmt", "config", "programs", "typstyle", "lineWidth"], "readOnly": false, "type": "null or signed integer"}, "treefmt.config.programs.typstyle.wrapText": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/typstyle.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/typstyle.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable line wrapping of markup text.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "typstyle", "wrapText"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.wgslfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/wgslfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/wgslfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable wgslfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "wgslfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.wgslfmt.tabs": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/wgslfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/wgslfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable Use tabs for indentation (instead of spaces).", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "wgslfmt", "tabs"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.xmllint.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/xmllint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/xmllint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable xmllint.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "xmllint", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.yamlfmt.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/yamlfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/yamlfmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable yamlfmt.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "yamlfmt", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.yamlfmt.settings": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/yamlfmt.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/yamlfmt.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Configuration for yamlfmt, see\n\nfor supported values.\n", "loc": ["treefmt", "config", "programs", "yamlfmt", "settings"], "readOnly": false, "type": "open submodule of (YAML 1.1 value)"}, "treefmt.config.programs.yamllint.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/yamllint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/yamllint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable yamllint.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "yamllint", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.yamllint.settings": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/yamllint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/yamllint.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Configuration for yamllint, see\n\nfor supported values.\n", "loc": ["treefmt", "config", "programs", "yamllint", "settings"], "readOnly": false, "type": "open submodule of (YAML 1.1 value)"}, "treefmt.config.programs.yapf.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/yapf.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/yapf.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable yapf.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "yapf", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.zig.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/zig.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/zig.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable zig.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "zig", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.zizmor.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/zizmor.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/zizmor.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable zizmor.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "zizmor", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.zprint.enable": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/zprint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/zprint.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable zprint.", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "config", "programs", "zprint", "enable"], "readOnly": false, "type": "boolean"}, "treefmt.config.programs.zprint.zprintOpts": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/programs/zprint.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/programs/zprint.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Clojure map containing zprint options.\n", "example": {"_type": "literalExpression", "text": "\"{:width 90}\""}, "loc": ["treefmt", "config", "programs", "zprint", "zprintOpts"], "readOnly": false, "type": "null or string"}, "treefmt.config.projectRootFile": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "default": {"_type": "literalExpression", "text": "\".git/config\""}, "description": "File to look for to determine the root of the project in the\nbuild.wrapper.\nSet to null to let treefmt use its native detection.\n", "loc": ["treefmt", "config", "projectRootFile"], "readOnly": false, "type": "null or string"}, "treefmt.config.settings": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "The contents of treefmt.toml", "loc": ["treefmt", "config", "settings"], "readOnly": false, "type": "open submodule of (TOML value)"}, "treefmt.config.settings.excludes": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "A global list of paths to exclude. Supports glob.", "example": {"_type": "literalExpression", "text": "[\n \"node_modules/*\"\n]"}, "loc": ["treefmt", "config", "settings", "excludes"], "readOnly": false, "type": "list of string"}, "treefmt.config.settings.formatter": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "default": {"_type": "literalExpression", "text": "{ }"}, "description": "Set of formatters to use", "loc": ["treefmt", "config", "settings", "formatter"], "readOnly": false, "type": "attribute set of (open submodule of (TOML value))"}, "treefmt.config.settings.formatter..command": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "description": "Executable obeying the treefmt formatter spec", "loc": ["treefmt", "config", "settings", "formatter", "", "command"], "readOnly": false, "type": "Path to executable"}, "treefmt.config.settings.formatter..excludes": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of files to exclude for formatting. Supports globbing. Takes precedence over the includes.", "loc": ["treefmt", "config", "settings", "formatter", "", "excludes"], "readOnly": false, "type": "list of string"}, "treefmt.config.settings.formatter..includes": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "description": "List of files to include for formatting. Supports globbing.", "loc": ["treefmt", "config", "settings", "formatter", "", "includes"], "readOnly": false, "type": "list of string"}, "treefmt.config.settings.formatter..options": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "default": {"_type": "literalExpression", "text": "[ ]"}, "description": "List of arguments to pass to the command", "loc": ["treefmt", "config", "settings", "formatter", "", "options"], "readOnly": false, "type": "list of string"}, "treefmt.config.settings.on-unmatched": {"declarations": [{"name": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix", "url": "https://github.com/numtide/treefmt-nix/blob/main/module-options.nix"}], "default": {"_type": "literalExpression", "text": "null"}, "description": "Log paths that did not match any formatters at the specified log level.", "loc": ["treefmt", "config", "settings", "on-unmatched"], "readOnly": false, "type": "null or one of \"debug\", \"info\", \"warn\", \"error\", \"fatal\""}, "treefmt.enable": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/treefmt.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/integrations/treefmt.nix"}], "default": {"_type": "literalExpression", "text": "false"}, "description": "Whether to enable treefmt integration (through treefmt-nix).", "example": {"_type": "literalExpression", "text": "true"}, "loc": ["treefmt", "enable"], "readOnly": false, "type": "boolean"}, "unsetEnvVars": {"declarations": [{"name": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix", "url": "https://github.com/cachix/devenv/blob/main/src/modules/top-level.nix"}], "default": {"_type": "literalExpression", "text": "[\n \"HOST_PATH\"\n \"NIX_BUILD_CORES\"\n \"__structuredAttrs\"\n \"buildInputs\"\n \"buildPhase\"\n \"builder\"\n \"depsBuildBuild\"\n \"depsBuildBuildPropagated\"\n \"depsBuildTarget\"\n \"depsBuildTargetPropagated\"\n \"depsHostHost\"\n \"depsHostHostPropagated\"\n \"depsTargetTarget\"\n \"depsTargetTargetPropagated\"\n \"dontAddDisableDepTrack\"\n \"doCheck\"\n \"doInstallCheck\"\n \"nativeBuildInputs\"\n \"out\"\n \"outputs\"\n \"patches\"\n \"phases\"\n \"preferLocalBuild\"\n \"propagatedBuildInputs\"\n \"propagatedNativeBuildInputs\"\n \"shell\"\n \"shellHook\"\n \"stdenv\"\n \"strictDeps\"\n]"}, "description": "A list of removed environment variables to make the shell/direnv more lean.", "loc": ["unsetEnvVars"], "readOnly": false, "type": "list of string"}} \ No newline at end of file diff --git a/docs/src/individual-docs/languages/elixir.md b/docs/src/individual-docs/languages/elixir.md index d3615c80f0..af5afe32fe 100644 --- a/docs/src/individual-docs/languages/elixir.md +++ b/docs/src/individual-docs/languages/elixir.md @@ -1,3 +1,12 @@ +Enable Elixir with: + +```nix +languages.elixir.enable = true; +``` + +Since devenv 2.4.1, this also provides `erl`, `erlc`, and `escript` from the Erlang runtime used to build your selected Elixir package. Selecting a different `languages.elixir.package` automatically selects its matching runtime. + +For custom packages that do not expose their Erlang dependency, set `languages.elixir.erlang.package` explicitly to the runtime used to build that package. [comment]: # (Please add your documentation on top of this line) diff --git a/docs/src/individual-docs/languages/zig.md b/docs/src/individual-docs/languages/zig.md index f3f00ab77f..9663cfc32f 100644 --- a/docs/src/individual-docs/languages/zig.md +++ b/docs/src/individual-docs/languages/zig.md @@ -1,6 +1,7 @@ ## Getting Started -The simplest way to get started with Zig is to use the `version` attribute, which automatically sets up both the Zig compiler and ZLS (Zig Language Server) from the [zig-overlay](https://github.com/mitchellh/zig-overlay): +Use the `version` attribute to select the Zig compiler from [zig-overlay](https://github.com/mitchellh/zig-overlay) +and the matching [ZLS](https://github.com/zigtools/zls) (Zig Language Server) release: ```nix languages.zig = { @@ -14,13 +15,25 @@ This will automatically: - Use the specified Zig version from zig-overlay - Install the corresponding ZLS version (e.g., version "0.15.1" uses ZLS 0.15.0) +Add the required inputs before starting the environment. For the example above: + +```sh +devenv inputs add zig-overlay github:mitchellh/zig-overlay --follows nixpkgs +devenv inputs add zls github:zigtools/zls/0.15.0 --follows nixpkgs --follows zig-overlay +``` + +For Zig 0.16.0, use `version = "0.16.0"` and add ZLS with +`devenv inputs add zls github:zigtools/zls/0.16.0 --follows nixpkgs`. +ZLS 0.16 uses its own `zig-flake` input instead of zig-overlay. +Setting `languages.zig.lsp.enable = false` disables ZLS and removes the need for the `zls` input. + Alternatively, you can manually specify packages: ```nix languages.zig = { enable = true; package = pkgs.zig; - zls.package = pkgs.zls; + lsp.package = pkgs.zls; }; ``` diff --git a/src/modules/languages/elixir.nix b/src/modules/languages/elixir.nix index b96182df31..d49ef9493b 100644 --- a/src/modules/languages/elixir.nix +++ b/src/modules/languages/elixir.nix @@ -14,6 +14,20 @@ in defaultText = lib.literalExpression "pkgs.beamPackages.elixir"; }; + erlang.package = lib.mkOption { + type = lib.types.package; + default = cfg.package.erlang or (lib.findFirst + (package: (package.pname or "") == "erlang") + (throw "Cannot determine the Erlang runtime for languages.elixir.package; set languages.elixir.erlang.package explicitly.") + (cfg.package.buildInputs or [ ])); + defaultText = lib.literalExpression "the Erlang runtime used to build languages.elixir.package"; + description = '' + The Erlang runtime to include in the environment alongside Elixir. + Defaults to the runtime used to build the selected Elixir package. + Set this explicitly for custom packages that do not expose their Erlang dependency. + ''; + }; + lsp = { enable = lib.mkEnableOption "Elixir Language Server" // { default = true; }; @@ -29,6 +43,16 @@ in config = lib.mkMerge [ { changelogs = [ + { + date = "2026-10-09"; + title = "languages.elixir now includes its matching Erlang runtime"; + when = cfg.enable; + description = '' + Elixir environments now provide `erl`, `erlc`, and `escript` from the Erlang runtime used to build the selected Elixir package. + This prevents tools from using a missing or mismatched OTP runtime. + Custom packages can select the runtime with `languages.elixir.erlang.package`. + ''; + } { date = "2026-08-24"; title = "languages.elixir.package and languages.elixir.lsp.package default to the pkgs.beamPackages set"; @@ -50,6 +74,7 @@ in packages = [ cfg.package + cfg.erlang.package ] ++ lib.optional cfg.lsp.enable cfg.lsp.package; }) ]; diff --git a/src/modules/languages/zig.nix b/src/modules/languages/zig.nix index 627b004b29..177a620baf 100644 --- a/src/modules/languages/zig.nix +++ b/src/modules/languages/zig.nix @@ -25,12 +25,33 @@ let follows = [ "nixpkgs" ]; }; + # zig-overlay imports files directly from its nixpkgs input. devenv-nixpkgs + # is a wrapper flake, so its source root is not the package set's source. + # Import the overlay with the source that produced pkgs instead. + zigPackages = import "${zig-overlay.outPath}/default.nix" { + inherit pkgs; + nixpkgs = pkgs.path; + system = pkgs.stdenv.hostPlatform.system; + }; + zls = config.lib.getInput { name = "zls"; url = "github:zigtools/zls/${zlsVersion}"; attribute = "languages.zig.version"; - follows = [ "nixpkgs" "zig-overlay" ]; + follows = [ "nixpkgs" ] ++ lib.optional (lib.versionOlder zlsVersion "0.16.0") "zig-overlay"; }; + + # Older ZLS releases build with zig-overlay themselves. Supply the corrected + # packages there too, preserving the compiler version selected by ZLS. + zlsPackages = + if zls.inputs ? zig-overlay then + ((import "${zls.outPath}/flake.nix").outputs (zls.inputs // { + self = zls; + zig-overlay = zig-overlay // { + packages.${pkgs.stdenv.hostPlatform.system} = zigPackages; + }; + })).packages + else zls.packages; in { imports = [ @@ -45,7 +66,8 @@ in default = null; description = '' The Zig version to use. - This automatically sets the `languages.zig.package` and `languages.zig.lsp.package` using [zig-overlay](https://github.com/mitchellh/zig-overlay). + This sets `languages.zig.package` using [zig-overlay](https://github.com/mitchellh/zig-overlay) + and `languages.zig.lsp.package` using the matching [ZLS](https://github.com/zigtools/zls) release. ''; example = "0.15.1"; }; @@ -70,11 +92,11 @@ in config = lib.mkIf cfg.enable { languages.zig.package = lib.mkIf (cfg.version != null) ( - zig-overlay.packages.${pkgs.stdenv.system}.${cfg.version} + zigPackages.${cfg.version} ); languages.zig.lsp.package = lib.mkIf (cfg.version != null) ( - zls.packages.${pkgs.stdenv.system}.zls + zlsPackages.${pkgs.stdenv.hostPlatform.system}.zls ); packages = [ diff --git a/src/modules/services/mailpit.nix b/src/modules/services/mailpit.nix index 416d528b18..de8da9e406 100644 --- a/src/modules/services/mailpit.nix +++ b/src/modules/services/mailpit.nix @@ -8,14 +8,21 @@ let parsePort = addr: lib.toInt (lib.last (lib.splitString ":" addr)); parseHost = addr: lib.head (lib.splitString ":" addr); - baseUiPort = parsePort cfg.uiListenAddress; - baseSmtpPort = parsePort cfg.smtpListenAddress; - allocatedUiPort = config.processes.mailpit.ports.ui.value; - allocatedSmtpPort = config.processes.mailpit.ports.smtp.value; - uiHost = parseHost cfg.uiListenAddress; - smtpHost = parseHost cfg.smtpListenAddress; - uiAddr = "${uiHost}:${toString allocatedUiPort}"; - smtpAddr = "${smtpHost}:${toString allocatedSmtpPort}"; + # A unix socket address ends in its permissions, not a port, so it is passed + # through rather than parsed. + isUnixAddress = addr: lib.hasPrefix "unix:" addr; + + uiIsUnix = isUnixAddress cfg.uiListenAddress; + smtpIsUnix = isUnixAddress cfg.smtpListenAddress; + + uiAddr = + if uiIsUnix + then cfg.uiListenAddress + else "${parseHost cfg.uiListenAddress}:${toString config.processes.mailpit.ports.ui.value}"; + smtpAddr = + if smtpIsUnix + then cfg.smtpListenAddress + else "${parseHost cfg.smtpListenAddress}:${toString config.processes.mailpit.ports.smtp.value}"; in { options.services.mailpit = { @@ -30,14 +37,28 @@ in uiListenAddress = lib.mkOption { type = types.str; - description = "Listen address for UI."; + description = '' + Listen address for UI. + + Either `:`, where the port is the base devenv allocates + from, or a unix socket as `unix::`, which is passed + to mailpit as given. Mailpit requires the permissions. + ''; default = "127.0.0.1:8025"; + example = lib.literalExpression "\"unix:\${config.env.DEVENV_RUNTIME}/mailpit-ui.sock:660\""; }; smtpListenAddress = lib.mkOption { type = types.str; - description = "Listen address for SMTP."; + description = '' + Listen address for SMTP. + + Either `:`, where the port is the base devenv allocates + from, or a unix socket as `unix::`, which is passed + to mailpit as given. Mailpit requires the permissions. + ''; default = "127.0.0.1:1025"; + example = lib.literalExpression "\"unix:\${config.env.DEVENV_RUNTIME}/mailpit-smtp.sock:660\""; }; additionalArgs = lib.mkOption { @@ -50,17 +71,25 @@ in }; }; - config = lib.mkIf cfg.enable { - # For `sendmail` - packages = [ cfg.package ]; + config = lib.mkIf cfg.enable (lib.mkMerge [ + { + # For `sendmail` + packages = [ cfg.package ]; - tasks."devenv:mailpit:setup" = { - exec = ''mkdir -p "$DEVENV_STATE/mailpit"''; - before = [ "devenv:processes:mailpit" ]; - }; + tasks."devenv:mailpit:setup" = { + exec = ''mkdir -p "$DEVENV_STATE/mailpit"''; + before = [ "devenv:processes:mailpit" ]; + }; - processes.mailpit.ports.ui.allocate = baseUiPort; - processes.mailpit.ports.smtp.allocate = baseSmtpPort; - processes.mailpit.exec = "exec ${cfg.package}/bin/mailpit --db-file $DEVENV_STATE/mailpit/db.sqlite3 --listen ${lib.escapeShellArg uiAddr} --smtp ${lib.escapeShellArg smtpAddr} ${lib.escapeShellArgs cfg.additionalArgs}"; - }; + processes.mailpit.exec = "exec ${cfg.package}/bin/mailpit --db-file $DEVENV_STATE/mailpit/db.sqlite3 --listen ${lib.escapeShellArg uiAddr} --smtp ${lib.escapeShellArg smtpAddr} ${lib.escapeShellArgs cfg.additionalArgs}"; + } + + # An undeclared port is one devenv never allocates. + (lib.mkIf (!uiIsUnix) { + processes.mailpit.ports.ui.allocate = parsePort cfg.uiListenAddress; + }) + (lib.mkIf (!smtpIsUnix) { + processes.mailpit.ports.smtp.allocate = parsePort cfg.smtpListenAddress; + }) + ]); } diff --git a/src/modules/services/minio.nix b/src/modules/services/minio.nix index cd017a58c5..a5b66432c1 100644 --- a/src/modules/services/minio.nix +++ b/src/modules/services/minio.nix @@ -120,7 +120,17 @@ in }; clientPackage = lib.mkOption { - default = pkgs.minio-client; + # go-m1cpu's cgo initializer crashes when an Apple CPU's IOKit frequency + # properties are missing: https://github.com/shoenig/go-m1cpu/issues/25. + # The pure Go build avoids that initializer and supports the same commands. + default = + if pkgs.stdenv.hostPlatform.isDarwin && pkgs.stdenv.hostPlatform.isAarch64 then + pkgs.minio-client.overrideAttrs + (old: { + env = (old.env or { }) // { CGO_ENABLED = "0"; }; + }) + else + pkgs.minio-client; defaultText = lib.literalExpression "pkgs.minio-client"; type = types.package; description = "MinIO client package to use."; diff --git a/tests/elixir-erlang-override/devenv.nix b/tests/elixir-erlang-override/devenv.nix new file mode 100644 index 0000000000..79b411007c --- /dev/null +++ b/tests/elixir-erlang-override/devenv.nix @@ -0,0 +1,32 @@ +{ pkgs, ... }: +{ + languages.elixir.enable = true; + languages.elixir.lsp.enable = false; + + languages.elixir = { + # Model a custom package that does not expose its runtime dependency. + package = pkgs.beamPackages.elixir // { + buildInputs = [ ]; + }; + erlang.package = pkgs.beamPackages.erlang; + }; + + enterTest = '' + for tool in elixir erl erlc escript; do + command -v "$tool" + done + + # Compare the actual runtime, including its store path, rather than just the OTP major. + elixir_runtime=$(elixir -e 'IO.write(:erlang.system_info(:version)); IO.write(" "); IO.write(:code.root_dir())') + erlang_runtime=$(erl -noshell -eval 'io:format("~s ~s", [erlang:system_info(version), code:root_dir()]), halt().') + test "$elixir_runtime" = "$erlang_runtime" + + cat > runtime_probe.erl <<'ERLANG' + -module(runtime_probe). + -export([main/1]). + main(_) -> io:format("compiled and executed~n"). + ERLANG + erlc runtime_probe.erl + test "$(escript runtime_probe.beam)" = "compiled and executed" + ''; +} diff --git a/tests/elixir-package/devenv.nix b/tests/elixir-package/devenv.nix new file mode 100644 index 0000000000..9b813ec649 --- /dev/null +++ b/tests/elixir-package/devenv.nix @@ -0,0 +1,27 @@ +{ pkgs, ... }: +{ + languages.elixir.enable = true; + languages.elixir.lsp.enable = false; + + # The default package set uses a newer OTP. Follow the selected Elixir instead. + languages.elixir.package = pkgs.beam27Packages.elixir; + + enterTest = '' + for tool in elixir erl erlc escript; do + command -v "$tool" + done + + # Compare the actual runtime, including its store path, rather than just the OTP major. + elixir_runtime=$(elixir -e 'IO.write(:erlang.system_info(:version)); IO.write(" "); IO.write(:code.root_dir())') + erlang_runtime=$(erl -noshell -eval 'io:format("~s ~s", [erlang:system_info(version), code:root_dir()]), halt().') + test "$elixir_runtime" = "$erlang_runtime" + + cat > runtime_probe.erl <<'ERLANG' + -module(runtime_probe). + -export([main/1]). + main(_) -> io:format("compiled and executed~n"). + ERLANG + erlc runtime_probe.erl + test "$(escript runtime_probe.beam)" = "compiled and executed" + ''; +} diff --git a/tests/elixir/devenv.nix b/tests/elixir/devenv.nix new file mode 100644 index 0000000000..424ff5b4b3 --- /dev/null +++ b/tests/elixir/devenv.nix @@ -0,0 +1,25 @@ +{ + languages.elixir = { + enable = true; + lsp.enable = false; + }; + + enterTest = '' + for tool in elixir erl erlc escript; do + command -v "$tool" + done + + # Compare the actual runtime, including its store path, rather than just the OTP major. + elixir_runtime=$(elixir -e 'IO.write(:erlang.system_info(:version)); IO.write(" "); IO.write(:code.root_dir())') + erlang_runtime=$(erl -noshell -eval 'io:format("~s ~s", [erlang:system_info(version), code:root_dir()]), halt().') + test "$elixir_runtime" = "$erlang_runtime" + + cat > runtime_probe.erl <<'ERLANG' + -module(runtime_probe). + -export([main/1]). + main(_) -> io:format("compiled and executed~n"). + ERLANG + erlc runtime_probe.erl + test "$(escript runtime_probe.beam)" = "compiled and executed" + ''; +} diff --git a/tests/files-treefmt-order/devenv.nix b/tests/files-treefmt-order/devenv.nix index 61874a5bf3..87d463eb07 100644 --- a/tests/files-treefmt-order/devenv.nix +++ b/tests/files-treefmt-order/devenv.nix @@ -20,10 +20,10 @@ }; # Use a slow producer and a reader to exercise the integration's ordering edge. - tasks."devenv:files".exec = lib.mkForce '' - sleep 1 - printf 'managed content\n' > managed.txt - ''; + tasks."test:delay-files" = { + exec = "sleep 1"; + before = [ "devenv:files" ]; + }; tasks."devenv:treefmt:run".exec = lib.mkForce '' grep -qx "managed content" managed.txt ''; diff --git a/tests/mailpit-unix-socket/.test.sh b/tests/mailpit-unix-socket/.test.sh new file mode 100755 index 0000000000..18387caa3a --- /dev/null +++ b/tests/mailpit-unix-socket/.test.sh @@ -0,0 +1,13 @@ +#!/usr/bin/env bash +set -ex + +wait_for_processes + +sendmail -S "unix:$MAILPIT_SMTP_SOCKET" john@example.com < up.log 2>&1) || { cat repo1/up.log; exit 1; } +(cd repo1 && devenv --no-tui processes wait --timeout 90) || { cat repo1/up.log; exit 1; } (cd repo2 && devenv --no-tui up -d > up.log 2>&1) || { cat repo2/up.log; exit 1; } +(cd repo2 && devenv --no-tui processes wait --timeout 90) || { cat repo2/up.log; exit 1; } repo1_status=$(cd repo1 && devenv --no-tui processes list) repo2_status=$(cd repo2 && devenv --no-tui processes list) diff --git a/tests/process-attach-interactive/.test.sh b/tests/process-attach-interactive/.test.sh index 33b34e3aac..55201eb378 100644 --- a/tests/process-attach-interactive/.test.sh +++ b/tests/process-attach-interactive/.test.sh @@ -103,12 +103,12 @@ DAEMON_PID=$(sed -n '1p' "$PID_FILE") kill -0 "$DAEMON_PID" # E04: plain interactive `devenv up` attaches and a second Ctrl-C detaches. -# First attach on a fresh daemon: "Serving HTTP" is still the newest alpha -# line, and seeing it guarantees alpha is bound before the marker fetch. +# Readiness probes can push the startup line out of the visible log backlog. +# Check readiness directly, then synchronize on a fresh request marker. +http_is_ready "$PORT_ALPHA" set +e devenv-run-tests pty plain-up.typescript "devenv up" >/dev/null < "$fixtures/$name/devenv.nix" + printf 'use_shell: false\ngit_init: false\n' > "$fixtures/$name/.test-config.yml" +done + +echo 'exit 23' > "$fixtures/01-failed-patch/.patch.sh" +echo 'echo TEST_SHOULD_NOT_RUN' > "$fixtures/01-failed-patch/.test.sh" +echo 'echo NEXT_TEST_RAN' > "$fixtures/02-next-test/.test.sh" + +if devenv-run-tests run "$fixtures" > "$fixtures/output.log" 2>&1; then + cat "$fixtures/output.log" + echo "Expected a failing patch script to fail its test" + exit 1 +fi + +cat "$fixtures/output.log" +grep -q 'Patch script failed. Status code: 23' "$fixtures/output.log" +grep -q 'NEXT_TEST_RAN' "$fixtures/output.log" +grep -q 'Ran 2 tests, 1 failed, 0 skipped' "$fixtures/output.log" +if grep -q 'TEST_SHOULD_NOT_RUN' "$fixtures/output.log"; then + echo "The test ran after its patch script failed" + exit 1 +fi diff --git a/tests/test-runner-patch-failure/devenv.nix b/tests/test-runner-patch-failure/devenv.nix new file mode 100644 index 0000000000..c915eb0a89 --- /dev/null +++ b/tests/test-runner-patch-failure/devenv.nix @@ -0,0 +1 @@ +{ ... }: { } diff --git a/tests/zig-version-lsp-015/devenv.nix b/tests/zig-version-lsp-015/devenv.nix new file mode 100644 index 0000000000..afaca9547e --- /dev/null +++ b/tests/zig-version-lsp-015/devenv.nix @@ -0,0 +1,11 @@ +{ + languages.zig = { + enable = true; + version = "0.15.1"; + }; + + enterTest = '' + test "$(zig version)" = "0.15.1" + test "$(zls --version)" = "0.15.0" + ''; +} diff --git a/tests/zig-version-lsp-015/devenv.yaml b/tests/zig-version-lsp-015/devenv.yaml new file mode 100644 index 0000000000..4b9cf34e43 --- /dev/null +++ b/tests/zig-version-lsp-015/devenv.yaml @@ -0,0 +1,13 @@ +inputs: + zig-overlay: + url: github:mitchellh/zig-overlay + inputs: + nixpkgs: + follows: nixpkgs + zls: + url: github:zigtools/zls/0.15.0 + inputs: + nixpkgs: + follows: nixpkgs + zig-overlay: + follows: zig-overlay diff --git a/tests/zig-version-lsp/devenv.nix b/tests/zig-version-lsp/devenv.nix new file mode 100644 index 0000000000..83fd9a59e7 --- /dev/null +++ b/tests/zig-version-lsp/devenv.nix @@ -0,0 +1,11 @@ +{ + languages.zig = { + enable = true; + version = "0.16.0"; + }; + + enterTest = '' + test "$(zig version)" = "0.16.0" + test "$(zls --version)" = "0.16.0" + ''; +} diff --git a/tests/zig-version-lsp/devenv.yaml b/tests/zig-version-lsp/devenv.yaml new file mode 100644 index 0000000000..48b55a4ad1 --- /dev/null +++ b/tests/zig-version-lsp/devenv.yaml @@ -0,0 +1,11 @@ +inputs: + zig-overlay: + url: github:mitchellh/zig-overlay + inputs: + nixpkgs: + follows: nixpkgs + zls: + url: github:zigtools/zls/0.16.0 + inputs: + nixpkgs: + follows: nixpkgs diff --git a/tests/zig-version/devenv.nix b/tests/zig-version/devenv.nix new file mode 100644 index 0000000000..1be9f93f6e --- /dev/null +++ b/tests/zig-version/devenv.nix @@ -0,0 +1,11 @@ +{ + languages.zig = { + enable = true; + version = "0.16.0"; + lsp.enable = false; + }; + + enterTest = '' + test "$(zig version)" = "0.16.0" + ''; +} diff --git a/tests/zig-version/devenv.yaml b/tests/zig-version/devenv.yaml new file mode 100644 index 0000000000..5f2a784786 --- /dev/null +++ b/tests/zig-version/devenv.yaml @@ -0,0 +1,6 @@ +inputs: + zig-overlay: + url: github:mitchellh/zig-overlay + inputs: + nixpkgs: + follows: nixpkgs diff --git a/tokio-shutdown/src/lib.rs b/tokio-shutdown/src/lib.rs index 918f50a70c..78a8a2ada6 100644 --- a/tokio-shutdown/src/lib.rs +++ b/tokio-shutdown/src/lib.rs @@ -443,6 +443,21 @@ where } } + /// Wait for tasks to finish their own cancellation and cleanup paths. + /// + /// Unlike `wait_all`, this does not abort futures on shutdown. Every task + /// must observe the cancellation token itself and return after cleanup. + /// Panics are propagated to the caller. + pub async fn wait_all_gracefully(&mut self) { + while let Some(result) = self.join_set.join_next().await { + match result { + Ok(_) => {} + Err(err) if err.is_panic() => std::panic::resume_unwind(err.into_panic()), + Err(err) => panic!("{err}"), + } + } + } + /// Check if the join set is empty pub fn is_empty(&self) -> bool { self.join_set.is_empty() @@ -490,6 +505,42 @@ mod tests { assert_eq!(shutdown.last_signal(), Some(Signal::SIGHUP)); } + #[tokio::test] + async fn graceful_join_waits_for_cancellation_cleanup() { + let shutdown = Shutdown::new(); + let mut tasks = shutdown.join_set(); + let token = shutdown.cancellation_token(); + let (started_tx, started_rx) = oneshot::channel(); + let (cleaning_tx, cleaning_rx) = oneshot::channel(); + let (finish_tx, finish_rx) = oneshot::channel(); + tasks.spawn(move || async move { + started_tx.send(()).unwrap(); + token.cancelled().await; + cleaning_tx.send(()).unwrap(); + finish_rx.await.unwrap(); + }); + started_rx.await.unwrap(); + shutdown.shutdown(); + + let wait = tokio::spawn(async move { tasks.wait_all_gracefully().await }); + cleaning_rx.await.expect("cleanup was aborted"); + assert!(!wait.is_finished(), "join returned before cleanup finished"); + finish_tx.send(()).unwrap(); + tokio::time::timeout(Duration::from_secs(5), wait) + .await + .expect("join did not finish after cleanup") + .unwrap(); + } + + #[tokio::test] + #[should_panic(expected = "cleanup task panicked")] + async fn graceful_join_propagates_panics() { + let shutdown = Shutdown::new(); + let mut tasks = shutdown.join_set::<()>(); + tasks.spawn(|| async { panic!("cleanup task panicked") }); + tasks.wait_all_gracefully().await; + } + #[tokio::test] async fn test_shutdown_when_done() { let shutdown = Shutdown::new();