Elektron Translation Module
Welcome to the Elektron Translation Module.
This module defines the core structure of any translation provider service for the elektron framework.
Submodules will provide different implementations of this core definition for different technologies.
Getting Started
Tools
- latest current version of NodeJs
- We recommend using Visual Studio Code as a lot of settings are pre-configured for it.
Having your environment ready
npm i typescript tslint -g
Installing the dependencies
npm i
Building
npm run build
Debugging
Run this command from this repo:
npm link
(npm unlink to undo)
Create a project using the generator.
Run this command from the debugging repo:
npm link elektron-muon-translation
(npm unlink elektron-muon-translation to undo)
Publishing
Please refer to the following documentation
Continuous integration
Please refer to the following documentation
static analysis url.
No unit testing in place at the moment.
Contributing
Please refer to the following documentation
repo url
Providers
ITranslationProvider
This interface defines the structure to implement a translation provider.
SingleTranslationProvider
This class is a simple wrapper that can be extended to create new translation provider and is intended to provider a singleton.
Models
TranslationDictionary
Simple class allowing you to load more translations into the context for later reuse.