Files

Misaka_Company 681f3ba517 refactor(docs): reorganize documentation directory structure

- Create user/ - User guides and configuration documentation
- Create features/ - Feature specifications and business flows
- Create debugging/ - Debug guides and quick references
- Create testing/ - Test infrastructure, reports, and plans
- Create internal/ - Internal plans, analyses, and templates
- Move cleaner/*.md to cleaner/ directory
- Move LOGGING_*.md to developer/guides/

Add docs/README.md as documentation index with category navigation
and quick lookup guide.

The reorganized structure makes it easier for users and developers
to quickly locate relevant documentation.

2026-04-14 12:15:09 +08:00

1.6 KiB

Raw Blame History

Settings Partial Save Feature

Overview

The settings system now implements partial save functionality to prevent unintended overwrites of configuration values.

How It Works

Field Whitelist: Only fields exposed in the UI can be modified
Deep Merge: Updates are merged with existing config, preserving unmodified fields
Backup & Rollback: Config is backed up before save; failures trigger automatic rollback

Editable Fields

Currently editable via UI:

erp.url - ERP system URL
erp.username - ERP login username
erp.password - ERP login password

Adding New Editable Fields

To add a new field to the UI:

Add field to whitelist in src/main/services/config/config-manager.ts:

const UI_EDITABLE_FIELDS: string[] = [
  'erp.url',
  'erp.username',
  'erp.password',
  'database.dbType' // Add new field here
]

Add UI input in src/renderer/src/pages/SettingsPage.tsx
Update handleSaveSettings to include the new field

API

savePartialSettings(settings: Partial)

Saves only the provided fields, preserving all existing configuration.

Returns: { success: boolean, error?: string }

Validation:

Checks whitelist before applying changes
Returns error for unauthorized fields

Error Handling

Unauthorized field: Returns error message listing invalid fields
Save failure: Automatically restores from backup
Backup failure: Logs warning, continues with save

Backup File

Location: .env.backup (in project root)

Created before every save operation. Used for rollback on failure.

1.6 KiB Raw Blame History