fix: Handle missing properties in .kicad_sym file like ki_keywords or ki_description

Author: SebastianRumohr

release-notes/3.0.0.md

@@ -6,4 +6,3 @@ Breaking changes:
 Features:
 
 - Spaces are converted to underscores when a custom field is added.
-- 

release-notes/3.0.1.md

@@ -0,0 +1,2 @@
+Bug fixes:
+- Handle missing properties in `.kicad_sym` file like `ki_keywords` or `ki_description`

src/KiCadDbLib/Services/KiCad/LibraryWriter/KiCad6LibraryWriter.cs

@@ -80,12 +80,12 @@ public async Task WritePartAsync(Part part)
             SetSymbolId(symbol, part.Value);
             UpdateUnitIds(symbol, symbolInfo.Name, part.Value);
 
-            SetPropertyByName(symbol, "Reference", part.Reference);
-            SetPropertyByName(symbol, "Value", part.Value);
-            SetPropertyByName(symbol, "Footprint", part.Footprint);
-            SetPropertyByName(symbol, "Datasheet", string.IsNullOrEmpty(part.Datasheet) ? "~" : part.Datasheet);
-            SetPropertyByName(symbol, "ki_keywords", part.Keywords);
-            SetPropertyByName(symbol, "ki_description", part.Description);
+            SetOrAddPropertyByName(symbol, "Reference", part.Reference);
+            SetOrAddPropertyByName(symbol, "Value", part.Value);
+            SetOrAddPropertyByName(symbol, "Footprint", part.Footprint);
+            SetOrAddPropertyByName(symbol, "Datasheet", string.IsNullOrEmpty(part.Datasheet) ? "~" : part.Datasheet);
+            SetOrAddPropertyByName(symbol, "ki_keywords", part.Keywords);
+            SetOrAddPropertyByName(symbol, "ki_description", part.Description);
 
             foreach (var customField in part.CustomFields.OrderBy(cf => cf.Key))
             {
@@ -113,20 +113,23 @@ private static void UpdateUnitIds(SNode symbol, string symbolName, string partVa
             }
         }
 
-        private static void SetPropertyByName(SNode symbol, string propertyName, string value)
+        private static void SetOrAddPropertyByName(SNode symbol, string propertyName, string value)
         {
             var property = symbol.Childs
                 .Where(child => child.Name == _property)
                 .SingleOrDefault(property => property.Childs[0].Name == propertyName);
 
-            if (property is null)
+            if (property is not null)
             {
-                var symbolName = symbol.Childs[0].Name;
-                throw new KeyNotFoundException($"Property \"{propertyName}\" not found in symbol\"{symbolName}\".");
+                property.Childs[1].Name = value;
+                property.Childs[1].IsString = true;
+            }
+            else
+            {
+                var index = GetIndexOfLastProperty(symbol) + 1;
+                property = CreateCustomProperty(null, KeyValuePair.Create(propertyName, value));
+                symbol.Insert(index, property);
             }
-
-            property.Childs[1].Name = value;
-            property.Childs[1].IsString = true;
         }
 
         private static void AddCustomProperty(SNode symbol, KeyValuePair<string, string> property)
@@ -176,7 +179,7 @@ private static SNode CreateCustomProperty(int? propertyId, KeyValuePair<string,
             }
 
             return symbol.Childs
-                .Where(child => child.Name == "property")
+                .Where(child => child.Name == _property)
                 .Select(GetIdOfProperty)
                 .Last();
         }