simvx.core.config

Unified application configuration for SimVX.

Merges editor and IDE settings into a single ~/.config/simvx/config.json file with general, editor, and ide sections.

Module Contents

Classes

GeneralConfig	Settings shared by both editor and IDE.
EditorSection	Editor-specific settings.
IDESection	IDE-specific settings.
AppConfig	Unified config with sections, persisted in ~/.config/simvx/config.json.

Functions

project_config_path

Return the .simvx/config.json path for a project root.

Data

log
CONFIG_DIR
CONFIG_FILE
PROJECT_CONFIG_DIRNAME
PROJECT_CONFIG_FILENAME

API

simvx.core.config.log

‘getLogger(…)’

simvx.core.config.CONFIG_DIR

None

simvx.core.config.CONFIG_FILE

None

simvx.core.config.PROJECT_CONFIG_DIRNAME

‘.simvx’

simvx.core.config.PROJECT_CONFIG_FILENAME

‘config.json’

simvx.core.config.project_config_path(project_root: pathlib.Path | str) → pathlib.Path

Return the .simvx/config.json path for a project root.

Always returns a path even if no file exists yet; callers should test .exists() before reading.

class simvx.core.config.GeneralConfig

Settings shared by both editor and IDE.

theme_preset: str

‘dark’

font_size: float

11.0

window_width: int

1600

window_height: int

900

physics_backend: str = <Multiline-String>

recent_files: list[str]

‘field(…)’

recent_folders: list[str]

‘field(…)’

recent_projects: list[dict[str, str]]

‘field(…)’

custom_shortcuts: dict[str, str]

‘field(…)’

class simvx.core.config.EditorSection

Editor-specific settings.

dock_layout: dict[str, Any]

‘field(…)’

show_grid: bool

True

grid_size: float

1.0

grid_subdivisions: int

4

snap_enabled: bool

False

snap_size: float

0.5

auto_save_interval: int

300

hot_reload_enabled: bool

True

class simvx.core.config.IDESection

IDE-specific settings.

tab_size: int

4

insert_spaces: bool

True

show_line_numbers: bool

True

show_minimap: bool

True

show_code_folding: bool

True

show_indent_guides: bool

True

auto_save: bool

False

format_on_save: bool

True

sidebar_width: int

250

bottom_panel_height: int

200

sidebar_visible: bool

True

bottom_panel_visible: bool

True

lsp_enabled: bool

True

lsp_command: str

‘pylsp’

lsp_args: list[str]

‘field(…)’

lint_enabled: bool

True

lint_on_save: bool

True

lint_command: str

‘ruff check –output-format=json’

format_command: str

‘ruff format’

python_path: str = <Multiline-String>

venv_path: str = <Multiline-String>

auto_detect_venv: bool

True

debug_adapter: str

‘debugpy’

keybindings: dict[str, str]

‘field(…)’

class simvx.core.config.AppConfig

Unified config with sections, persisted in ~/.config/simvx/config.json.

general: simvx.core.config.GeneralConfig

‘field(…)’

editor: simvx.core.config.EditorSection

‘field(…)’

ide: simvx.core.config.IDESection

‘field(…)’

load() → None

Load from config.json, keeping the defaults when there is none.

A file that is not valid JSON is logged as an error and renamed to config.json.corrupt (config.json.corrupt.1 and so on when that name is taken), so the next :meth:save writes a fresh file beside it instead of replacing the user’s settings with defaults. Loading then continues on the defaults: a broken config must not stop an application starting. A file that cannot be read is logged and left where it is.

load_with_project(project_root: pathlib.Path | str | None) → None

Load user config, then overlay any .simvx/config.json for the project.

Project config is loaded ON TOP of the already-applied user config: every key present in the project file replaces the user-config value for that key. Sections / fields omitted from the project file keep their user-config (or default) value. This mirrors the .editorconfig / .vscode/settings.json precedent: flat per-key override, no deep dict merging (a project editor dict replaces the user one wholesale only for the fields it sets, thanks to _update_dataclass skipping absent keys).

Passing None is equivalent to calling :meth:load.

save_project(project_root: pathlib.Path | str, *, sections: list[str] | None = None) → None

Persist the current config to <project_root>/.simvx/config.json.

When sections is given, only those top-level sections are written (e.g. ["editor"] writes just the editor block): useful for committing project-level overrides without leaking machine-specific general fields like recent_files into the project repo.

save() → None

Write current config to config.json.

add_recent_file(path: str) → None

add_recent_folder(path: str) → None