replace optimist with yargs

README.md

@@ -61,7 +61,7 @@ The output will be:
 
 Configuration management can get complicated very quickly for even trivial applications running in production. `nconf` addresses this problem by enabling you to setup a hierarchy for different sources of configuration with no defaults. **The order in which you attach these configuration sources determines their priority in the hierarchy.** Lets take a look at the options available to you
 
-  1. **nconf.argv(options)** Loads `process.argv` using optimist. If `options` is supplied it is passed along to optimist.
+  1. **nconf.argv(options)** Loads `process.argv` using yargs. If `options` is supplied it is passed along to yargs.
   2. **nconf.env(options)** Loads `process.env` into the hierarchy.
   3. **nconf.file(options)** Loads the configuration data at options.file into the hierarchy.
   4. **nconf.defaults(options)** Loads the data in options.store into the hierarchy.
@@ -159,11 +159,11 @@ A simple in-memory storage engine that stores a nested JSON representation of th
 ```
 
 ### Argv
-Responsible for loading the values parsed from `process.argv` by `optimist` into the configuration hierarchy. See the [optimist option docs](https://github.com/substack/node-optimist/#optionskey-opt) for more on the option format.
+Responsible for loading the values parsed from `process.argv` by `yargs` into the configuration hierarchy. See the [yargs option docs](https://github.com/bcoe/yargs#optionskey-opt) for more on the option format.
 
 ``` js
   //
-  // Can optionally also be an object literal to pass to `optimist`.
+  // Can optionally also be an object literal to pass to `yargs`.
   //
   nconf.argv({
     "x": {

docs/nconf/stores/system.html

@@ -5,7 +5,7 @@
 <span class="cm"> * (C) 2011, Charlie Robbins</span>
 <span class="cm"> *</span>
 <span class="cm"> */</span>
- 
+
 <span class="kd">var</span> <span class="nx">util</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;util&#39;</span><span class="p">),</span>
     <span class="nx">Memory</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;./memory&#39;</span><span class="p">).</span><span class="nx">Memory</span><span class="p">;</span>
  </pre></div>             </td>           </tr>                               <tr id="section-2">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-2">&#182;</a>               </div>               <h3>function System (options)</h3>
@@ -28,15 +28,15 @@ <h4>@options {Object} Options for this instance.</h4>
   <span class="k">if</span> <span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">env</span><span class="p">)</span> <span class="p">{</span>
     <span class="k">this</span><span class="p">.</span><span class="nx">loadEnv</span><span class="p">();</span>
   <span class="p">}</span>
-  
+
   <span class="k">if</span> <span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">argv</span><span class="p">)</span> <span class="p">{</span>
     <span class="k">this</span><span class="p">.</span><span class="nx">loadArgv</span><span class="p">();</span>
   <span class="p">}</span>
-  
+
   <span class="k">if</span> <span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">overrides</span><span class="p">)</span> <span class="p">{</span>
     <span class="k">this</span><span class="p">.</span><span class="nx">loadOverrides</span><span class="p">();</span>
   <span class="p">}</span>
-  
+
   <span class="k">return</span> <span class="k">this</span><span class="p">.</span><span class="nx">store</span><span class="p">;</span>
 <span class="p">};</span></pre></div>             </td>           </tr>                               <tr id="section-5">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-5">&#182;</a>               </div>               <h3>function loadOverrides ()</h3>
 
@@ -45,54 +45,54 @@ <h4>@options {Object} Options for this instance.</h4>
   <span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="k">this</span><span class="p">.</span><span class="nx">overrides</span><span class="p">)</span> <span class="p">{</span>
     <span class="k">return</span><span class="p">;</span>
   <span class="p">}</span>
-  
+
   <span class="kd">var</span> <span class="nx">self</span> <span class="o">=</span> <span class="k">this</span><span class="p">,</span>
       <span class="nx">keys</span> <span class="o">=</span> <span class="nb">Object</span><span class="p">.</span><span class="nx">keys</span><span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">overrides</span><span class="p">);</span>
-  
+
   <span class="nx">keys</span><span class="p">.</span><span class="nx">forEach</span><span class="p">(</span><span class="kd">function</span> <span class="p">(</span><span class="nx">key</span><span class="p">)</span> <span class="p">{</span>
     <span class="nx">self</span><span class="p">.</span><span class="nx">set</span><span class="p">(</span><span class="nx">key</span><span class="p">,</span> <span class="nx">self</span><span class="p">.</span><span class="nx">overrides</span><span class="p">[</span><span class="nx">key</span><span class="p">]);</span>
   <span class="p">});</span>
