[Settings]Fix restore typo in code (#28992)

Fixes simple typo/grammar errors

It's easier to understand if it is spelled correctly. This is especially important for those for whom english may not be their first language.

Signed-off-by: brian teeman <brian@teeman.net>
This commit is contained in:
Brian Teeman
2023-10-04 11:13:01 +01:00
committed by GitHub
parent 74dd40e203
commit 5c1e4ac471

View File

@@ -292,9 +292,9 @@ namespace Microsoft.PowerToys.Settings.UI.Library
} }
// get data needed for process // get data needed for process
var backupRetoreSettings = JsonNode.Parse(GetBackupRestoreSettingsJson()); var backupRestoreSettings = JsonNode.Parse(GetBackupRestoreSettingsJson());
var currentSettingsFiles = GetSettingsFiles(backupRetoreSettings, appBasePath).ToList().ToDictionary(x => x.Substring(appBasePath.Length)); var currentSettingsFiles = GetSettingsFiles(backupRestoreSettings, appBasePath).ToList().ToDictionary(x => x.Substring(appBasePath.Length));
var backupSettingsFiles = GetSettingsFiles(backupRetoreSettings, latestSettingsFolder).ToList().ToDictionary(x => x.Substring(latestSettingsFolder.Length)); var backupSettingsFiles = GetSettingsFiles(backupRestoreSettings, latestSettingsFolder).ToList().ToDictionary(x => x.Substring(latestSettingsFolder.Length));
if (backupSettingsFiles.Count == 0) if (backupSettingsFiles.Count == 0)
{ {
@@ -306,13 +306,13 @@ namespace Microsoft.PowerToys.Settings.UI.Library
foreach (var currentFile in backupSettingsFiles) foreach (var currentFile in backupSettingsFiles)
{ {
var relativePath = currentFile.Value.Substring(latestSettingsFolder.Length + 1); var relativePath = currentFile.Value.Substring(latestSettingsFolder.Length + 1);
var retoreFullPath = Path.Combine(appBasePath, relativePath); var restoreFullPath = Path.Combine(appBasePath, relativePath);
var settingsToRestoreJson = GetExportVersion(backupRetoreSettings, currentFile.Key, currentFile.Value); var settingsToRestoreJson = GetExportVersion(backupRestoreSettings, currentFile.Key, currentFile.Value);
if (currentSettingsFiles.TryGetValue(currentFile.Key, out string value)) if (currentSettingsFiles.TryGetValue(currentFile.Key, out string value))
{ {
// we have a setting file to restore to // we have a setting file to restore to
var currentSettingsFileJson = GetExportVersion(backupRetoreSettings, currentFile.Key, value); var currentSettingsFileJson = GetExportVersion(backupRestoreSettings, currentFile.Key, value);
if (JsonNormalizer.Normalize(settingsToRestoreJson) != JsonNormalizer.Normalize(currentSettingsFileJson)) if (JsonNormalizer.Normalize(settingsToRestoreJson) != JsonNormalizer.Normalize(currentSettingsFileJson))
{ {
@@ -339,7 +339,7 @@ namespace Microsoft.PowerToys.Settings.UI.Library
if (anyFilesUpdated) if (anyFilesUpdated)
{ {
// something was changed do we need to return true to indicate a restart is needed. // something was changed do we need to return true to indicate a restart is needed.
var restartAfterRestore = (bool?)backupRetoreSettings!["RestartAfterRestore"]; var restartAfterRestore = (bool?)backupRestoreSettings!["RestartAfterRestore"];
if (!restartAfterRestore.HasValue || restartAfterRestore.Value) if (!restartAfterRestore.HasValue || restartAfterRestore.Value)
{ {
return (true, $"RESTART APP", "Success"); return (true, $"RESTART APP", "Success");
@@ -639,11 +639,11 @@ namespace Microsoft.PowerToys.Settings.UI.Library
} }
// get data needed for process // get data needed for process
var backupRetoreSettings = JsonNode.Parse(GetBackupRestoreSettingsJson()); var backupRestoreSettings = JsonNode.Parse(GetBackupRestoreSettingsJson());
var currentSettingsFiles = GetSettingsFiles(backupRetoreSettings, appBasePath).ToList().ToDictionary(x => x.Substring(appBasePath.Length)); var currentSettingsFiles = GetSettingsFiles(backupRestoreSettings, appBasePath).ToList().ToDictionary(x => x.Substring(appBasePath.Length));
var fullBackupDir = Path.Combine(Path.GetTempPath(), $"settings_{DateTime.UtcNow.ToFileTimeUtc().ToString(CultureInfo.InvariantCulture)}"); var fullBackupDir = Path.Combine(Path.GetTempPath(), $"settings_{DateTime.UtcNow.ToFileTimeUtc().ToString(CultureInfo.InvariantCulture)}");
var latestSettingsFolder = GetLatestSettingsFolder(); var latestSettingsFolder = GetLatestSettingsFolder();
var lastBackupSettingsFiles = GetSettingsFiles(backupRetoreSettings, latestSettingsFolder).ToList().ToDictionary(x => x.Substring(latestSettingsFolder.Length)); var lastBackupSettingsFiles = GetSettingsFiles(backupRestoreSettings, latestSettingsFolder).ToList().ToDictionary(x => x.Substring(latestSettingsFolder.Length));
lastBackupExists = lastBackupSettingsFiles.Count > 0; lastBackupExists = lastBackupSettingsFiles.Count > 0;
@@ -661,13 +661,13 @@ namespace Microsoft.PowerToys.Settings.UI.Library
tempFile = currentFile; tempFile = currentFile;
// need to check and back this up; // need to check and back this up;
var currentSettingsFileToBackup = GetExportVersion(backupRetoreSettings, currentFile.Key, currentFile.Value); var currentSettingsFileToBackup = GetExportVersion(backupRestoreSettings, currentFile.Key, currentFile.Value);
var doBackup = false; var doBackup = false;
if (lastBackupSettingsFiles.TryGetValue(currentFile.Key, out string value)) if (lastBackupSettingsFiles.TryGetValue(currentFile.Key, out string value))
{ {
// there is a previous backup for this, get an export version of it. // there is a previous backup for this, get an export version of it.
var lastSettingsFileDoc = GetExportVersion(backupRetoreSettings, currentFile.Key, value); var lastSettingsFileDoc = GetExportVersion(backupRestoreSettings, currentFile.Key, value);
// check to see if the new export version would be same as last export version. // check to see if the new export version would be same as last export version.
if (JsonNormalizer.Normalize(currentSettingsFileToBackup) != JsonNormalizer.Normalize(lastSettingsFileDoc)) if (JsonNormalizer.Normalize(currentSettingsFileToBackup) != JsonNormalizer.Normalize(lastSettingsFileDoc))
@@ -804,9 +804,9 @@ namespace Microsoft.PowerToys.Settings.UI.Library
/// Method <c>GetExportVersion</c> gets the version of the settings file that we want to backup. /// Method <c>GetExportVersion</c> gets the version of the settings file that we want to backup.
/// It will be formatted and all problematic settings removed from it. /// It will be formatted and all problematic settings removed from it.
/// </summary> /// </summary>
public static string GetExportVersion(JsonNode backupRetoreSettings, string settingFileKey, string settingsFileName) public static string GetExportVersion(JsonNode backupRestoreSettings, string settingFileKey, string settingsFileName)
{ {
var ignoredSettings = GetIgnoredSettings(backupRetoreSettings, settingFileKey); var ignoredSettings = GetIgnoredSettings(backupRestoreSettings, settingFileKey);
var settingsFile = JsonDocument.Parse(File.ReadAllText(settingsFileName)); var settingsFile = JsonDocument.Parse(File.ReadAllText(settingsFileName));
var outputBuffer = new ArrayBufferWriter<byte>(); var outputBuffer = new ArrayBufferWriter<byte>();
@@ -828,7 +828,7 @@ namespace Microsoft.PowerToys.Settings.UI.Library
if (settingFileKey.Equals("\\PowerToys Run\\settings.json", StringComparison.OrdinalIgnoreCase)) if (settingFileKey.Equals("\\PowerToys Run\\settings.json", StringComparison.OrdinalIgnoreCase))
{ {
// PowerToys Run hack fix-up // PowerToys Run hack fix-up
var ptRunIgnoredSettings = GetPTRunIgnoredSettings(backupRetoreSettings); var ptRunIgnoredSettings = GetPTRunIgnoredSettings(backupRestoreSettings);
var ptrSettings = JsonNode.Parse(Encoding.UTF8.GetString(outputBuffer.WrittenSpan)); var ptrSettings = JsonNode.Parse(Encoding.UTF8.GetString(outputBuffer.WrittenSpan));
foreach (JsonObject pluginToChange in ptRunIgnoredSettings) foreach (JsonObject pluginToChange in ptRunIgnoredSettings)
@@ -856,16 +856,16 @@ namespace Microsoft.PowerToys.Settings.UI.Library
/// <summary> /// <summary>
/// Method <c>GetPTRunIgnoredSettings</c> gets the 'Run-Plugin-level' settings we should ignore because they are problematic to backup/restore. /// Method <c>GetPTRunIgnoredSettings</c> gets the 'Run-Plugin-level' settings we should ignore because they are problematic to backup/restore.
/// </summary> /// </summary>
private static JsonArray GetPTRunIgnoredSettings(JsonNode backupRetoreSettings) private static JsonArray GetPTRunIgnoredSettings(JsonNode backupRestoreSettings)
{ {
if (backupRetoreSettings == null) if (backupRestoreSettings == null)
{ {
throw new ArgumentNullException(nameof(backupRetoreSettings)); throw new ArgumentNullException(nameof(backupRestoreSettings));
} }
if (backupRetoreSettings["IgnoredPTRunSettings"] != null) if (backupRestoreSettings["IgnoredPTRunSettings"] != null)
{ {
return (JsonArray)backupRetoreSettings["IgnoredPTRunSettings"]; return (JsonArray)backupRestoreSettings["IgnoredPTRunSettings"];
} }
return new JsonArray(); return new JsonArray();
@@ -874,11 +874,11 @@ namespace Microsoft.PowerToys.Settings.UI.Library
/// <summary> /// <summary>
/// Method <c>GetIgnoredSettings</c> gets the 'top-level' settings we should ignore because they are problematic to backup/restore. /// Method <c>GetIgnoredSettings</c> gets the 'top-level' settings we should ignore because they are problematic to backup/restore.
/// </summary> /// </summary>
private static string[] GetIgnoredSettings(JsonNode backupRetoreSettings, string settingFileKey) private static string[] GetIgnoredSettings(JsonNode backupRestoreSettings, string settingFileKey)
{ {
if (backupRetoreSettings == null) if (backupRestoreSettings == null)
{ {
throw new ArgumentNullException(nameof(backupRetoreSettings)); throw new ArgumentNullException(nameof(backupRestoreSettings));
} }
if (settingFileKey.StartsWith("\\", StringComparison.OrdinalIgnoreCase)) if (settingFileKey.StartsWith("\\", StringComparison.OrdinalIgnoreCase))
@@ -886,11 +886,11 @@ namespace Microsoft.PowerToys.Settings.UI.Library
settingFileKey = settingFileKey.Substring(1); settingFileKey = settingFileKey.Substring(1);
} }
if (backupRetoreSettings["IgnoredSettings"] != null) if (backupRestoreSettings["IgnoredSettings"] != null)
{ {
if (backupRetoreSettings["IgnoredSettings"][settingFileKey] != null) if (backupRestoreSettings["IgnoredSettings"][settingFileKey] != null)
{ {
var settingsArray = (JsonArray)backupRetoreSettings["IgnoredSettings"][settingFileKey]; var settingsArray = (JsonArray)backupRestoreSettings["IgnoredSettings"][settingFileKey];
Console.WriteLine("settingsArray " + settingsArray.GetType().FullName); Console.WriteLine("settingsArray " + settingsArray.GetType().FullName);