As a IDEasy user comming from a devonfw-ide project, I want to have a command to upgrade my settings from devonfw-ide to IDEasy so that I can get rid of all legacy after all my team members have already switched to IDEasy.
An UpgradeSettingsCommandlet shall be added so I can run ide upgrade-settings to upgrade my settings:
[ ] all devon.properties are renamed to ide.properties. In case a corresponding ide.properties already exists, the config from the devon.properties is merged into the existing ide.properties. This not only applies to settings but also to conf and all workspaces.
[ ] We ensure all legacy variables in ide.properties are replaced with their new name (if both legacy and new variable name is defined, the legacy one is removed).
[ ] Duplicated variables in the same ide.properties are removed (only the last occurrence is kept).
[ ] If variable DEVON_IDE_CUSTOM_TOOLS exists, it is converted into a custom-tools.json file in settings and the variable is removed (see here and legacy).
[ ] if settings/devon folder exists, it is renamed to settings/templates
[ ] XXX if settings/templates/conf/.m2 folder exists, it is renamed to settings/templates/conf/mvn
[ ] if settings/projects folder exists, it is renamed to settings/repositories
[ ] we recursively traverse all files in settings/workspace and settings/*/workspace and replace all known IdeVariables from CURLY into ANGLED syntax and legacy variable names are replaced with their new names. So e.g. ${DEVON_IDE_HOME} is replaced with $[IDE_HOME] or ${MAVEN_VERSION} is replaced with $[MVN_VERSION]. We also need to replace ${SETTINGS_PATH} with $[IDE_HOME]/settings.
[ ] if we hit an xml file that is not containing the XML namespace of our merger, we print a warning with the filepath saying that this file is most-likely outdated and print a link to a documentation page about this settings migration feature and linking to our XML merger docs in configurator and telling the project to sync their workspace config manually with the official ide-settings git repo on github provided by us as template for the settings.
[ ] that documentation page needs to exist and open when I click the link from that warning and explain the migration from devonfw-ide to IDEasy.
[ ] if a replacement-patterns.properties is found in a workspace folder a warning will be logged if the file is not empty and the file will be deleted.
[ ] if settings/ide.properties does not contain IDE_VARIABLE_SYNTAX_LEGACY_SUPPORT_ENABLED=false it will be added.
General note:
points above marked with XXX are potentially dangerous and we should discuss if we want to ask the user before applying the change. Therefore the user must understand the impact, what might not be so easy to explain. For .m2 vs. mvn all existing installations also need to be updated. IMHO I cared about compatibilities and fallbacks in our code so it should not break but maybe some templates may contain hardcoded references to .m2 and will stop working then.
Whenever it says a folder shall be renamed, it must be ensured that the new name does not already exist. Otherwise the rename should not take place and a warning must be logged.
As a IDEasy user comming from a devonfw-ide project, I want to have a command to upgrade my settings from devonfw-ide to IDEasy so that I can get rid of all legacy after all my team members have already switched to IDEasy.
An
UpgradeSettingsCommandletshall be added so I can runide upgrade-settingsto upgrade my settings:devon.propertiesare renamed toide.properties. In case a correspondingide.propertiesalready exists, the config from thedevon.propertiesis merged into the existingide.properties. This not only applies tosettingsbut also toconfand allworkspaces.ide.propertiesare replaced with their new name (if both legacy and new variable name is defined, the legacy one is removed).ide.propertiesare removed (only the last occurrence is kept).DEVON_IDE_CUSTOM_TOOLSexists, it is converted into acustom-tools.jsonfile insettingsand the variable is removed (see here and legacy).settings/devonfolder exists, it is renamed tosettings/templatessettings/templates/conf/.m2folder exists, it is renamed tosettings/templates/conf/mvnsettings/projectsfolder exists, it is renamed tosettings/repositoriessettings/workspaceandsettings/*/workspaceand replace all knownIdeVariablesfrom CURLY into ANGLED syntax and legacy variable names are replaced with their new names. So e.g.${DEVON_IDE_HOME}is replaced with$[IDE_HOME]or${MAVEN_VERSION}is replaced with$[MVN_VERSION]. We also need to replace${SETTINGS_PATH}with$[IDE_HOME]/settings.xmlfile that is not containing the XML namespace of our merger, we print a warning with the filepath saying that this file is most-likely outdated and print a link to a documentation page about this settings migration feature and linking to our XML merger docs in configurator and telling the project to sync their workspace config manually with the officialide-settingsgit repo on github provided by us as template for the settings.workspacefolder a warning will be logged if the file is not empty and the file will be deleted.settings/ide.propertiesdoes not containIDE_VARIABLE_SYNTAX_LEGACY_SUPPORT_ENABLED=falseit will be added.General note:
XXXare potentially dangerous and we should discuss if we want to ask the user before applying the change. Therefore the user must understand the impact, what might not be so easy to explain. For.m2vs.mvnall existing installations also need to be updated. IMHO I cared about compatibilities and fallbacks in our code so it should not break but maybe some templates may contain hardcoded references to.m2and will stop working then.