Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: modernize sample code #2019

Merged
merged 6 commits into from Sep 23, 2021
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 0 additions & 1 deletion 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) {
Expand Down
1 change: 0 additions & 1 deletion 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
Expand Down
1 change: 0 additions & 1 deletion 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'])
Expand Down
3 changes: 1 addition & 2 deletions 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')
Expand Down
1 change: 0 additions & 1 deletion 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')
Expand Down
1 change: 0 additions & 1 deletion 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({
Expand Down
13 changes: 7 additions & 6 deletions 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();
Expand Down
5 changes: 3 additions & 2 deletions 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;

Expand Down
1 change: 1 addition & 0 deletions 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')
Expand Down