Change menu.ini to dockstarter.ini

[CLHatch]

Rename the menu.ini config file to dockstarter.ini, and create more generic configuration functions, to allow config options un-related to the menu system.

Summary by Sourcery

Rename menu.ini to dockstarter.ini and refactor configuration handling to be more generic by introducing dedicated config creation and application scripts, and updating all script references to use the new APPLICATION_INI_FILE constant.

New Features:

• Add config_create script to initialize or migrate the new dockstarter.ini file
• Add apply_config script to orchestrate config creation, theme application, and sorting of the ini file

Enhancements:

• Replace explicit menu.ini references with APPLICATION_INI_FILE (dockstarter.ini) across all scripts
• Refactor config_get and config_set to default to the new ini file when no path is provided
• Update apply_theme and menu_options_display to auto-create config and drop filename parameters
• Introduce DEFAULTS_FOLDER and TIMESTAMPS_FOLDER constants in global_variables and move dialog file paths to the project root

Tests:

• Add stub tests for config_create and apply_config

[sourcery-ai]

Reviewer's Guide

Introduces a generic application config (dockstarter.ini) by renaming menu.ini, adding dynamic creation and migration of the config file, refactoring config_get/config_set to default to the new file, and updating related scripts to operate against the generic config.

Sequence diagram for config file creation and migration

sequenceDiagram
    participant SCRIPTS as "Script Entry Point"
    participant CONFIG as "config_create()"
    participant FS as "File System"
    SCRIPTS->>CONFIG: Check if dockstarter.ini exists
    alt dockstarter.ini does not exist
        CONFIG->>FS: Check for menu.ini
        alt menu.ini exists
            CONFIG->>FS: Rename menu.ini to dockstarter.ini
        else menu.ini does not exist
            CONFIG->>FS: Copy default dockstarter.ini from .defaults/
        end
    end

Loading

Class diagram for config_get and config_set refactor

classDiagram
    class config_get {
        +GET_VAR
        +VAR_FILE = APPLICATION_INI_FILE (default)
        +Reads value from VAR_FILE
    }
    class config_set {
        +SET_VAR
        +NEW_VAL
        +VAR_FILE = APPLICATION_INI_FILE (default)
        +Sets value in VAR_FILE
    }
    config_get <..> config_set: Both use APPLICATION_INI_FILE by default

Loading

Flow diagram for updated main initialization process

flowchart TD
    A["main()"] --> B["init()"]
    B --> C["apply_config()"]
    C --> D["config_create() if dockstarter.ini missing"]
    C --> E["apply_theme()"]
    C --> F["sort dockstarter.ini"]
    E --> G["Read theme and options from dockstarter.ini"]

Loading

File-Level Changes

Change	Details	Files
Rename and dynamically generate the application config file	Introduce APPLICATION_INI_NAME and APPLICATION_INI_FILE constants Add config_create.sh to migrate or copy the default config Add apply_config.sh to handle config initialization and call apply_theme Update main.sh to invoke apply_config instead of apply_theme directly	.scripts/config_create.sh .scripts/apply_config.sh main.sh
Refactor config_get and config_set to use the generic config	Default VAR_FILE to APPLICATION_INI_FILE when no file argument is passed Remove explicit menu.ini arguments from config_get and config_set calls Update theme_name to read Theme from APPLICATION_INI_FILE	.scripts/config_get.sh .scripts/config_set.sh .scripts/theme_name.sh
Refactor global variable definitions for new config	Add DEFAULTS_FOLDER and DEFAULTS_FOLDER_NAME constants Declare APPLICATION_INI_NAME and APPLICATION_INI_FILE Remove MENU_INI_NAME and MENU_INI_FILE declarations Reorder and group folder constants for clarity	.includes/global_variables.sh
Update apply_theme to use the generic config and handle missing file	Check for APPLICATION_INI_FILE and invoke config_create if missing Replace MENU_INI_NAME references with APPLICATION_INI_NAME Simplify config_get/config_set calls to omit file path Minor formatting improvements in fatal error messages	.scripts/apply_theme.sh
Adjust menu display and dialog functions for generic config	Silence apply_theme calls in menu_options_display Update config_get/config_set invocations to target APPLICATION_INI_FILE Relocate DIALOG_OPTIONS_FILE and DIALOGRC paths to use script root	.scripts/menu_options_display.sh .includes/dialog_functions.sh

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey there - I've reviewed your changes and they look great!

Prompt for AI Agents

Please address the comments from this code review:

## Individual Comments

### Comment 1
<location> `.scripts/menu_options_display.sh:12` </location>
<code_context>
     local Title="Display Options"

-    #run_script 'apply_theme'
+    run_script 'apply_theme' &> /dev/null

     local DrawLineOption="Draw Lines"
</code_context>

<issue_to_address>
**suggestion (bug_risk):** apply_theme output is now suppressed.

Suppressing all output may hide errors from apply_theme. Consider capturing or logging error messages separately to ensure failures are not overlooked.

```suggestion
    # Suppress standard output, but capture error output
    local apply_theme_err
    apply_theme_err=$(run_script 'apply_theme' 2>&1 > /dev/null)
    if [[ -n "$apply_theme_err" ]]; then
        echo "Error applying theme: $apply_theme_err" >&2
    fi
```
</issue_to_address>

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}