format command sorts "files" property and breaks packages

[raijinsetsu]

Description

syncpack is reordering the contents of the "files" property which changes the contents of the tarball when using "npm publish" or "npm pack".

example package.json:

{
    files: [
        "dist/",
        "!*.test.*",
        "!__mocks__"
   ]
}

command:
npx syncpack format

result:

{
    files: [
        "!*.test.*",
        "!__mocks__",
        "dist/"
   ]
}

expected result:

{
    files: [
        "dist/",
        "!*.test.*",
        "!__mocks__"
   ]
}

The only work-around is to use .npmignore and remove the files property, but this becomes unmanageable.

Suggested Solution

Do not sort the "files" property.

[raijinsetsu]

I can submit a PR for this but wanted to get input from other contributors.

Removing the sort for the "files" array would be, technically, backwards incompatible. Should a flag be used to remove "files" from the list of things to be sorted or should I just update constants.ts and remove "files" from it?

[JamieMason]

Thanks a lot @raijinsetsu, I think you're right that files should be excluded from the sorting behaviour – this is something I hadn't considered.

Taking a look at the codebase, it should be a case of just removing files from this Array. I happen to have just finished work so I'll do this now and put together a release.

[raijinsetsu]

Sounds good to me. I did code the fix in my branch and it was exactly that: removing the one line from the array in constants.ts.

[JamieMason]

Great, thanks a lot. I have the fix ready locally and will release soon.

[JamieMason]

Should be available now in syncpack@5.0.3

[raijinsetsu]

Works perfectly. Thanks for the fast turn around!

…

-Luke

On Fri, Jun 19, 2020, 12:21 Jamie Mason ***@***.***> wrote: Should be available now in ***@***.*** — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#35 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABT6LNWOAGI5A7XITB5BPCDRXOGARANCNFSM4OC2TFLA> .