cldr-data

Npm's cldr-data

Npm module for Unicode CLDR JSON data.

Goal

• Allow i18n libraries to define CLDR data as versioned "peer" dependency.
• Provide tools to assist (in other words, ease the pain) on fetching the data.

Bonus goals

• Optimal for backend development. (Frontend, see Bower's cldr-data).
• Optimal for Node.js environment. (AMD, see Bower's cldr-data).

Usage

On the package.json of your i18n library, define its CLDR data dependency. compatible with.

"peerDependencies": {
  "cldr-data": ">=25"
}

On your library, access CLDR JSON data using require("cldr-data").

cldr = require("cldr-data");

function Pluralize(locale) {
  var plurals = cldr("supplemental/plurals");
  var language = extractLanguageFrom(locale);

  // Your awesome pluralization logic
  pluralForm = doAwesomeStuffWith(
    plurals.supplemental["plurals-type-cardinal"][language]
  );

  return pluralForm;
}

For your convinience, use cldr-data in conjunction with cldr.js. You can find more details switching to the Foo Number Format Library Example or Application Example branches.

Locale coverage

By default, the locale coverage installed is core, which Unicode defines as the top tier languages and is equivalent to the json.zip content. There exists two solutions to get the full coverage: either by setting the environmental variable CLDR_COVERAGE to full or define the coverage in your package.json.

Environmental variable

In this example we are installing cldr-data by setting the CLDR_COVERAGE to full:

$ CLDR_COVERAGE=full npm install

package.json

Define your coverage by setting the property cldr-data-coverage in your `package.json:

{
	...
	"cldr-data-coverage": "full",
	...
}

License

MIT © Rafael Xavier de Souza