Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added options to specify which worksheet to use, or use all worksheets #11

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Added options to specify which worksheet to use, or use all worksheets #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
08a1741
Added the option to specify which worksheet to use.
Nov 27, 2014
36af070
Updates to config
Jun 2, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Gruntfile.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ module.exports = function(grunt) {
key_column: 'key',
output_dir: 'tmp',
// this document key points to the test file -- see readme for more info
document_key: '0Araic6gTol6SdEtwb1Badl92c2tlek45OUxJZDlyN2c',
document_key: '17i9VdgI2_jEq7tLmkA6YtwswjOAyH_8hyGJW7xG2LzU',
write_default_translations: true
}
}
Expand Down
24 changes: 23 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Set to true to prompt for username and password instead of using `options.google
#### options.document_key
Type: `String` (required)

The spreadsheet key. You can get this from the URL while viewing your spreadsheet
The spreadsheet key. You can get this from the URL while viewing your spreadsheet
*Example: `https://docs.google.com/spreadsheet/ccc?key=<THE-KEY-IS-THIS-THING>#gid=0`*

#### options.key_column
Expand All @@ -86,6 +86,28 @@ Type: `Boolean` -- Default: `true`

Enable/disable sorting of the translation keys before writing to the file. If false, translations will appear in the same order as they do in the spreadsheet.

#### options.use_all_worksheets
Type: `Boolean` -- Default: `false`

Set to true to parse all worksheets. This allows you to break up your localisation spreadsheet into more manageable worksheets if you have a lot of content and/or locales.

#### options.worksheet_id: 1,
Type: `Integer` -- Default: `1`

An integer value to signify which worksheet to use - this will be ignored if the `use_all_worksheets` option (above) is set to `true`.

**NOTE** the worksheet index starts from 1, not 0.

#### options.use_worksheet_namespacing
Type: `Boolean` -- Default: `false`

Set to true to prefix all translation keys with the name of the selected worksheet. `"About us": "About us"` from `Sheet1` would become `"Sheet1-About us": "About us"`

#### options.prevent_conflicts
Type: `Boolean` -- Default: `true`

Set to true to throw an error if any duplicate translation keys are encountered for any locale. This is useful if the `use_all_worksheets` option (above) is set to `true` and the `use_worksheet_namespacing` option (above) is set to `false` and you inadvertently duplicate translateion keys in different worksheets.

### Command Line Options

#### --regex-filter
Expand Down
15 changes: 11 additions & 4 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,23 @@
"test": "grunt test"
},
"devDependencies": {
"grunt-contrib-jshint": "~0.6.0",
"grunt": "~0.4.1",
"grunt-contrib-clean": "~0.4.0",
"grunt-contrib-nodeunit": "~0.2.0",
"grunt": "~0.4.1"
"grunt-contrib-jshint": "~0.6.0",
"grunt-contrib-nodeunit": "~0.2.0"
},
"peerDependencies": {
"grunt": "~0.4.1"
},
"keywords": [
"gruntplugin", "grunt", "i18n", "google", "spreadsheet", "gdocs", "locale", "translation"
"gruntplugin",
"grunt",
"i18n",
"google",
"spreadsheet",
"gdocs",
"locale",
"translation"
],
"dependencies": {
"google-spreadsheet": "~0.2.6",
Expand Down
115 changes: 79 additions & 36 deletions tasks/i18n_gspreadsheet.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,13 @@ module.exports = function(grunt) {
default_locale: 'en',
use_default_on_missing: false,
write_default_translations: false,
sort_keys: true
sort_keys: true,
use_all_worksheets: false,
worksheet_id: 1,
use_worksheet_namespacing: false,
prevent_conflicts: true
});

