yargs 3.21.1 → 3.23.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## Change Log
 
+### v3.23.0 (2015/08/30 23:00 +00:00)
+
+- [#246](https://github.com/bcoe/yargs/pull/246) detect locale based only on environment variables (@bcoe)
+- [#244](https://github.com/bcoe/yargs/pull/244) adds Windows CI testing (@bcoe)
+- [#245](https://github.com/bcoe/yargs/pull/245) adds OSX CI testing (@bcoe, @nexdrew)
+
+### v3.22.0 (2015/08/28 22:26 +00:00)
+- [#242](https://github.com/bcoe/yargs/pull/242) adds detectLocale config option (@bcoe)
+
 ### v3.21.1 (2015/08/28 20:58 +00:00)
 - [#240](https://github.com/bcoe/yargs/pull/240) hot-fix for Atom on Windows (@bcoe)
 

package/README.md

@@ -9,6 +9,7 @@ With yargs, ye be havin' a map that leads straight to yer treasure! Treasure of
 [![Dependency Status][gemnasium-image]][gemnasium-url]
 [![Coverage Status][coveralls-image]][coveralls-url]
 [![NPM version][npm-image]][npm-url]
+[![Windows Tests][windows-image]][windows-url]
 
 > Yargs is the official successor to optimist. Please feel free to submit issues and pull requests. If you'd like to contribute and don't know where to start, have a look at [the issue list](https://github.com/bcoe/yargs/issues) :)
 
@@ -655,8 +656,7 @@ Optionally `.implies()` can accept an object specifying multiple implications.
 
 Return the locale that yargs is currently using.
 
-By default, yargs will auto-detect the operating system's locale
-(via [os-locale](https://www.npmjs.com/package/os-locale)) so that
+By default, yargs will auto-detect the operating system's locale so that
 yargs-generated help content will display in the user's language.
 
 To override this behavior with a static locale, pass the desired locale as a
@@ -717,6 +717,11 @@ To submit a new translation for yargs:
 1. use `./locales/en.json` as a starting point.
 2. submit a pull request with the new locale file.
 
+.detectLocale(boolean)
+-----------
+
+Should yargs attempt to detect the os' locale? defaults to `true`.
+
 .nargs(key, count)
 -----------
 
@@ -1084,3 +1089,5 @@ This module is loosely inspired by Perl's
 [coveralls-image]: https://img.shields.io/coveralls/bcoe/yargs.svg
 [npm-url]: https://npmjs.org/package/yargs
 [npm-image]: https://img.shields.io/npm/v/yargs.svg
+[windows-url]: https://ci.appveyor.com/project/bcoe/yargs
+[windows-image]: https://img.shields.io/appveyor/ci/bcoe/yargs/master.svg?label=Windows%20Tests

package/index.js

@@ -1,6 +1,6 @@
 var assert = require('assert')
 var Completion = require('./lib/completion')
-var osLocale = require('os-locale')
+var locale = require('./lib/locale')
 var Parser = require('./lib/parser')
 var path = require('path')
 var Usage = require('./lib/usage')
@@ -19,7 +19,6 @@ function Argv (processArgs, cwd) {
   var validation = null
   var y18n = Y18n({
     directory: path.resolve(__dirname, './locales'),
-    locale: guessLocale(),
     updateFiles: false
   })
 
@@ -408,16 +407,30 @@ function Argv (processArgs, cwd) {
   }
 
   self.locale = function (locale) {
-    if (arguments.length === 0) return y18n.getLocale()
+    if (arguments.length === 0) {
+      guessLocale()
+      return y18n.getLocale()
+    }
+    detectLocale = false
     y18n.setLocale(locale)
     return self
   }
 
   self.updateStrings = self.updateLocale = function (obj) {
+    detectLocale = false
     y18n.updateLocale(obj)
     return self
   }
 
+  var detectLocale = true
+  self.detectLocale = function (detect) {
+    detectLocale = detect
+    return self
+  }
+  self.getDetectLocale = function () {
+    return detectLocale
+  }
+
   self.getUsageInstance = function () {
     return usage
   }
@@ -454,6 +467,8 @@ function Argv (processArgs, cwd) {
 
     self.parsed = parsed
 
+    guessLocale() // guess locale lazily, so that it can be turned off in chain.
+
     // while building up the argv object, there
     // are two passes through the parser. If completion
     // is being performed short-circuit on the first pass.
@@ -532,11 +547,8 @@ function Argv (processArgs, cwd) {
   }
 
   function guessLocale () {
-    try {
-      return osLocale.sync()
-    } catch (err) {
-      return 'en'
-    }
+    if (!detectLocale) return
+    self.locale(locale())
   }
 
   function setPlaceholderKeys (argv) {

package/lib/locale.js

@@ -0,0 +1,19 @@
+// port of https://github.com/sindresorhus/os-locale
+// that only looks at environment variables.
+module.exports = function () {
+  return getEnvLocale()
+}
+
+function getEnvLocale () {
+  var env = process.env
+  var ret = env.LC_ALL || env.LANGUAGE || env.LANG || env.LC_MESSAGES
+  return getLocale(ret)
+}
+
+function getLocale (str) {
+  return (str && str.replace(/[.:].*/, '')) || fallback()
+}
+
+function fallback () {
+  return 'en_US'
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yargs",
-  "version": "3.21.1",
+  "version": "3.23.0",
   "description": "Light-weight option parsing with an argv hash. No optstrings attached.",
   "main": "./index.js",
   "files": [
@@ -14,7 +14,6 @@
     "camelcase": "^1.2.1",
     "cliui": "^2.1.0",
     "decamelize": "^1.0.0",
-    "os-locale": "^1.2.1",
     "window-size": "^0.1.2",
     "y18n": "^3.1.0"
   },
@@ -22,12 +21,13 @@
     "chai": "^3.2.0",
     "coveralls": "^2.11.4",
     "hashish": "0.0.4",
-    "mocha": "^2.2.5",
+    "mocha": "^2.3.0",
     "nyc": "^3.1.0",
-    "standard": "^5.1.0"
+    "standard": "^5.1.1"
   },
   "scripts": {
-    "test": "standard && nyc mocha --check-leaks",
+    "test": "standard && nyc mocha --timeout=4000 --check-leaks",
+    "test-windows": "mocha --timeout=4000",
     "coverage": "nyc report --reporter=text-lcov | coveralls"
   },
   "repository": {