broccolijs/broccoli-output-wrapper

broccoli-output-wrapper

This libary is to provide Proxy to FS operations for Broccoli. Broccoli Plugin developers can just write to the outputPath using the proxy. This libary is not intended to use independently outside broccoli or broccoli-plugin as of now.

APIs

• readFileSync
• existsSync
• lstatSync
• readdirSync
• statSync
• writeFileSync
• appendFileSync
• mkdirSync
• unlinkSync
• symlinkSync
• utimesSync

All these operations above are same as File Operations documented in node API guide.

• rmdirSync

Perform same operation as node guide. We have polyfilled recursive: true option to perform a recursive directory removal. In recursive mode, errors are not reported if path does not exist, and operations are retried on failure. Default: false

• symlinkOrCopySync
• outputFileSync

broccoli-output-wrapper's Issues

Incorrect type of rmdirSync

When using @types/node@10, typescript gives a compile error if you try to pass the recursive option.

Related: broccolijs/broccoli-persistent-filter#197

ts has different name than actual function name.

https://github.com/SparshithNR/broccoli-output-wrapper/blob/617d76c49f7dbdf3feadd8485dc5f195506f8291/src/index.ts#L74

This is supposed to be symlinkOrCopySync

Why no async operations?

Just wondering why async operations are blocked? I can't seem to find documentation regarding this. All of my plugins are async for performance reasons, and they work fine on older Broccoli (0.16.9).

[...] If we needed the plugin to be asynchronous, we could alternatively return a promise and Broccoli would wait until the promise resolved before continuing the build.

https://broccoli.build/plugins.html

Add more operations

Add following operations

1. rmdirSync with recursive:true
2. unlinkSync
3. symlinkOrCopy.sync