Add requirements to help pages

.config/rollup.dist.config.mjs

@@ -107,13 +107,13 @@ async function copyBlessedWidgets() {
   const blessedDestPath = path.join(rootDistPath, 'blessed')
   const blessedNmPath = path.join(rootPath, 'node_modules/blessed')
   const folders = ['lib', 'usr', 'vendor']
-  await Promise.all([
-    ...folders.map(f =>
+  await Promise.all(
+    folders.map(f =>
       fs.cp(path.join(blessedNmPath, f), path.join(blessedDestPath, f), {
         recursive: true
       })
     )
-  ])
+  )
   // Add 'use strict' directive to js files.
   const jsFiles = await tinyGlob(['**/*.js'], {
     absolute: true,

src/commands/analytics/cmd-analytics.test.ts

@@ -23,6 +23,10 @@ describe('socket analytics', async () => {
           Usage
             $ socket analytics --scope=<scope> --time=<time filter>
 
+          API Token Requirements
+            - Quota: 1 unit
+            - Permissions: report:write
+
           Default parameters are set to show the organization-level analytics over the
           last 7 days.
 

src/commands/analytics/cmd-analytics.ts

@@ -52,6 +52,10 @@ const config: CliCommandConfig = {
     Usage
       $ ${command} --scope=<scope> --time=<time filter>
 
+    API Token Requirements
+      - Quota: 1 unit
+      - Permissions: report:write
+
     Default parameters are set to show the organization-level analytics over the
     last 7 days.
 

src/commands/audit-log/cmd-audit-log.test.ts

@@ -23,6 +23,10 @@ describe('socket audit-log', async () => {
           Usage
             $ socket audit-log <org slug>
 
+          API Token Requirements
+            - Quota: 1 unit
+            - Permissions: audit-log:list
+
           This feature requires an Enterprise Plan. To learn more about getting access
           to this feature and many more, please visit https://socket.dev/pricing
 

src/commands/audit-log/cmd-audit-log.ts

@@ -43,6 +43,10 @@ const config: CliCommandConfig = {
     Usage
       $ ${command} <org slug>
 
+    API Token Requirements
+      - Quota: 1 unit
+      - Permissions: audit-log:list
+
     This feature requires an Enterprise Plan. To learn more about getting access
     to this feature and many more, please visit https://socket.dev/pricing
 

src/commands/dependencies/cmd-dependencies.test.ts

@@ -23,6 +23,10 @@ describe('socket dependencies', async () => {
           Usage
             socket dependencies
 
+          API Token Requirements
+            - Quota: 1 unit
+            - Permissions: none (does need token with access to target org)
+
           Options
             --dryRun          Do input validation for a command and exit 0 when input is ok
             --help            Print this help

src/commands/dependencies/cmd-dependencies.ts

@@ -37,6 +37,10 @@ const config: CliCommandConfig = {
     Usage
       ${command}
 
+    API Token Requirements
+      - Quota: 1 unit
+      - Permissions: none (does need token with access to target org)
+
     Options
       ${getFlagListOutput(config.flags, 6)}
 

src/commands/diff-scan/cmd-diff-scan-get.test.ts

@@ -23,6 +23,10 @@ describe('socket diff-scan get', async () => {
           Usage
             $ socket diff-scan get <org slug> --before=<before> --after=<after>
 
+          API Token Requirements
+            - Quota: 1 unit
+            - Permissions: full-scans:list
+
           This command displays the package changes between two scans. The full output
           can be pretty large depending on the size of your repo and time range. It is
           best stored to disk to be further analyzed by other tools.

src/commands/diff-scan/cmd-diff-scan-get.ts

@@ -56,6 +56,10 @@ const config: CliCommandConfig = {
     Usage
       $ ${command} <org slug> --before=<before> --after=<after>
 
+    API Token Requirements
+      - Quota: 1 unit
+      - Permissions: full-scans:list
+
     This command displays the package changes between two scans. The full output
     can be pretty large depending on the size of your repo and time range. It is
     best stored to disk to be further analyzed by other tools.

src/commands/login/cmd-login.test.ts

@@ -23,6 +23,9 @@ describe('socket login', async () => {
           Usage
             $ socket login
 
+          API Token Requirements
+            - Quota: 1 unit
+
           Logs into the Socket API by prompting for an API key
 
           Options

src/commands/login/cmd-login.ts

@@ -31,6 +31,9 @@ const config: CliCommandConfig = {
     Usage
       $ ${command}
 
+    API Token Requirements
+      - Quota: 1 unit
+
     Logs into the Socket API by prompting for an API key
 
     Options

src/commands/organization/cmd-organization-list.test.ts

@@ -23,6 +23,10 @@ describe('socket organization list', async () => {
           Usage
             $ socket organization list
 
+          API Token Requirements
+            - Quota: 1 unit
+            - Permissions: none (does need a token)
+
           Options
             --dryRun          Do input validation for a command and exit 0 when input is ok
             --help            Print this help

src/commands/organization/cmd-organization-list.ts

@@ -24,6 +24,10 @@ const config: CliCommandConfig = {
     Usage
       $ ${command}
 
+    API Token Requirements
+      - Quota: 1 unit
+      - Permissions: none (does need a token)
+
     Options
       ${getFlagListOutput(config.flags, 6)}
   `

src/commands/organization/cmd-organization-policy-license.test.ts

@@ -23,6 +23,10 @@ describe('socket organization policy license', async () => {
           Usage
             $ socket organization policy license <org slug>
 
+          API Token Requirements
+            - Quota: 1 unit
+            - Permissions: license-policy:read
+
           Options
             --dryRun          Do input validation for a command and exit 0 when input is ok
             --help            Print this help

src/commands/organization/cmd-organization-policy-license.ts

@@ -26,6 +26,10 @@ const config: CliCommandConfig = {
     Usage
       $ ${command} <org slug>
 
+    API Token Requirements
+      - Quota: 1 unit
+      - Permissions: license-policy:read
+
     Options
       ${getFlagListOutput(config.flags, 6)}
 

src/commands/organization/cmd-organization-policy-security.test.ts

@@ -23,6 +23,10 @@ describe('socket organization policy security', async () => {
           Usage
             $ socket organization policy security <org slug>
 
+          API Token Requirements
+            - Quota: 1 unit
+            - Permissions: security-policy:read
+
           Options
             --dryRun          Do input validation for a command and exit 0 when input is ok
             --help            Print this help

src/commands/organization/cmd-organization-policy-security.ts

@@ -26,6 +26,10 @@ const config: CliCommandConfig = {
     Usage
       $ ${command} <org slug>
 
+    API Token Requirements
+      - Quota: 1 unit
+      - Permissions: security-policy:read
+
     Options
       ${getFlagListOutput(config.flags, 6)}
 

src/commands/package/cmd-package-score.test.ts

@@ -23,16 +23,16 @@ describe('socket package score', async () => {
           Usage
             $ socket package score <<ecosystem> <name> | <purl>>
 
+          API Token Requirements
+            - Quota: 100 units
+            - Permissions: packages:list
+
           Options
             --dryRun          Do input validation for a command and exit 0 when input is ok
             --help            Print this help
             --json            Output result as json
             --markdown        Output result as markdown
 
-          Requirements
-            - quota: 100
-            - scope: \`packages:list\`
-
           Show deep scoring details for one package. The score will reflect the package
           itself, any of its dependencies, and any of its transitive dependencies.
 

src/commands/package/cmd-package-score.ts

@@ -26,13 +26,13 @@ const config: CliCommandConfig = {
     Usage
       $ ${command} <<ecosystem> <name> | <purl>>
 
+    API Token Requirements
+      - Quota: 100 units
+      - Permissions: packages:list
+
     Options
       ${getFlagListOutput(config.flags, 6)}
 
-    Requirements
-      - quota: 100
-      - scope: \`packages:list\`
-
     Show deep scoring details for one package. The score will reflect the package
     itself, any of its dependencies, and any of its transitive dependencies.
 

src/commands/package/cmd-package-shallow.test.ts

@@ -23,16 +23,16 @@ describe('socket package shallow', async () => {
           Usage
             $ socket package shallow <<ecosystem> <name> [<name> ...] | <purl> [<purl> ...]>
 
+          API Token Requirements
+            - Quota: 100 units
+            - Permissions: packages:list
+
           Options
             --dryRun          Do input validation for a command and exit 0 when input is ok
             --help            Print this help
             --json            Output result as json
             --markdown        Output result as markdown
 
-          Requirements
-            - quota: 100
-            - scope: \`packages:list\`
-
           Show scoring details for one or more packages purely based on their own package.
           This means that any dependency scores are not reflected by the score. You can
           use the \`socket package score <pkg>\` command to get its full transitive score.

src/commands/package/cmd-package-shallow.ts

@@ -25,13 +25,13 @@ const config: CliCommandConfig = {
     Usage
       $ ${command} <<ecosystem> <name> [<name> ...] | <purl> [<purl> ...]>
 
+    API Token Requirements
+      - Quota: 100 units
+      - Permissions: packages:list
+
     Options
       ${getFlagListOutput(config.flags, 6)}
 
-    Requirements
-      - quota: 100
-      - scope: \`packages:list\`
-
     Show scoring details for one or more packages purely based on their own package.
     This means that any dependency scores are not reflected by the score. You can
     use the \`socket package score <pkg>\` command to get its full transitive score.

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

@@ -23,6 +23,10 @@ describe('socket repos create', async () => {
           Usage
             $ socket repos create <org slug>
 
+          API Token Requirements
+            - Quota: 1 unit
+            - Permissions: repo:create
+
           Options
             --defaultBranch   Repository default branch
             --dryRun          Do input validation for a command and exit 0 when input is ok

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

@@ -54,6 +54,10 @@ const config: CliCommandConfig = {
     Usage
       $ ${command} <org slug>
 
+    API Token Requirements
+      - Quota: 1 unit
+      - Permissions: repo:create
+
     Options
       ${getFlagListOutput(config.flags, 6)}
 

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

@@ -23,6 +23,10 @@ describe('socket repos del', async () => {
           Usage
             $ socket repos del <org slug> <repo slug>
 
+          API Token Requirements
+            - Quota: 1 unit
+            - Permissions: repo:delete
+
           Options
             --dryRun          Do input validation for a command and exit 0 when input is ok
             --help            Print this help

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

@@ -24,6 +24,10 @@ const config: CliCommandConfig = {
     Usage
       $ ${command} <org slug> <repo slug>
 
+    API Token Requirements
+      - Quota: 1 unit
+      - Permissions: repo:delete
+
     Options
       ${getFlagListOutput(config.flags, 6)}
 

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

@@ -23,6 +23,10 @@ describe('socket repos list', async () => {
           Usage
             $ socket repos list <org slug>
 
+          API Token Requirements
+            - Quota: 1 unit
+            - Permissions: repo:list
+
           Options
             --direction       Direction option
             --dryRun          Do input validation for a command and exit 0 when input is ok

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

@@ -48,6 +48,10 @@ const config: CliCommandConfig = {
     Usage
       $ ${command} <org slug>
 
+    API Token Requirements
+      - Quota: 1 unit
+      - Permissions: repo:list
+
     Options
       ${getFlagListOutput(config.flags, 6)}
 

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

@@ -23,6 +23,10 @@ describe('socket repos update', async () => {
           Usage
             $ socket repos update <org slug>
 
+          API Token Requirements
+            - Quota: 1 unit
+            - Permissions: repo:update
+
           Options
             --defaultBranch   Repository default branch
             --dryRun          Do input validation for a command and exit 0 when input is ok

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

@@ -54,6 +54,10 @@ const config: CliCommandConfig = {
     Usage
       $ ${command} <org slug>
 
+    API Token Requirements
+      - Quota: 1 unit
+      - Permissions: repo:update
+
     Options
       ${getFlagListOutput(config.flags, 6)}
 

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

@@ -23,6 +23,10 @@ describe('socket repos view', async () => {
           Usage
             $ socket repos view <org slug>
 
+          API Token Requirements
+            - Quota: 1 unit
+            - Permissions: repo:list
+
           Options
             --dryRun          Do input validation for a command and exit 0 when input is ok
             --help            Print this help

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

@@ -30,6 +30,10 @@ const config: CliCommandConfig = {
     Usage
       $ ${command} <org slug>
 
+    API Token Requirements
+      - Quota: 1 unit
+      - Permissions: repo:list
+
     Options
       ${getFlagListOutput(config.flags, 6)}
 

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

@@ -22,6 +22,10 @@ describe('socket scan create', async () => {
           Usage
             $ socket scan create [...options] <org> <TARGET> [TARGET...]
 
+          API Token Requirements
+            - Quota: 1 unit
+            - Permissions: full-scans:create
+
           Uploads the specified "package.json" and lock files for JavaScript, Python,
           Go, Scala, Gradle, and Kotlin dependency manifests.
           If any folder is specified, the ones found in there recursively are uploaded.