Translation module for QualWeb reports.
$ npm i @qualweb/locale --saveIf you want a translation on your own language, follow these steps:
- Make a copy of src/locales/en.json and rename it to use the lang code (check 639-1 column)
- Translate the modules you want
- Update the README.md language support table
- Make a pull request with the changes
| Language | Code | Modules support | ||
|---|---|---|---|---|
| act-rules | wcag-techniques | best-practices | ||
| English | en | Full | Full | Full |
| Finnish | fi | Full | none | none |
| Swedish | sv | Full | none | none |
| Norwegian Bokmål | nb | Full | none | none |
| Norwegian Nynorsk | nn | Full | none | none |
The best way to have a translated report is by using the @qualweb/core module, and passing the locale code you want in the options. If you really want to use this package separately bear in mind that the variables in the sentences wont be translated and some meaning can be lost.
'use strict';
import locales, { translateReport } from '@qualweb/locale';
async () => {
// EvaluationReport only. EARL report is not currently supported. If you need a EARL report, convert the evaluation report after the translation. Check https://github.com/qualweb/earl-reporter
const report = 'Evaluation report obtained from @qualweb/cli or @qualweb/core';
const translatedReport = translateReport(report, 'en');
// OR
const translatedReport = translateReport(report, locales.en);
// OR
const ownLocale = {
// If you have a compatible locale object
};
const translatedReport = translateReport(report, ownLocale);
console.log(translatedReport);
};ISC