fix: improve the logic to determine whether a JSON document needs for…

…matting
josdejong · Feb 15, 2024 · bb15bd1 · bb15bd1
1 parent 4588c13
commit bb15bd1
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/src/lib/utils/jsonUtils.test.ts b/src/lib/utils/jsonUtils.test.ts
@@ -420,6 +420,11 @@ describe('jsonUtils', () => {
       expect(needsFormatting('{\n  "a": "some:message"\n}')).toBe(false)
       expect(needsFormatting('{\n  "a": "some,message"\n}')).toBe(false)
 
+      expect(needsFormatting('\n[1,2,3]')).toBe(true)
+      expect(needsFormatting('[1,2,3]\n')).toBe(true)
+      expect(needsFormatting('[1,2,3]\n  ')).toBe(true)
+      expect(needsFormatting('  \n[1,2,3]')).toBe(true)
+
       // a colon or comma inside a string gives a false positive (when the text doesn't contain a return character)
       expect(needsFormatting('{"a": "some:message"}')).toBe(true)
       expect(needsFormatting('{"a": "some,message"}')).toBe(true)

diff --git a/src/lib/utils/jsonUtils.ts b/src/lib/utils/jsonUtils.ts
@@ -485,7 +485,7 @@ export function isEqualParser(a: JSONParser, b: JSONParser): boolean {
  */
 export function needsFormatting(jsonText: string): boolean {
   const maxLength = 999
-  const head = jsonText.substring(0, maxLength)
+  const head = jsonText.substring(0, maxLength).trim()
   return !head.includes('\n') && DELIMITER_WITHOUT_SPACING_REGEX.test(head)
 }