Question: is there a way to use node `fs` within a plugin? about skpm HOT 13 CLOSED

not part of skpm no, you need to install it separately: npm install @skpm/fs

from skpm.

you can't use fs directly because it's a node package and sketch plugins doesn't run on node. That being said, there is a way to access the file system using the NSFoundation APIs: NSFileManager, NSString.stringWithContentsOfFile_encoding_error, etc.

I started creating a package to polyfill the fs package on sketch: https://github.com/mathieudutour/sketch-module-fs but i was too lazy to do it entirely. If you want to contribute to it and if we manage to have a complete polyfill, we could include it automatically in skpm (like fetch and console here: #35)

from skpm.

Going to close this but feel free to ping me if you get the change to implement a polypill

from skpm.

Is it part of skpm now or how to use the sketch-module-fs?

from skpm.

Thanks a lot.

from skpm.

Module not found: Error: Can't resolve 'fs'

from skpm.

Have you read the previous comments?

from skpm.

Yes, @mathieudutour I did.
But the issue is, I am using a node module which eventually depends on multiple node modules.
So I think It's not a feasible solution to manually update all imports

   const fs  = require('fs')

   to

   import * as fs from '@skpm/fs'

Can you please share something more generic, because there can be the case where the one dependent node module in our app internally depends on multiple node modules which depends on 'fs'?

 inception 🤯

Please let me know if I missed something.

Thanks

from skpm.

Please write a comment like that the first time next time 🙂

You don't have to manually update all imports, you can tell webpack to do it for you https://webpack.js.org/configuration/resolve/

That being said, @skpm/fs only implements the synchronous API so depending on thee modules you are using, it might still not work.

from skpm.

@mathieudutour thanks for quick response, can you suggest some alternative to this.

from skpm.

Use another module?

from skpm.

@mathieudutour

from skpm.

That's not a joke. There isn't any other fs polyfill for Sketch as far as I know. So if you can't use this one, you will need to find a workaround which might be to use a module that doesn't need fs

from skpm.