Outdated version

You are viewing the outdated version of Timeago library. Switch to the latest version to get all the new features and improvements

Contribute translation

You can contribute a language support in 3 simple steps. All you need to do is to copy/paste 2 files and change them to match the language that you want to add.

Here is my commit for supporting Dutch language that shows changes that I did to add the support. It's pretty straightforward. Waiting for you PR 😉.

TIP

You can skip the step with README.md file, since all the documentation is here instead of a README.md file like it was before.

Step 1. Add translation file

Translation files live in langs directory. Each translation file is pretty simple JSON object. Here's the example of en.json.

{
    "Ago": "ago",
    "Online": "Online",
    "JustNow": "Just now",
    "Second": "second",
    "Seconds": "seconds",
    "Minute": "minute",
    "Minutes": "minutes",
    "Hour": "hour",
    "Hours": "hours",
    "Day": "day",
    "Days": "days",
    "Week": "week",
    "Weeks": "weeks",
    "Month": "month",
    "Months": "months",
    "Year": "year",
    "Years": "years"
}

Some languages (like Russian) have multiple plural forms of the word. For example English has only second and seconds, but Russian language has 3 types секунда, секунд and секунды. For these cases we can add additional translation for seconds, minutes, hours, days, weeks, months and years. Here is the example of ru.json.

{
    "Ago": "назад",
    "Online": "В сети",
    "JustNow": "Только что",
    "Second": "секунда",
    "Seconds": "секунды",
    "SecondsSpecial": "секунд",
    "Minute": "минута",
    "Minutes": "минуты",
    "MinutesSpecial": "минут",
    "Hour": "час",
    "Hours": "часа",
    "HoursSpecial": "часов",
    "Day": "день",
    "Days": "дня",
    "DaysSpecial": "дней",
    "Week": "неделя",
    "Weeks": "недели",
    "WeeksSpecial": "недель",
    "Month": "месяц",
    "Months": "месяца",
    "MonthsSpecial": "месяцев",
    "Year": "год",
    "Years": "года",
    "YearsSpecial": "лет"
}

You can see that it has SecondsSpecial, MinutesSpecial, HoursSpecial, DaysSpecial, WeeksSpecial and YearsSpecial keys. Those are responsible for special age cases.

Step 2. Add language rules

All rules for each language is defined in getRules function in rules.go file. Rule is just a set of conditions that define when to apply singular form and when to apply plural form.

Here is the example for English rules:

func getRules(number, lastDigit int) map[string]Rule {
	return map[string]Rule{
		"en": {
			Single: number == 1,
			Plural: number > 1 || number == 0,
		},
	}
}

We'll use singular form when number is equal to 1, and plural if number is more than 1 or number is 0. You can easily write your own rules for your language.

Step 3. Add tests

Tests for languages live in tests directory. Each language has it's own file. The easies way to add tests for your language is to copy paste one of the tests and change it to match your language.