docs(ui): add comments to add context on special characters escaping

neofacto · May 29, 2020 · 67e8538 · 67e8538
1 parent c828d2a
commit 67e8538
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/ui/src/helpers/formatConfigExtract.ts b/ui/src/helpers/formatConfigExtract.ts
@@ -23,8 +23,10 @@ export default function formatConfigExtract(configError: ConfigError): string {
  try {
  JSON.parse(configExtract)
  } catch (err) {
+ // Escape special characters to display the config as text, not as HTML
  const sanitizedConfigExtract = configExtract
  .replace(/[\u00A0-\u9999<>&]/gim, (match) => {
+ // Replace with the HTML Entity of the character
  return `&#${match.charCodeAt(0)};`
  })
  .replace(/\\\\/g, '\\')