feat: allow setting scriptName $0 (#1143)

laggingreflex · bcoe · commit a2f2eae2235f · 2018-06-24T15:02:51.000-07:00
diff --git a/docs/api.md b/docs/api.md
@@ -813,6 +813,20 @@ var yargs = require("yargs")(['--info'])
   .argv
 ```
 
+<a name="scriptName"></a>.scriptName($0)
+------------------
+
+Set the name of your script ($0). Default is the base filename executed by node (`process.argv[1]`)
+
+Example:
+
+```js
+var yargs = require("yargs")
+  .scriptName("my-script")
+  .help()
+  .argv
+```
+
 <a name="showHidden"></a>.showHidden()
 -----------------------------------------
 .showHidden([option | boolean])
diff --git a/test/usage.js b/test/usage.js
@@ -1232,6 +1232,26 @@ describe('usage tests', () => {
     })
   })
 
+  describe('scriptName', () => {
+    it('should display user supplied scriptName', () => {
+      const r = checkUsage(() => yargs(['--help'])
+        .scriptName('custom')
+        .command('command')
+        .parse()
+      )
+      r.logs.join('\n').split(/\n+/).should.deep.equal([
+        'custom [command]',
+        'Commands:',
+        '  custom command',
+        'Options:',
+        '  --help     Show help                                                 [boolean]',
+        '  --version  Show version number                                       [boolean]'
+      ])
+      r.errors.should.have.length(0)
+      r.exit.should.equal(true)
+    })
+  })
+
   it('should succeed when rebase', () => {
     rebase(['home', 'chevex'].join(path.sep), ['home', 'chevex', 'foo', 'bar', 'baz'].join(path.sep)).should.equal(['foo', 'bar', 'baz'].join(path.sep))
     rebase(['home', 'chevex', 'foo', 'bar', 'baz'].join(path.sep), ['home', 'chevex'].join(path.sep)).should.equal(['..', '..', '..'].join(path.sep))
diff --git a/yargs.js b/yargs.js
@@ -37,6 +37,11 @@ function Yargs (processArgs, cwd, parentRequire) {
 
   if (!cwd) cwd = process.cwd()
 
+  self.scriptName = function scriptName (scriptName) {
+    self.$0 = scriptName
+    return self
+  }
+
   self.$0 = process.argv
     .slice(0, 2)
     .map((x, i) => {
