From 3a03f018683beb6d206693418af3edcbe6f1fb39 Mon Sep 17 00:00:00 2001 From: Joshua Cline Date: Wed, 1 Apr 2020 13:30:00 -0700 Subject: [PATCH 1/3] Added initial help flag. --- src/index.js | 36 +++++++++++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/src/index.js b/src/index.js index 4153c9cfca..125fe79658 100755 --- a/src/index.js +++ b/src/index.js @@ -90,6 +90,7 @@ const args = (() => { boolean: [ 'version', 'home', + 'help', 'log', 'perf', 'performance', @@ -134,6 +135,7 @@ const args = (() => { return { version: minimistArgs.version, url: minimistArgs._[0] || '', + help: minimistArgs.help || false, home: minimistArgs.home, log: minimistArgs.log, webgl: minimistArgs.webgl || '2', @@ -150,13 +152,41 @@ const args = (() => { nogl: minimistArgs.nogl, headless: minimistArgs.headless, uncapped: minimistArgs.uncapped, - onbeforeload: minimistArgs.onbeforeload + onbeforeload: minimistArgs.onbeforeload, }; } else { return {}; } })(); +const helpText = `Exokit Help +Usage: exokit [flags] + +Flags: +--help +Display's this text and exits. +--version, -v +Prints current exokit version. +--home, -h +--log, -l +--perf, +--performance, --perf +--frame, -f +--minimalFrame, -m +--tab, -t +--quit, -q +--blit, -b +--require, -u +--nogl, -n +--headless, -e +--uncapped, -u +--webgl, -w +--xr, -x +--size, -s +--replace, -r +--onbeforeload +`; + core.setArgs(args); core.setVersion(version); @@ -1618,6 +1648,10 @@ if (require.main === module) { console.log(version); process.exit(0); } + if (args.help){ + console.log(helpText); + process.exit(0); + } if (args.size) { const match = args.size.match(/^([0-9]+)x([0-9]+)$/); if (match) { From 62c23530d0a808b268ed9a88fa8045a7bf1ca1f1 Mon Sep 17 00:00:00 2001 From: Joshua Cline Date: Wed, 1 Apr 2020 13:32:30 -0700 Subject: [PATCH 2/3] Made heading look a bit better? --- src/index.js | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/index.js b/src/index.js index 125fe79658..ae3a310a60 100755 --- a/src/index.js +++ b/src/index.js @@ -159,7 +159,8 @@ const args = (() => { } })(); -const helpText = `Exokit Help +const helpText = `Exokit v${version} + Usage: exokit [flags] Flags: @@ -184,7 +185,7 @@ Prints current exokit version. --xr, -x --size, -s --replace, -r ---onbeforeload +--onbeforeload `; core.setArgs(args); From 2acf91e7e2582c65ece9374659d7cc77a3a8aecf Mon Sep 17 00:00:00 2001 From: Joshua Cline Date: Wed, 1 Apr 2020 13:40:55 -0700 Subject: [PATCH 3/3] Added stubs so we can start to work on some actual documentation. --- src/index.js | 48 +++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 43 insertions(+), 5 deletions(-) diff --git a/src/index.js b/src/index.js index ae3a310a60..68981207fd 100755 --- a/src/index.js +++ b/src/index.js @@ -166,26 +166,64 @@ Usage: exokit [flags] Flags: --help Display's this text and exits. + --version, -v Prints current exokit version. + --home, -h +stub + --log, -l +stub + --perf, +stub + --performance, --perf +stub + --frame, -f +stub + --minimalFrame, -m +stub + --tab, -t +stub + --quit, -q +stub + --blit, -b +stub + --require, -u +stub + --nogl, -n +stub + --headless, -e +stub + --uncapped, -u ---webgl, -w ---xr, -x ---size, -s ---replace, -r ---onbeforeload +stub + +--webgl [option], -w [option] +stub + +--xr [option], -x [option] +stub + +--size [option], -s [option] +stub + +--replace [option], -r [option] +stub + +--onbeforeload [option] +stub + `; core.setArgs(args);