feat(lint): output more detail about invalid formatting

[crfrolik]

Description

Running syncpack lint gives me output like the following (package names changed to protect the innocent):

$ yarn syncpack lint
Versions
= Version Group 1 ==============================================================
    10 → ignored
= Default Version Group ========================================================
   134 ✓ already valid
Semver Ranges
= Semver Group 1 ===============================================================
✓ 9 valid
= Semver Group 2 ===============================================================
    10 - 10 ignored
= Semver Group 3 ===============================================================
✓ 125 valid
Formatting
✘ package.json
✘ ModuleA/package.json
✘ ModuleB/package.json
✘ ModuleC/package.json

The problem is, the "Formatting" section indicates that I have a problem, but I have no idea what that problem is or how to fix it.

Suggested Solution

I think that if there is an error in the formatting (what does that mean?), the tool should at least tell me what that error is.

[crfrolik]

Well, I figured out that I can fix it with syncpack format, but I think some indication of what's going on would still be helpful.

[JamieMason]

Thanks a lot for raising this @crfrolik. What kinds of output would you want to see for this issue to be considered fixed? Granular things like "devDependencies is not in alphabetical order" etc? and/or do you have some other things in mind?

[crfrolik]

It would be nice to have granular output about the specific problems, yes.
Also, maybe the tool could direct me to syncpack format as a way to fix those problems? I did manage to find it on my own after exploring, but that might have been due to luck.

[JamieMason]

That's a good idea, I've added a "What next?" section on eg. syncpack list but haven't applied that to every command 👍