Command is required

.changeset/soft-ties-applaud.md

@@ -0,0 +1,5 @@
+---
+'vercel': patch
+---
+
+Update dns commands to new structure

packages/cli/src/commands/dns/command.ts

@@ -0,0 +1,136 @@
+import { Command } from '../help';
+import { packageName } from '../../util/pkg-name';
+
+export const dnsCommand: Command = {
+  name: 'dns',
+  description: 'Interact with DNS entries for a project.',
+  arguments: [
+    {
+      name: 'command',
+      required: true,
+    },
+  ],
+  subcommands: [
+    {
+      name: 'import',
+      description: 'Import a DNS zone file (see below for examples)',
+      arguments: [
+        {
+          name: 'domain',
+          required: true,
+        },
+        {
+          name: 'zonefile',
+          required: true,
+        },
+      ],
+      options: [],
+      examples: [],
+    },
+    {
+      name: 'ls',
+      description: 'List all DNS entries for a domain',
+      arguments: [
+        {
+          name: 'domain',
+          required: true,
+        },
+      ],
+      options: [],
+      examples: [],
+    },
+    {
+      name: 'add',
+      description: 'Add a new DNS entry (see below for examples)',
+      arguments: [
+        {
+          name: 'details',
+          required: true,
+        },
+        {
+          name: 'alias',
+          required: true,
+        },
+      ],
+      options: [],
+      examples: [],
+    },
+    {
+      name: 'rm',
+      description: 'Remove a DNS entry using its ID',
+      arguments: [
+        {
+          name: 'id',
+          required: true,
+        },
+      ],
+      options: [],
+      examples: [],
+    },
+  ],
+  options: [
+    {
+      name: 'next',
+      description: 'Show next page of results',
+      argument: 'MS',
+      shorthand: 'n',
+      type: 'string',
+      deprecated: false,
+      multi: false,
+    },
+    {
+      name: 'limit',
+      shorthand: 'n',
+      description:
+        'Number of results to return per page (default: 20, max: 100)',
+      argument: 'NUMBER',
+      type: 'string',
+      deprecated: false,
+      multi: false,
+    },
+  ],
+  examples: [
+    {
+      name: 'Add an A record for a subdomain',
+      value: [
+        `${packageName} dns add <DOMAIN> <SUBDOMAIN> <A | AAAA | ALIAS | CNAME | TXT>  <VALUE>`,
+        `${packageName} dns add zeit.rocks api A 198.51.100.100`,
+      ],
+    },
+    {
+      name: 'Add an MX record (@ as a name refers to the domain)',
+      value: [
+        `${packageName} dns add <DOMAIN> '@' MX <RECORD VALUE> <PRIORITY>`,
+        `${packageName} dns add zeit.rocks '@' MX mail.zeit.rocks 10`,
+      ],
+    },
+    {
+      name: 'Add an SRV record',
+      value: [
+        `${packageName} dns add <DOMAIN> <NAME> SRV <PRIORITY> <WEIGHT> <PORT> <TARGET>`,
+        `${packageName} dns add zeit.rocks '@' SRV 10 0 389 zeit.party`,
+      ],
+    },
+    {
+      name: 'Add a CAA record',
+      value: [
+        `${packageName} dns add <DOMAIN> <NAME> CAA '<FLAGS> <TAG> "<VALUE>"'`,
+        `${packageName} dns add zeit.rocks '@' CAA '0 issue "example.com"'`,
+      ],
+    },
+    {
+      name: 'Import a Zone file',
+      value: [
+        `${packageName} dns import <DOMAIN> <FILE>`,
+        `${packageName} dns import zeit.rocks ./zonefile.txt`,
+      ],
+    },
+    {
+      name: 'Paginate results, where `1584722256178` is the time in milliseconds since the UNIX epoch.',
+      value: [
+        `${packageName} dns ls --next 1584722256178`,
+        `${packageName} dns ls zeit.rocks --next 1584722256178`,
+      ],
+    },
+  ],
+};

packages/cli/src/commands/dns/index.ts

@@ -1,96 +1,14 @@
-import chalk from 'chalk';
-
 import Client from '../../util/client';
 import getArgs from '../../util/get-args';
 import getSubcommand from '../../util/get-subcommand';
 import handleError from '../../util/handle-error';
-import { packageName, logo } from '../../util/pkg-name';
 
 import add from './add';
 import importZone from './import';
 import ls from './ls';
 import rm from './rm';
