Kept order of headers

[tearwyx]

When the pofile loads and saves the PO file saved by another application, headers will be swapped. This then causes frequent differences in commits when PO file is indexed by git. A possible solution would be to change an object containing headers to an array.

[rubenv]

Hmmm, this would mean a major API break.

[tearwyx]

Or save the order of headers to the new property for serialization.

[rubenv]

Or save the order of headers to the new property for serialization.

Could you elaborate a bit on that?

[tearwyx]

The new instance property of type Array will contain header names. Their order will be taken from parsing. Headers will be serialized in this order.

[rubenv]

So the existing headers property can stay as it is, with a new headerOrder (or something like that) array for the serialization order, right?

That sounds like a better (backwards-compatible) solution. Should make the change much smaller as well.

[tearwyx]

The problem is how to sort the default headers. Are the default headers necessary?

[tearwyx]

@rubenv, headerOrder implemented.

[rubenv]

Can we keep this? I know it's ugly, but (if I remember correctly) some tools balk when these are missing.

[tearwyx]

Kept.

[rubenv]

What happens if I manually do po.headers["test"] = "123".

Not sure if that will still get serialized?

[tearwyx]

Fixed.

[rubenv]

Great, thanks for the fixes! Really like it now, as it's now a non-breaking change. I see no reason not to include this.

Can we come up with a unit test that fails without this in place (but obviously works with)? That way we'll be assured that we won't break it in the future.

Such a test might depend on the enumeration order in JS (not 100% sure how that works), so might be hard to write. Don't worry if that's the case, we'll just merge without one then.

[tearwyx]

@rubenv, some unit test added.

[rubenv]

Perfect! Excellent work. Merged!

[rubenv]

Also pushed to NPM as v1.0.11. Thanks a lot!

[tearwyx]

@rubenv, thank you too.