feat: exclude common unnecessary files by default (#23)

tmokmss · Oct 30, 2024 · c2d1940 · c2d1940
1 parent 8d90902
commit c2d1940
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 1 deletion.
diff --git a/API.md b/API.md
diff --git a/src/nodejs-build.ts b/src/nodejs-build.ts
@@ -75,6 +75,12 @@ export interface NodejsBuildProps {
    * @default false
    */
   readonly outputEnvFile?: boolean;
+  /**
+   * If true, common unnecessary files/directories such as .DS_Store, .git, node_modules, etc are excluded
+   * from the assets by default.
+   * @default true
+   */
+  readonly excludeCommonFiles?: boolean;
 }
 
 /**
@@ -229,9 +235,11 @@ curl -v -i -X PUT -H 'Content-Type:' -d "@payload.json" "$responseURL"
 
     this.grantPrincipal = project.grantPrincipal;
 
+    const commonExclude = ['.DS_Store', '.git', 'node_modules'];
     const assets = props.assets.map((assetProps) => {
       const asset = new Asset(this, `Source-${assetProps.path.replace('/', '')}`, {
         ...assetProps,
+        ...(props.excludeCommonFiles ?? true ? { exclude: [...commonExclude, ...(assetProps.exclude ?? [])] } : {}),
       });
       asset.grantRead(project);
       return asset;

diff --git a/test/integ.nodejs-build.ts b/test/integ.nodejs-build.ts
@@ -20,7 +20,7 @@ class TestStack extends Stack {
       assets: [
         {
           path: '../example/example-app',
-          exclude: ['dist', 'node_modules'],
+          exclude: ['dist'],
         },
       ],
       destinationBucket: dstBucket,