update readme
This commit is contained in:
Родитель
33aa03952a
Коммит
d654123fea
|
@ -5,6 +5,7 @@ MSLG is a command line tool that parses .lg files which adheres to the [LG file
|
||||||
- Report an error on invalid .lg file. All errors that are statically detectable are reported.
|
- Report an error on invalid .lg file. All errors that are statically detectable are reported.
|
||||||
- Generate a collated .lg file by parsing and analyzing more than one .lg files.
|
- Generate a collated .lg file by parsing and analyzing more than one .lg files.
|
||||||
- Expand any given template (or all templates in a file) based on test values for entity references.
|
- Expand any given template (or all templates in a file) based on test values for entity references.
|
||||||
|
- Translate .lg files to a target language by microsoft translation API.
|
||||||
|
|
||||||
## Prerequisite
|
## Prerequisite
|
||||||
|
|
||||||
|
@ -23,7 +24,7 @@ npm i -g mslg
|
||||||
|
|
||||||
Usage: mslg [command] [options]
|
Usage: mslg [command] [options]
|
||||||
|
|
||||||
mslg is a command line tool to parse and collate lg files or expand lg templates.
|
MSLG is a command line tool to parse, collate, expand and translate lg files.
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
|
|
||||||
|
@ -34,6 +35,7 @@ npm i -g mslg
|
||||||
|
|
||||||
parse|p Parse any provided .lg file and collate them into a single file.
|
parse|p Parse any provided .lg file and collate them into a single file.
|
||||||
expand|d Expand one or all templates in a .lg file or an inline expression.
|
expand|d Expand one or all templates in a .lg file or an inline expression.
|
||||||
|
translate|t Translate .lg files to a target language by microsoft translation API.
|
||||||
help [cmd] display help for [cmd]
|
help [cmd] display help for [cmd]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -75,6 +77,24 @@ npm i -g mslg
|
||||||
-h, --help output usage information
|
-h, --help output usage information
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Translate command
|
||||||
|
```
|
||||||
|
Usage: mslg translate [options]
|
||||||
|
|
||||||
|
Translate .lg files to a target language by microsoft translation API.
|
||||||
|
|
||||||
|
Options:
|
||||||
|
-k, --translate_key <translatorKey> Microsoft translation API key
|
||||||
|
-t, --target_lang <targetLang> Target language to localize content to. See https://aka.ms/translate-langs for list of supported languages and codes. You can also specify comma or space delimited list of target languages.
|
||||||
|
--in <lgFile> A direct .lg file passed in
|
||||||
|
-l, --lg_folder <folder_name> [Optional] Relative or absolute path to a folder containing .lg files
|
||||||
|
-s, --subfolder [Optional] Flag option used to denote that subfolders need to be recursively checked to find .lg files
|
||||||
|
-o, --out_folder <output_folder> [Optional] output folder to write out the final .lg file
|
||||||
|
-c, --translate_comments [Optional] Flag option to indicate if comments in the input file is also translated. Default is set to false
|
||||||
|
--verbose [Optional] Flag option used to request verbose output. With this option set, additional useful parse, validate and collate logs are written to stdout
|
||||||
|
-h, --help output usage information
|
||||||
|
```
|
||||||
|
|
||||||
## Sample Usage
|
## Sample Usage
|
||||||
- [More Samples](examples/samples.md)
|
- [More Samples](examples/samples.md)
|
||||||
|
|
||||||
|
@ -92,3 +112,7 @@ mslg parse -l examples/validExamples -s --out finalResult -c // parse and mer
|
||||||
```bash
|
```bash
|
||||||
mslg expand --in examples/validExamples/simple.lg -t FinalGreeting // basic usage of expand command.
|
mslg expand --in examples/validExamples/simple.lg -t FinalGreeting // basic usage of expand command.
|
||||||
```
|
```
|
||||||
|
### Translate
|
||||||
|
```
|
||||||
|
mslg translate -k your_translate_Key -t your_target_lang --in examples/validExamples/translator.lg -c // basic usage of translate command.
|
||||||
|
```
|
|
@ -47,3 +47,14 @@ mslg expand --in validExamples/simepleWithVariables.lg --all -j variables.json
|
||||||
```bash
|
```bash
|
||||||
mslg expand --in validExamples/simepleWithVariables.lg --all -i // expand all the templates and get the variable values from stdin prompts.
|
mslg expand --in validExamples/simepleWithVariables.lg --all -i // expand all the templates and get the variable values from stdin prompts.
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Translate
|
||||||
|
Translate .lg files to a target language by microsoft translation API.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
mslg translate -k your_translate_Key -t your_target_lang --in validExamples/translator.lg -c // translate specific lg file to target language, including comments.
|
||||||
|
```
|
||||||
|
|
||||||
|
```bash
|
||||||
|
mslg translate -k your_translate_Key -t your_target_lang -l validExamples -s -o validExamples/output --verbose // translate all lg files from a specific folder, including sub folders and output the generated files to a specific folder.
|
||||||
|
```
|
|
@ -16,7 +16,7 @@ program.Command.prototype.unknownOption = function () {
|
||||||
program
|
program
|
||||||
.version(pkg.version, '-v, --Version')
|
.version(pkg.version, '-v, --Version')
|
||||||
.usage('[command] [options]')
|
.usage('[command] [options]')
|
||||||
.description('MSLG is a command line tool to parse and collate lg files or expand lg templates.')
|
.description('MSLG is a command line tool to parse, collate, expand and translate lg files.')
|
||||||
.command('parse', 'Parse any provided .lg file and collate them into a single file.')
|
.command('parse', 'Parse any provided .lg file and collate them into a single file.')
|
||||||
.alias('p')
|
.alias('p')
|
||||||
.command('expand', 'Expand one or all templates in a .lg file or an inline expression.')
|
.command('expand', 'Expand one or all templates in a .lg file or an inline expression.')
|
||||||
|
|
Загрузка…
Ссылка в новой задаче