Format JSON file contents to allow for easier editing

[kelfish]

Currently the JSON file contents are written on a single line. If this external config.json needs to be edited externally, it is very hard to do so. This change uses a 2 space tabbed format when utils.sync is called to ensure the JSON is formatted in a more friendly, readable & editable format in the file.

[de-luca]

Thanks for submitting changes.
I'd guard this feature behind some configuration so the change of storage has no impact without explicitly requesting so.
This could be done by adding a facultative option object in the Config constructor.
It could then be used in the decorator to run the sync function with the expected behaviour.

[kelfish]

Yeah, good idea, I will add that... I am thinking an options arg for the factory and the Config constructor. e.g.

type ConfigOptions = {
  prettyJson?: {
    enabled: boolean;
    tabSize?: number;
  };
};

Also, do you mind if I add prettier as a devDependency so my formatting aligns with yours?

[de-luca]

Also, do you mind if I add prettier as a devDependency so my formatting aligns with yours?

Can you split that one in another PR so limit the diff to the corresponding changes?

[kelfish]

@de-luca - would you mind checking this PR now please? I will do a separate one after this with prettier setup...

[codecov]

Codecov Report

Merging #525 (0bb1529) into master (5c73bd8) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##            master      #525   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            3         3           
  Lines           79        87    +8     
  Branches        11        16    +5     
=========================================
+ Hits            79        87    +8     

Files Changed	Coverage Δ
src/Config.ts	100.00% <100.00%> (ø)
src/factory.ts	100.00% <100.00%> (ø)
src/utils.ts	100.00% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[kelfish]

I've removed the redundant options? check as options is always defined, it has a default if undefined is passed.

@de-luca

[de-luca]

Thank you for the submission, Good job!