axe-core/build/tasks/add-locale.js

Accessibility engine for automated Web UI testing

/*eslint-env node */
'use strict';
var clone = require('clone');
var buildManual = require('../build-manual');

module.exports = function (grunt) {
	function mergeMessages (newMessages, oldMessages) {
		Object.keys(newMessages).forEach(function (key) {
			if (!oldMessages.hasOwnProperty(key)) {
				return;
			}

			var newValue = newMessages[key];
			var oldValue = oldMessages[key];

			if (typeof newValue === 'object') {
				// the message format might be changed, ignore old message
				if (typeof oldValue !== 'object') {
					return;
				}

				newMessages[key] = mergeMessages(clone(newValue), oldValue);
			} else {
				newMessages[key] = clone(oldValue);
			}
		});

		return newMessages;
	}

	grunt.registerMultiTask('add-locale',
		'Task for localizing messages in rules and checks',
		function () {
			var options = this.options({
				rules: ['lib/rules/**/*.json'],
				checks: ['lib/checks/**/*.json'],
				tools: ['lib/tools/**/*.json'],
				misc: ['lib/misc/**/*.json'],
				blacklist: ['metadata'],
				tags: '',
				lang: 'xxx'
			});

			this.files.forEach(function (file) {
				var commons = file.src[0];

				buildManual(grunt, options, commons, function (result) {
					var out = {
						lang: options.lang,
						rules: result.rules.reduce(function (out, rule) {
							out[rule.id] = rule.metadata;
							return out;
						}, {}),
						checks: result.checks.reduce(function (out, check) {
							if (check.metadata) {
								out[check.id] = check.metadata.messages;
							}
							return out;
						}, {}),
						failureSummaries: result.misc.reduce(function (out, misc) {
							out[misc.type] = misc.metadata;
							return out;
						}, {}),
						incompleteFallbackMessage: result.misc.reduce(function (out, misc) {
							out[misc.incompleteFallbackMessage] = misc.metadata;
							return out;
						}, {})
					};

					// update locale file if exists
					var localeFile = './locales/' + options.lang + '.json';
					if (grunt.file.exists(localeFile)) {
						var oldMessages = grunt.file.readJSON(localeFile);

						// mergeMessages mutates out
						mergeMessages(out, oldMessages);
					}

					grunt.file.write(file.dest, JSON.stringify(out, null, '  '));
					console.log('created file at', file.dest);
				});
			});
		}
	);
};