-  
+
   <span class="k">return</span> <span class="k">this</span><span class="p">.</span><span class="nx">store</span><span class="p">;</span>
 <span class="p">};</span></pre></div>             </td>           </tr>                               <tr id="section-6">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-6">&#182;</a>               </div>               <h3>function loadArgv ()</h3>
 
-<p>Loads the data passed in from the command-line arguments 
+<p>Loads the data passed in from the command-line arguments
 into this instance.</p>             </td>             <td class="code">               <div class="highlight"><pre><span class="nx">System</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">loadArgv</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
-  <span class="kd">var</span> <span class="nx">self</span> <span class="o">=</span> <span class="k">this</span><span class="p">,</span> 
+  <span class="kd">var</span> <span class="nx">self</span> <span class="o">=</span> <span class="k">this</span><span class="p">,</span>
       <span class="nx">argv</span><span class="p">;</span>
-  
+
   <span class="k">if</span> <span class="p">(</span><span class="k">typeof</span> <span class="k">this</span><span class="p">.</span><span class="nx">argv</span> <span class="o">===</span> <span class="s1">&#39;object&#39;</span><span class="p">)</span> <span class="p">{</span>
-    <span class="nx">argv</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;optimist&#39;</span><span class="p">).</span><span class="nx">options</span><span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">argv</span><span class="p">).</span><span class="nx">argv</span><span class="p">;</span>
+    <span class="nx">argv</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;yargs&#39;</span><span class="p">).</span><span class="nx">options</span><span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">argv</span><span class="p">).</span><span class="nx">argv</span><span class="p">;</span>
   <span class="p">}</span>
   <span class="k">else</span> <span class="k">if</span> <span class="p">(</span><span class="k">this</span><span class="p">.</span><span class="nx">argv</span><span class="p">)</span> <span class="p">{</span>
-    <span class="nx">argv</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;optimist&#39;</span><span class="p">).</span><span class="nx">argv</span><span class="p">;</span>
+    <span class="nx">argv</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;yargs&#39;</span><span class="p">).</span><span class="nx">argv</span><span class="p">;</span>
   <span class="p">}</span>
-  
+
   <span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">argv</span><span class="p">)</span> <span class="p">{</span>
     <span class="k">return</span><span class="p">;</span>
   <span class="p">}</span>
-  
+
   <span class="nb">Object</span><span class="p">.</span><span class="nx">keys</span><span class="p">(</span><span class="nx">argv</span><span class="p">).</span><span class="nx">forEach</span><span class="p">(</span><span class="kd">function</span> <span class="p">(</span><span class="nx">key</span><span class="p">)</span> <span class="p">{</span>
     <span class="nx">self</span><span class="p">.</span><span class="nx">set</span><span class="p">(</span><span class="nx">key</span><span class="p">,</span> <span class="nx">argv</span><span class="p">[</span><span class="nx">key</span><span class="p">]);</span>
   <span class="p">});</span>
-  
+
   <span class="k">return</span> <span class="k">this</span><span class="p">.</span><span class="nx">store</span><span class="p">;</span>
 <span class="p">};</span></pre></div>             </td>           </tr>                               <tr id="section-7">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-7">&#182;</a>               </div>               <h3>function loadEnv ()</h3>
 
 <p>Loads the data passed in from <code>process.env</code> into this instance.</p>             </td>             <td class="code">               <div class="highlight"><pre><span class="nx">System</span><span class="p">.</span><span class="nx">prototype</span><span class="p">.</span><span class="nx">loadEnv</span> <span class="o">=</span> <span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
   <span class="kd">var</span> <span class="nx">self</span> <span class="o">=</span> <span class="k">this</span><span class="p">;</span>
-  
+
   <span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="k">this</span><span class="p">.</span><span class="nx">env</span><span class="p">)</span> <span class="p">{</span>
     <span class="k">return</span><span class="p">;</span>
   <span class="p">}</span>
-  
+
   <span class="nb">Object</span><span class="p">.</span><span class="nx">keys</span><span class="p">(</span><span class="nx">process</span><span class="p">.</span><span class="nx">env</span><span class="p">).</span><span class="nx">filter</span><span class="p">(</span><span class="kd">function</span> <span class="p">(</span><span class="nx">key</span><span class="p">)</span> <span class="p">{</span>
     <span class="k">return</span> <span class="o">!</span><span class="nx">self</span><span class="p">.</span><span class="nx">env</span><span class="p">.</span><span class="nx">length</span> <span class="o">||</span> <span class="nx">self</span><span class="p">.</span><span class="nx">env</span><span class="p">.</span><span class="nx">indexOf</span><span class="p">(</span><span class="nx">key</span><span class="p">)</span> <span class="o">!==</span> <span class="o">-</span><span class="mi">1</span><span class="p">;</span>
   <span class="p">}).</span><span class="nx">forEach</span><span class="p">(</span><span class="kd">function</span> <span class="p">(</span><span class="nx">key</span><span class="p">)</span> <span class="p">{</span>
     <span class="nx">self</span><span class="p">.</span><span class="nx">set</span><span class="p">(</span><span class="nx">key</span><span class="p">,</span> <span class="nx">process</span><span class="p">.</span><span class="nx">env</span><span class="p">[</span><span class="nx">key</span><span class="p">]);</span>
   <span class="p">});</span>
