From 3c7208559d7dcf87907d345bf5c4a5346bc7b8fe Mon Sep 17 00:00:00 2001 From: Hirotaka Tagawa / wafuwafu13 Date: Thu, 23 Sep 2021 10:28:11 +0900 Subject: [PATCH] docs: modernize sample code (#2019) --- example/bool.js | 1 - example/default_hash.js | 1 - example/divide.js | 1 - example/help.js | 3 +-- example/implies.js | 1 - example/implies_hash.js | 1 - example/requires_arg.js | 13 +++++++------ example/strict.js | 5 +++-- example/usage-options.js | 1 + 9 files changed, 12 insertions(+), 15 deletions(-) diff --git a/example/bool.js b/example/bool.js index 94b75f849..b7ab5857c 100644 --- a/example/bool.js +++ b/example/bool.js @@ -1,5 +1,4 @@ #!/usr/bin/env node -var util = require('util'); var argv = require('yargs/yargs')(process.argv.slice(2)).argv; if (argv.s) { diff --git a/example/default_hash.js b/example/default_hash.js index aa72e4daf..60d2c81c8 100644 --- a/example/default_hash.js +++ b/example/default_hash.js @@ -1,5 +1,4 @@ #!/usr/bin/env node - var argv = require('yargs/yargs')(process.argv.slice(2)) .default({ x : 10, y : 10 }) .argv diff --git a/example/divide.js b/example/divide.js index c3d569013..1aed4048c 100644 --- a/example/divide.js +++ b/example/divide.js @@ -1,5 +1,4 @@ #!/usr/bin/env node - var argv = require('yargs/yargs')(process.argv.slice(2)) .usage('Usage: $0 -x [num] -y [num]') .demand(['x','y']) diff --git a/example/help.js b/example/help.js index eb241fdfb..3254faaa6 100644 --- a/example/help.js +++ b/example/help.js @@ -1,5 +1,4 @@ -var yargs = require('../index'); - +#!/usr/bin/env node var argv = require('yargs/yargs')(process.argv.slice(2)) .usage('This is my awesome program\n\nUsage: $0 [options]') .help('help').alias('help', 'h') diff --git a/example/implies.js b/example/implies.js index 32a567b4c..7b828364d 100644 --- a/example/implies.js +++ b/example/implies.js @@ -1,5 +1,4 @@ #!/usr/bin/env node - var argv = require('yargs/yargs')(process.argv.slice(2)) .usage('Usage: $0 -x [num] -y [num]') .implies('x', 'y') diff --git a/example/implies_hash.js b/example/implies_hash.js index ba80a2632..3afe8c069 100644 --- a/example/implies_hash.js +++ b/example/implies_hash.js @@ -1,5 +1,4 @@ #!/usr/bin/env node - var argv = require('yargs/yargs')(process.argv.slice(2)) .usage('Usage: $0 -x [num] -y [num] -w [msg] -h [msg]') .implies({ diff --git a/example/requires_arg.js b/example/requires_arg.js index 06cc0ae38..a50a8a9dc 100644 --- a/example/requires_arg.js +++ b/example/requires_arg.js @@ -1,16 +1,17 @@ +#!/usr/bin/env node var yargs = require('yargs/yargs')(process.argv.slice(2)); -var argv = yargs.usage('This is my awesome program', { - 'input': { +var argv = yargs.usage('This is my awesome program').options({ + input: { description: 'Input file name', requiresArg: true, - short: 'i', + alias: 'i', }, - 'output': { + output: { description: 'Output file name', requiresArg: true, - short: 'o' - } + alias: 'o', + }, }).argv; yargs.showHelp(); diff --git a/example/strict.js b/example/strict.js index f1ec29cee..afdb2c1dc 100644 --- a/example/strict.js +++ b/example/strict.js @@ -1,15 +1,16 @@ +#!/usr/bin/env node var yargs = require('yargs/yargs')(process.argv.slice(2)); var argv = yargs.usage('This is my awesome program', { 'about': { description: 'Provide some details about the author of this program', boolean: true, - short: 'a', + alias: 'a', }, 'info': { description: 'Provide some information about this program', boolean: true, - short: 'i' + alias: 'i' } }).strict().argv; diff --git a/example/usage-options.js b/example/usage-options.js index 0ccc8ee0d..7d1a82317 100644 --- a/example/usage-options.js +++ b/example/usage-options.js @@ -1,3 +1,4 @@ +#!/usr/bin/env node var yargs = require('yargs/yargs')(process.argv.slice(2)); var argv = yargs.usage('This is my awesome program')