Thanks to contributors, Feri is currently available in the following languages.
- English (US)
- French (France)
- German (Germany and Switzerland)
- Italian (Italy and Switzerland)
- Portuguese (Brazil)
- Swedish (Sweden)
Additional languages are always welcome. Details on how to create a translation are available in the translation guide.
Specifying a language is accomplished with a custom config file.
For example, if we wanted to work in Swedish we would create a custom config file in our project directory with the following code in it:
module.exports = function(feri) {
feri.config.language = 'sv-se'
}By setting feri.config.language to sv-se, we are telling Feri to look in its own language directory for a file called sv-se.json. Assuming the language file exists and is valid, the next time you run Feri you'll be doing so in a certain Muppet Chef's preferred language!
In addition to US English, Feri stores translations inside her language directory. Files are named by language, then country, and saved as JSON.
To make a new translation, start by copying en-us.json to a new file. If you are not sure which language or country abbreviation to use, feel free to name your file new.json or similar.
Now that you have your own file to work in, let's go over the hierarchy of a language file in more detail.
This section contains various error messages in sentence format.
"error": {
"concatInclude" : "Warning: Concat files can use includes but should never be an include themselves.",
"configPaths" : "Source and destination should be unique and not nested within each other.",
"destPointsToSource" : "Destination points to a source directory.",
"destProtected" : "Destination should not be a protected location like {path}.",
"halted" : "Halted {software} version {version} due to errors.",
"locationInCode" : "{error} on line {number} character {position}.",
"missingDest" : "Missing destination file.",
"missingSource" : "Missing source file.",
"missingSourceDirectory": "Missing source directory.",
"removeDest" : "Source file delete ignored since source files should never be harmed.",
"watchingDest" : "Error watching destination folder.",
"watchingSource" : "Error watching source folder."
}Certain messages have special placeholders like {software}. These placeholders get replaced at run time, so a string like:
Halted {software} version {version} due to errors.
Will display like:
Halted Feri version 1.0 due to errors.
Having placeholders means you can change their order to better suit your language of choice.
This section contains various informative messages in sentence format.
"message": {
"fileChangedTooRecently" : "{file} was changed too recently, ignoring.",
"fileWasNotBuilt" : "File was not built.",
"includesNewer" : "{extension} include(s) newer than destination file.",
"listeningOnPort" : "{software} listening on port {port}.",
"missingSourceHelp" : "Check your folders for existing projects or run \"feri --init\" to start a new project.",
"missingSourceToDestTasks": "Missing config.map.sourceToDestTasks for the following file types:",
"usingConfigFile" : "Using {file} file.",
"watchRefreshed" : "{software} refreshed.",
"watchingDirectory" : "Watching {directory} for changes."
}Much like the Error section before it, placeholders are used so a string like:
Watching {directory} for changes.
Will display like:
Watching /source for changes.
Padded Groups are words, optionally padded with spaces so they line up nicely when displayed.
"paddedGroups": {
"build": {
"output": "output",
"copy" : "copy "
},
"stats": {
"load" : "Load ",
"clean": "Clean",
"build": "Build",
"watch": "Watch",
"total": "Total"
}
}Each word in a group should be padded with enough spaces to equal the longest string from that same group.
For example, paddedGroups.build has two keys, output and copy. The longest string is output with 6 characters. Extra spaces were added copy to reach a matching length of 6 characters. Now they both display nicely together.
Same idea for paddedGroups.stats except the longest strings here are 5 characters. Adding 1 space to load allows all of these strings to line up nicely when displayed.
Words get used in all sorts of places. Let's go over examples for each to understand them better.
"words": {
"add" : "add",
"addDirectory" : "add dir",
"build" : "Build",
"clean" : "Clean",
"change" : "change",
"done" : "Done",
"in" : "in",
"removed" : "removed",
"removedDirectory": "removed dir",
"seconds" : "seconds",
"stats" : "Stats",
"watch" : "Watch",
"watching" : "Watching"
}Add is used when a file is added while watching. For example...
/source/index.html add
Add Directory is used when a folder is added while watching. For example...
/source/new_folder add dir
Build is the title that displays once before any building tasks.
Clean is the title that displays once before any cleaning tasks.
Change is used when a file changes while watching. For example...
/source/index.html change
/dest/index.html change
Done is displayed after a clean or build phase if cleaning or building was not needed.
In is used to construct error messages like Error in /source/file.js.
Removed is used throughout Feri to indicate that a file was removed. For example...
/dest/old.txt removed
Removed Directory is used when a folder is removed while watching. For example...
/dest/old_folder removed dir
Seconds is only displayed when displaying statistics. For example...
Total 0.392 seconds
Stats is the title that displays once before listing statistics.
Watch is the title that displays once before listing which folders are being watched.
Watching is the title that displays once before Feri goes into watch mode.
Firstly, you are awesome! Thank you.
If you have not already, try testing your translation with different command line switches like --republish, --watch, and/or --extensions to see how everything looks. Once everything is set you can send a pull request.