git-node: restructure using commandDir of yargs

Author: joyeecheung

bin/get-metadata

@@ -4,6 +4,5 @@
 const path = require('path');
 const { runAsync } = require('../lib/run');
 
-const script = path.join(
-  __dirname, '..', 'components', 'git', 'git-node-metadata');
-runAsync(script, process.argv.slice(2));
+const script = path.join(__dirname, 'git-node');
+runAsync(script, ['metadata'].concat(process.argv.slice(2)));

bin/git-node

@@ -1,21 +1,19 @@
 #!/usr/bin/env node
 'use strict';
 
-const CMD = process.argv[2];
+const yargs = require('yargs');
 const path = require('path');
-const { runAsync } = require('../lib/run');
-const fs = require('fs');
+const epilogue = require('../components/git/epilogue');
 
-if (!CMD) {
-  console.log('Run `git node help` to see how to use this');
-  process.exit(1);
-}
+const commandDir = path.join(__dirname, '..', 'components', 'git');
 
-const script = path.join(
-  __dirname, '..', 'components', 'git', `git-node-${CMD}`);
-if (!fs.existsSync(script)) {
-  console.error(`No such command: git node ${CMD}`);
-  process.exit(1);
-}
-
-runAsync(process.execPath, [script, ...process.argv.slice(3)]);
+/* eslint-disable no-unused-expressions */
+yargs
+  .commandDir(commandDir, {
+    exclude: /epilogue/
+  })
+  .command('help', false, () => {}, (yargs) => { yargs.showHelp(); })
+  .demandCommand(1)
+  .epilogue(epilogue)
+  .help('help')
+  .argv;

components/git/git-node-help renamed to components/git/epilogue.js

@@ -1,14 +1,6 @@
-#!/usr/bin/env node
+'use strict';
 
-console.log(`
-Steps to get metadata for a pull request:
-==============================================================================
-$ cd path/to/node/project
-$ git node metadata $PRID        # Retrieves metadata for a PR and validates
-                                 # them against nodejs/node PR rules
-==============================================================================
-
-Steps to land a pull request:
+module.exports = `Steps to land a pull request:
 ==============================================================================
 $ cd path/to/node/project
 $ git node land --abort          # Abort a landing session, just in case
@@ -21,4 +13,4 @@ $ git rebase --continue          # Repeat until the rebase is done
 
 $ git node land --final          # Verify all the commit messages
 ==============================================================================
-Watch https://asciinema.org/a/148627 for a complete demo`);
+Watch https://asciinema.org/a/148627 for a complete demo`;

components/git/git-node-land

@@ -0,0 +1,143 @@
+'use strict';
+
+const getMetadata = require('../metadata');
+const CLI = require('../../lib/cli');
+const Request = require('../../lib/request');
+const { runPromise } = require('../../lib/run');
+const LandingSession = require('../../lib/landing_session');
+const epilogue = require('./epilogue');
+const yargs = require('yargs');
+
+const landOptions = {
+  apply: {
+    describe: 'Apply a patch with the given PR id',
+    type: 'number'
+  },
+  amend: {
+    describe: 'Amend the current commit',
+    type: 'boolean'
+  },
+  continue: {
+    alias: 'c',
+    describe: 'Continue the landing session',
+    type: 'boolean'
+  },
+  final: {
+    describe: 'Verify the landed PR and clean up',
+    type: 'boolean'
+  },
+  abort: {
+    describe: 'Abort the current landing session',
+    type: 'boolean'
+  }
+};
+
+function builder(yargs) {
+  return yargs
+    .options(landOptions).positional('prid', {
+      describe: 'ID of the Pull Request',
+      type: 'number'
+    })
+    .epilogue(epilogue)
+    .example('git node land 12344',
+      'Land https://github.com/nodejs/node/pull/12344 in the current directory')
+    .example('git node land --abort',
+      'Abort the current session')
+    .example('git node land --amend',
+      'Append metadata to the current commit message')
+    .example('git node land --final',
+      'Verify the landed PR and clean up')
+    .example('git node land --continue',
+      'Continue the current landing session');
+}
+
+const START = 'start';
+const APPLY = 'apply';
+const AMEND = 'amend';
+const FINAL = 'final';
+const CONTINUE = 'continue';
+const ABORT = 'abort';
+
+function handler(argv) {
+  if (argv.prid && Number.isInteger(argv.prid)) {
+    return land(START, argv);
+  }
+  const provided = [];
+  for (const type of Object.keys(landOptions)) {
+    if (argv[type]) {
+      provided.push(type);
+    }
+  }
+  if (provided.length === 0) {
+    yargs.showHelp();
+    return;
+  }
+  if (provided.length > 1) {
+    yargs.showHelp();
+    return;
+  }
+
+  return land(provided[0], argv);
+}
+
+function land(state, argv) {
+  const cli = new CLI(process.stderr);
+  const req = new Request();
+  const dir = process.cwd();
+
+  return runPromise(main(state, argv, cli, req, dir)).catch((err) => {
+    if (cli.spinner.enabled) {
+      cli.spinner.fail();
+    }
+    throw err;
+  });
+}
+
+module.exports = {
+  command: 'land [prid|options]',
+  describe:
+    'Manage the current landing session or start a new one for a pull request',
+  builder,
+  handler
+};
+
+async function main(state, argv, cli, req, dir) {
+  let session = new LandingSession(cli, req, dir);
+
+  try {
+    session.restore();
+  } catch (err) { // JSON error?
+    if (state === ABORT) {
+      await session.abort();
+      return;
+    }
+    cli.warn(
+      'Failed to detect previous session. ' +
+      'please run `git node land --abort`');
+    return;
+  }
+
+  if (state === START) {
+    if (session.hasStarted()) {
+      cli.warn(
+        'Previous `git node land` session for ' +
+        `${session.pullName} in progress.`);
+      cli.log('run `git node land --abort` before starting a new session');
+      return;
+    }
+    session = new LandingSession(cli, req, dir, argv.prid);
+    const { repo, owner, prid } = session;
+    const metadata = await getMetadata({ repo, owner, prid }, cli);
+    return session.start(metadata);
+  } else if (state === APPLY) {
+    return session.apply();
+  } else if (state === AMEND) {
+    return session.amend();
+  } else if (state === FINAL) {
+    return session.final();
+  } else if (state === ABORT) {
+    return session.abort();
+  } else if (state === CONTINUE) {
+    return session.continue();
+  }
+}