Merge pull request #19 from dhleong/dhleong/IncludeFilesOption

Add `include_files` option to lambda_package

Author: Tim-B

.npmignore

@@ -1,3 +1,3 @@
 .idea
 *.iml
-tmp
+tmp

Gruntfile.js

@@ -62,7 +62,8 @@ module.exports = function (grunt) {
                 options: {
                     dist_folder: 'tmp/dist',
                     include_time: false,
-                    package_folder: 'test/fixtures/package_custom'
+                    package_folder: 'test/fixtures/package_custom',
+                    include_files: ['custom.json']
                 }
             }
         },

README.md

@@ -191,6 +191,12 @@ grunt.initConfig({
 
 #### Options
 
+##### options.include_files
+Type: `Array`
+Default value: `[]`
+
+List of files to explicitly include in the package, even if they would be ignored by NPM
+
 ##### options.include_time
 Type: `Boolean`
 Default value: `true`

tasks/lambda_package.js

@@ -28,7 +28,8 @@ module.exports = function (grunt) {
         var options = this.options({
             'dist_folder': 'dist',
             'include_time': true,
-            'package_folder': './'
+            'package_folder': './',
+            'include_files': []
         });
 
         var pkg = grunt.file.readJSON(path.resolve(options.package_folder + '/package.json'));
@@ -91,6 +92,17 @@ module.exports = function (grunt) {
                     }
                 ]);
 
+                if (options.include_files.length) {
+                    zipArchive.bulk([
+                        {
+                            src: options.include_files,
+                            dot: true,
+                            expand: true,
+                            cwd: options.package_folder
+                        }
+                    ]);
+                }
+
                 zipArchive.finalize();
 
                 output.on('close', function () {

test/fixtures/package_custom/.npmignore

@@ -0,0 +1 @@
+custom.json

test/fixtures/package_custom/custom.json

@@ -0,0 +1 @@
+{}

test/lambda_package_test.js

@@ -59,11 +59,12 @@ exports.lambda_package = {
         });
     },
     custom_options: function (test) {
-        test.expect(5);
+        test.expect(6);
         var zip = new AdmZip("tmp/dist/another-lambda-function_0-0-1_latest.zip");
         var zipEntries = zip.getEntries();
 
         var required = [
+            'custom.json',
             'index.js',
             'package.json',
             'node_modules/',
@@ -79,4 +80,5 @@ exports.lambda_package = {
 
         test.done();
     }
+
 };