docs: update examples to run from examples folder (#2463)

Author: shadowspawn

docs/examples.md

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+const argv = require('yargs/yargs')(process.argv.slice(2)).parse();
+
+if (argv.s) {
+  console.log(argv.fr ? 'Le chat dit: ' : 'The cat says: ');
+}
+console.log((argv.fr ? 'miaou' : 'meow') + (argv.p ? '.' : ''));

example/bool.cjs

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+const argv = require('yargs/yargs')(process.argv.slice(2))
+  .boolean(['x', 'y', 'z'])
+  .parse();
+console.dir([argv.x, argv.y, argv.z]);
+console.dir(argv._);

example/bool.js

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+const argv = require('yargs/yargs')(process.argv.slice(2))
+  .boolean(['r', 'v'])
+  .parse();
+console.dir([argv.r, argv.v]);
+console.dir(argv._);

example/boolean_double.cjs

@@ -0,0 +1,10 @@
+export const command = 'init [dir]';
+export const desc = 'Create an empty repo';
+export const builder = {
+  dir: {
+    default: '.',
+  },
+};
+export const handler = function (argv) {
+  console.log('init called for dir', argv.dir);
+};

example/boolean_double.js

@@ -0,0 +1,6 @@
+export const command = 'remote <command>';
+export const description = 'Manage set of tracked repos';
+export const builder = function (yargs) {
+  return yargs.commandDir('remote_cmds');
+};
+export const handler = function (argv) {};

example/boolean_single.cjs

@@ -0,0 +1,6 @@
+export const command = 'add <name> <url>';
+export const desc = 'Add remote named <name> for repo at url <url>';
+export const builder = {};
+export const handler = function (argv) {
+  console.log('adding remote %s at url %s', argv.name, argv.url);
+};

example/boolean_single.js

@@ -0,0 +1,9 @@
+export const command = 'prune <name> [names..]';
+export const desc = 'Delete tracked branches gone stale for remotes';
+export const builder = {};
+export const handler = function (argv) {
+  console.log(
+    'pruning remotes %s',
+    [].concat(argv.name).concat(argv.names).join(', ')
+  );
+};

example/cmds/init.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import yargs from 'yargs';
+
+yargs(process.argv.slice(2)).commandDir('cmds').demandCommand().help().parse();

example/cmds/init.mjs

@@ -1,18 +1,24 @@
+import yargs from 'yargs';
+
 // a fairly complex CLI defined using the yargs 3.0 API:
-var argv = require('yargs/yargs')(process.argv.slice(2))
+const argv = yargs(process.argv.slice(2))
   .usage('Usage: $0 <cmd> [options]') // usage string of application.
   .command('install', 'install a package (name@version)') // describe commands available.
-  .command('publish', 'publish the package inside the current working directory')
-  .option('f', { // document options.
+  .command(
+    'publish',
+    'publish the package inside the current working directory'
+  )
+  .option('f', {
+    // document options.
     array: true, // even single values will be wrapped in [].
     description: 'an array of files',
     default: 'test.js',
-    alias: 'file'
+    alias: 'file',
   })
   .alias('f', 'fil')
   .option('h', {
     alias: 'help',
-    description: 'display help message'
+    description: 'display help message',
   })
   .string(['user', 'pass'])
   .implies('user', 'pass') // if 'user' is set 'pass' must be set.

example/cmds/remote.js

@@ -0,0 +1,23 @@
+#!/usr/bin/env node
+import yargs from 'yargs';
+
+const argv = yargs(process.argv.slice(2))
+  .count('verbose')
+  .alias('v', 'verbose')
+  .parse();
+
+const VERBOSE_LEVEL = argv.verbose;
+
+function WARN() {
+  VERBOSE_LEVEL >= 0 && console.log.apply(console, arguments);
+}
+function INFO() {
+  VERBOSE_LEVEL >= 1 && console.log.apply(console, arguments);
+}
+function DEBUG() {
+  VERBOSE_LEVEL >= 2 && console.log.apply(console, arguments);
+}
+
+WARN('Showing only important stuff');
+INFO('Showing semi-important stuff too');
+DEBUG('Extra chatty mode');

example/cmds/remote.mjs

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+import yargs from 'yargs';
+
+const argv = yargs(process.argv.slice(2)).default({x: 10, y: 10}).parse();
+console.log(argv.x + argv.y);

example/cmds/remote_cmds/add.js

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+import yargs from 'yargs';
+
+const argv = yargs(process.argv.slice(2))
+  .default('x', 10)
+  .default('y', 10)
+  .parse();
+console.log(argv.x + argv.y);

example/cmds/remote_cmds/add.mjs

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+import yargs from 'yargs';
+
+const argv = yargs(process.argv.slice(2)).demand(2).parse();
+console.dir(argv);

example/cmds/remote_cmds/prune.js

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+import yargs from 'yargs';
+
+const argv = yargs(process.argv.slice(2))
+  .usage('Usage: $0 -x [num] -y [num]')
+  .demand(['x', 'y'])
+  .parse();
+
+console.log(argv.x / argv.y);

example/cmds/remote_cmds/prune.mjs

@@ -0,0 +1,30 @@
+#!/usr/bin/env node
+import yargs from 'yargs';
+
+const argv = yargs(process.argv.slice(2))
+  .usage('This is my awesome program\n\nUsage: $0 [options]')
+  .help('help')
+  .alias('help', 'h')
+  .version('version', '1.0.1')
+  .alias('version', 'V')
+  .options({
+    input: {
+      alias: 'i',
+      description: '<filename> Input file name',
+      requiresArg: true,
+      required: true,
+    },
+    output: {
+      alias: 'o',
+      description: '<filename> output file name',
+      requiresArg: true,
+      required: true,
+    },
+  })
+  .parse();
+
+console.log('Inspecting options');
+console.dir(argv);
+
+console.log('input:', argv.input);
+console.log('output:', argv.output);

example/command_hierarchy.js

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+import yargs from 'yargs';
+
+const argv = yargs(process.argv.slice(2))
+  .usage('Usage: $0 -x [num] -y [num]')
+  .implies('x', 'y')
+  .parse();
+
+if (argv.x) {
+  console.log(argv.x / argv.y);
+}

example/command_hierarchy.mjs

@@ -0,0 +1,27 @@
+#!/usr/bin/env node
+import yargs from 'yargs';
+
+const argv = yargs(process.argv.slice(2))
+  .usage('Usage: $0 -x [num] -y [num] -w [msg] -h [msg]')
+  .implies({
+    x: 'y',
+    w: '--no-h',
+    1: 'h',
+  })
+  .parse();
+
+if (argv.x) {
+  console.log('x / y : ' + argv.x / argv.y);
+}
+
+if (argv.y) {
+  console.log('y: ' + argv.y);
+}
+
+if (argv.w) {
+  console.log('w: ' + argv.w);
+}
+
+if (argv.h) {
+  console.log('h: ' + argv.h);
+}