var regex_filter = grunt.option('regex-filter');
if (regex_filter) {
regex_filter = new RegExp(regex_filter);
Expand All @@ -51,6 +55,7 @@ module.exports = function(grunt) {

var locales = [];
var translations = {};
var worksheets = {};
var gsheet = new GoogleSpreadsheet( options.document_key );
var output_dir = path.resolve( process.cwd() + '/' + options.output_dir );

Expand Down Expand Up @@ -90,57 +95,95 @@ module.exports = function(grunt) {
grunt.log.error('Invalid google credentials for "' + options.google_account + '"');
return done( false );
}

gsheet.getRows( 1, this );
gsheet.getInfo( this );
},
function buildTranslationJson(err, rows){
function fetchRowData(err, info){
if ( err ){
grunt.log.error( err );
grunt.log.error('Error getting sheet info');
return done( false );
}
if ( rows.length === 0 ){
grunt.log.error('ERROR: no translations found in sheet');
worksheets = info.worksheets;
grunt.log.writeln( 'Found ' + worksheets.length + ' worksheets');
var group = this.group();
if ( options.use_all_worksheets ) {
// Get rows from all worksheets
for( var i=1; i <= worksheets.length; i++){
gsheet.getRows( i, group() );
}
} else {
gsheet.getRows( options.worksheet_id, group() );
}
},
function buildTranslationJson(err, sheets){
if ( err ){
grunt.log.error( err );
return done( false );
}
sheets.forEach(function(rows, ind, arr){
var sheetTitle = '';
if ( options.use_all_worksheets ) {
sheetTitle = worksheets[ind].title;
} else {
sheetTitle = worksheets[options.worksheet_id - 1].title;
}
grunt.log.writeln('Processing worksheet: ' + sheetTitle);
if ( rows.length === 0 ){
grunt.log.error('ERROR: no translations found in sheet');
grunt.log.error(rows);
return done( false );
}

// First determine which locales are supported
var gsheet_keys = _(rows[0]).keys();
_(gsheet_keys).each(function(locale){
if ( locale != 'id' && locale.length == 2 ){
locales.push( locale );
translations[locale] = {};
if (regex_filter) {
try {
translations[locale] = JSON.parse(fs.readFileSync(output_dir + '/' + locale + options.ext));
// First determine which locales are supported
var gsheet_keys = _(rows[0]).keys();
_(gsheet_keys).each(function(locale){
if ( locale != 'id' && locale.length == 2 ){
if(locales.indexOf(locale) == -1) {
locales.push( locale );
translations[locale] = {};
}
if (regex_filter) {
try {
translations[locale] = JSON.parse(fs.readFileSync(output_dir + '/' + locale + options.ext));
}
catch (e) {}
}
catch (e) {}
}
}
});
});

grunt.log.writeln( 'Found '+ rows.length.toString().cyan +' translations in ' + locales.length.toString().cyan + ' languages' );

grunt.log.writeln( 'Found '+ rows.length.toString().cyan +' translations in ' + locales.length.toString().cyan + ' languages' );
// read all translations into an object with the correct keys
_(rows).each(function(row){
// if an key override column is set, check that first, then use the default locale

// read all translations into an object with the correct keys
_(rows).each(function(row){
// if an key override column is set, check that first, then use the default locale
var use_key_override = options.key_column && row[options.key_column];
var translation_key = use_key_override ? row[options.key_column] : row[options.default_locale];
if ( !translation_key ) return;
if (regex_filter && !regex_filter.test(translation_key)) return;

var use_key_override = options.key_column && row[options.key_column];
var translation_key = use_key_override ? row[options.key_column] : row[options.default_locale];
if ( !translation_key ) return;
if (regex_filter && !regex_filter.test(translation_key)) return;
_(locales).each(function(locale){
if(options.use_worksheet_namespacing){
translation_key = sheetTitle + '-' + translation_key;
}

_(locales).each(function(locale){
if( options.prevent_conflicts && translations[locale][translation_key]){
grunt.log.error('ERROR: duplicated / conflicting content found in ' + sheetTitle + ': ' + locale + ' - ' + translation_key);
return done( false );
}

if ( locale == options.default_locale ){
if ( use_key_override || options.write_default_translations ){
if ( locale == options.default_locale ){
if ( use_key_override || options.write_default_translations ){
translations[locale][translation_key] = row[locale];
}
} else if ( row[locale] ) {
translations[locale][translation_key] = row[locale];
} else if ( options.use_default_on_missing ){
translations[locale][translation_key] = row[options.default_locale];
}
} else if ( row[locale] ) {
translations[locale][translation_key] = row[locale];
} else if ( options.use_default_on_missing ){
translations[locale][translation_key] = row[options.default_locale];
}
});
});
});

this();
},
function ensureDirectoryExists(err){
Expand Down