-    
+
   <span class="k">return</span> <span class="k">this</span><span class="p">.</span><span class="nx">store</span><span class="p">;</span>
 <span class="p">};</span>
 
-</pre></div>             </td>           </tr>                </tbody>     </table>   </div> </body> </html> 
+</pre></div>             </td>           </tr>                </tbody>     </table>   </div> </body> </html>

lib/nconf/stores/argv.js

@@ -42,15 +42,15 @@ Argv.prototype.loadSync = function () {
 //
 Argv.prototype.loadArgv = function () {
   var self = this,
-      optimist, argv;
+      yargs, argv;
 
-  optimist = typeof this.options === 'object'
-    ? require('optimist')(process.argv.slice(2)).options(this.options)
-    : require('optimist')(process.argv.slice(2));
+  yargs = typeof this.options === 'object'
+    ? require('yargs')(process.argv.slice(2)).options(this.options)
+    : require('yargs')(process.argv.slice(2));
 
-  if (typeof this.usage === 'string') { optimist.usage(this.usage) }
+  if (typeof this.usage === 'string') { yargs.usage(this.usage) }
 
-  argv = optimist.argv
+  argv = yargs.argv
 
   if (!argv) {
     return;
@@ -61,9 +61,9 @@ Argv.prototype.loadArgv = function () {
     self.set(key, argv[key]);
   });
 
-  this.showHelp = optimist.showHelp
-  this.help     = optimist.help
+  this.showHelp = yargs.showHelp
+  this.help     = yargs.help
 
   this.readOnly = true;
   return this.store;
-};
+};

package.json

@@ -15,7 +15,7 @@
   "dependencies": {
     "async": "~0.9.0",
     "ini": "1.x.x",
-    "optimist": "~0.6.0"
+    "yargs": "~3.15.0"
   },
   "devDependencies": {
     "vows": "0.8.x"
@@ -28,4 +28,3 @@
     "node": ">= 0.4.0"
   }
 }
-

test/fixtures/scripts/nconf-argv.js

@@ -1,10 +1,10 @@
 /*
- * default-argv.js: Test fixture for using optimist defaults with nconf.
+ * default-argv.js: Test fixture for using yargs defaults with nconf.
  *
  * (C) 2011, Charlie Robbins and the Contributors.
  *
  */
 
 var nconf = require('../../../lib/nconf').argv().env();
 
-process.stdout.write(nconf.get('something'));
+process.stdout.write(nconf.get('something'));

test/fixtures/scripts/nconf-hierarchical-file-argv.js

@@ -1,5 +1,5 @@
 /*
- * nconf-hierarchical-file-argv.js: Test fixture for using optimist defaults and a file store with nconf.
+ * nconf-hierarchical-file-argv.js: Test fixture for using yargs defaults and a file store with nconf.
  *
  * (C) 2011, Charlie Robbins and the Contributors.
  * (C) 2011, Sander Tolsma
@@ -14,4 +14,4 @@ nconf.add('file', {
   file: path.join(__dirname, '../hierarchy/hierarchical.json')
 });
 
-process.stdout.write(nconf.get('something') || 'undefined');
+process.stdout.write(nconf.get('something') || 'undefined');

test/fixtures/scripts/nconf-hierarchical-load-save.js

@@ -1,5 +1,5 @@
 /*
- * nconf-hierarchical-load-save.js: Test fixture for using optimist, envvars and a file store with nconf.
+ * nconf-hierarchical-load-save.js: Test fixture for using yargs, envvars and a file store with nconf.
  *
  * (C) 2011, Charlie Robbins and the Contributors.
  *
@@ -29,4 +29,4 @@ process.stdout.write(nconf.get('foo'));
 //
 // Save the configuration object to disk
 //
-nconf.save();
+nconf.save();

test/fixtures/scripts/provider-argv.js

@@ -1,5 +1,5 @@
 /*
- * provider-argv.js: Test fixture for using optimist defaults with nconf.
+ * provider-argv.js: Test fixture for using yargs defaults with nconf.
  *
  * (C) 2011, Charlie Robbins and the Contributors.
  *
@@ -9,4 +9,4 @@ var nconf = require('../../../lib/nconf');
 
 var provider = new (nconf.Provider)().argv();
 
-process.stdout.write(provider.get('something'));
+process.stdout.write(provider.get('something'));