-
-const help = () => {
-  console.log(`
-  ${chalk.bold(`${logo} ${packageName} dns`)} [options] <command>
-
-  ${chalk.dim('Commands:')}
-
-    add     [details]             Add a new DNS entry (see below for examples)
-    import  [domain] [zonefile]   Import a DNS zone file (see below for examples)
-    rm      [id]                  Remove a DNS entry using its ID
-    ls      [domain]              List all DNS entries for a domain
-
-  ${chalk.dim('Options:')}
-
-    -h, --help                     Output usage information
-    -A ${chalk.bold.underline('FILE')}, --local-config=${chalk.bold.underline(
-    'FILE'
-  )}   Path to the local ${'`vercel.json`'} file
-    -Q ${chalk.bold.underline('DIR')}, --global-config=${chalk.bold.underline(
-    'DIR'
-  )}    Path to the global ${'`.vercel`'} directory
-    -d, --debug                    Debug mode [off]
-    --no-color                     No color mode [off]
-    -t ${chalk.bold.underline('TOKEN')}, --token=${chalk.bold.underline(
-    'TOKEN'
-  )}        Login token
-    -S, --scope                    Set a custom scope
-    -N, --next                     Show next page of results
-    --limit=${chalk.bold.underline(
-      'VALUE'
-    )}                  Number of results to return per page (default: 20, max: 100)
-
-  ${chalk.dim('Examples:')}
-
-  ${chalk.gray('–')} Add an A record for a subdomain
-
-      ${chalk.cyan(
-        `$ ${packageName} dns add <DOMAIN> <SUBDOMAIN> <A | AAAA | ALIAS | CNAME | TXT>  <VALUE>`
-      )}
-      ${chalk.cyan(`$ ${packageName} dns add zeit.rocks api A 198.51.100.100`)}
-
-  ${chalk.gray('–')} Add an MX record (@ as a name refers to the domain)
-
-      ${chalk.cyan(
-        `$ ${packageName} dns add <DOMAIN> '@' MX <RECORD VALUE> <PRIORITY>`
-      )}
-      ${chalk.cyan(
-        `$ ${packageName} dns add zeit.rocks '@' MX mail.zeit.rocks 10`
-      )}
-
-  ${chalk.gray('–')} Add an SRV record
-
-      ${chalk.cyan(
-        `$ ${packageName} dns add <DOMAIN> <NAME> SRV <PRIORITY> <WEIGHT> <PORT> <TARGET>`
-      )}
-      ${chalk.cyan(
-        `$ ${packageName} dns add zeit.rocks '@' SRV 10 0 389 zeit.party`
-      )}
-
-  ${chalk.gray('–')} Add a CAA record
-
-      ${chalk.cyan(
-        `$ ${packageName} dns add <DOMAIN> <NAME> CAA '<FLAGS> <TAG> "<VALUE>"'`
-      )}
-      ${chalk.cyan(
-        `$ ${packageName} dns add zeit.rocks '@' CAA '0 issue "example.com"'`
-      )}
-
-  ${chalk.gray('–')} Import a Zone file
-
-      ${chalk.cyan(`$ ${packageName} dns import <DOMAIN> <FILE>`)}
-      ${chalk.cyan(`$ ${packageName} dns import zeit.rocks ./zonefile.txt`)}
-
-  ${chalk.gray('–')} Paginate results, where ${chalk.dim(
-    '`1584722256178`'
-  )} is the time in milliseconds since the UNIX epoch.
-
-      ${chalk.cyan(`$ ${packageName} dns ls --next 1584722256178`)}
-      ${chalk.cyan(`$ ${packageName} dns ls zeit.rocks --next 1584722256178`)}
-`);
-};
+import { dnsCommand } from './command';
+import { help } from '../help';
 
 const COMMAND_CONFIG = {
   add: ['add'],
@@ -99,7 +17,7 @@ const COMMAND_CONFIG = {
   rm: ['rm', 'remove'],
 };
 
-export default async function main(client: Client) {
+export default async function dns(client: Client) {
   let argv;
 
   try {
@@ -114,7 +32,7 @@ export default async function main(client: Client) {
   }
 
   if (argv['--help']) {
-    help();
+    client.output.print(help(dnsCommand, { columns: client.stderr.columns }));
     return 2;
   }