Include files and directories while preserving its permissions.

[b04zdotcom]

This is a Feature Proposal

Description

Including a static file or directory and preserving its original file permissions. This would be particularly useful for including binaries in the final package.

Currently the only way that I am aware of to do this, is to run a shell script that copies the files into the .webpack folder before the bundling process. But maybe this functionality can be included in this plugin.

[HyperBrain]

The feature can be part of the 3.1.0 feature release.

[HyperBrain]

I've set the official release date for 3.0.0 to September 9th. We can take care of this right afterwards. See #213 .

[pierreis]

Is there any solution as of today to include static files while waiting for the official support? That seems to be a blocking issue for me.

[HyperBrain]

@pierreis If you do not need exact permission replication but only want to add arbitrary files you can either use the webpack file-loader or the webpack CopyFiles plugin.

file-loader is quite good, as you e.g. can use it to include files that you acquire in your code with require(). It will include the files as is, renames them by default with a hash and changes the requires accordingly. The naming is configurable.

The CopyFiles just adds files to the package/bundle.

[HyperBrain]

I reiterated over this again. If we'd add a includeBinary option to the config, that will only package the binary files or folders in the packaging step. But they would not be available in the compiled output of invoke local which might break the execution locally.
Having that in mind, I'd tend to write a CopyBinary webpack plugin, that is executed at compile time and leaves the binary files in the webpack output folder. Imo that approach is more consistent and puts the copy operation at the place it should be. Effort-wise it shouldn't make any difference.
Any thoughts?

[HyperBrain]

@serverless-heaven/serverless-webpack-contributors Any ideas out there?

[franciscocpg]

@HyperBrain
The #205 (comment) approach looks fine to me.
But I didn't understand why you named it includeBinary and CopyBinary, after all we're talking about any static file, right? Not specific to binaries files.
Or did I miss something?

[HyperBrain]

For files that do not need a replication of the permissions (e.g. executable persmission) in the target the existing webpack plugins like file-loader or the CopyFile plugins already work fine and lead to the expected results.
But this is not true, if you need to copy "raw" files and must persist the file permissions. Either of the plugins will not transfer the executable bit. To distinguish the needed functionality from the already existing I just added "binary" to express the difference. If there's a better way to name it - appreciated 😄

BTW: I'm not aware that you could tweak the webpack copy files plugin to copy permission accordingly, or is there a way to do that?