feat: Automatic settings migration

[Nerivec]

Changes

• Add auto versioning to configuration.yaml for successive migration support
• Remove migrated schema keys
• Update old tests to use new schema keys
• Remove tests no longer needed due to migration system
• Remove leftover legacy type in DeviceOptions
• Fix settings.test.ts not properly mocked (from).

Migration

• Backup existing configuration.yaml before each migration
• Handle (in that order):
  • transfer: if path exists, remove it, and:
    • create new path with previous value
    • or if both paths already exist and are arrays, merge them
    • or if new path already has a different value, keep new path as is
  • change: change value at path if needed, and possibly if matching one of given values
  • add: add new path with given value
  • remove: remove path if exists
  • combination of above (through successive iterations on same-ish path, e.g. transfer experimental.xyz then remove experimental)
• Create migration notes for each migration based on previous value (if a change is actually produced) in data/ directory

Example migration notes

[REMOVAL] HA discovery_topic was moved from advanced.homeassistant_discovery_topic to homeassistant.discovery_topic.

[TRANSFER] Baudrate was moved from advanced.baudrate to serial.baudrate.

[REMOVAL] RTSCTS was moved from advanced.rtscts to serial.rtscts.

[TRANSFER] ban was renamed to passlist.

[ADDITION] Migrated settings to version 2

For more details, see https://github.com/Koenkk/zigbee2mqtt/discussions/24198

Important

While this automatically migrates Z2M settings, it cannot migrate side-effects on third parties (like Home Assistant). Make sure you go over the migration notes and the link given to adjust things accordingly on that front.

[Koenkk]

Very nice 🥇