Add sync script

[marcofugaro]

Sometimes, some packages use just the sync commands of node, no await.
It would be useful if this package offered a sync version as well.

With this PR, you would import it and use it like this:

const fastFolderSizeSync = require('fast-folder-size/sync')

const bytes = fastFolderSizeSync('.')

console.log(bytes)

[simoneb]

I like the idea but the implementation could be improved:

• the code is pretty much duplicated from the async version, it would be good to find a way to refactor it and remove duplication
• types are missing
• tests are missing

[marcofugaro]

the code is pretty much duplicated from the async version, it would be good to find a way to refactor it and remove duplication

Any idea of how to do that? I couldn't find a simple solution.

types are missing
tests are missing

I can take care of that.

[simoneb]

the code is pretty much duplicated from the async version, it would be good to find a way to refactor it and remove duplication

Any idea of how to do that? I couldn't find a simple solution.

What changes across the platforms are the arguments provided to the exec* methods and the processing of the output. If we extract those in a map whose key is the platform (with a catch-all option) we will limit the duplication to the strictly necessary to provide the 2 types of sync/async apis.

types are missing
tests are missing

I can take care of that.

Thanks

[marcofugaro]

Thanks for the suggestion, all done!

[marcofugaro]

Ad damn the sync test is failing on windows..

[marcofugaro]

All good now, @simoneb could you check?

[simoneb]

Looks good. Can you add type tests in https://github.com/simoneb/fast-folder-size/blob/master/types/index.test-d.ts?

[marcofugaro]

Can you add type tests in https://github.com/simoneb/fast-folder-size/blob/master/types/index.test-d.ts?

I did, but how do I import fastFolderSizeSync from 'index.d.ts'?

[simoneb]

Can you add type tests in https://github.com/simoneb/fast-folder-size/blob/master/types/index.test-d.ts?

I did, but how do I import fastFolderSizeSync from 'index.d.ts'?

I don't know, I'm not a ts expert :)

[marcofugaro]

Me neither 🤣

[simoneb]

Me neither 🤣

Look up how other packages are doing this perhaps. Anyway, from within the type tests I believe you need to import ./sync, not the full package name

[marcofugaro]

Alright, it works all fine now, found a way.

The types I did were based on this stackoverflow answer

[simoneb]

despite the tests passing, I have a feeling that defining the types this way will not let a typescript consumer use it in the way you intend it:

import fastFolderSizeSync from 'fast-folder-size/sync'
// or
const fastFolderSizeSync = require('fast-folder-size/sync')

[marcofugaro]

I think it's correct, what are you proposing?

[simoneb]

I'm happy to merge and release a new version. Will you have a chance to try the released package to see if the typings work correctly?

[marcofugaro]

Okay I will!