Compare commits
69 Commits
Author | SHA1 | Date | |
---|---|---|---|
|
97e8937709 | ||
|
eb7f3f603e | ||
|
ab2b78eaec | ||
|
75ee2bdfda | ||
|
4fe3c43624 | ||
|
41bd679fcd | ||
|
24ebd8f428 | ||
|
e1bb5bfd02 | ||
|
1323c2e6a1 | ||
|
0f465014df | ||
|
5d5b07ba2c | ||
|
7eefd6c8d3 | ||
|
50fd3ae9e2 | ||
|
a5b8f6e6c6 | ||
|
3cbc20e0a0 | ||
|
7ce01b97e4 | ||
|
393e1ed03f | ||
|
8b014abf49 | ||
|
71cc6e6883 | ||
|
ceb4be7e3d | ||
|
e41fc88d97 | ||
|
ac551b1824 | ||
|
73877a5a35 | ||
|
6e161c83f8 | ||
|
7d1bcd2a80 | ||
|
bc2bfac7d7 | ||
|
c7563d4998 | ||
|
f9b3c63c4c | ||
|
9e5dad362c | ||
|
e133e0ce30 | ||
|
7ee0b7da71 | ||
|
c38ca59d43 | ||
|
98b84447c7 | ||
|
2507d0cdd2 | ||
|
69047857b2 | ||
|
04b6684024 | ||
|
9a8abb3248 | ||
|
c8ba1312b5 | ||
|
e0178b5a97 | ||
|
3e43fde1cc | ||
|
8493015e15 | ||
|
deb38eb7c3 | ||
|
36928e253d | ||
|
230b13e245 | ||
|
4fd7efa2dc | ||
|
02fc705bc0 | ||
|
cb53f6f3b1 | ||
|
842b0a7d97 | ||
|
f32128b2ec | ||
|
53eb4d1202 | ||
|
102286a209 | ||
|
ab29c9ab67 | ||
|
590f58fff3 | ||
|
d07d81681e | ||
|
141eaca7b1 | ||
|
7d5d38e6a1 | ||
|
64ebb5e6e8 | ||
|
40051f4144 | ||
|
14eb09f947 | ||
|
8d1e2c5a2f | ||
|
4892ea5146 | ||
|
ee28fe2a64 | ||
|
7c06b66974 | ||
|
b2ae17697d | ||
|
5259da8fe3 | ||
|
2d73f056ff | ||
|
fde5245731 | ||
|
4ee7258a31 | ||
|
a6c7af0630 |
2
.github/FUNDING.yml
vendored
Normal file
2
.github/FUNDING.yml
vendored
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
github: #biesbjerg
|
||||||
|
custom: https://donate.biesbjerg.com
|
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2017 Kim Biesbjerg
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
82
README.md
82
README.md
@@ -1,72 +1,84 @@
|
|||||||
If you like this project please show your support with a GitHub star. Much appreciated!
|
If this tool saves you time, please consider making a donation towards the continued maintainence and development: https://donate.biesbjerg.com
|
||||||
|
|
||||||
# ngx-translate-extract
|
[](https://donate.biesbjerg.com)
|
||||||
|
|
||||||
|
# Usage
|
||||||
|
|
||||||
|
## ngx-translate-extract
|
||||||
Extract translatable (ngx-translate) strings and save as a JSON or Gettext pot file.
|
Extract translatable (ngx-translate) strings and save as a JSON or Gettext pot file.
|
||||||
Merges with existing strings if the output file already exists.
|
Merges with existing strings if the output file already exists.
|
||||||
|
|
||||||
## Usage
|
### Usage
|
||||||
Install the package in your project:
|
Install the package in your project:
|
||||||
|
|
||||||
`npm install @biesbjerg/ngx-translate-extract --save-dev`
|
`npm install @biesbjerg/ngx-translate-extract --save-dev`
|
||||||
|
|
||||||
Add an `extract` script to your project's `package.json`:
|
Add a script to your project's `package.json`:
|
||||||
```
|
```json
|
||||||
|
...
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"extract": "ngx-translate-extract --input ./src --output ./src/assets/i18n/*.json --clean --sort --format namespaced-json"
|
"extract-i18n": "ngx-translate-extract --input ./src --output ./src/assets/i18n/ --clean --sort --format namespaced-json"
|
||||||
}
|
}
|
||||||
|
...
|
||||||
```
|
```
|
||||||
You can now run `npm run extract` to extract strings.
|
You can now run `npm run extract-i18n` and it will extract strings from your project.
|
||||||
|
|
||||||
## Extract examples
|
### Examples
|
||||||
|
|
||||||
**Extract from dir and save to file**
|
**Extract from dir and save to file**
|
||||||
|
|
||||||
`ngx-translate-extract -i ./src -o ./src/i18n/strings.json`
|
`ngx-translate-extract --input ./src --output ./src/assets/i18n/template.json`
|
||||||
|
|
||||||
**Extract from multiple dirs**
|
**Extract from multiple dirs**
|
||||||
|
|
||||||
`ngx-translate-extract -i ./src/folder-a ./src/folder-b -o ./src/i18n/strings.json`
|
`ngx-translate-extract --input ./src-a ./src-b --output ./src/assets/i18n/template.json`
|
||||||
|
|
||||||
**Extract and save to multiple files**
|
|
||||||
|
|
||||||
`ngx-translate-extract -i ./src -o ./src/i18n/{da,en,fr}.json`
|
**Extract and save to multiple files using path expansion**
|
||||||
|
|
||||||
**or**
|
_Note: This method does not work on Windows!_
|
||||||
|
|
||||||
`ngx-translate-extract -i ./src -o ./src/i18n/da.json ./src/i18n/en.json ./src/i18n/fr.json`
|
`ngx-translate-extract --input ./src --output ./src/i18n/{da,en}.json`
|
||||||
|
|
||||||
**or (update only)**
|
On Windows you must specify each output destination individually:
|
||||||
|
|
||||||
`ngx-translate-extract -i ./src -o ./src/i18n/*.json`
|
`ngx-translate-extract --input ./src --output ./src/i18n/da.json ./src/i18n/en.json`
|
||||||
|
|
||||||
**or (update only)**
|
### JSON indentation
|
||||||
|
Tabs are used by default for indentation when saving extracted strings in json formats:
|
||||||
## Custom indentation
|
|
||||||
By default, tabs are used for indentation when writing extracted strings to json formats:
|
|
||||||
|
|
||||||
`ngx-translate-extract -i ./src -o ./src/i18n/en.json --format-indentation $'\t'`
|
|
||||||
|
|
||||||
If you want to use spaces instead, you can do the following:
|
If you want to use spaces instead, you can do the following:
|
||||||
|
|
||||||
`ngx-translate-extract -i ./src -o ./src/i18n/en.json --format-indentation ' '`
|
`ngx-translate-extract --input ./src --output ./src/i18n/en.json --format-indentation ' '`
|
||||||
|
|
||||||
## Mark strings for extraction using a marker function
|
## Mark strings for extraction using a marker function
|
||||||
If, for some reason, you want to extract strings not passed directly to TranslateService, you can wrap them in a custom marker function.
|
If, for some reason, you want to extract strings not passed directly to `TranslateService`'s `get()` or `instant()` methods, you can wrap them in a marker function to let `ngx-translate-extract` know you want to extract them.
|
||||||
|
|
||||||
|
Install marker function:
|
||||||
|
`npm install @biesbjerg/ngx-translate-extract-marker`
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
import { _ } from '@biesbjerg/ngx-translate-extract';
|
import { marker } from '@biesbjerg/ngx-translate-extract-marker';
|
||||||
|
|
||||||
_('Extract me');
|
marker('Extract me');
|
||||||
```
|
```
|
||||||
|
|
||||||
Add the `marker` argument when running the extract script:
|
Add the `marker` argument when running the extract script:
|
||||||
|
|
||||||
|
`ngx-translate-extract ... -m extract`
|
||||||
|
|
||||||
|
You can alias the marker function if needed:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { marker as _ } from '@biesbjerg/ngx-translate-extract-marker';
|
||||||
|
|
||||||
|
_('Extract me');
|
||||||
|
```
|
||||||
|
|
||||||
`ngx-translate-extract ... -m _`
|
`ngx-translate-extract ... -m _`
|
||||||
|
|
||||||
Modify the scripts arguments as required.
|
|
||||||
|
|
||||||
## Commandline arguments
|
## Commandline arguments
|
||||||
```
|
```shell
|
||||||
Usage:
|
Usage:
|
||||||
ngx-translate-extract [options]
|
ngx-translate-extract [options]
|
||||||
|
|
||||||
@@ -76,20 +88,24 @@ Options:
|
|||||||
--input, -i Paths you would like to extract strings from. You
|
--input, -i Paths you would like to extract strings from. You
|
||||||
can use path expansion, glob patterns and multiple
|
can use path expansion, glob patterns and multiple
|
||||||
paths
|
paths
|
||||||
[array] [default: current working path]
|
[array] [default: current working path]
|
||||||
--patterns, -p Extract strings from the following file patterns
|
--patterns, -p Extract strings from the following file patterns
|
||||||
[array] [default: ["/**/*.html","/**/*.ts"]]
|
[array] [default: ["/**/*.html","/**/*.ts"]]
|
||||||
--output, -o Paths where you would like to save extracted
|
--output, -o Paths where you would like to save extracted
|
||||||
strings. You can use path expansion, glob patterns
|
strings. You can use path expansion, glob patterns
|
||||||
and multiple paths [array] [required]
|
and multiple paths [array] [required]
|
||||||
--marker, -m Extract strings passed to a marker function
|
|
||||||
[string] [default: false]
|
|
||||||
--format, -f Output format
|
--format, -f Output format
|
||||||
[string] [choices: "json", "namespaced-json", "pot"] [default: "json"]
|
[string] [choices: "json", "namespaced-json", "pot"] [default: "json"]
|
||||||
--format-indentation, --fi Output format indentation [string] [default: "\t"]
|
--format-indentation, --fi Output format indentation [string] [default: " "]
|
||||||
--replace, -r Replace the contents of output file if it exists
|
--replace, -r Replace the contents of output file if it exists
|
||||||
(Merges by default) [boolean] [default: false]
|
(Merges by default) [boolean] [default: false]
|
||||||
--sort, -s Sort strings in alphabetical order when saving
|
--sort, -s Sort strings in alphabetical order when saving
|
||||||
[boolean] [default: false]
|
[boolean] [default: false]
|
||||||
--clean, -c Remove obsolete strings when merging
|
--clean, -c Remove obsolete strings when merging
|
||||||
[boolean] [default: false]
|
[boolean] [default: false]
|
||||||
|
--key-as-default-value, -k Use key as default value for translations
|
||||||
|
[boolean] [default: false]
|
||||||
|
--null-as-default-value, -n Use null as default value for translations
|
||||||
|
[boolean] [default: false]
|
||||||
|
|
||||||
|
Arguments key-as-default-value and null-as-default-value are mutually exclusive
|
||||||
|
BIN
images/donate-badge.png
Normal file
BIN
images/donate-badge.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 16 KiB |
1678
package-lock.json
generated
Normal file
1678
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
57
package.json
57
package.json
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@biesbjerg/ngx-translate-extract",
|
"name": "@biesbjerg/ngx-translate-extract",
|
||||||
"version": "2.3.0",
|
"version": "4.1.0",
|
||||||
"description": "Extract strings from projects using ngx-translate",
|
"description": "Extract strings from projects using ngx-translate",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
"typings": "dist/index.d.ts",
|
"typings": "dist/index.d.ts",
|
||||||
@@ -24,10 +24,7 @@
|
|||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"angular",
|
"angular",
|
||||||
"angular2",
|
|
||||||
"ionic",
|
"ionic",
|
||||||
"ionic2",
|
|
||||||
"ng2-translate",
|
|
||||||
"ngx-translate",
|
"ngx-translate",
|
||||||
"extract",
|
"extract",
|
||||||
"extractor",
|
"extractor",
|
||||||
@@ -43,34 +40,38 @@
|
|||||||
},
|
},
|
||||||
"homepage": "https://github.com/biesbjerg/ngx-translate-extract",
|
"homepage": "https://github.com/biesbjerg/ngx-translate-extract",
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=4.3.2"
|
"node": ">=8"
|
||||||
},
|
},
|
||||||
"config": {},
|
"config": {},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/chai": "3.4.35",
|
"@types/chai": "^4.2.2",
|
||||||
"@types/glob": "5.0.30",
|
"@types/flat": "^0.0.28",
|
||||||
"@types/mocha": "2.2.40",
|
"@types/glob": "^7.1.1",
|
||||||
"@types/cheerio": "0.22.1",
|
"@types/mkdirp": "^0.5.2",
|
||||||
"@types/chalk": "0.4.31",
|
"@types/mocha": "^5.2.7",
|
||||||
"@types/flat": "0.0.28",
|
"@types/node": "^12.7.5",
|
||||||
"@types/yargs": "6.6.0",
|
"@types/yargs": "^13.0.2",
|
||||||
"@types/mkdirp": "0.3.29",
|
"chai": "^4.2.0",
|
||||||
"chai": "3.5.0",
|
"mocha": "^6.2.0",
|
||||||
"mocha": "3.2.0",
|
"ts-node": "^8.4.1",
|
||||||
"ts-node": "3.0.2",
|
"tslint": "^5.20.0",
|
||||||
"tslint": "5.0.0",
|
"tslint-eslint-rules": "^5.4.0"
|
||||||
"tslint-eslint-rules": "4.0.0",
|
|
||||||
"typescript": "2.2.2"
|
|
||||||
},
|
},
|
||||||
|
"bundledDependencies": [
|
||||||
|
"flat"
|
||||||
|
],
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"chalk": "1.1.3",
|
"@angular/compiler": "^8.2.6",
|
||||||
"yargs": "7.0.2",
|
"@phenomnomnominal/tsquery": "^3.0.0",
|
||||||
"cheerio": "0.22.0",
|
"boxen": "^4.1.0",
|
||||||
"fs": "0.0.1-security",
|
"colorette": "^1.1.0",
|
||||||
"gettext-parser": "1.2.2",
|
"flat": "github:lenchvolodymyr/flat#ffe77ef",
|
||||||
"glob": "7.1.1",
|
"gettext-parser": "^4.0.2",
|
||||||
"path": "0.12.7",
|
"glob": "^7.1.4",
|
||||||
"mkdirp": "0.5.1",
|
"mkdirp": "^0.5.1",
|
||||||
"flat": "2.0.1"
|
"path": "^0.12.7",
|
||||||
|
"terminal-link": "^2.0.0",
|
||||||
|
"typescript": "^3.6.3",
|
||||||
|
"yargs": "^14.0.0"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@@ -1,14 +1,20 @@
|
|||||||
|
import * as fs from 'fs';
|
||||||
|
import * as yargs from 'yargs';
|
||||||
|
|
||||||
import { ExtractTask } from './tasks/extract.task';
|
import { ExtractTask } from './tasks/extract.task';
|
||||||
import { ParserInterface } from '../parsers/parser.interface';
|
import { ParserInterface } from '../parsers/parser.interface';
|
||||||
import { PipeParser } from '../parsers/pipe.parser';
|
import { PipeParser } from '../parsers/pipe.parser';
|
||||||
import { DirectiveParser } from '../parsers/directive.parser';
|
import { DirectiveParser } from '../parsers/directive.parser';
|
||||||
import { ServiceParser } from '../parsers/service.parser';
|
import { ServiceParser } from '../parsers/service.parser';
|
||||||
import { FunctionParser } from '../parsers/function.parser';
|
import { MarkerParser } from '../parsers/marker.parser';
|
||||||
|
import { PostProcessorInterface } from '../post-processors/post-processor.interface';
|
||||||
|
import { SortByKeyPostProcessor } from '../post-processors/sort-by-key.post-processor';
|
||||||
|
import { KeyAsDefaultValuePostProcessor } from '../post-processors/key-as-default-value.post-processor';
|
||||||
|
import { NullAsDefaultValuePostProcessor } from '../post-processors/null-as-default-value.post-processor';
|
||||||
|
import { PurgeObsoleteKeysPostProcessor } from '../post-processors/purge-obsolete-keys.post-processor';
|
||||||
import { CompilerInterface } from '../compilers/compiler.interface';
|
import { CompilerInterface } from '../compilers/compiler.interface';
|
||||||
import { CompilerFactory } from '../compilers/compiler.factory';
|
import { CompilerFactory } from '../compilers/compiler.factory';
|
||||||
|
import { donateMessage } from '../utils/donate';
|
||||||
import * as fs from 'fs';
|
|
||||||
import * as yargs from 'yargs';
|
|
||||||
|
|
||||||
export const cli = yargs
|
export const cli = yargs
|
||||||
.usage('Extract strings from files for translation.\nUsage: $0 [options]')
|
.usage('Extract strings from files for translation.\nUsage: $0 [options]')
|
||||||
@@ -24,7 +30,7 @@ export const cli = yargs
|
|||||||
normalize: true
|
normalize: true
|
||||||
})
|
})
|
||||||
.check(options => {
|
.check(options => {
|
||||||
options.input.forEach((dir: string) => {
|
(options.input as unknown as string[]).forEach((dir: string) => {
|
||||||
if (!fs.existsSync(dir) || !fs.statSync(dir).isDirectory()) {
|
if (!fs.existsSync(dir) || !fs.statSync(dir).isDirectory()) {
|
||||||
throw new Error(`The path you supplied was not found: '${dir}'`);
|
throw new Error(`The path you supplied was not found: '${dir}'`);
|
||||||
}
|
}
|
||||||
@@ -45,12 +51,6 @@ export const cli = yargs
|
|||||||
normalize: true,
|
normalize: true,
|
||||||
required: true
|
required: true
|
||||||
})
|
})
|
||||||
.option('marker', {
|
|
||||||
alias: 'm',
|
|
||||||
describe: 'Extract strings passed to a marker function',
|
|
||||||
default: false,
|
|
||||||
type: 'string'
|
|
||||||
})
|
|
||||||
.option('format', {
|
.option('format', {
|
||||||
alias: 'f',
|
alias: 'f',
|
||||||
describe: 'Output format',
|
describe: 'Output format',
|
||||||
@@ -82,31 +82,57 @@ export const cli = yargs
|
|||||||
default: false,
|
default: false,
|
||||||
type: 'boolean'
|
type: 'boolean'
|
||||||
})
|
})
|
||||||
|
.option('key-as-default-value', {
|
||||||
|
alias: 'k',
|
||||||
|
describe: 'Use key as default value for translations',
|
||||||
|
default: false,
|
||||||
|
type: 'boolean'
|
||||||
|
})
|
||||||
|
.option('null-as-default-value', {
|
||||||
|
alias: 'n',
|
||||||
|
describe: 'Use null as default value for translations',
|
||||||
|
default: false,
|
||||||
|
type: 'boolean'
|
||||||
|
})
|
||||||
|
.conflicts('key-as-default-value', 'null-as-default-value')
|
||||||
.exitProcess(true)
|
.exitProcess(true)
|
||||||
.parse(process.argv);
|
.parse(process.argv);
|
||||||
|
|
||||||
const extract = new ExtractTask(cli.input, cli.output, {
|
const extractTask = new ExtractTask(cli.input as unknown as string[], cli.output, {
|
||||||
replace: cli.replace,
|
replace: cli.replace,
|
||||||
sort: cli.sort,
|
|
||||||
clean: cli.clean,
|
|
||||||
patterns: cli.patterns
|
patterns: cli.patterns
|
||||||
});
|
});
|
||||||
|
|
||||||
const compiler: CompilerInterface = CompilerFactory.create(cli.format, {
|
// Parsers
|
||||||
indentation: cli.formatIndentation
|
|
||||||
});
|
|
||||||
extract.setCompiler(compiler);
|
|
||||||
|
|
||||||
const parsers: ParserInterface[] = [
|
const parsers: ParserInterface[] = [
|
||||||
new PipeParser(),
|
new PipeParser(),
|
||||||
new DirectiveParser(),
|
new DirectiveParser(),
|
||||||
new ServiceParser()
|
new ServiceParser(),
|
||||||
|
new MarkerParser()
|
||||||
];
|
];
|
||||||
if (cli.marker) {
|
extractTask.setParsers(parsers);
|
||||||
parsers.push(new FunctionParser({
|
|
||||||
identifier: cli.marker
|
|
||||||
}));
|
|
||||||
}
|
|
||||||
extract.setParsers(parsers);
|
|
||||||
|
|
||||||
extract.execute();
|
// Post processors
|
||||||
|
const postProcessors: PostProcessorInterface[] = [];
|
||||||
|
if (cli.clean) {
|
||||||
|
postProcessors.push(new PurgeObsoleteKeysPostProcessor());
|
||||||
|
}
|
||||||
|
if (cli.keyAsDefaultValue) {
|
||||||
|
postProcessors.push(new KeyAsDefaultValuePostProcessor());
|
||||||
|
} else if (cli.nullAsDefaultValue) {
|
||||||
|
postProcessors.push(new NullAsDefaultValuePostProcessor());
|
||||||
|
}
|
||||||
|
if (cli.sort) {
|
||||||
|
postProcessors.push(new SortByKeyPostProcessor());
|
||||||
|
}
|
||||||
|
extractTask.setPostProcessors(postProcessors);
|
||||||
|
|
||||||
|
// Compiler
|
||||||
|
const compiler: CompilerInterface = CompilerFactory.create(cli.format, {
|
||||||
|
indentation: cli.formatIndentation
|
||||||
|
});
|
||||||
|
extractTask.setCompiler(compiler);
|
||||||
|
|
||||||
|
extractTask.execute();
|
||||||
|
|
||||||
|
console.log(donateMessage);
|
||||||
|
@@ -1,9 +1,10 @@
|
|||||||
import { TranslationCollection } from '../../utils/translation.collection';
|
import { TranslationCollection } from '../../utils/translation.collection';
|
||||||
import { TaskInterface } from './task.interface';
|
import { TaskInterface } from './task.interface';
|
||||||
import { ParserInterface } from '../../parsers/parser.interface';
|
import { ParserInterface } from '../../parsers/parser.interface';
|
||||||
|
import { PostProcessorInterface } from '../../post-processors/post-processor.interface';
|
||||||
import { CompilerInterface } from '../../compilers/compiler.interface';
|
import { CompilerInterface } from '../../compilers/compiler.interface';
|
||||||
|
|
||||||
import * as chalk from 'chalk';
|
import { cyan, green, bold, dim } from 'colorette';
|
||||||
import * as glob from 'glob';
|
import * as glob from 'glob';
|
||||||
import * as fs from 'fs';
|
import * as fs from 'fs';
|
||||||
import * as path from 'path';
|
import * as path from 'path';
|
||||||
@@ -11,126 +12,136 @@ import * as mkdirp from 'mkdirp';
|
|||||||
|
|
||||||
export interface ExtractTaskOptionsInterface {
|
export interface ExtractTaskOptionsInterface {
|
||||||
replace?: boolean;
|
replace?: boolean;
|
||||||
sort?: boolean;
|
|
||||||
clean?: boolean;
|
|
||||||
patterns?: string[];
|
patterns?: string[];
|
||||||
}
|
}
|
||||||
|
|
||||||
export class ExtractTask implements TaskInterface {
|
export class ExtractTask implements TaskInterface {
|
||||||
|
|
||||||
protected _options: ExtractTaskOptionsInterface = {
|
protected options: ExtractTaskOptionsInterface = {
|
||||||
replace: false,
|
replace: false,
|
||||||
sort: false,
|
|
||||||
clean: false,
|
|
||||||
patterns: []
|
patterns: []
|
||||||
};
|
};
|
||||||
|
|
||||||
protected _parsers: ParserInterface[] = [];
|
protected parsers: ParserInterface[] = [];
|
||||||
protected _compiler: CompilerInterface;
|
protected postProcessors: PostProcessorInterface[] = [];
|
||||||
|
protected compiler: CompilerInterface;
|
||||||
|
|
||||||
public constructor(protected _input: string[], protected _output: string[], options?: ExtractTaskOptionsInterface) {
|
public constructor(protected inputs: string[], protected outputs: string[], options?: ExtractTaskOptionsInterface) {
|
||||||
this._options = Object.assign({}, this._options, options);
|
this.inputs = inputs.map(input => path.resolve(input));
|
||||||
|
this.outputs = outputs.map(output => path.resolve(output));
|
||||||
|
this.options = { ...this.options, ...options };
|
||||||
}
|
}
|
||||||
|
|
||||||
public execute(): void {
|
public execute(): void {
|
||||||
if (!this._parsers) {
|
if (!this.compiler) {
|
||||||
throw new Error('No parsers configured');
|
|
||||||
}
|
|
||||||
if (!this._compiler) {
|
|
||||||
throw new Error('No compiler configured');
|
throw new Error('No compiler configured');
|
||||||
}
|
}
|
||||||
|
|
||||||
const collection = this._extract();
|
this.printEnabledParsers();
|
||||||
this._out(chalk.green('Extracted %d strings\n'), collection.count());
|
this.printEnabledPostProcessors();
|
||||||
this._save(collection);
|
this.printEnabledCompiler();
|
||||||
|
|
||||||
|
this.out(bold('Extracting:'));
|
||||||
|
const extracted = this.extract();
|
||||||
|
this.out(green(`\nFound %d strings.\n`), extracted.count());
|
||||||
|
|
||||||
|
this.out(bold('Saving:'));
|
||||||
|
|
||||||
|
this.outputs.forEach(output => {
|
||||||
|
let dir: string = output;
|
||||||
|
let filename: string = `strings.${this.compiler.extension}`;
|
||||||
|
if (!fs.existsSync(output) || !fs.statSync(output).isDirectory()) {
|
||||||
|
dir = path.dirname(output);
|
||||||
|
filename = path.basename(output);
|
||||||
|
}
|
||||||
|
|
||||||
|
const outputPath: string = path.join(dir, filename);
|
||||||
|
|
||||||
|
let existing: TranslationCollection = new TranslationCollection();
|
||||||
|
if (!this.options.replace && fs.existsSync(outputPath)) {
|
||||||
|
existing = this.compiler.parse(fs.readFileSync(outputPath, 'utf-8'));
|
||||||
|
}
|
||||||
|
|
||||||
|
// merge extracted strings with existing
|
||||||
|
const draft = extracted.union(existing);
|
||||||
|
|
||||||
|
if (existing.isEmpty()) {
|
||||||
|
this.out(dim(`- ${outputPath}`));
|
||||||
|
} else {
|
||||||
|
this.out(dim(`- ${outputPath} (merged)`));
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run collection through post processors
|
||||||
|
const final = this.process(draft, extracted, existing);
|
||||||
|
|
||||||
|
// Save to file
|
||||||
|
this.save(outputPath, final);
|
||||||
|
});
|
||||||
|
|
||||||
|
this.out(green('\nDone.\n'));
|
||||||
}
|
}
|
||||||
|
|
||||||
public setParsers(parsers: ParserInterface[]): this {
|
public setParsers(parsers: ParserInterface[]): this {
|
||||||
this._parsers = parsers;
|
this.parsers = parsers;
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public setPostProcessors(postProcessors: PostProcessorInterface[]): this {
|
||||||
|
this.postProcessors = postProcessors;
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
public setCompiler(compiler: CompilerInterface): this {
|
public setCompiler(compiler: CompilerInterface): this {
|
||||||
this._compiler = compiler;
|
this.compiler = compiler;
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Extract strings from input dirs using configured parsers
|
* Extract strings from specified input dirs using configured parsers
|
||||||
*/
|
*/
|
||||||
protected _extract(): TranslationCollection {
|
protected extract(): TranslationCollection {
|
||||||
this._out(chalk.bold('Extracting strings...'));
|
|
||||||
|
|
||||||
let collection: TranslationCollection = new TranslationCollection();
|
let collection: TranslationCollection = new TranslationCollection();
|
||||||
this._input.forEach(dir => {
|
this.inputs.forEach(dir => {
|
||||||
this._readDir(dir, this._options.patterns).forEach(path => {
|
this.readDir(dir, this.options.patterns).forEach(path => {
|
||||||
this._out(chalk.gray('- %s'), path);
|
this.out(dim('- %s'), path);
|
||||||
const contents: string = fs.readFileSync(path, 'utf-8');
|
const contents: string = fs.readFileSync(path, 'utf-8');
|
||||||
this._parsers.forEach((parser: ParserInterface) => {
|
this.parsers.forEach(parser => {
|
||||||
collection = collection.union(parser.extract(contents, path));
|
const extracted = parser.extract(contents, path);
|
||||||
|
if (extracted) {
|
||||||
|
collection = collection.union(extracted);
|
||||||
|
}
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
return collection;
|
return collection;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Process collection according to options (merge, clean, sort), compile and save
|
* Run strings through configured post processors
|
||||||
|
*/
|
||||||
|
protected process(draft: TranslationCollection, extracted: TranslationCollection, existing: TranslationCollection): TranslationCollection {
|
||||||
|
this.postProcessors.forEach(postProcessor => {
|
||||||
|
draft = postProcessor.process(draft, extracted, existing);
|
||||||
|
});
|
||||||
|
return draft;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Compile and save translations
|
||||||
* @param collection
|
* @param collection
|
||||||
*/
|
*/
|
||||||
protected _save(collection: TranslationCollection): void {
|
protected save(output: string, collection: TranslationCollection): void {
|
||||||
this._output.forEach(output => {
|
const dir = path.dirname(output);
|
||||||
const normalizedOutput: string = path.resolve(output);
|
if (!fs.existsSync(dir)) {
|
||||||
|
mkdirp.sync(dir);
|
||||||
let dir: string = normalizedOutput;
|
}
|
||||||
let filename: string = `strings.${this._compiler.extension}`;
|
fs.writeFileSync(output, this.compiler.compile(collection));
|
||||||
if (!fs.existsSync(normalizedOutput) || !fs.statSync(normalizedOutput).isDirectory()) {
|
|
||||||
dir = path.dirname(normalizedOutput);
|
|
||||||
filename = path.basename(normalizedOutput);
|
|
||||||
}
|
|
||||||
|
|
||||||
const outputPath: string = path.join(dir, filename);
|
|
||||||
let processedCollection: TranslationCollection = collection;
|
|
||||||
|
|
||||||
this._out(chalk.bold('\nSaving: %s'), outputPath);
|
|
||||||
|
|
||||||
if (fs.existsSync(outputPath) && !this._options.replace) {
|
|
||||||
const existingCollection: TranslationCollection = this._compiler.parse(fs.readFileSync(outputPath, 'utf-8'));
|
|
||||||
if (!existingCollection.isEmpty()) {
|
|
||||||
processedCollection = processedCollection.union(existingCollection);
|
|
||||||
this._out(chalk.dim('- merged with %d existing strings'), existingCollection.count());
|
|
||||||
}
|
|
||||||
|
|
||||||
if (this._options.clean) {
|
|
||||||
const collectionCount = processedCollection.count();
|
|
||||||
processedCollection = processedCollection.intersect(collection);
|
|
||||||
const removeCount = collectionCount - processedCollection.count();
|
|
||||||
if (removeCount > 0) {
|
|
||||||
this._out(chalk.dim('- removed %d obsolete strings'), removeCount);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (this._options.sort) {
|
|
||||||
processedCollection = processedCollection.sort();
|
|
||||||
this._out(chalk.dim('- sorted strings'));
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!fs.existsSync(dir)) {
|
|
||||||
mkdirp.sync(dir);
|
|
||||||
this._out(chalk.dim('- created dir: %s'), dir);
|
|
||||||
}
|
|
||||||
fs.writeFileSync(outputPath, this._compiler.compile(processedCollection));
|
|
||||||
|
|
||||||
this._out(chalk.green('Done!'));
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get all files in dir matching patterns
|
* Get all files in dir matching patterns
|
||||||
*/
|
*/
|
||||||
protected _readDir(dir: string, patterns: string[]): string[] {
|
protected readDir(dir: string, patterns: string[]): string[] {
|
||||||
return patterns.reduce((results, pattern) => {
|
return patterns.reduce((results, pattern) => {
|
||||||
return glob.sync(dir + pattern)
|
return glob.sync(dir + pattern)
|
||||||
.filter(path => fs.statSync(path).isFile())
|
.filter(path => fs.statSync(path).isFile())
|
||||||
@@ -138,8 +149,34 @@ export class ExtractTask implements TaskInterface {
|
|||||||
}, []);
|
}, []);
|
||||||
}
|
}
|
||||||
|
|
||||||
protected _out(...args: any[]): void {
|
protected out(...args: any[]): void {
|
||||||
console.log.apply(this, arguments);
|
console.log.apply(this, arguments);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
protected printEnabledParsers(): void {
|
||||||
|
this.out(cyan('Enabled parsers:'));
|
||||||
|
if (this.parsers.length) {
|
||||||
|
this.out(cyan(dim(this.parsers.map(parser => `- ${parser.constructor.name}`).join('\n'))));
|
||||||
|
} else {
|
||||||
|
this.out(cyan(dim('(none)')));
|
||||||
|
}
|
||||||
|
this.out();
|
||||||
|
}
|
||||||
|
|
||||||
|
protected printEnabledPostProcessors(): void {
|
||||||
|
this.out(cyan('Enabled post processors:'));
|
||||||
|
if (this.postProcessors.length) {
|
||||||
|
this.out(cyan(dim(this.postProcessors.map(postProcessor => `- ${postProcessor.constructor.name}`).join('\n'))));
|
||||||
|
} else {
|
||||||
|
this.out(cyan(dim('(none)')));
|
||||||
|
}
|
||||||
|
this.out();
|
||||||
|
}
|
||||||
|
|
||||||
|
protected printEnabledCompiler(): void {
|
||||||
|
this.out(cyan('Compiler:'));
|
||||||
|
this.out(cyan(dim(`- ${this.compiler.constructor.name}`)));
|
||||||
|
this.out();
|
||||||
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
@@ -1,13 +1,14 @@
|
|||||||
import { CompilerInterface } from './compiler.interface';
|
import { CompilerInterface } from './compiler.interface';
|
||||||
import { TranslationCollection } from '../utils/translation.collection';
|
import { TranslationCollection } from '../utils/translation.collection';
|
||||||
|
import { stripBOM } from '../utils/utils';
|
||||||
|
|
||||||
import * as flat from 'flat';
|
import { flatten } from 'flat';
|
||||||
|
|
||||||
export class JsonCompiler implements CompilerInterface {
|
export class JsonCompiler implements CompilerInterface {
|
||||||
|
|
||||||
public indentation: string = '\t';
|
public indentation: string = '\t';
|
||||||
|
|
||||||
public extension = 'json';
|
public extension: string = 'json';
|
||||||
|
|
||||||
public constructor(options?: any) {
|
public constructor(options?: any) {
|
||||||
if (options && typeof options.indentation !== 'undefined') {
|
if (options && typeof options.indentation !== 'undefined') {
|
||||||
@@ -20,14 +21,14 @@ export class JsonCompiler implements CompilerInterface {
|
|||||||
}
|
}
|
||||||
|
|
||||||
public parse(contents: string): TranslationCollection {
|
public parse(contents: string): TranslationCollection {
|
||||||
let values: any = JSON.parse(contents);
|
let values: any = JSON.parse(stripBOM(contents));
|
||||||
if (this._isNamespacedJsonFormat(values)) {
|
if (this.isNamespacedJsonFormat(values)) {
|
||||||
values = flat.flatten(values);
|
values = flatten(values);
|
||||||
}
|
}
|
||||||
return new TranslationCollection(values);
|
return new TranslationCollection(values);
|
||||||
}
|
}
|
||||||
|
|
||||||
protected _isNamespacedJsonFormat(values: any): boolean {
|
protected isNamespacedJsonFormat(values: any): boolean {
|
||||||
return Object.keys(values).some(key => typeof values[key] === 'object');
|
return Object.keys(values).some(key => typeof values[key] === 'object');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@@ -1,7 +1,8 @@
|
|||||||
import { CompilerInterface } from './compiler.interface';
|
import { CompilerInterface } from './compiler.interface';
|
||||||
import { TranslationCollection } from '../utils/translation.collection';
|
import { TranslationCollection } from '../utils/translation.collection';
|
||||||
|
import { stripBOM } from '../utils/utils';
|
||||||
|
|
||||||
import * as flat from 'flat';
|
import { flatten, unflatten } from 'flat';
|
||||||
|
|
||||||
export class NamespacedJsonCompiler implements CompilerInterface {
|
export class NamespacedJsonCompiler implements CompilerInterface {
|
||||||
|
|
||||||
@@ -16,14 +17,14 @@ export class NamespacedJsonCompiler implements CompilerInterface {
|
|||||||
}
|
}
|
||||||
|
|
||||||
public compile(collection: TranslationCollection): string {
|
public compile(collection: TranslationCollection): string {
|
||||||
const values: {} = flat.unflatten(collection.values, {
|
const values: {} = unflatten(collection.values, {
|
||||||
object: true
|
object: true
|
||||||
});
|
});
|
||||||
return JSON.stringify(values, null, this.indentation);
|
return JSON.stringify(values, null, this.indentation);
|
||||||
}
|
}
|
||||||
|
|
||||||
public parse(contents: string): TranslationCollection {
|
public parse(contents: string): TranslationCollection {
|
||||||
const values: {} = flat.flatten(JSON.parse(contents));
|
const values: {} = flatten(JSON.parse(stripBOM(contents)));
|
||||||
return new TranslationCollection(values);
|
return new TranslationCollection(values);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@@ -5,14 +5,14 @@ import * as gettext from 'gettext-parser';
|
|||||||
|
|
||||||
export class PoCompiler implements CompilerInterface {
|
export class PoCompiler implements CompilerInterface {
|
||||||
|
|
||||||
public extension = 'po';
|
public extension: string = 'po';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Translation domain
|
* Translation domain
|
||||||
*/
|
*/
|
||||||
public domain = '';
|
public domain: string = '';
|
||||||
|
|
||||||
public constructor(options?: any) { }
|
public constructor(options?: any) {}
|
||||||
|
|
||||||
public compile(collection: TranslationCollection): string {
|
public compile(collection: TranslationCollection): string {
|
||||||
const data = {
|
const data = {
|
||||||
@@ -29,17 +29,17 @@ export class PoCompiler implements CompilerInterface {
|
|||||||
msgstr: collection.get(key)
|
msgstr: collection.get(key)
|
||||||
};
|
};
|
||||||
return translations;
|
return translations;
|
||||||
}, <any> {})
|
}, {} as any)
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
return gettext.po.compile(data, 'utf-8');
|
return gettext.po.compile(data);
|
||||||
}
|
}
|
||||||
|
|
||||||
public parse(contents: string): TranslationCollection {
|
public parse(contents: string): TranslationCollection {
|
||||||
const collection = new TranslationCollection();
|
const collection = new TranslationCollection();
|
||||||
|
|
||||||
const po = gettext.po.parse(contents, 'utf-8');
|
const po = gettext.po.parse(contents, 'utf8');
|
||||||
if (!po.translations.hasOwnProperty(this.domain)) {
|
if (!po.translations.hasOwnProperty(this.domain)) {
|
||||||
return collection;
|
return collection;
|
||||||
}
|
}
|
||||||
@@ -49,7 +49,7 @@ export class PoCompiler implements CompilerInterface {
|
|||||||
.reduce((values, key) => {
|
.reduce((values, key) => {
|
||||||
values[key] = po.translations[this.domain][key].msgstr.pop();
|
values[key] = po.translations[this.domain][key].msgstr.pop();
|
||||||
return values;
|
return values;
|
||||||
}, <TranslationType> {});
|
}, {} as TranslationType);
|
||||||
|
|
||||||
return new TranslationCollection(values);
|
return new TranslationCollection(values);
|
||||||
}
|
}
|
||||||
|
@@ -6,15 +6,18 @@ export * from './cli/tasks/task.interface';
|
|||||||
export * from './cli/tasks/extract.task';
|
export * from './cli/tasks/extract.task';
|
||||||
|
|
||||||
export * from './parsers/parser.interface';
|
export * from './parsers/parser.interface';
|
||||||
export * from './parsers/abstract-template.parser';
|
|
||||||
export * from './parsers/abstract-ast.parser';
|
|
||||||
export * from './parsers/directive.parser';
|
export * from './parsers/directive.parser';
|
||||||
export * from './parsers/pipe.parser';
|
export * from './parsers/pipe.parser';
|
||||||
export * from './parsers/service.parser';
|
export * from './parsers/service.parser';
|
||||||
export * from './parsers/function.parser';
|
export * from './parsers/marker.parser';
|
||||||
|
|
||||||
export * from './compilers/compiler.interface';
|
export * from './compilers/compiler.interface';
|
||||||
export * from './compilers/compiler.factory';
|
export * from './compilers/compiler.factory';
|
||||||
export * from './compilers/json.compiler';
|
export * from './compilers/json.compiler';
|
||||||
export * from './compilers/namespaced-json.compiler';
|
export * from './compilers/namespaced-json.compiler';
|
||||||
export * from './compilers/po.compiler';
|
export * from './compilers/po.compiler';
|
||||||
|
|
||||||
|
export * from './post-processors/post-processor.interface';
|
||||||
|
export * from './post-processors/key-as-default-value.post-processor';
|
||||||
|
export * from './post-processors/purge-obsolete-keys.post-processor';
|
||||||
|
export * from './post-processors/sort-by-key.post-processor';
|
||||||
|
@@ -1,69 +0,0 @@
|
|||||||
import * as ts from 'typescript';
|
|
||||||
|
|
||||||
export abstract class AbstractAstParser {
|
|
||||||
|
|
||||||
protected _sourceFile: ts.SourceFile;
|
|
||||||
|
|
||||||
protected _createSourceFile(path: string, contents: string): ts.SourceFile {
|
|
||||||
return ts.createSourceFile(path, contents, null, /*setParentNodes */ false);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Get strings from function call's first argument
|
|
||||||
*/
|
|
||||||
protected _getCallArgStrings(callNode: ts.CallExpression): string[] {
|
|
||||||
if (!callNode.arguments.length) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const firstArg = callNode.arguments[0];
|
|
||||||
switch (firstArg.kind) {
|
|
||||||
case ts.SyntaxKind.StringLiteral:
|
|
||||||
case ts.SyntaxKind.FirstTemplateToken:
|
|
||||||
return [(firstArg as ts.StringLiteral).text];
|
|
||||||
case ts.SyntaxKind.ArrayLiteralExpression:
|
|
||||||
return (firstArg as ts.ArrayLiteralExpression).elements
|
|
||||||
.map((element: ts.StringLiteral) => element.text);
|
|
||||||
case ts.SyntaxKind.Identifier:
|
|
||||||
console.log('WARNING: We cannot extract variable values passed to TranslateService (yet)');
|
|
||||||
break;
|
|
||||||
default:
|
|
||||||
console.log(`SKIP: Unknown argument type: '${this._syntaxKindToName(firstArg.kind)}'`, firstArg);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Find all child nodes of a kind
|
|
||||||
*/
|
|
||||||
protected _findNodes(node: ts.Node, kind: ts.SyntaxKind, onlyOne: boolean = false): ts.Node[] {
|
|
||||||
if (node.kind === kind && onlyOne) {
|
|
||||||
return [node];
|
|
||||||
}
|
|
||||||
|
|
||||||
const childrenNodes: ts.Node[] = node.getChildren(this._sourceFile);
|
|
||||||
const initialValue: ts.Node[] = node.kind === kind ? [node] : [];
|
|
||||||
|
|
||||||
return childrenNodes.reduce((result: ts.Node[], childNode: ts.Node) => {
|
|
||||||
return result.concat(this._findNodes(childNode, kind));
|
|
||||||
}, initialValue);
|
|
||||||
}
|
|
||||||
|
|
||||||
protected _syntaxKindToName(kind: ts.SyntaxKind): string {
|
|
||||||
return ts.SyntaxKind[kind];
|
|
||||||
}
|
|
||||||
|
|
||||||
protected _printAllChildren(sourceFile: ts.SourceFile, node: ts.Node, depth = 0): void {
|
|
||||||
console.log(
|
|
||||||
new Array(depth + 1).join('----'),
|
|
||||||
`[${node.kind}]`,
|
|
||||||
this._syntaxKindToName(node.kind),
|
|
||||||
`[pos: ${node.pos}-${node.end}]`,
|
|
||||||
':\t\t\t',
|
|
||||||
node.getFullText(sourceFile).trim()
|
|
||||||
);
|
|
||||||
|
|
||||||
depth++;
|
|
||||||
node.getChildren(sourceFile).forEach(childNode => this._printAllChildren(sourceFile, childNode, depth));
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
@@ -1,24 +0,0 @@
|
|||||||
export abstract class AbstractTemplateParser {
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Checks if file is of type javascript or typescript and
|
|
||||||
* makes the assumption that it is an Angular Component
|
|
||||||
*/
|
|
||||||
protected _isAngularComponent(path: string): boolean {
|
|
||||||
return (/\.ts|js$/i).test(path);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Extracts inline template from components
|
|
||||||
*/
|
|
||||||
protected _extractInlineTemplate(contents: string): string {
|
|
||||||
const regExp: RegExp = /template\s*:\s*(["'`])([^\1]*?)\1/;
|
|
||||||
const match = regExp.exec(contents);
|
|
||||||
if (match !== null) {
|
|
||||||
return match[2];
|
|
||||||
}
|
|
||||||
|
|
||||||
return '';
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
@@ -1,55 +1,83 @@
|
|||||||
import { ParserInterface } from './parser.interface';
|
import { ParserInterface } from './parser.interface';
|
||||||
import { AbstractTemplateParser } from './abstract-template.parser';
|
|
||||||
import { TranslationCollection } from '../utils/translation.collection';
|
import { TranslationCollection } from '../utils/translation.collection';
|
||||||
|
import { isPathAngularComponent, extractComponentInlineTemplate } from '../utils/utils';
|
||||||
|
|
||||||
import * as $ from 'cheerio';
|
import { parseTemplate, TmplAstNode, TmplAstElement, TmplAstTextAttribute } from '@angular/compiler';
|
||||||
|
|
||||||
export class DirectiveParser extends AbstractTemplateParser implements ParserInterface {
|
export class DirectiveParser implements ParserInterface {
|
||||||
|
|
||||||
public extract(contents: string, path?: string): TranslationCollection {
|
public extract(template: string, path: string): TranslationCollection {
|
||||||
if (path && this._isAngularComponent(path)) {
|
if (path && isPathAngularComponent(path)) {
|
||||||
contents = this._extractInlineTemplate(contents);
|
template = extractComponentInlineTemplate(template);
|
||||||
}
|
}
|
||||||
|
|
||||||
return this._parseTemplate(contents);
|
|
||||||
}
|
|
||||||
|
|
||||||
protected _parseTemplate(template: string): TranslationCollection {
|
|
||||||
let collection: TranslationCollection = new TranslationCollection();
|
let collection: TranslationCollection = new TranslationCollection();
|
||||||
|
|
||||||
template = this._normalizeTemplateAttributes(template);
|
const nodes: TmplAstNode[] = this.parseTemplate(template, path);
|
||||||
|
this.getTranslatableElements(nodes).forEach(element => {
|
||||||
const selector = '[translate], [ng2-translate]';
|
const key = this.getElementTranslateAttrValue(element) || this.getElementContents(element);
|
||||||
$(template)
|
collection = collection.add(key);
|
||||||
.find(selector)
|
});
|
||||||
.addBack(selector)
|
|
||||||
.each((i: number, element: CheerioElement) => {
|
|
||||||
const $element = $(element);
|
|
||||||
const attr = $element.attr('translate') || $element.attr('ng2-translate');
|
|
||||||
|
|
||||||
if (attr) {
|
|
||||||
collection = collection.add(attr);
|
|
||||||
} else {
|
|
||||||
$element
|
|
||||||
.contents()
|
|
||||||
.toArray()
|
|
||||||
.filter(node => node.type === 'text')
|
|
||||||
.map(node => node.nodeValue.trim())
|
|
||||||
.filter(text => text.length > 0)
|
|
||||||
.forEach(text => collection = collection.add(text));
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
return collection;
|
return collection;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
protected getTranslatableElements(nodes: TmplAstNode[]): TmplAstElement[] {
|
||||||
* Angular's `[attr]="'val'"` syntax is not valid HTML,
|
return nodes
|
||||||
* so it can't be parsed by standard HTML parsers.
|
.filter(element => this.isElement(element))
|
||||||
* This method replaces `[attr]="'val'""` with `attr="val"`
|
.reduce((result: TmplAstElement[], element: TmplAstElement) => {
|
||||||
*/
|
return result.concat(this.findChildrenElements(element));
|
||||||
protected _normalizeTemplateAttributes(template: string): string {
|
}, [])
|
||||||
return template.replace(/\[([^\]]+)\]="'([^']*)'"/g, '$1="$2"');
|
.filter(element => this.isTranslatable(element));
|
||||||
|
}
|
||||||
|
|
||||||
|
protected findChildrenElements(node: TmplAstNode): TmplAstElement[] {
|
||||||
|
if (!this.isElement(node)) {
|
||||||
|
return [];
|
||||||
|
}
|
||||||
|
|
||||||
|
// If element has translate attribute all its contents is translatable
|
||||||
|
// so we don't need to traverse any deeper
|
||||||
|
if (this.isTranslatable(node)) {
|
||||||
|
return [node];
|
||||||
|
}
|
||||||
|
|
||||||
|
return node.children.reduce((result: TmplAstElement[], childNode: TmplAstNode) => {
|
||||||
|
if (this.isElement(childNode)) {
|
||||||
|
const children = this.findChildrenElements(childNode);
|
||||||
|
return result.concat(children);
|
||||||
|
}
|
||||||
|
return result;
|
||||||
|
}, [node]);
|
||||||
|
}
|
||||||
|
|
||||||
|
protected parseTemplate(template: string, path: string): TmplAstNode[] {
|
||||||
|
return parseTemplate(template, path).nodes;
|
||||||
|
}
|
||||||
|
|
||||||
|
protected isElement(node: any): node is TmplAstElement {
|
||||||
|
return node
|
||||||
|
&& node.attributes !== undefined
|
||||||
|
&& node.children !== undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
protected isTranslatable(node: TmplAstNode): boolean {
|
||||||
|
if (this.isElement(node) && node.attributes.some(attribute => attribute.name === 'translate')) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
protected getElementTranslateAttrValue(element: TmplAstElement): string {
|
||||||
|
const attr: TmplAstTextAttribute = element.attributes.find(attribute => attribute.name === 'translate');
|
||||||
|
return attr && attr.value || '';
|
||||||
|
}
|
||||||
|
|
||||||
|
protected getElementContents(element: TmplAstElement): string {
|
||||||
|
const contents = element.sourceSpan.start.file.content;
|
||||||
|
const start = element.startSourceSpan.end.offset;
|
||||||
|
const end = element.endSourceSpan.start.offset;
|
||||||
|
return contents.substring(start, end).trim();
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
@@ -1,61 +0,0 @@
|
|||||||
import { ParserInterface } from './parser.interface';
|
|
||||||
import { AbstractAstParser } from './abstract-ast.parser';
|
|
||||||
import { TranslationCollection } from '../utils/translation.collection';
|
|
||||||
|
|
||||||
import * as ts from 'typescript';
|
|
||||||
|
|
||||||
export class FunctionParser extends AbstractAstParser implements ParserInterface {
|
|
||||||
|
|
||||||
protected _functionIdentifier: string = '_';
|
|
||||||
|
|
||||||
public constructor(options?: any) {
|
|
||||||
super();
|
|
||||||
if (options && typeof options.identifier !== 'undefined') {
|
|
||||||
this._functionIdentifier = options.identifier;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
public extract(contents: string, path?: string): TranslationCollection {
|
|
||||||
let collection: TranslationCollection = new TranslationCollection();
|
|
||||||
|
|
||||||
this._sourceFile = this._createSourceFile(path, contents);
|
|
||||||
|
|
||||||
const callNodes = this._findCallNodes();
|
|
||||||
callNodes.forEach(callNode => {
|
|
||||||
const keys: string[] = this._getCallArgStrings(callNode);
|
|
||||||
if (keys && keys.length) {
|
|
||||||
collection = collection.addKeys(keys);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
return collection;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Find all calls to marker function
|
|
||||||
*/
|
|
||||||
protected _findCallNodes(node?: ts.Node): ts.CallExpression[] {
|
|
||||||
if (!node) {
|
|
||||||
node = this._sourceFile;
|
|
||||||
}
|
|
||||||
|
|
||||||
let callNodes = this._findNodes(node, ts.SyntaxKind.CallExpression) as ts.CallExpression[];
|
|
||||||
callNodes = callNodes
|
|
||||||
.filter(callNode => {
|
|
||||||
// Only call expressions with arguments
|
|
||||||
if (callNode.arguments.length < 1) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
const identifier = (callNode.getChildAt(0) as ts.Identifier).text;
|
|
||||||
if (identifier !== this._functionIdentifier) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
return true;
|
|
||||||
});
|
|
||||||
|
|
||||||
return callNodes;
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
34
src/parsers/marker.parser.ts
Normal file
34
src/parsers/marker.parser.ts
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
import { tsquery } from '@phenomnomnominal/tsquery';
|
||||||
|
|
||||||
|
import { ParserInterface } from './parser.interface';
|
||||||
|
import { TranslationCollection } from '../utils/translation.collection';
|
||||||
|
import { getNamedImportAlias, findFunctionCallExpressions, getStringsFromExpression } from '../utils/ast-helpers';
|
||||||
|
|
||||||
|
const MARKER_PACKAGE_MODULE_NAME = '@biesbjerg/ngx-translate-extract-marker';
|
||||||
|
const MARKER_PACKAGE_IMPORT_NAME = 'marker';
|
||||||
|
|
||||||
|
export class MarkerParser implements ParserInterface {
|
||||||
|
|
||||||
|
public extract(contents: string, filePath: string): TranslationCollection | null {
|
||||||
|
const sourceFile = tsquery.ast(contents, filePath);
|
||||||
|
|
||||||
|
const markerFnName = getNamedImportAlias(sourceFile, MARKER_PACKAGE_MODULE_NAME, MARKER_PACKAGE_IMPORT_NAME);
|
||||||
|
if (!markerFnName) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
let collection: TranslationCollection = new TranslationCollection();
|
||||||
|
|
||||||
|
const callNodes = findFunctionCallExpressions(sourceFile, markerFnName);
|
||||||
|
callNodes.forEach(callNode => {
|
||||||
|
const [firstArgNode] = callNode.arguments;
|
||||||
|
if (!firstArgNode) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const strings = getStringsFromExpression(firstArgNode);
|
||||||
|
collection = collection.addKeys(strings);
|
||||||
|
});
|
||||||
|
return collection;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@@ -2,6 +2,6 @@ import { TranslationCollection } from '../utils/translation.collection';
|
|||||||
|
|
||||||
export interface ParserInterface {
|
export interface ParserInterface {
|
||||||
|
|
||||||
extract(contents: string, path?: string): TranslationCollection;
|
extract(source: string, filePath: string): TranslationCollection | null;
|
||||||
|
|
||||||
}
|
}
|
||||||
|
@@ -1,24 +1,24 @@
|
|||||||
import { ParserInterface } from './parser.interface';
|
import { ParserInterface } from './parser.interface';
|
||||||
import { AbstractTemplateParser } from './abstract-template.parser';
|
|
||||||
import { TranslationCollection } from '../utils/translation.collection';
|
import { TranslationCollection } from '../utils/translation.collection';
|
||||||
|
import { isPathAngularComponent, extractComponentInlineTemplate } from '../utils/utils';
|
||||||
|
|
||||||
export class PipeParser extends AbstractTemplateParser implements ParserInterface {
|
export class PipeParser implements ParserInterface {
|
||||||
|
|
||||||
public extract(contents: string, path?: string): TranslationCollection {
|
public extract(template: string, path: string): TranslationCollection {
|
||||||
if (path && this._isAngularComponent(path)) {
|
if (path && isPathAngularComponent(path)) {
|
||||||
contents = this._extractInlineTemplate(contents);
|
template = extractComponentInlineTemplate(template);
|
||||||
}
|
}
|
||||||
|
|
||||||
return this._parseTemplate(contents);
|
return this.parseTemplate(template);
|
||||||
}
|
}
|
||||||
|
|
||||||
protected _parseTemplate(template: string): TranslationCollection {
|
protected parseTemplate(template: string): TranslationCollection {
|
||||||
let collection: TranslationCollection = new TranslationCollection();
|
let collection: TranslationCollection = new TranslationCollection();
|
||||||
|
|
||||||
const regExp: RegExp = /(['"`])((?:(?!\1).|\\\1)+)\1\s*\|\s*translate/g;
|
const regExp: RegExp = /(['"`])((?:(?!\1).|\\\1)+)\1\s*\|\s*translate/g;
|
||||||
let matches: RegExpExecArray;
|
let matches: RegExpExecArray;
|
||||||
while (matches = regExp.exec(template)) {
|
while (matches = regExp.exec(template)) {
|
||||||
collection = collection.add(matches[2].replace('\\\'', '\''));
|
collection = collection.add(matches[2].split('\\\'').join('\''));
|
||||||
}
|
}
|
||||||
|
|
||||||
return collection;
|
return collection;
|
||||||
|
@@ -1,120 +1,41 @@
|
|||||||
|
import { tsquery } from '@phenomnomnominal/tsquery';
|
||||||
|
|
||||||
import { ParserInterface } from './parser.interface';
|
import { ParserInterface } from './parser.interface';
|
||||||
import { AbstractAstParser } from './abstract-ast.parser';
|
|
||||||
import { TranslationCollection } from '../utils/translation.collection';
|
import { TranslationCollection } from '../utils/translation.collection';
|
||||||
|
import { findClasses, findClassPropertyByType, findMethodCallExpressions, getStringsFromExpression } from '../utils/ast-helpers';
|
||||||
|
|
||||||
import * as ts from 'typescript';
|
const TRANSLATE_SERVICE_TYPE_REFERENCE = 'TranslateService';
|
||||||
|
const TRANSLATE_SERVICE_METHOD_NAMES = ['get', 'instant', 'stream'];
|
||||||
|
|
||||||
export class ServiceParser extends AbstractAstParser implements ParserInterface {
|
export class ServiceParser implements ParserInterface {
|
||||||
|
|
||||||
protected _sourceFile: ts.SourceFile;
|
public extract(source: string, filePath: string): TranslationCollection | null {
|
||||||
|
const sourceFile = tsquery.ast(source, filePath);
|
||||||
|
|
||||||
public extract(contents: string, path?: string): TranslationCollection {
|
const classNodes = findClasses(sourceFile);
|
||||||
this._sourceFile = this._createSourceFile(path, contents);
|
if (!classNodes) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
let collection: TranslationCollection = new TranslationCollection();
|
let collection: TranslationCollection = new TranslationCollection();
|
||||||
|
|
||||||
const constructorNodes: ts.ConstructorDeclaration[] = this._findConstructorNodes();
|
classNodes.forEach(classNode => {
|
||||||
constructorNodes.forEach(constructorNode => {
|
const propName: string = findClassPropertyByType(classNode, TRANSLATE_SERVICE_TYPE_REFERENCE);
|
||||||
const propertyName: string = this._getPropertyName(constructorNode);
|
if (!propName) {
|
||||||
if (!propertyName) {
|
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
const callNodes = this._findCallNodes(this._sourceFile, propertyName);
|
const callNodes = findMethodCallExpressions(classNode, propName, TRANSLATE_SERVICE_METHOD_NAMES);
|
||||||
callNodes.forEach(callNode => {
|
callNodes.forEach(callNode => {
|
||||||
const keys: string[] = this._getCallArgStrings(callNode);
|
const [firstArgNode] = callNode.arguments;
|
||||||
if (keys && keys.length) {
|
if (!firstArgNode) {
|
||||||
collection = collection.addKeys(keys);
|
return;
|
||||||
}
|
}
|
||||||
|
const strings = getStringsFromExpression(firstArgNode);
|
||||||
|
collection = collection.addKeys(strings);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
return collection;
|
return collection;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Detect what the TranslateService instance property
|
|
||||||
* is called by inspecting constructor params
|
|
||||||
*/
|
|
||||||
protected _getPropertyName(constructorNode: ts.ConstructorDeclaration): string {
|
|
||||||
if (!constructorNode) {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
const result = constructorNode.parameters.find(parameter => {
|
|
||||||
// Skip if visibility modifier is not present (we want it set as an instance property)
|
|
||||||
if (!parameter.modifiers) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Parameter has no type
|
|
||||||
if (!parameter.type) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Make sure className is of the correct type
|
|
||||||
const parameterType: ts.Identifier = (parameter.type as ts.TypeReferenceNode).typeName as ts.Identifier;
|
|
||||||
if (!parameterType) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
const className: string = parameterType.text;
|
|
||||||
if (className !== 'TranslateService') {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
return true;
|
|
||||||
});
|
|
||||||
|
|
||||||
if (result) {
|
|
||||||
return (result.name as ts.Identifier).text;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Find constructor nodes
|
|
||||||
*/
|
|
||||||
protected _findConstructorNodes(): ts.ConstructorDeclaration[] {
|
|
||||||
const constructors = this._findNodes(this._sourceFile, ts.SyntaxKind.Constructor, true) as ts.ConstructorDeclaration[];
|
|
||||||
if (constructors.length) {
|
|
||||||
return constructors;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Find all calls to TranslateService methods
|
|
||||||
*/
|
|
||||||
protected _findCallNodes(node: ts.Node, propertyIdentifier: string): ts.CallExpression[] {
|
|
||||||
let callNodes = this._findNodes(node, ts.SyntaxKind.CallExpression) as ts.CallExpression[];
|
|
||||||
callNodes = callNodes
|
|
||||||
.filter(callNode => {
|
|
||||||
// Only call expressions with arguments
|
|
||||||
if (callNode.arguments.length < 1) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
const propAccess = callNode.getChildAt(0).getChildAt(0) as ts.PropertyAccessExpression;
|
|
||||||
if (!propAccess || propAccess.kind !== ts.SyntaxKind.PropertyAccessExpression) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
if (!propAccess.getFirstToken() || propAccess.getFirstToken().kind !== ts.SyntaxKind.ThisKeyword) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
if (propAccess.name.text !== propertyIdentifier) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
const methodAccess = callNode.getChildAt(0) as ts.PropertyAccessExpression;
|
|
||||||
if (!methodAccess || methodAccess.kind !== ts.SyntaxKind.PropertyAccessExpression) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
if (!methodAccess.name || (methodAccess.name.text !== 'get' && methodAccess.name.text !== 'instant')) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
return true;
|
|
||||||
});
|
|
||||||
|
|
||||||
return callNodes;
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
}
|
||||||
|
12
src/post-processors/key-as-default-value.post-processor.ts
Normal file
12
src/post-processors/key-as-default-value.post-processor.ts
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
import { TranslationCollection } from '../utils/translation.collection';
|
||||||
|
import { PostProcessorInterface } from './post-processor.interface';
|
||||||
|
|
||||||
|
export class KeyAsDefaultValuePostProcessor implements PostProcessorInterface {
|
||||||
|
|
||||||
|
public name: string = 'KeyAsDefaultValue';
|
||||||
|
|
||||||
|
public process(draft: TranslationCollection, extracted: TranslationCollection, existing: TranslationCollection): TranslationCollection {
|
||||||
|
return draft.map((key, val) => val === '' ? key : val);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
12
src/post-processors/null-as-default-value.post-processor.ts
Normal file
12
src/post-processors/null-as-default-value.post-processor.ts
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
import { TranslationCollection } from '../utils/translation.collection';
|
||||||
|
import { PostProcessorInterface } from './post-processor.interface';
|
||||||
|
|
||||||
|
export class NullAsDefaultValuePostProcessor implements PostProcessorInterface {
|
||||||
|
|
||||||
|
public name: string = 'NullAsDefaultValue';
|
||||||
|
|
||||||
|
public process(draft: TranslationCollection, extracted: TranslationCollection, existing: TranslationCollection): TranslationCollection {
|
||||||
|
return draft.map((key, val) => existing.get(key) === undefined ? null : val);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
9
src/post-processors/post-processor.interface.ts
Normal file
9
src/post-processors/post-processor.interface.ts
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
import { TranslationCollection } from '../utils/translation.collection';
|
||||||
|
|
||||||
|
export interface PostProcessorInterface {
|
||||||
|
|
||||||
|
name: string;
|
||||||
|
|
||||||
|
process(draft: TranslationCollection, extracted: TranslationCollection, existing: TranslationCollection): TranslationCollection;
|
||||||
|
|
||||||
|
}
|
12
src/post-processors/purge-obsolete-keys.post-processor.ts
Normal file
12
src/post-processors/purge-obsolete-keys.post-processor.ts
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
import { TranslationCollection } from '../utils/translation.collection';
|
||||||
|
import { PostProcessorInterface } from './post-processor.interface';
|
||||||
|
|
||||||
|
export class PurgeObsoleteKeysPostProcessor implements PostProcessorInterface {
|
||||||
|
|
||||||
|
public name: string = 'PurgeObsoleteKeys';
|
||||||
|
|
||||||
|
public process(draft: TranslationCollection, extracted: TranslationCollection, existing: TranslationCollection): TranslationCollection {
|
||||||
|
return draft.intersect(extracted);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
12
src/post-processors/sort-by-key.post-processor.ts
Normal file
12
src/post-processors/sort-by-key.post-processor.ts
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
import { TranslationCollection } from '../utils/translation.collection';
|
||||||
|
import { PostProcessorInterface } from './post-processor.interface';
|
||||||
|
|
||||||
|
export class SortByKeyPostProcessor implements PostProcessorInterface {
|
||||||
|
|
||||||
|
public name: string = 'SortByKey';
|
||||||
|
|
||||||
|
public process(draft: TranslationCollection, extracted: TranslationCollection, existing: TranslationCollection): TranslationCollection {
|
||||||
|
return draft.sort();
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
135
src/utils/ast-helpers.ts
Normal file
135
src/utils/ast-helpers.ts
Normal file
@@ -0,0 +1,135 @@
|
|||||||
|
import { tsquery } from '@phenomnomnominal/tsquery';
|
||||||
|
import {
|
||||||
|
Node,
|
||||||
|
NamedImports,
|
||||||
|
Identifier,
|
||||||
|
ClassDeclaration,
|
||||||
|
CallExpression,
|
||||||
|
isStringLiteralLike,
|
||||||
|
isArrayLiteralExpression,
|
||||||
|
Expression,
|
||||||
|
isBinaryExpression,
|
||||||
|
SyntaxKind,
|
||||||
|
isConditionalExpression,
|
||||||
|
PropertyAccessExpression
|
||||||
|
} from 'typescript';
|
||||||
|
|
||||||
|
export function getNamedImports(node: Node, moduleName: string): NamedImports[] {
|
||||||
|
const query = `ImportDeclaration[moduleSpecifier.text="${moduleName}"] NamedImports`;
|
||||||
|
return tsquery<NamedImports>(node, query);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function getNamedImportAlias(node: Node, moduleName: string, importName: string): string | null {
|
||||||
|
const [namedImportNode] = getNamedImports(node, moduleName);
|
||||||
|
if (!namedImportNode) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const query = `ImportSpecifier:has(Identifier[name="${importName}"]) > Identifier`;
|
||||||
|
const identifiers = tsquery<Identifier>(namedImportNode, query);
|
||||||
|
if (identifiers.length === 1) {
|
||||||
|
return identifiers[0].text;
|
||||||
|
}
|
||||||
|
if (identifiers.length > 1) {
|
||||||
|
return identifiers[identifiers.length - 1].text;
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function findClasses(node: Node): ClassDeclaration[] {
|
||||||
|
const query = 'ClassDeclaration';
|
||||||
|
return tsquery<ClassDeclaration>(node, query);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function findClassPropertyByType(node: ClassDeclaration, type: string): string | null {
|
||||||
|
return findClassPropertyConstructorParameterByType(node, type) || findClassPropertyDeclarationByType(node, type);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function findClassPropertyConstructorParameterByType(node: ClassDeclaration, type: string): string | null {
|
||||||
|
const query = `Constructor Parameter:has(TypeReference > Identifier[name="${type}"]):has(PublicKeyword,ProtectedKeyword,PrivateKeyword) > Identifier`;
|
||||||
|
const [result] = tsquery<Identifier>(node, query);
|
||||||
|
if (result) {
|
||||||
|
return result.text;
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function findClassPropertyDeclarationByType(node: ClassDeclaration, type: string): string | null {
|
||||||
|
const query = `PropertyDeclaration:has(TypeReference > Identifier[name="${type}"]) > Identifier`;
|
||||||
|
const [result] = tsquery<Identifier>(node, query);
|
||||||
|
if (result) {
|
||||||
|
return result.text;
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function findFunctionCallExpressions(node: Node, fnName: string | string[]): CallExpression[] {
|
||||||
|
if (Array.isArray(fnName)) {
|
||||||
|
fnName = fnName.join('|');
|
||||||
|
}
|
||||||
|
const query = `CallExpression:has(Identifier[name="${fnName}"]):not(:has(PropertyAccessExpression))`;
|
||||||
|
const nodes = tsquery<CallExpression>(node, query);
|
||||||
|
return nodes;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function findMethodCallExpressions(node: Node, prop: string, fnName: string | string[]): CallExpression[] {
|
||||||
|
if (Array.isArray(fnName)) {
|
||||||
|
fnName = fnName.join('|');
|
||||||
|
}
|
||||||
|
const query = `CallExpression > PropertyAccessExpression:has(Identifier[name=/^(${fnName})$/]):has(PropertyAccessExpression:has(Identifier[name="${prop}"]):has(ThisKeyword))`;
|
||||||
|
let nodes = tsquery<PropertyAccessExpression>(node, query).map(node => node.parent as CallExpression);
|
||||||
|
return nodes;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function getStringsFromExpression(expression: Expression): string[] {
|
||||||
|
if (isStringLiteralLike(expression)) {
|
||||||
|
return [expression.text];
|
||||||
|
}
|
||||||
|
|
||||||
|
if (isArrayLiteralExpression(expression)) {
|
||||||
|
return expression.elements.reduce((result: string[], element: Expression) => {
|
||||||
|
const strings = this.getStringsFromExpression(element);
|
||||||
|
return [
|
||||||
|
...result,
|
||||||
|
...strings
|
||||||
|
];
|
||||||
|
}, []);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (isBinaryExpression(expression)) {
|
||||||
|
const [left] = this.getStringsFromExpression(expression.left);
|
||||||
|
const [right] = this.getStringsFromExpression(expression.right);
|
||||||
|
|
||||||
|
if (expression.operatorToken.kind === SyntaxKind.PlusToken) {
|
||||||
|
if (typeof left === 'string' && typeof right === 'string') {
|
||||||
|
return [left + right];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (expression.operatorToken.kind === SyntaxKind.BarBarToken) {
|
||||||
|
const result = [];
|
||||||
|
if (typeof left === 'string') {
|
||||||
|
result.push(left);
|
||||||
|
}
|
||||||
|
if (typeof right === 'string') {
|
||||||
|
result.push(right);
|
||||||
|
}
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (isConditionalExpression(expression)) {
|
||||||
|
const [whenTrue] = this.getStringsFromExpression(expression.whenTrue);
|
||||||
|
const [whenFalse] = this.getStringsFromExpression(expression.whenFalse);
|
||||||
|
|
||||||
|
const result = [];
|
||||||
|
if (typeof whenTrue === 'string') {
|
||||||
|
result.push(whenTrue);
|
||||||
|
}
|
||||||
|
if (typeof whenFalse === 'string') {
|
||||||
|
result.push(whenFalse);
|
||||||
|
}
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
return [];
|
||||||
|
}
|
17
src/utils/donate.ts
Normal file
17
src/utils/donate.ts
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
import { yellow } from 'colorette';
|
||||||
|
import * as boxen from 'boxen';
|
||||||
|
import * as terminalLink from 'terminal-link';
|
||||||
|
|
||||||
|
const url = 'https://donate.biesbjerg.com';
|
||||||
|
const link = terminalLink(url, url);
|
||||||
|
const message = `
|
||||||
|
If this tool saves you or your company time, please consider making a
|
||||||
|
donation to support my work and the continued maintainence and development:
|
||||||
|
|
||||||
|
${yellow(link)}`;
|
||||||
|
|
||||||
|
export const donateMessage = boxen(message.trim(), {
|
||||||
|
padding: 1,
|
||||||
|
margin: 0,
|
||||||
|
dimBorder: true
|
||||||
|
});
|
@@ -1,5 +1,5 @@
|
|||||||
export interface TranslationType {
|
export interface TranslationType {
|
||||||
[key: string]: string
|
[key: string]: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
export class TranslationCollection {
|
export class TranslationCollection {
|
||||||
@@ -11,15 +11,15 @@ export class TranslationCollection {
|
|||||||
}
|
}
|
||||||
|
|
||||||
public add(key: string, val: string = ''): TranslationCollection {
|
public add(key: string, val: string = ''): TranslationCollection {
|
||||||
return new TranslationCollection(Object.assign({}, this.values, { [key]: val }));
|
return new TranslationCollection({ ...this.values, [key]: val });
|
||||||
}
|
}
|
||||||
|
|
||||||
public addKeys(keys: string[]): TranslationCollection {
|
public addKeys(keys: string[]): TranslationCollection {
|
||||||
const values = keys.reduce((results, key) => {
|
const values = keys.reduce((results, key) => {
|
||||||
results[key] = '';
|
results[key] = '';
|
||||||
return results;
|
return results;
|
||||||
}, <TranslationType> {});
|
}, {} as TranslationType);
|
||||||
return new TranslationCollection(Object.assign({}, this.values, values));
|
return new TranslationCollection({ ...this.values, ...values });
|
||||||
}
|
}
|
||||||
|
|
||||||
public remove(key: string): TranslationCollection {
|
public remove(key: string): TranslationCollection {
|
||||||
@@ -41,8 +41,16 @@ export class TranslationCollection {
|
|||||||
return new TranslationCollection(values);
|
return new TranslationCollection(values);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public map(callback: (key?: string, val?: string) => string): TranslationCollection {
|
||||||
|
let values: TranslationType = {};
|
||||||
|
this.forEach((key: string, val: string) => {
|
||||||
|
values[key] = callback.call(this, key, val);
|
||||||
|
});
|
||||||
|
return new TranslationCollection(values);
|
||||||
|
}
|
||||||
|
|
||||||
public union(collection: TranslationCollection): TranslationCollection {
|
public union(collection: TranslationCollection): TranslationCollection {
|
||||||
return new TranslationCollection(Object.assign({}, this.values, collection.values));
|
return new TranslationCollection({ ...this.values, ...collection.values });
|
||||||
}
|
}
|
||||||
|
|
||||||
public intersect(collection: TranslationCollection): TranslationCollection {
|
public intersect(collection: TranslationCollection): TranslationCollection {
|
||||||
|
@@ -1,3 +1,22 @@
|
|||||||
export function _(key: string | string[]): string | string[] {
|
/**
|
||||||
return key;
|
* Assumes file is an Angular component if type is javascript/typescript
|
||||||
|
*/
|
||||||
|
export function isPathAngularComponent(path: string): boolean {
|
||||||
|
return (/\.ts|js$/i).test(path);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Extract inline template from a component
|
||||||
|
*/
|
||||||
|
export function extractComponentInlineTemplate(contents: string): string {
|
||||||
|
const regExp: RegExp = /template\s*:\s*(["'`])([^\1]*?)\1/;
|
||||||
|
const match = regExp.exec(contents);
|
||||||
|
if (match !== null) {
|
||||||
|
return match[2];
|
||||||
|
}
|
||||||
|
return '';
|
||||||
|
}
|
||||||
|
|
||||||
|
export function stripBOM(contents: string): string {
|
||||||
|
return contents.trim();
|
||||||
}
|
}
|
||||||
|
@@ -37,9 +37,9 @@ describe('NamespacedJsonCompiler', () => {
|
|||||||
|
|
||||||
it('should preserve numeric values on compile', () => {
|
it('should preserve numeric values on compile', () => {
|
||||||
const collection = new TranslationCollection({
|
const collection = new TranslationCollection({
|
||||||
"option.0": '',
|
'option.0': '',
|
||||||
"option.1": '',
|
'option.1': '',
|
||||||
"option.2": ''
|
'option.2': ''
|
||||||
});
|
});
|
||||||
const result: string = compiler.compile(collection);
|
const result: string = compiler.compile(collection);
|
||||||
expect(result).to.equal('{\n\t"option": {\n\t\t"0": "",\n\t\t"1": "",\n\t\t"2": ""\n\t}\n}');
|
expect(result).to.equal('{\n\t"option": {\n\t\t"0": "",\n\t\t"1": "",\n\t\t"2": ""\n\t}\n}');
|
||||||
@@ -57,4 +57,13 @@ describe('NamespacedJsonCompiler', () => {
|
|||||||
expect(result).to.equal('{\n "NAMESPACE": {\n "KEY": {\n "FIRST_KEY": "",\n "SECOND_KEY": "VALUE"\n }\n }\n}');
|
expect(result).to.equal('{\n "NAMESPACE": {\n "KEY": {\n "FIRST_KEY": "",\n "SECOND_KEY": "VALUE"\n }\n }\n}');
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it('should not reorder keys when compiled', () => {
|
||||||
|
const collection = new TranslationCollection({
|
||||||
|
'BROWSE': '',
|
||||||
|
'LOGIN': ''
|
||||||
|
});
|
||||||
|
const result: string = compiler.compile(collection);
|
||||||
|
expect(result).to.equal('{\n\t"BROWSE": "",\n\t"LOGIN": ""\n}');
|
||||||
|
});
|
||||||
|
|
||||||
});
|
});
|
||||||
|
@@ -2,78 +2,39 @@ import { expect } from 'chai';
|
|||||||
|
|
||||||
import { DirectiveParser } from '../../src/parsers/directive.parser';
|
import { DirectiveParser } from '../../src/parsers/directive.parser';
|
||||||
|
|
||||||
class TestDirectiveParser extends DirectiveParser {
|
|
||||||
|
|
||||||
public normalizeTemplateAttributes(template: string): string {
|
|
||||||
return this._normalizeTemplateAttributes(template);
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
describe('DirectiveParser', () => {
|
describe('DirectiveParser', () => {
|
||||||
|
|
||||||
const templateFilename: string = 'test.template.html';
|
const templateFilename: string = 'test.template.html';
|
||||||
const componentFilename: string = 'test.component.ts';
|
const componentFilename: string = 'test.component.ts';
|
||||||
|
|
||||||
let parser: TestDirectiveParser;
|
let parser: DirectiveParser;
|
||||||
|
|
||||||
beforeEach(() => {
|
beforeEach(() => {
|
||||||
parser = new TestDirectiveParser();
|
parser = new DirectiveParser();
|
||||||
});
|
});
|
||||||
|
|
||||||
it('should extract contents when no translate attribute value is provided', () => {
|
it('should not choke when no html is present in template', () => {
|
||||||
|
const contents = 'Hello World';
|
||||||
|
const keys = parser.extract(contents, templateFilename).keys();
|
||||||
|
expect(keys).to.deep.equal([]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should use contents as key when there is no translate attribute value provided', () => {
|
||||||
const contents = '<div translate>Hello World</div>';
|
const contents = '<div translate>Hello World</div>';
|
||||||
const keys = parser.extract(contents, templateFilename).keys();
|
const keys = parser.extract(contents, templateFilename).keys();
|
||||||
expect(keys).to.deep.equal(['Hello World']);
|
expect(keys).to.deep.equal(['Hello World']);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('should extract translate attribute if provided', () => {
|
it('should use translate attribute value as key when provided', () => {
|
||||||
const contents = '<div translate="KEY">Hello World<div>';
|
const contents = '<div translate="MY_KEY">Hello World<div>';
|
||||||
const keys = parser.extract(contents, templateFilename).keys();
|
const keys = parser.extract(contents, templateFilename).keys();
|
||||||
expect(keys).to.deep.equal(['KEY']);
|
expect(keys).to.deep.equal(['MY_KEY']);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('should extract bound translate attribute as key if provided', () => {
|
it('should not process children when translate attribute is present', () => {
|
||||||
const contents = `<div [translate]="'KEY'">Hello World<div>`;
|
const contents = `<div translate>Hello <strong translate>World</strong></div>`;
|
||||||
const keys = parser.extract(contents, templateFilename).keys();
|
const keys = parser.extract(contents, templateFilename).keys();
|
||||||
expect(keys).to.deep.equal(['KEY']);
|
expect(keys).to.deep.equal(['Hello <strong translate>World</strong>']);
|
||||||
});
|
|
||||||
|
|
||||||
it('should extract direct text nodes when no translate attribute value is provided', () => {
|
|
||||||
const contents = `
|
|
||||||
<div translate>
|
|
||||||
<span>✓</span>
|
|
||||||
Hello <strong>World</strong>
|
|
||||||
Hi <em>there</em>
|
|
||||||
</div>
|
|
||||||
`;
|
|
||||||
const keys = parser.extract(contents, templateFilename).keys();
|
|
||||||
expect(keys).to.deep.equal(['Hello', 'Hi']);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should extract direct text nodes of tags with a translate attribute', () => {
|
|
||||||
const contents = `
|
|
||||||
<div translate>
|
|
||||||
<span>✓</span>
|
|
||||||
Hello World
|
|
||||||
<div translate>Hi there</div>
|
|
||||||
</div>
|
|
||||||
`;
|
|
||||||
const keys = parser.extract(contents, templateFilename).keys();
|
|
||||||
expect(keys).to.deep.equal(['Hello World', 'Hi there']);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should extract translate attribute if provided or direct text nodes if not', () => {
|
|
||||||
const contents = `
|
|
||||||
<div translate="KEY">
|
|
||||||
<span>✓</span>
|
|
||||||
Hello World
|
|
||||||
<p translate>Hi there</p>
|
|
||||||
<p [translate]="'OTHER_KEY'">Lorem Ipsum</p>
|
|
||||||
</div>
|
|
||||||
`;
|
|
||||||
const keys = parser.extract(contents, templateFilename).keys();
|
|
||||||
expect(keys).to.deep.equal(['KEY', 'Hi there', 'OTHER_KEY']);
|
|
||||||
});
|
});
|
||||||
|
|
||||||
it('should extract and parse inline template', () => {
|
it('should extract and parse inline template', () => {
|
||||||
@@ -88,34 +49,42 @@ describe('DirectiveParser', () => {
|
|||||||
expect(keys).to.deep.equal(['Hello World']);
|
expect(keys).to.deep.equal(['Hello World']);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('should extract contents when no ng2-translate attribute value is provided', () => {
|
it('should extract contents when no translate attribute value is provided', () => {
|
||||||
const contents = '<div ng2-translate>Hello World</div>';
|
const contents = '<div translate>Hello World</div>';
|
||||||
const keys = parser.extract(contents, templateFilename).keys();
|
const keys = parser.extract(contents, templateFilename).keys();
|
||||||
expect(keys).to.deep.equal(['Hello World']);
|
expect(keys).to.deep.equal(['Hello World']);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('should extract ng2-translate attribute if provided', () => {
|
it('should extract translate attribute value if provided', () => {
|
||||||
const contents = '<div ng2-translate="KEY">Hello World<div>';
|
const contents = '<div translate="KEY">Hello World<div>';
|
||||||
const keys = parser.extract(contents, templateFilename).keys();
|
|
||||||
expect(keys).to.deep.equal(['KEY']);
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should extract bound ng2-translate attribute as key if provided', () => {
|
|
||||||
const contents = `<div [ng2-translate]="'KEY'">Hello World<div>`;
|
|
||||||
const keys = parser.extract(contents, templateFilename).keys();
|
const keys = parser.extract(contents, templateFilename).keys();
|
||||||
expect(keys).to.deep.equal(['KEY']);
|
expect(keys).to.deep.equal(['KEY']);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('should not extract translate pipe in html tag', () => {
|
it('should not extract translate pipe in html tag', () => {
|
||||||
const contents = `<p>{{ 'Audiobooks for personal development' | translate }}</p>`;
|
const contents = `<p>{{ 'Audiobooks for personal development' | translate }}</p>`;
|
||||||
const collection = parser.extract(contents, templateFilename);
|
const collection = parser.extract(contents, templateFilename);
|
||||||
expect(collection.values).to.deep.equal({});
|
expect(collection.values).to.deep.equal({});
|
||||||
});
|
});
|
||||||
|
|
||||||
it('should normalize bound attributes', () => {
|
it('should extract contents from within custom tags', () => {
|
||||||
const contents = `<p [translate]="'KEY'">Hello World</p>`;
|
const contents = `<custom-table><tbody><tr><td translate>Hello World</td></tr></tbody></custom-table>`;
|
||||||
const template = parser.normalizeTemplateAttributes(contents);
|
const keys = parser.extract(contents, templateFilename).keys();
|
||||||
expect(template).to.equal('<p translate="KEY">Hello World</p>');
|
expect(keys).to.deep.equal(['Hello World']);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should not cause error when no html is present in template', () => {
|
||||||
|
const contents = `
|
||||||
|
import { Component } from '@angular/core';
|
||||||
|
@Component({
|
||||||
|
template: '{{ variable }}'
|
||||||
|
})
|
||||||
|
export class MyComponent {
|
||||||
|
variable: string
|
||||||
|
}
|
||||||
|
`;
|
||||||
|
const keys = parser.extract(contents, componentFilename).keys();
|
||||||
|
expect(keys).to.deep.equal([]);
|
||||||
});
|
});
|
||||||
|
|
||||||
});
|
});
|
||||||
|
@@ -1,27 +0,0 @@
|
|||||||
import { expect } from 'chai';
|
|
||||||
|
|
||||||
import { FunctionParser } from '../../src/parsers/function.parser';
|
|
||||||
|
|
||||||
describe('FunctionParser', () => {
|
|
||||||
|
|
||||||
const componentFilename: string = 'test.component.ts';
|
|
||||||
|
|
||||||
let parser: FunctionParser;
|
|
||||||
|
|
||||||
beforeEach(() => {
|
|
||||||
parser = new FunctionParser();
|
|
||||||
});
|
|
||||||
|
|
||||||
|
|
||||||
it('should extract strings using marker function', () => {
|
|
||||||
const contents = `
|
|
||||||
import { _ } from '@biesbjerg/ngx-translate-extract';
|
|
||||||
_('Hello world');
|
|
||||||
_(['I', 'am', 'extracted']);
|
|
||||||
otherFunction('But I am not');
|
|
||||||
`;
|
|
||||||
const keys = parser.extract(contents, componentFilename).keys();
|
|
||||||
expect(keys).to.deep.equal(['Hello world', 'I', 'am', 'extracted']);
|
|
||||||
});
|
|
||||||
|
|
||||||
});
|
|
45
tests/parsers/marker.parser.spec.ts
Normal file
45
tests/parsers/marker.parser.spec.ts
Normal file
@@ -0,0 +1,45 @@
|
|||||||
|
import { expect } from 'chai';
|
||||||
|
|
||||||
|
import { MarkerParser } from '../../src/parsers/marker.parser';
|
||||||
|
|
||||||
|
describe('MarkerParser', () => {
|
||||||
|
|
||||||
|
const componentFilename: string = 'test.component.ts';
|
||||||
|
|
||||||
|
let parser: MarkerParser;
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
parser = new MarkerParser();
|
||||||
|
});
|
||||||
|
|
||||||
|
|
||||||
|
it('should extract strings using marker function', () => {
|
||||||
|
const contents = `
|
||||||
|
import { marker } from '@biesbjerg/ngx-translate-extract-marker';
|
||||||
|
marker('Hello world');
|
||||||
|
marker(['I', 'am', 'extracted']);
|
||||||
|
otherFunction('But I am not');
|
||||||
|
marker(message || 'binary expression');
|
||||||
|
marker(message ? message : 'conditional operator');
|
||||||
|
marker('FOO.bar');
|
||||||
|
`;
|
||||||
|
const keys = parser.extract(contents, componentFilename).keys();
|
||||||
|
expect(keys).to.deep.equal(['Hello world', 'I', 'am', 'extracted', 'binary expression', 'conditional operator', 'FOO.bar']);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should extract split strings', () => {
|
||||||
|
const contents = `
|
||||||
|
import { marker as _ } from '@biesbjerg/ngx-translate-extract-marker';
|
||||||
|
_('Hello ' + 'world');
|
||||||
|
_('This is a ' + 'very ' + 'very ' + 'very ' + 'very ' + 'long line.');
|
||||||
|
_('Mix ' + \`of \` + 'different ' + \`types\`);
|
||||||
|
`;
|
||||||
|
const keys = parser.extract(contents, componentFilename).keys();
|
||||||
|
expect(keys).to.deep.equal([
|
||||||
|
'Hello world',
|
||||||
|
'This is a very very very very long line.',
|
||||||
|
'Mix of different types'
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
});
|
@@ -30,20 +30,32 @@ describe('PipeParser', () => {
|
|||||||
expect(keys).to.deep.equal(['World']);
|
expect(keys).to.deep.equal(['World']);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it('should extract interpolated strings when translate pipe is used in conjunction with other pipes', () => {
|
||||||
|
const contents = `Hello {{ 'World' | translate | upper }}`;
|
||||||
|
const keys = parser.extract(contents, templateFilename).keys();
|
||||||
|
expect(keys).to.deep.equal(['World']);
|
||||||
|
});
|
||||||
|
|
||||||
it('should extract strings with escaped quotes', () => {
|
it('should extract strings with escaped quotes', () => {
|
||||||
const contents = `Hello {{ 'World\\'s largest potato' | translate }}`;
|
const contents = `Hello {{ 'World\\'s largest potato' | translate }}`;
|
||||||
const keys = parser.extract(contents, templateFilename).keys();
|
const keys = parser.extract(contents, templateFilename).keys();
|
||||||
expect(keys).to.deep.equal([`World's largest potato`]);
|
expect(keys).to.deep.equal([`World's largest potato`]);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it('should extract strings with multiple escaped quotes', () => {
|
||||||
|
const contents = `{{ 'C\\'est ok. C\\'est ok' | translate }}`;
|
||||||
|
const keys = parser.extract(contents, templateFilename).keys();
|
||||||
|
expect(keys).to.deep.equal([`C'est ok. C'est ok`]);
|
||||||
|
});
|
||||||
|
|
||||||
it('should extract interpolated strings using translate pipe in attributes', () => {
|
it('should extract interpolated strings using translate pipe in attributes', () => {
|
||||||
const contents = `<span attr="{{ 'Hello World' | translate }}"></span>`;
|
const contents = `<span attr="{{ 'Hello World' | translate }}"></span>`;
|
||||||
const keys = parser.extract(contents, templateFilename).keys();
|
const keys = parser.extract(contents, templateFilename).keys();
|
||||||
expect(keys).to.deep.equal(['Hello World']);
|
expect(keys).to.deep.equal(['Hello World']);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('should extract bound strings using translate pipe in attributes', () => {
|
it('should extract bound strings using translate pipe in attributes', () => {
|
||||||
const contents = `<span [attr]="'Hello World' | translate"></span>`;
|
const contents = `<span [attr]="'Hello World' | translate"></span>`;
|
||||||
const keys = parser.extract(contents, templateFilename).keys();
|
const keys = parser.extract(contents, templateFilename).keys();
|
||||||
expect(keys).to.deep.equal(['Hello World']);
|
expect(keys).to.deep.equal(['Hello World']);
|
||||||
});
|
});
|
||||||
@@ -52,14 +64,14 @@ describe('PipeParser', () => {
|
|||||||
const contents = `
|
const contents = `
|
||||||
<ion-header>
|
<ion-header>
|
||||||
<ion-navbar color="brand">
|
<ion-navbar color="brand">
|
||||||
<ion-title>{{ 'Info' | translate }}</ion-title>
|
<ion-title>{{ 'Info' | translate }}</ion-title>
|
||||||
</ion-navbar>
|
</ion-navbar>
|
||||||
</ion-header>
|
</ion-header>
|
||||||
|
|
||||||
<ion-content>
|
<ion-content>
|
||||||
|
|
||||||
<content-loading *ngIf="isLoading">
|
<content-loading *ngIf="isLoading">
|
||||||
{{ 'Loading...' | translate }}
|
{{ 'Loading...' | translate }}
|
||||||
</content-loading>
|
</content-loading>
|
||||||
|
|
||||||
</ion-content>
|
</ion-content>
|
||||||
@@ -69,7 +81,7 @@ describe('PipeParser', () => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
it('should extract strings on same line', () => {
|
it('should extract strings on same line', () => {
|
||||||
const contents = `<span [attr]="'Hello' | translate"></span><span [attr]="'World' | translate"></span>`;
|
const contents = `<span [attr]="'Hello' | translate"></span><span [attr]="'World' | translate"></span>`;
|
||||||
const keys = parser.extract(contents, templateFilename).keys();
|
const keys = parser.extract(contents, templateFilename).keys();
|
||||||
expect(keys).to.deep.equal(['Hello', 'World']);
|
expect(keys).to.deep.equal(['Hello', 'World']);
|
||||||
});
|
});
|
||||||
@@ -79,7 +91,7 @@ describe('PipeParser', () => {
|
|||||||
<ion-list inset>
|
<ion-list inset>
|
||||||
<ion-item>
|
<ion-item>
|
||||||
<ion-icon item-left name="person" color="dark"></ion-icon>
|
<ion-icon item-left name="person" color="dark"></ion-icon>
|
||||||
<ion-input formControlName="name" type="text" [placeholder]="'Name' | translate"></ion-input>
|
<ion-input formControlName="name" type="text" [placeholder]="'Name' | translate"></ion-input>
|
||||||
</ion-item>
|
</ion-item>
|
||||||
<ion-item>
|
<ion-item>
|
||||||
<p color="danger" danger *ngFor="let error of form.get('name').getError('remote')">
|
<p color="danger" danger *ngFor="let error of form.get('name').getError('remote')">
|
||||||
@@ -88,11 +100,23 @@ describe('PipeParser', () => {
|
|||||||
</ion-item>
|
</ion-item>
|
||||||
</ion-list>
|
</ion-list>
|
||||||
<div class="form-actions">
|
<div class="form-actions">
|
||||||
<button ion-button (click)="onSubmit()" color="secondary" block>{{ 'Create account' | translate }}</button>
|
<button ion-button (click)="onSubmit()" color="secondary" block>{{ 'Create account' | translate }}</button>
|
||||||
</div>
|
</div>
|
||||||
`;
|
`;
|
||||||
const keys = parser.extract(contents, templateFilename).keys();
|
const keys = parser.extract(contents, templateFilename).keys();
|
||||||
expect(keys).to.deep.equal(['Name', 'Create account']);
|
expect(keys).to.deep.equal(['Name', 'Create account']);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it('should not extract variables', () => {
|
||||||
|
const contents = '<p>{{ message | translate }}</p>';
|
||||||
|
const keys = parser.extract(contents, templateFilename).keys();
|
||||||
|
expect(keys).to.deep.equal([]);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should be able to extract without html', () => {
|
||||||
|
const contents = `{{ 'message' | translate }}`;
|
||||||
|
const keys = parser.extract(contents, templateFilename).keys();
|
||||||
|
expect(keys).to.deep.equal(['message']);
|
||||||
|
});
|
||||||
|
|
||||||
});
|
});
|
||||||
|
@@ -4,10 +4,6 @@ import { ServiceParser } from '../../src/parsers/service.parser';
|
|||||||
|
|
||||||
class TestServiceParser extends ServiceParser {
|
class TestServiceParser extends ServiceParser {
|
||||||
|
|
||||||
/*public getInstancePropertyName(): string {
|
|
||||||
return this._getInstancePropertyName();
|
|
||||||
}*/
|
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
describe('ServiceParser', () => {
|
describe('ServiceParser', () => {
|
||||||
@@ -20,19 +16,33 @@ describe('ServiceParser', () => {
|
|||||||
parser = new TestServiceParser();
|
parser = new TestServiceParser();
|
||||||
});
|
});
|
||||||
|
|
||||||
/*it('should extract variable used for TranslateService', () => {
|
it('should support extracting binary expressions', () => {
|
||||||
const contents = `
|
const contents = `
|
||||||
@Component({ })
|
@Component({ })
|
||||||
export class AppComponent {
|
export class AppComponent {
|
||||||
public constructor(
|
public constructor(protected _translateService: TranslateService) { }
|
||||||
_serviceA: ServiceA,
|
public test() {
|
||||||
public _serviceB: ServiceB,
|
const message = 'The Message';
|
||||||
protected _translateService: TranslateService
|
this._translateService.get(message || 'Fallback message');
|
||||||
) { }
|
}
|
||||||
`;
|
`;
|
||||||
const name = parser.getInstancePropertyName();
|
const keys = parser.extract(contents, componentFilename).keys();
|
||||||
expect(name).to.equal('_translateService');
|
expect(keys).to.deep.equal(['Fallback message']);
|
||||||
});*/
|
});
|
||||||
|
|
||||||
|
it('should support conditional operator', () => {
|
||||||
|
const contents = `
|
||||||
|
@Component({ })
|
||||||
|
export class AppComponent {
|
||||||
|
public constructor(protected _translateService: TranslateService) { }
|
||||||
|
public test() {
|
||||||
|
const message = 'The Message';
|
||||||
|
this._translateService.get(message ? message : 'Fallback message');
|
||||||
|
}
|
||||||
|
`;
|
||||||
|
const keys = parser.extract(contents, componentFilename).keys();
|
||||||
|
expect(keys).to.deep.equal(['Fallback message']);
|
||||||
|
});
|
||||||
|
|
||||||
it('should extract strings in TranslateService\'s get() method', () => {
|
it('should extract strings in TranslateService\'s get() method', () => {
|
||||||
const contents = `
|
const contents = `
|
||||||
@@ -60,6 +70,19 @@ describe('ServiceParser', () => {
|
|||||||
expect(keys).to.deep.equal(['Hello World']);
|
expect(keys).to.deep.equal(['Hello World']);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it('should extract strings in TranslateService\'s stream() method', () => {
|
||||||
|
const contents = `
|
||||||
|
@Component({ })
|
||||||
|
export class AppComponent {
|
||||||
|
public constructor(protected _translateService: TranslateService) { }
|
||||||
|
public test() {
|
||||||
|
this._translateService.stream('Hello World');
|
||||||
|
}
|
||||||
|
`;
|
||||||
|
const keys = parser.extract(contents, componentFilename).keys();
|
||||||
|
expect(keys).to.deep.equal(['Hello World']);
|
||||||
|
});
|
||||||
|
|
||||||
it('should extract array of strings in TranslateService\'s get() method', () => {
|
it('should extract array of strings in TranslateService\'s get() method', () => {
|
||||||
const contents = `
|
const contents = `
|
||||||
@Component({ })
|
@Component({ })
|
||||||
@@ -86,7 +109,33 @@ describe('ServiceParser', () => {
|
|||||||
expect(key).to.deep.equal(['Hello', 'World']);
|
expect(key).to.deep.equal(['Hello', 'World']);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('should not extract strings in get()/instant() methods of other services', () => {
|
it('should extract array of strings in TranslateService\'s stream() method', () => {
|
||||||
|
const contents = `
|
||||||
|
@Component({ })
|
||||||
|
export class AppComponent {
|
||||||
|
public constructor(protected _translateService: TranslateService) { }
|
||||||
|
public test() {
|
||||||
|
this._translateService.stream(['Hello', 'World']);
|
||||||
|
}
|
||||||
|
`;
|
||||||
|
const key = parser.extract(contents, componentFilename).keys();
|
||||||
|
expect(key).to.deep.equal(['Hello', 'World']);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should extract string arrays encapsulated in backticks', () => {
|
||||||
|
const contents = `
|
||||||
|
@Component({ })
|
||||||
|
export class AppComponent {
|
||||||
|
public constructor(protected _translateService: TranslateService) { }
|
||||||
|
public test() {
|
||||||
|
this._translateService.get([\`Hello\`, \`World\`]);
|
||||||
|
}
|
||||||
|
`;
|
||||||
|
const keys = parser.extract(contents, componentFilename).keys();
|
||||||
|
expect(keys).to.deep.equal(['Hello', 'World']);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should not extract strings in get()/instant()/stream() methods of other services', () => {
|
||||||
const contents = `
|
const contents = `
|
||||||
@Component({ })
|
@Component({ })
|
||||||
export class AppComponent {
|
export class AppComponent {
|
||||||
@@ -97,6 +146,7 @@ describe('ServiceParser', () => {
|
|||||||
public test() {
|
public test() {
|
||||||
this._otherService.get('Hello World');
|
this._otherService.get('Hello World');
|
||||||
this._otherService.instant('Hi there');
|
this._otherService.instant('Hi there');
|
||||||
|
this._otherService.stream('Hi there');
|
||||||
}
|
}
|
||||||
`;
|
`;
|
||||||
const keys = parser.extract(contents, componentFilename).keys();
|
const keys = parser.extract(contents, componentFilename).keys();
|
||||||
@@ -164,25 +214,89 @@ describe('ServiceParser', () => {
|
|||||||
expect(keys).to.deep.equal([]);
|
expect(keys).to.deep.equal([]);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it('should not extract variables', () => {
|
||||||
|
const contents = `
|
||||||
|
@Component({ })
|
||||||
|
export class AppComponent {
|
||||||
|
public constructor(protected translateService: TranslateService) { }
|
||||||
|
public test() {
|
||||||
|
this.translateService.get(["yes", variable]).then(translations => {
|
||||||
|
console.log(translations[variable]);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
`;
|
||||||
|
const keys = parser.extract(contents, componentFilename).keys();
|
||||||
|
expect(keys).to.deep.equal(['yes']);
|
||||||
|
});
|
||||||
|
|
||||||
it('should extract strings from all classes in the file', () => {
|
it('should extract strings from all classes in the file', () => {
|
||||||
const contents = `
|
const contents = `
|
||||||
import { Injectable } from '@angular/core';
|
import { Injectable } from '@angular/core';
|
||||||
import { TranslateService } from '@ngx-translate/core';
|
import { TranslateService } from '@ngx-translate/core';
|
||||||
export class Stuff {
|
export class Stuff {
|
||||||
thing: string;
|
thing: string;
|
||||||
|
translate: any;
|
||||||
constructor(thing: string) {
|
constructor(thing: string) {
|
||||||
|
this.translate.get('Not me');
|
||||||
this.thing = thing;
|
this.thing = thing;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@Injectable()
|
@Injectable()
|
||||||
|
export class MyComponent {
|
||||||
|
constructor(public translate: TranslateService) {
|
||||||
|
this.translate.instant("Extract me!");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
export class OtherClass {
|
||||||
|
constructor(thing: string, _translate: TranslateService) {
|
||||||
|
this._translate.get("Do not extract me");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
@Injectable()
|
||||||
export class AuthService {
|
export class AuthService {
|
||||||
constructor(public translate: TranslateService) {
|
constructor(public translate: TranslateService) {
|
||||||
console.log(this.translate.instant("Hello!"));
|
this.translate.instant("Hello!");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
`;
|
`;
|
||||||
const keys = parser.extract(contents, componentFilename).keys();
|
const keys = parser.extract(contents, componentFilename).keys();
|
||||||
expect(keys).to.deep.equal(['Hello!']);
|
expect(keys).to.deep.equal(['Extract me!', 'Hello!']);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should extract strings when TranslateService is declared as a property', () => {
|
||||||
|
const contents = `
|
||||||
|
export class MyComponent {
|
||||||
|
protected translateService: TranslateService;
|
||||||
|
public constructor() {
|
||||||
|
this.translateService = new TranslateService();
|
||||||
|
}
|
||||||
|
public test() {
|
||||||
|
this.translateService.instant('Hello World');
|
||||||
|
}
|
||||||
|
`;
|
||||||
|
const keys = parser.extract(contents, componentFilename).keys();
|
||||||
|
expect(keys).to.deep.equal(['Hello World']);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should extract strings passed to TranslateServices methods only', () => {
|
||||||
|
const contents = `
|
||||||
|
export class AppComponent implements OnInit {
|
||||||
|
constructor(protected config: Config, protected translateService: TranslateService) {}
|
||||||
|
|
||||||
|
public ngOnInit(): void {
|
||||||
|
this.localizeBackButton();
|
||||||
|
}
|
||||||
|
|
||||||
|
protected localizeBackButton(): void {
|
||||||
|
this.translateService.onLangChange.subscribe((event: LangChangeEvent) => {
|
||||||
|
this.config.set('backButtonText', this.translateService.instant('Back'));
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
`;
|
||||||
|
const keys = parser.extract(contents, componentFilename).keys();
|
||||||
|
expect(keys).to.deep.equal(['Back']);
|
||||||
});
|
});
|
||||||
|
|
||||||
});
|
});
|
||||||
|
@@ -1,39 +1,21 @@
|
|||||||
import { expect } from 'chai';
|
import { expect } from 'chai';
|
||||||
|
|
||||||
import { AbstractTemplateParser } from '../../src/parsers/abstract-template.parser';
|
import { isPathAngularComponent, extractComponentInlineTemplate } from '../../src/utils/utils';
|
||||||
|
|
||||||
class TestTemplateParser extends AbstractTemplateParser {
|
describe('Utils', () => {
|
||||||
|
|
||||||
public isAngularComponent(filePath: string): boolean {
|
|
||||||
return this._isAngularComponent(filePath);
|
|
||||||
}
|
|
||||||
|
|
||||||
public extractInlineTemplate(contents: string): string {
|
|
||||||
return this._extractInlineTemplate(contents);
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
describe('AbstractTemplateParser', () => {
|
|
||||||
|
|
||||||
let parser: TestTemplateParser;
|
|
||||||
|
|
||||||
beforeEach(() => {
|
|
||||||
parser = new TestTemplateParser();
|
|
||||||
});
|
|
||||||
|
|
||||||
it('should recognize js extension as angular component', () => {
|
it('should recognize js extension as angular component', () => {
|
||||||
const result = parser.isAngularComponent('test.js');
|
const result = isPathAngularComponent('test.js');
|
||||||
expect(result).to.equal(true);
|
expect(result).to.equal(true);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('should recognize ts extension as angular component', () => {
|
it('should recognize ts extension as angular component', () => {
|
||||||
const result = parser.isAngularComponent('test.ts');
|
const result = isPathAngularComponent('test.ts');
|
||||||
expect(result).to.equal(true);
|
expect(result).to.equal(true);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('should not recognize html extension as angular component', () => {
|
it('should not recognize html extension as angular component', () => {
|
||||||
const result = parser.isAngularComponent('test.html');
|
const result = isPathAngularComponent('test.html');
|
||||||
expect(result).to.equal(false);
|
expect(result).to.equal(false);
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -45,10 +27,22 @@ describe('AbstractTemplateParser', () => {
|
|||||||
})
|
})
|
||||||
export class TestComponent { }
|
export class TestComponent { }
|
||||||
`;
|
`;
|
||||||
const template = parser.extractInlineTemplate(contents);
|
const template = extractComponentInlineTemplate(contents);
|
||||||
expect(template).to.equal('<p translate>Hello World</p>');
|
expect(template).to.equal('<p translate>Hello World</p>');
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it('should extract inline template without html', () => {
|
||||||
|
const contents = `
|
||||||
|
@Component({
|
||||||
|
selector: 'test',
|
||||||
|
template: '{{ "Hello World" | translate }}'
|
||||||
|
})
|
||||||
|
export class TestComponent { }
|
||||||
|
`;
|
||||||
|
const template = extractComponentInlineTemplate(contents);
|
||||||
|
expect(template).to.equal('{{ "Hello World" | translate }}');
|
||||||
|
});
|
||||||
|
|
||||||
it('should extract inline template spanning multiple lines', () => {
|
it('should extract inline template spanning multiple lines', () => {
|
||||||
const contents = `
|
const contents = `
|
||||||
@Component({
|
@Component({
|
||||||
@@ -66,7 +60,7 @@ describe('AbstractTemplateParser', () => {
|
|||||||
})
|
})
|
||||||
export class TestComponent { }
|
export class TestComponent { }
|
||||||
`;
|
`;
|
||||||
const template = parser.extractInlineTemplate(contents);
|
const template = extractComponentInlineTemplate(contents);
|
||||||
expect(template).to.equal('\n\t\t\t\t\t<p>\n\t\t\t\t\t\tHello World\n\t\t\t\t\t</p>\n\t\t\t\t');
|
expect(template).to.equal('\n\t\t\t\t\t<p>\n\t\t\t\t\t\tHello World\n\t\t\t\t\t</p>\n\t\t\t\t');
|
||||||
});
|
});
|
||||||
|
|
@@ -0,0 +1,31 @@
|
|||||||
|
import { expect } from 'chai';
|
||||||
|
|
||||||
|
import { PostProcessorInterface } from '../../src/post-processors/post-processor.interface';
|
||||||
|
import { KeyAsDefaultValuePostProcessor } from '../../src/post-processors/key-as-default-value.post-processor';
|
||||||
|
import { TranslationCollection } from '../../src/utils/translation.collection';
|
||||||
|
|
||||||
|
describe('KeyAsDefaultValuePostProcessor', () => {
|
||||||
|
|
||||||
|
let processor: PostProcessorInterface;
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
processor = new KeyAsDefaultValuePostProcessor();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should use key as default value', () => {
|
||||||
|
const collection = new TranslationCollection({
|
||||||
|
'I have no value': '',
|
||||||
|
'I am already translated': 'Jeg er allerede oversat',
|
||||||
|
'Use this key as value as well': ''
|
||||||
|
});
|
||||||
|
const extracted = new TranslationCollection();
|
||||||
|
const existing = new TranslationCollection();
|
||||||
|
|
||||||
|
expect(processor.process(collection, extracted, existing).values).to.deep.equal({
|
||||||
|
'I have no value': 'I have no value',
|
||||||
|
'I am already translated': 'Jeg er allerede oversat',
|
||||||
|
'Use this key as value as well': 'Use this key as value as well'
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
});
|
@@ -0,0 +1,42 @@
|
|||||||
|
import { expect } from 'chai';
|
||||||
|
|
||||||
|
import { PostProcessorInterface } from '../../src/post-processors/post-processor.interface';
|
||||||
|
import { NullAsDefaultValuePostProcessor } from '../../src/post-processors/null-as-default-value.post-processor';
|
||||||
|
import { TranslationCollection } from '../../src/utils/translation.collection';
|
||||||
|
|
||||||
|
describe('NullAsDefaultValuePostProcessor', () => {
|
||||||
|
|
||||||
|
let processor: PostProcessorInterface;
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
processor = new NullAsDefaultValuePostProcessor();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should use null as default value', () => {
|
||||||
|
const draft = new TranslationCollection({ 'String A': '' });
|
||||||
|
const extracted = new TranslationCollection({ 'String A': '' });
|
||||||
|
const existing = new TranslationCollection();
|
||||||
|
expect(processor.process(draft, extracted, existing).values).to.deep.equal({
|
||||||
|
'String A': null
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should keep existing value even if it is an empty string', () => {
|
||||||
|
const draft = new TranslationCollection({ 'String A': '' });
|
||||||
|
const extracted = new TranslationCollection({ 'String A': '' });
|
||||||
|
const existing = new TranslationCollection({ 'String A': '' });
|
||||||
|
expect(processor.process(draft, extracted, existing).values).to.deep.equal({
|
||||||
|
'String A': ''
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should keep existing value', () => {
|
||||||
|
const draft = new TranslationCollection({ 'String A': 'Streng A' });
|
||||||
|
const extracted = new TranslationCollection({ 'String A': 'Streng A' });
|
||||||
|
const existing = new TranslationCollection({ 'String A': 'Streng A' });
|
||||||
|
expect(processor.process(draft, extracted, existing).values).to.deep.equal({
|
||||||
|
'String A': 'Streng A'
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
});
|
@@ -0,0 +1,36 @@
|
|||||||
|
import { expect } from 'chai';
|
||||||
|
|
||||||
|
import { PostProcessorInterface } from '../../src/post-processors/post-processor.interface';
|
||||||
|
import { PurgeObsoleteKeysPostProcessor } from '../../src/post-processors/purge-obsolete-keys.post-processor';
|
||||||
|
import { TranslationCollection } from '../../src/utils/translation.collection';
|
||||||
|
|
||||||
|
describe('PurgeObsoleteKeysPostProcessor', () => {
|
||||||
|
|
||||||
|
let processor: PostProcessorInterface;
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
processor = new PurgeObsoleteKeysPostProcessor();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should purge obsolete keys', () => {
|
||||||
|
const collection = new TranslationCollection({
|
||||||
|
'I am completely new': '',
|
||||||
|
'I already exist': '',
|
||||||
|
'I already exist but was not present in extract': ''
|
||||||
|
});
|
||||||
|
const extracted = new TranslationCollection({
|
||||||
|
'I am completely new': '',
|
||||||
|
'I already exist': ''
|
||||||
|
});
|
||||||
|
const existing = new TranslationCollection({
|
||||||
|
'I already exist': '',
|
||||||
|
'I already exist but was not present in extract': ''
|
||||||
|
});
|
||||||
|
|
||||||
|
expect(processor.process(collection, extracted, existing).values).to.deep.equal({
|
||||||
|
'I am completely new': '',
|
||||||
|
'I already exist': ''
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
});
|
33
tests/post-processors/sort-by-key.post-processor.spec.ts
Normal file
33
tests/post-processors/sort-by-key.post-processor.spec.ts
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
import { expect } from 'chai';
|
||||||
|
|
||||||
|
import { PostProcessorInterface } from '../../src/post-processors/post-processor.interface';
|
||||||
|
import { SortByKeyPostProcessor } from '../../src/post-processors/sort-by-key.post-processor';
|
||||||
|
import { TranslationCollection } from '../../src/utils/translation.collection';
|
||||||
|
|
||||||
|
describe('SortByKeyPostProcessor', () => {
|
||||||
|
|
||||||
|
let processor: PostProcessorInterface;
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
processor = new SortByKeyPostProcessor();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('should sort keys alphanumerically', () => {
|
||||||
|
const collection = new TranslationCollection({
|
||||||
|
'z': 'last value',
|
||||||
|
'a': 'a value',
|
||||||
|
'9': 'a numeric key',
|
||||||
|
'b': 'another value'
|
||||||
|
});
|
||||||
|
const extracted = new TranslationCollection();
|
||||||
|
const existing = new TranslationCollection();
|
||||||
|
|
||||||
|
expect(processor.process(collection, extracted, existing).values).to.deep.equal({
|
||||||
|
'9': 'a numeric key',
|
||||||
|
'a': 'a value',
|
||||||
|
'b': 'another value',
|
||||||
|
'z': 'last value'
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
});
|
@@ -69,7 +69,7 @@ describe('StringCollection', () => {
|
|||||||
|
|
||||||
it('should intersect with passed collection', () => {
|
it('should intersect with passed collection', () => {
|
||||||
collection = collection.addKeys(['red', 'green', 'blue']);
|
collection = collection.addKeys(['red', 'green', 'blue']);
|
||||||
const newCollection = new TranslationCollection( { red: '', blue: '' });
|
const newCollection = new TranslationCollection( { red: '', blue: '' });
|
||||||
expect(collection.intersect(newCollection).values).to.deep.equal({ red: '', blue: '' });
|
expect(collection.intersect(newCollection).values).to.deep.equal({ red: '', blue: '' });
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -79,10 +79,16 @@ describe('StringCollection', () => {
|
|||||||
expect(collection.intersect(newCollection).values).to.deep.equal({ red: 'rød', blue: 'blå' });
|
expect(collection.intersect(newCollection).values).to.deep.equal({ red: 'rød', blue: 'blå' });
|
||||||
});
|
});
|
||||||
|
|
||||||
it('should sort translations in alphabetical order', () => {
|
it('should sort keys alphabetically', () => {
|
||||||
collection = new TranslationCollection({ red: 'rød', green: 'grøn', blue: 'blå' });
|
collection = new TranslationCollection({ red: 'rød', green: 'grøn', blue: 'blå' });
|
||||||
collection = collection.sort();
|
collection = collection.sort();
|
||||||
expect(collection.keys()).deep.equal(['blue', 'green', 'red']);
|
expect(collection.keys()).deep.equal(['blue', 'green', 'red']);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it('should map values', () => {
|
||||||
|
collection = new TranslationCollection({ red: 'rød', green: 'grøn', blue: 'blå' });
|
||||||
|
collection = collection.map((key, val) => 'mapped value');
|
||||||
|
expect(collection.values).to.deep.equal({ red: 'mapped value', green: 'mapped value', blue: 'mapped value' });
|
||||||
|
});
|
||||||
|
|
||||||
});
|
});
|
||||||
|
@@ -5,10 +5,10 @@
|
|||||||
"noImplicitAny": true,
|
"noImplicitAny": true,
|
||||||
"removeComments": true,
|
"removeComments": true,
|
||||||
"declaration": true,
|
"declaration": true,
|
||||||
"target": "es5",
|
"target": "es2015",
|
||||||
"lib": [
|
"lib": [
|
||||||
"dom",
|
"dom",
|
||||||
"es2015"
|
"es2018"
|
||||||
],
|
],
|
||||||
"module": "commonjs",
|
"module": "commonjs",
|
||||||
"outDir": "./dist/",
|
"outDir": "./dist/",
|
||||||
|
Reference in New Issue
Block a user