Key order wasn't respected about json-diff-kit HOT 8 CLOSED

Your scenario seems reasonable; maybe we can add an option to let differ respect the key order:

interface DifferOptions {
  /**
   * If the value is set, differ will make sure the key order of results is the same as inputs ("before" or "after").
   * Otherwise, differ will sort the keys of results.
   */
  preserveKeyOrder?: 'before' | 'after';
}

from json-diff-kit.

It's because of a bug that I forgot to change the compare operator to the cmp result. It should be okay now.

from json-diff-kit.

lineNumber field also did not respect the key order.

from json-diff-kit.

The key order does not affect JSON value, the following two JSONs should be assumed equal:

{ "a": 1, "z": 2 }
{ "z": 2, "a": 1 }

I think the behaviour of json-diff-kit is acceptable. Also, the algorithm relies on this behaviour - it scans keys on both sides from small to large (based on ASCII value).

If we should respect the key order (on which side?), we would not be able to display the "modified" lines (the yellow lines).

{         | {
  "a": 1, |   "z": 2,
  "z": 2  |   "a": 1
}         | }

from json-diff-kit.

Thank you for your reply!
You are right, but I think at least a field (say "lineIndex" for example) should be provided to indicate all lines' original position, users will not like to see their json object being re-ordered, for example, user wouldn't like to see

{
    "start_date": "20201231",
    "end_date": "20210101"
}

turns into

{
    "end_date": "20210101",
    "start_date": "20201231"
}

from json-diff-kit.

Supported from 1.0.20; playground is also updated.

from json-diff-kit.

Thank you for your work! We will try it out tomorrow on our project.

from json-diff-kit.

Wrong result of this example when using preserveKeyOrder: "after" .

from json-diff-kit.