@qualweb/locale

@qualweb/locale

Translation module for QualWeb reports.

Notice

WORK IN PROGRESS.

How to install

  $ npm i @qualweb/locale --save

Language support

Language	Code	Modules support
act-rules	wcag-techniques	best-practices
English	en	Full	No	Full
Portuguese	pt	Partial	No	No

How to run

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);
  });

License

ISC