@suitest/translate
v4.18.0
Published
A module that translate Suitest server messages to human readable strings
Downloads
18,908
Readme
Suitest test execution results translation
This package contains all results that Suitest may return for the test execution and translations for those errors.
Error translations support small subset of Markdown text formatting:
- Bold text
**bold**
- Code block
`code`
- Hyperlinks
[text](url){attribute: 'value'}
- Images
![caption](src){attribute: 'value'}
Messages are split into following categories:
Using the library
Library provides 2 builds: UMD library is loaded by default when importing
@suitest/translate
and commonJS is available in case you need to import
specific files. E.g. if you would want to get a list of Suitest message
code you could import @suitest/translate/commonjs/constants.js
.
The UMD build is isomorphic and already minified. It has one peer dependency - "unist-builder". Make sure it's either available is node_modules (when running in NodeJS), or as a global "ub" variable in browser.
CommonJS build is not minified and meant to be used with NodeJS (or with bundler).
Lines and line result translation
@suitest/translate
can translate a line (optionally with line result) into a smst format. Then, you can use
one of the following libs to convert smst into human readable language:
- @suitest/smst-to-text - to convert it to the plain text format
- @suitest/smst-to-html - to convert it to HTML fragment
For a complete demo on library usage check out SuitestAutomation/translate-demo repo.