Add indentation configuration from modes #136

mkh-user · 2025-11-24T07:25:25Z

Summary of Changes

Added ability to modes to change indentation settings (not yet) with feature of custom or locked settings.

Related Items

Closes Indentation configuration from modes #135
Modifies Create "Auto Indent" action #30, Create "Remove All Indents" action #28, Change Auto Indention section to "Edit" #76

Technical Details & Testing

Some new properties for modes are available to define indentation settings
A new experimental Checkbox option type for submenus is available (used in added options)
All related menus and menu translations were updated (missing translations were added by Microsoft Copilot as fallback)

Checklist

Linked all relevant issues/PRs/discussions
Code follows project style and guidelines
Self-reviewed and tested thoroughly
Documentation updated (if applicable)
No new warnings or errors introduced
Relevant changes added to CHANGELOG

Summary by CodeRabbit

Bug Fixes
- Fixed typos in menu labels and clarified fallback messages.
New Features
- Per-mode indentation settings (type and size) exposed and controllable.
- New indentation actions: convert to spaces/tabs, remove all indents, auto-indent new lines, lock indentation, reset mode indentation.
- Submenus now support checkbox items.
UI/UX Improvements
- Consolidated indentation options under Format > Indentation; bottom bar shows current indent type and size.
Documentation
- Updated menus and modes docs to reflect new indentation options and wording.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

coderabbitai · 2025-11-24T07:25:34Z

📝 Walkthrough

Walkthrough

Adds per-mode indentation fields to TextForgeMode and EditorAPI, new EditorAPI signals and functions for managing per-mode/global indentation, UI/menu entries and bottom-bar control to view/change indentation (including lock/reset), action scripts for lock/reset, and theme adjustments for the bottom bar.

Changes

Cohort / File(s)	Summary
Mode declarations `core/classes/text_forge_mode.gd`	Added public enum `INDENT_TYPE` and public members `indent_type: INDENT_TYPE` and `indent_size: int` to expose mode indentation defaults.
Editor API & indentation logic `core/scripts/editor_api.gd`	Added `signal indentation_settings_updated(use_space: bool, indent_size: int)`, `var custom_mode_indentations := {}`, and functions `update_indentation_settings(use_mode := true)`, `reset_to_mode_indentation_settings()`, `change_indentation_type(use_spaces: bool)`, `change_indent_size(indent_size: int)`. Integrates per-mode overrides, persistence, and emits updates on relevant lifecycle events.
UI: menu data `data/main_ui.ini`	Renamed `indention_submenu` → `indentation_submenu`, migrated/renamed indentation menu keys from `menu.edit.` to `menu.format.indentation.`, corrected "Evulate" → "Evaluate", added convert/to-spaces/tabs, remove indents, auto-indent new lines, lock indentation, reset mode indentation, and consolidated Format menu entry.
Bottom-bar control & scene `core/main.tscn`, `core/scripts/indentation_settings_label.gd`, `core/scripts/indentation_settings_label.gd.uid`	Added BottomBar `IndentationSettings` MenuButton with script; script subscribes to `indentation_settings_updated`, updates label ("Spaces (N)" / "Tabs (N)"), handles user actions to change type/size, and triggers EditorAPI calls. Scene load_steps incremented and layout offsets adjusted.
Action scripts `action_scripts/lock_indentation_settings.gd`, `action_scripts/lock_indentation_settings.gd.uid`, `action_scripts/reset_mode_indentation.gd`, `action_scripts/reset_mode_indentation.gd.uid`	New CheckableActionScript to persist `lock_indentation_settings` and an ActionScript to reset current mode indentation (validates mode id and calls `EditorAPI.reset_to_mode_indentation_settings()`).
Main runtime changes `core/main.gd`	Fixed typo in OptionTypes enum text, extended `_create_submenu` to support checkbox items for non-root submenus, and replaced direct editor property assignments with `Global.get_editor_api().update_indentation_settings(false)`.
Theme `data/themes/dark.tres`	Added BottomBarLabel properties: `base_type`, `colors/font_color`, and `font_sizes/font_size`.
Docs & changelog `docs/menus.md`, `docs/modes.md`, `CHANGELOG.md`	Updated docs to refer to "Indentation" submenu and describe new options (auto-indent new lines, lock, reset, per-mode settings). Added changelog entry for mode-driven indentation settings.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UI as BottomBar / Menu
    participant Editor as EditorAPI
    participant Mode as TextForgeMode

    Note over Mode,Editor: Modes expose indent_type & indent_size
    Mode->>Editor: provide indent_type & indent_size on load
    Editor->>UI: emit indentation_settings_updated(use_space, indent_size)
    UI->>User: display label ("Spaces (N)" / "Tabs (N)")
    User->>UI: choose option (spaces/tabs/edit size/lock/reset)
    UI->>Editor: call change_indentation_type / change_indent_size / reset_to_mode_indentation_settings
    Editor->>Editor: update custom_mode_indentations or global setting and persist
    Editor-->>UI: emit indentation_settings_updated(updated values)
    UI-->>User: reflect updated label/state

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'Add indentation configuration from modes' clearly and concisely describes the main change: adding the ability for modes to configure indentation settings.
Linked Issues check	✅ Passed	All acceptance criteria from issue #135 are satisfied: modes define indentation via new INDENT_TYPE enum and indent_size/indent_type properties [#135]; custom per-mode indentation settings are stored and restored via custom_mode_indentations [#135]; users can lock settings via lock_indentation_settings.gd [#135]; reset functionality implemented via reset_mode_indentation.gd [#135].
Out of Scope Changes check	✅ Passed	All changes are aligned with issue #135: new INDENT_TYPE enum and indentation properties in TextForgeMode, EditorAPI functions for managing per-mode indentation, UI components for indentation settings, menu reorganization to support indentation features, and documentation updates. No out-of-scope modifications detected.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch 135-indentation-configuration-from-modes

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

- Fix spelling and hyphenation issues in Indentation submenu documentation. - Fix spelling errors in the new Indentation Settings section. Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

mkh-user added 3 commits November 24, 2025 10:48

Refactor menus for mode based indentation

df8bf5d

Update TextForgeMode class for indentation properties

f701a06

Add experimental checkboxes to submenus

d348034

mkh-user linked an issue Nov 24, 2025 that may be closed by this pull request

Indentation configuration from modes #135

Closed

3 tasks

github-project-automation bot added this to Release: Text Forge 1.0 Nov 24, 2025

github-project-automation bot moved this to Needs Review in Release: Text Forge 1.0 Nov 24, 2025

mkh-user self-assigned this Nov 24, 2025

mkh-user moved this from Needs Review to In Progress in Release: Text Forge 1.0 Nov 24, 2025

mkh-user added this to the Text Forge 0.2 milestone Nov 24, 2025