Fix escaping of quote marks in descriptions (#33)

* Fix escaping of quote marks in descriptions

* * add tests and comment

diagram/diagram_util.go

@@ -62,14 +62,21 @@ func getDescription(options []string, column database.ColumnResult) string {
 				description = append(description, "<"+column.EnumValues+">")
 			}
 		case "columnComments":
-			description = append(description, column.Comment)
+			description = append(description, escapeComments(column.Comment))
 		default:
 			logrus.Errorf("Could not parse option %q", option)
 		}
 	}
 	return strings.TrimSpace(strings.Join(description, " "))
 }
 
+// escapeComments escapes invalid characters in comments.
+// mermaid does not support quote marks ("), as it uses this to mark the comment, as such these need to be replaced
+// with `#quot;`.
+func escapeComments(str string) string {
+	return strings.ReplaceAll(str, `"`, "#quot;")
+}
+
 func shouldSkipConstraint(config config.MermerdConfig, tables []ErdTableData, constraint database.ConstraintResult) bool {
 	if config.ShowAllConstraints() {
 		return false

diagram/diagram_util_test.go

@@ -128,7 +128,9 @@ func TestTableNameInSlice(t *testing.T) {
 func TestGetColumnData(t *testing.T) {
 	columnName := "testColumn"
 	enumValues := "a,b"
-	comment := "comment"
+	comment := `{"comment":"detail"}`
+	expectedComment := "{#quot;comment#quot;:#quot;detail#quot;}"
+
 	column := database.ColumnResult{
 		Name:       columnName,
 		IsPrimary:  true,
@@ -148,7 +150,7 @@ func TestGetColumnData(t *testing.T) {
 		// Assert
 		configMock.AssertExpectations(t)
 		assert.Equal(t, columnName, result.Name)
-		assert.Equal(t, "<"+enumValues+"> "+comment, result.Description)
+		assert.Equal(t, "<"+enumValues+"> "+expectedComment, result.Description)
 		assert.Equal(t, primaryKey, result.AttributeKey)
 	})
 
@@ -180,7 +182,7 @@ func TestGetColumnData(t *testing.T) {
 		// Assert
 		configMock.AssertExpectations(t)
 		assert.Equal(t, columnName, result.Name)
-		assert.Equal(t, comment, result.Description)
+		assert.Equal(t, expectedComment, result.Description)
 		assert.Equal(t, primaryKey, result.AttributeKey)
 	})
 
@@ -212,7 +214,7 @@ func TestGetColumnData(t *testing.T) {
 		// Assert
 		configMock.AssertExpectations(t)
 		assert.Equal(t, columnName, result.Name)
-		assert.Equal(t, "<"+enumValues+"> "+comment, result.Description)
+		assert.Equal(t, "<"+enumValues+"> "+expectedComment, result.Description)
 		assert.Equal(t, none, result.AttributeKey)
 	})