feat(build-name): add build-name option

BREAKING CHANGE: --externalBuildId is now --external-build-id

README.md

@@ -26,18 +26,19 @@ Commands:
 ### Upload
 
 ```sh
-Usage: argos upload [options] <directory>
+Usage: index upload [options] <directory>
 
 Upload screenshots
 
 Options:
-  -T, --token <token>         Repository token
-  -C, --commit <commit>       Git commit
-  -B, --branch <branch>       Git branch
-  --externalBuildId [string]  ID of the build (batch mode only)
-  --batchCount [int]          Number of batches expected (batch mode)
-  --ignore <list>             List of glob files to ignore (ex: "**/*.png,**/diff.jpg")
-  -h, --help                  output usage information
+  -T, --token <token>           Repository token
+  -C, --commit <commit>         Git commit
+  -B, --branch <branch>         Git branch
+  --external-build-id [string]  ID of the build (batch mode only)
+  --batchCount [int]            Number of batches expected (batch mode)
+  --build-name [string]         Name of the build
+  --ignore <list>               List of glob files to ignore (ex: "**/*.png,**/diff.jpg")
+  -h, --help                    display help for command
 ```
 
 ### Cancel
@@ -49,7 +50,7 @@ Cancel the build (batch mode only)
 
 Options:
   -T, --token <token>         Repository token
-  --externalBuildId [string]  ID of the build (batch mode only)
+  --external-build-id [string]  ID of the build (batch mode only)
   -h, --help                  output usage information
 ```
 

src/config.js

@@ -38,7 +38,7 @@ const config = convict({
     default: '',
     env: 'ARGOS_BATCH_COUNT',
   },
-  name: {
+  buildName: {
     doc: 'Build name',
     format: String,
     default: '',

src/index.js

@@ -13,12 +13,12 @@ updateNotifier({ pkg }).notify()
 initializeErrorReporter()
 
 if (process.env.NODE_ENV !== 'production') {
-  process.on('exit', code => {
+  process.on('exit', (code) => {
     console.info(`exit code: ${code}`)
   })
 }
 
-const list = value => value.split(',')
+const list = (value) => value.split(',')
 
 program.version(pkg.version)
 
@@ -28,13 +28,13 @@ program
   .option('-T, --token <token>', 'Repository token')
   .option('-C, --commit <commit>', 'Git commit')
   .option('-B, --branch <branch>', 'Git branch')
-  .option('--externalBuildId [string]', 'ID of the build (batch mode only)')
+  .option('--external-build-id [string]', 'ID of the build (batch mode only)')
   .option(
     '--batchCount [int]',
     'Number of batches expected (batch mode)',
     parseInt,
   )
-  .option('--name [string]', 'Name of the build')
+  .option('--build-name [string]', 'Name of the build')
   .option(
     '--ignore <list>',
     'List of glob files to ignore (ex: "**/*.png,**/diff.jpg")',
@@ -78,8 +78,8 @@ program
   .command('cancel')
   .description('Cancel the build (batch mode only)')
   .option('-T, --token <token>', 'Repository token')
-  .option('--externalBuildId [string]', 'ID of the build (batch mode only)')
-  .action(async command => {
+  .option('--external-build-id [string]', 'ID of the build (batch mode only)')
+  .action(async (command) => {
     console.log(`=== argos-cli: canceling build`)
 
     let json

src/upload.js

@@ -19,7 +19,7 @@ async function upload(options) {
     branch: branchOption,
     commit: commitOption,
     externalBuildId: externalBuildIdOption,
-    name: nameOption,
+    buildName: buildNameOption,
     batchCount: batchCountOption,
   } = options
 
@@ -35,9 +35,9 @@ async function upload(options) {
     externalBuildIdOption ||
     config.get('externalBuildId') ||
     environment.externalBuildId
-  const name = nameOption || config.get('name') || environment.name
   const batchCount =
     batchCountOption || config.get('batchCount') || environment.batchCount
+  const name = buildNameOption || config.get('buildName')
 
   if (environment.ci) {
     displayInfo(`identified \`${environment.ci}\` environment`)
@@ -94,7 +94,7 @@ async function upload(options) {
       token,
       externalBuildId,
       batchCount,
-      names: screenshots.map(screenshot => screenshot.name),
+      names: screenshots.map((screenshot) => screenshot.name),
     }),
   )