Merge branch 'main' into polish_usage

Author: jdalton

src/commands/repos/cmd-repos-create.test.ts

@@ -72,7 +72,7 @@ describe('socket repos create', async () => {
 
           - Org name as the first argument (\\x1b[31mmissing\\x1b[39m)
 
-          - Repository name using --repoNam (\\x1b[31minvalid\\x1b[39m)
+          - Repository name using --repoNam (\\x1b[31mmissing\\x1b[39m)
 
           - You need to be logged in to use this command. See \`socket login\`. (\\x1b[31mmissing API token\\x1b[39m)"
       `)

src/commands/repos/cmd-repos-create.ts

@@ -101,7 +101,7 @@ async function run(
       test: repoName,
       message: 'Repository name using --repoNam',
       pass: 'ok',
-      fail: typeof repoName !== 'string' ? 'missing' : 'invalid'
+      fail: 'missing'
     },
     {
       nook: true,

src/commands/repos/cmd-repos-del.test.ts

@@ -67,7 +67,7 @@ describe('socket repos del', async () => {
 
           - Org name as the first argument (\\x1b[31mmissing\\x1b[39m)
 
-          - Repository name argument (\\x1b[31minvalid\\x1b[39m)
+          - Repository name argument (\\x1b[31mmissing\\x1b[39m)
 
           - You need to be logged in to use this command. See \`socket login\`. (\\x1b[31mmissing API token\\x1b[39m)"
       `)

src/commands/repos/cmd-repos-del.ts

@@ -71,7 +71,7 @@ async function run(
       test: repoName,
       message: 'Repository name argument',
       pass: 'ok',
-      fail: typeof repoName !== 'string' ? 'missing' : 'invalid'
+      fail: 'missing'
     },
     {
       nook: true,

src/commands/repos/cmd-repos-update.test.ts

@@ -72,7 +72,7 @@ describe('socket repos update', async () => {
 
           - Org name as the first argument (\\x1b[31mmissing\\x1b[39m)
 
-          - Repository name using --repoName (\\x1b[31minvalid\\x1b[39m)
+          - Repository name using --repoName (\\x1b[31mmissing\\x1b[39m)
 
           - You need to be logged in to use this command. See \`socket login\`. (\\x1b[31mmissing API token\\x1b[39m)"
       `)

src/commands/repos/cmd-repos-update.ts

@@ -101,7 +101,7 @@ async function run(
       test: repoName,
       message: 'Repository name using --repoName',
       pass: 'ok',
-      fail: typeof repoName !== 'string' ? 'missing' : 'invalid'
+      fail: 'missing'
     },
     {
       nook: true,

src/commands/repos/cmd-repos-view.test.ts

@@ -70,7 +70,7 @@ describe('socket repos view', async () => {
 
           - Org name as the first argument (\\x1b[31mmissing\\x1b[39m)
 
-          - Repository name using --repoName (\\x1b[31minvalid\\x1b[39m)
+          - Repository name using --repoName (\\x1b[31mmissing\\x1b[39m)
 
           - You need to be logged in to use this command. See \`socket login\`. (\\x1b[31mmissing API token\\x1b[39m)"
       `)

src/commands/repos/cmd-repos-view.ts

@@ -78,7 +78,7 @@ async function run(
       test: repoName,
       message: 'Repository name using --repoName',
       pass: 'ok',
-      fail: typeof repoName !== 'string' ? 'missing' : 'invalid'
+      fail: 'missing'
     },
     {
       nook: true,

src/commands/scan/cmd-scan-create.test.ts

@@ -63,7 +63,6 @@ describe('socket scan create', async () => {
             --repo            Repository name
             --report          Wait for the scan creation to complete, then basically run \`socket scan report\` on it
             --tmp             Set the visibility (true/false) of the scan in your dashboard
-            --view            Will wait for and return the created scan details. Use --no-view to disable.
 
           Examples
             $ socket scan create --repo=test-repo --branch=main FakeOrg ./package.json"

src/commands/scan/cmd-scan-create.ts

@@ -22,12 +22,6 @@ const config: CliCommandConfig = {
   flags: {
     ...commonFlags,
     ...outputFlags,
-    repo: {
-      type: 'string',
-      shortFlag: 'r',
-      default: 'socket-default-repository',
-      description: 'Repository name'
-    },
     branch: {
       type: 'string',
       shortFlag: 'b',
@@ -46,6 +40,12 @@ const config: CliCommandConfig = {
       default: '',
       description: 'Commit hash'
     },
+    committers: {
+      type: 'string',
+      shortFlag: 'c',
+      default: '',
+      description: 'Committers'
+    },
     cwd: {
       type: 'string',
       description: 'working directory, defaults to process.cwd()'
@@ -56,34 +56,34 @@ const config: CliCommandConfig = {
       description:
         'Set the default branch of the repository to the branch of this full-scan. Should only need to be done once, for example for the "main" or "master" branch.'
     },
-    pendingHead: {
+    dryRun: {
       type: 'boolean',
-      default: true,
       description:
-        'Designate this full-scan as the latest scan of a given branch. This must be set to have it show up in the dashboard.'
+        'Run input validation part of command without any concrete side effects'
     },
-    dryRun: {
+    pendingHead: {
       type: 'boolean',
+      default: true,
       description:
-        'run input validation part of command without any concrete side effects'
+        'Designate this full-scan as the latest scan of a given branch. This must be set to have it show up in the dashboard.'
     },
     pullRequest: {
       type: 'number',
       shortFlag: 'pr',
       description: 'Commit hash'
     },
-    committers: {
-      type: 'string',
-      shortFlag: 'c',
-      default: '',
-      description: 'Committers'
-    },
     readOnly: {
       type: 'boolean',
       default: false,
       description:
         'Similar to --dry-run except it can read from remote, stops before it would create an actual report'
     },
+    repo: {
+      type: 'string',
+      shortFlag: 'r',
+      default: 'socket-default-repository',
+      description: 'Repository name'
+    },
     report: {
       type: 'boolean',
       default: false,
@@ -96,13 +96,6 @@ const config: CliCommandConfig = {
       default: false,
       description:
         'Set the visibility (true/false) of the scan in your dashboard'
-    },
-    view: {
-      type: 'boolean',
-      shortFlag: 'v',
-      default: true,
-      description:
-        'Will wait for and return the created scan details. Use --no-view to disable.'
     }
   },
   // TODO: your project's "socket.yml" file's "projectIgnorePaths"
@@ -162,24 +155,32 @@ async function run(
 
   const {
     branch: branchName = '',
+    commitHash,
+    commitMessage,
+    committers,
     cwd: cwdOverride,
     defaultBranch,
     dryRun,
     json,
     markdown,
     pendingHead,
+    pullRequest,
     readOnly,
     repo: repoName = '',
     report,
     tmp
   } = cli.flags as {
     branch: string
     cwd: string
+    commitHash: string
+    commitMessage: string
+    committers: string
     defaultBranch: boolean
     dryRun: boolean
     json: boolean
     markdown: boolean
     pendingHead: boolean
+    pullRequest: number
     readOnly: boolean
     repo: string
     report: boolean
@@ -235,17 +236,20 @@ async function run(
 
   const wasBadInput = handleBadInput(
     {
-      nook: true,
-      test: orgSlug,
+      nook: !!defaultOrgSlug,
+      test: orgSlug && orgSlug !== '.',
       message: 'Org name as the first argument',
       pass: 'ok',
-      fail: 'missing'
+      fail:
+        orgSlug === '.'
+          ? 'dot is an invalid org, most likely you forgot the org name here?'
+          : 'missing'
     },
     {
       test: targets.length,
       message: 'At least one TARGET (e.g. `.` or `./package.json`)',
       pass: 'ok',
-      fail: 'missing'
+      fail: 'missing (or perhaps you forgot the org slug?)'
     },
     {
       nook: true,
@@ -257,9 +261,9 @@ async function run(
     {
       nook: true,
       test: apiToken,
-      message: 'This command requires an API token for access`)',
+      message: 'This command requires an API token for access',
       pass: 'ok',
-      fail: 'missing'
+      fail: 'missing (try `socket login`)'
     }
   )
   if (wasBadInput) {
@@ -274,12 +278,15 @@ async function run(
 
   await handleCreateNewScan({
     branchName: branchName as string,
-    commitMessage: (cli.flags['commitMessage'] as string | undefined) ?? '',
+    commitHash: (commitHash && String(commitHash)) || '',
+    commitMessage: (commitMessage && String(commitMessage)) || '',
+    committers: (committers && String(committers)) || '',
     cwd,
     defaultBranch: Boolean(defaultBranch),
     orgSlug,
     outputKind: json ? 'json' : markdown ? 'markdown' : 'text',
     pendingHead: Boolean(pendingHead),
+    pullRequest: Number(pullRequest),
     readOnly: Boolean(readOnly),
     repoName: repoName,
     report,