feat: S3_DIRECTORY_SYNC_REMOVE_HTML_EXTENSIONS option

Author: adamhenson

README.md

@@ -80,6 +80,11 @@ Parameters can either be passed in the command line as arguments or as environme
     <td>The directory of an S3 bucket to sync from a local directory. An empty string signifies the root.</td>
     <td><code>''</code></td>
   </tr>
+  <tr>
+    <td><code>S3_DIRECTORY_SYNC_REMOVE_HTML_EXTENSIONS/code></td>
+    <td>If <code>true</code> HTML files will be uploaded with the `.html` extension omitted from the `Key`. This can be helpful if hosting an S3 website.</td>
+    <td><code>false</code></td>
+  </tr>
   <tr>
     <td><code>S3_DIRECTORY_SYNC_ACL</code></td>
     <td>The <a href="https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html">Access Control Policy</a> as documented.</td>

src/bin/sync.js

@@ -19,20 +19,17 @@ const defaultOptions = {
   S3_DIRECTORY_SYNC_ACL: process.env.S3_DIRECTORY_SYNC_ACL || 'public-read',
   S3_DIRECTORY_SYNC_BUCKET: process.env.S3_DIRECTORY_SYNC_BUCKET,
   S3_DIRECTORY_SYNC_DERIVE_CONTENT_TYPE:
-    typeof process.env.S3_DIRECTORY_SYNC_DERIVE_CONTENT_TYPE === 'undefined'
-      ? true
-      : process.env.S3_DIRECTORY_SYNC_DERIVE_CONTENT_TYPE,
+    process.env.S3_DIRECTORY_SYNC_DERIVE_CONTENT_TYPE === 'true',
   S3_DIRECTORY_SYNC_LOCAL_DIRECTORY:
     process.env.S3_DIRECTORY_SYNC_LOCAL_DIRECTORY,
-  S3_DIRECTORY_SYNC_PROGRESS:
-    typeof process.env.S3_DIRECTORY_SYNC_PROGRESS === 'undefined'
-      ? true
-      : process.env.S3_DIRECTORY_SYNC_PROGRESS,
+  S3_DIRECTORY_SYNC_PROGRESS: process.env.S3_DIRECTORY_SYNC_PROGRESS === 'true',
   S3_DIRECTORY_SYNC_REMOTE_DIRECTORY:
     process.env.S3_DIRECTORY_SYNC_REMOTE_DIRECTORY || '',
+  S3_DIRECTORY_SYNC_REMOVE_HTML_EXTENSIONS:
+    process.env.S3_DIRECTORY_SYNC_REMOVE_HTML_EXTENSIONS === 'true',
   S3_DIRECTORY_SYNC_SECRET_ACCESS_KEY:
     process.env.S3_DIRECTORY_SYNC_SECRET_ACCESS_KEY,
-  S3_DIRECTORY_SYNC_STRICT: process.env.S3_DIRECTORY_SYNC_STRICT || false
+  S3_DIRECTORY_SYNC_STRICT: process.env.S3_DIRECTORY_SYNC_STRICT === 'true'
 };
 
 // override options with any that are passed in as arguments
@@ -97,13 +94,17 @@ const rootFolder = path.resolve();
   }
 
   for (const [index, file] of filesToUpload.entries()) {
-    const Key = file.replace(
+    let Key = file.replace(
       `${rootFolder}/${options.S3_DIRECTORY_SYNC_LOCAL_DIRECTORY}/`,
       !options.S3_DIRECTORY_SYNC_REMOTE_DIRECTORY
         ? ''
         : `${options.S3_DIRECTORY_SYNC_REMOTE_DIRECTORY}/`
     );
 
+    if (options.S3_DIRECTORY_SYNC_REMOVE_HTML_EXTENSIONS) {
+      Key = Key.replace('.html', '');
+    }
+
     const params = {
       ACL: options.S3_DIRECTORY_SYNC_ACL,
       Bucket: options.S3_DIRECTORY_SYNC_BUCKET,