Merge pull request #6 from liquid-labs/work-liquid-labs/s3-empty-buck…

…et/5

Add quiet option

package.json

@@ -28,7 +28,8 @@
   "homepage": "https://github.com/liquid-labs/s3-empty-bucket#readme",
   "dependencies": {
     "@aws-sdk/client-s3": "^3.525.0",
-    "@aws-sdk/credential-providers": "^3.525.0"
+    "@aws-sdk/credential-providers": "^3.525.0",
+    "command-line-args": "^5.2.1"
   },
   "devDependencies": {
     "@liquid-labs/sdlc-resource-babel-and-rollup": "^1.0.0-alpha.8",

src/cli/s3-empty-bucket.mjs

@@ -1,16 +1,27 @@
 import { S3Client } from '@aws-sdk/client-s3'
 
+import commandLineArgs from 'command-line-args'
+
 import { getCredentials } from './lib/get-credentials'
 import { emptyBucket } from '../lib/s3-empty-bucket'
 
+const cliSpec = {
+  mainCommand : 's3-empty-bucket',
+  mainOptions : [
+    { name : 'bucketName', defaultOption : true, description : 'The name of the bucket to empty.' },
+    { name : 'profile', alias : 'p', description : 'The SSO profile to use.' },
+    { name : 'quiet', alias : 'q', type : Boolean, description : 'Suppresses output.' }
+  ]
+}
+
 const s3EmptyBucket = () => {
-  const bucketName = process.argv[2]
-  const ssoProfile = process.argv[3]
+  const options = commandLineArgs(cliSpec.mainOptions)
+  const { bucketName, profile, quiet } = options
 
-  const credentials = getCredentials({ ssoProfile })
+  const credentials = getCredentials({ ssoProfile : profile })
   const s3Client = new S3Client({ credentials })
 
-  emptyBucket({ bucketName, s3Client })
+  emptyBucket({ bucketName, s3Client, verbose : !quiet })
 }
 
 export { s3EmptyBucket }

src/lib/s3-empty-bucket.mjs

@@ -1,9 +1,10 @@
 import { DeleteObjectsCommand, ListObjectsCommand } from '@aws-sdk/client-s3'
 
-const emptyBucket = async ({ bucketName, s3Client }) => {
+const emptyBucket = async ({ bucketName, s3Client, verbose }) => {
   const objects = []
   let marker, isTruncated
-  process.stdout.write('Cataloging files...\n')
+
+  maybeSay('Cataloging files...\n', verbose)
   do {
     const listObjectsCommand = new ListObjectsCommand({ Bucket : bucketName, Marker : marker })
     const listObjectsResult = await s3Client.send(listObjectsCommand)
@@ -15,11 +16,11 @@ const emptyBucket = async ({ bucketName, s3Client }) => {
   } while (isTruncated === true)
 
   if (objects.length === 0) {
-    process.stdout.write('Bucket already empty.\n')
+    maybeSay('Bucket already empty.\n', verbose)
     return
   }
 
-  process.stdout.write(`Deleting ${objects.length} files...\n`)
+  maybeSay(`Deleting ${objects.length} files...\n`, verbose)
 
   const input = {
     Bucket : bucketName,
@@ -32,7 +33,13 @@ const emptyBucket = async ({ bucketName, s3Client }) => {
   const deleteObjectsCommand = new DeleteObjectsCommand(input)
   await s3Client.send(deleteObjectsCommand)
 
-  process.stdout.write('Done!\n')
+  maybeSay('Done!\n', verbose)
+}
+
+const maybeSay = (message, verbose) => {
+  if (verbose === true) {
+    process.stdout.write(message)
+  }
 }
 
 export { emptyBucket }