Compare commits

...

35 Commits

Author SHA1 Message Date
Kim Biesbjerg
8aa2774eca Bump version 2020-03-21 12:21:14 +01:00
Kim Biesbjerg
37ca29648a Remove files committed by mistake 2020-03-21 12:20:06 +01:00
Kim Biesbjerg
97d844c3d2 Fix paths on Windows. Closes #171 2020-03-21 04:18:07 -07:00
Kim Biesbjerg
e7795c5349 Use rimraf to support Windows 2020-03-21 04:17:17 -07:00
Kim Biesbjerg
9da4939f5d Fix readme 2020-03-19 14:04:00 +01:00
Kim Biesbjerg
8fa7b60d2d Update dependencies 2020-03-19 11:18:39 +01:00
Kim Biesbjerg
d3d6a72d5f Update readme 2020-03-19 11:18:15 +01:00
Kim Biesbjerg
bfd069b755 Change description of default key value 2020-03-19 11:17:55 +01:00
Kim Biesbjerg
72b4fb0545 (chore) clean up tsconfig 2020-03-08 10:26:47 +01:00
Kim Biesbjerg
131713d9db (chore) refactor to use safe navigation operator 2020-03-08 10:07:27 +01:00
Jens Habegger
a17ad9c373 Parse Pipes with Angular Compiler AST, enable ternary operator parsing (#159)
(feature) Use AST-based approach to translate pipe parsing. Also enables parsing translate pipes from any position in a pipe chain. Fixes #111, Fixes #154. (Thanks @TekSiDoT)
2020-03-08 09:54:44 +01:00
Kim Biesbjerg
56a5ab31bf (feature) add StringAsDefaultValue. Closes #40 2020-03-07 09:21:01 +01:00
Kim Biesbjerg
d579114dd2 (chore) update typescript 2020-03-07 09:08:56 +01:00
Kim Biesbjerg
cc45df9b44 prevent conflicting options 2020-03-06 15:54:40 +01:00
Kim Biesbjerg
b813ec0063 (feature) add support for expanding paths on Windows + added more usage examples to cli 2020-03-06 13:53:46 +01:00
Kim Biesbjerg
7b94c9b9a5 (chore) update lint-staged usage 2020-03-06 12:14:53 +01:00
Kim Biesbjerg
a45039ef17 (chore) update dependencies 2020-03-06 12:14:14 +01:00
Robbert Wolfs
5d0c92871e Update flat dependency to the original, but the latest version (#157)
(chore) update flat package
2020-03-06 12:02:39 +01:00
Kim Biesbjerg
9887f9d6ab update tsconfig 2019-09-19 15:24:00 +02:00
Kim Biesbjerg
608c4e8e22 cleanup 2019-09-19 15:22:39 +02:00
Kim Biesbjerg
0345778aa1 refactor 2019-09-19 15:07:06 +02:00
Kim Biesbjerg
77769983d5 refactor 2019-09-19 15:03:46 +02:00
Kim Biesbjerg
306622b9a0 (chore) run prettier 2019-09-18 14:16:47 +02:00
Kim Biesbjerg
7d0d52429f (chore) add husky, lint-staged and prettier 2019-09-18 14:11:12 +02:00
Kim Biesbjerg
2fce357306 fix 2019-09-18 14:04:11 +02:00
Kim Biesbjerg
3827789346 cleanup 2019-09-18 13:47:57 +02:00
Kim Biesbjerg
8c8fe8d131 make ts compiler options more strict 2019-09-18 13:36:08 +02:00
Kim Biesbjerg
7bf0c138b8 (refactor) rename constants 2019-09-17 14:24:01 +02:00
Kim Biesbjerg
16bf5f59e0 Check extracted is an instance of TranslationCollection before merging 2019-09-17 14:15:21 +02:00
Kim Biesbjerg
096fc79a9b Update readme 2019-09-17 08:25:47 +02:00
Kim Biesbjerg
a72dbf0494 (refactor) rename variables 2019-09-17 08:15:51 +02:00
Kim Biesbjerg
8fd157802b update README 2019-09-16 20:42:10 +02:00
Kim Biesbjerg
1db4794ee9 bump version 2019-09-16 20:39:22 +02:00
Kim Biesbjerg
1eb1d0092d remove default boolean values 2019-09-16 20:39:02 +02:00
Kim Biesbjerg
4d3a3529b8 add typeRoots 2019-09-16 20:38:23 +02:00
41 changed files with 2310 additions and 975 deletions

2
.gitignore vendored
View File

@@ -8,6 +8,8 @@ npm-debug.log*
# Compiled files # Compiled files
dist dist
src/**/*.js
tests/**/*.js
# Extracted strings # Extracted strings
strings.json strings.json

View File

@@ -2,13 +2,11 @@ If this tool saves you time, please consider making a donation towards the conti
[![Donate](images/donate-badge.png)](https://donate.biesbjerg.com) [![Donate](images/donate-badge.png)](https://donate.biesbjerg.com)
# Usage # ngx-translate-extract
## 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 ## Install
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`
@@ -23,7 +21,7 @@ Add a script to your project's `package.json`:
``` ```
You can now run `npm run extract-i18n` and it will extract strings from your project. You can now run `npm run extract-i18n` and it will extract strings from your project.
### Examples ## Usage
**Extract from dir and save to file** **Extract from dir and save to file**
@@ -36,14 +34,8 @@ You can now run `npm run extract-i18n` and it will extract strings from your pro
**Extract and save to multiple files using path expansion** **Extract and save to multiple files using path expansion**
_Note: This method does not work on Windows!_
`ngx-translate-extract --input ./src --output ./src/i18n/{da,en}.json` `ngx-translate-extract --input ./src --output ./src/i18n/{da,en}.json`
On Windows you must specify each output destination individually:
`ngx-translate-extract --input ./src --output ./src/i18n/da.json ./src/i18n/en.json`
### JSON indentation ### JSON indentation
Tabs are used by default for indentation when saving extracted strings in json formats: Tabs are used by default for indentation when saving extracted strings in json formats:
@@ -51,8 +43,8 @@ If you want to use spaces instead, you can do the following:
`ngx-translate-extract --input ./src --output ./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 ### 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. If you want to extract strings that are not passed directly to `TranslateService`'s `get()`/`instant()`/`stream()` methods, you can wrap them in a marker function to let `ngx-translate-extract` know you want to extract them.
Install marker function: Install marker function:
`npm install @biesbjerg/ngx-translate-extract-marker` `npm install @biesbjerg/ngx-translate-extract-marker`
@@ -63,10 +55,6 @@ import { marker } from '@biesbjerg/ngx-translate-extract-marker';
marker('Extract me'); marker('Extract me');
``` ```
Add the `marker` argument when running the extract script:
`ngx-translate-extract ... -m extract`
You can alias the marker function if needed: You can alias the marker function if needed:
```ts ```ts
@@ -75,37 +63,40 @@ import { marker as _ } from '@biesbjerg/ngx-translate-extract-marker';
_('Extract me'); _('Extract me');
``` ```
`ngx-translate-extract ... -m _` _Note: `ngx-translate-extract` will automatically detect the import name_
## Commandline arguments ### Commandline arguments
```shell ```
Usage: Usage:
ngx-translate-extract [options] ngx-translate-extract [options]
Options: Output
--version, -v Show version number [boolean] --format, -f Format [string] [choices: "json", "namespaced-json", "pot"] [default: "json"]
--help, -h Show help [boolean] --format-indentation, --fi Format indentation (JSON/Namedspaced JSON) [string] [default: " "]
--input, -i Paths you would like to extract strings from. You --sort, -s Sort strings in alphabetical order [boolean]
can use path expansion, glob patterns and multiple --clean, -c Remove obsolete strings after merge [boolean]
paths --replace, -r Replace the contents of output file if it exists (Merges by default) [boolean]
[array] [default: current working path]
--patterns, -p Extract strings from the following file patterns
[array] [default: ["/**/*.html","/**/*.ts"]]
--output, -o Paths where you would like to save extracted
strings. You can use path expansion, glob patterns
and multiple paths [array] [required]
--format, -f Output format
[string] [choices: "json", "namespaced-json", "pot"] [default: "json"]
--format-indentation, --fi Output format indentation [string] [default: " "]
--replace, -r Replace the contents of output file if it exists
(Merges by default) [boolean] [default: false]
--sort, -s Sort strings in alphabetical order when saving
[boolean] [default: false]
--clean, -c Remove obsolete strings when merging
[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 Extracted key value (defaults to empty string)
--key-as-default-value, -k Use key as default value [boolean]
--null-as-default-value, -n Use null as default value [boolean]
--string-as-default-value, -d Use string as default value [string]
Options:
--version, -v Show version number [boolean]
--help, -h Show help [boolean]
--input, -i Paths you would like to extract strings from. You can use path expansion, glob patterns and
multiple paths [array] [required] [default: ["/Users/kim/apps/ngx-translate-extract"]]
--output, -o Paths where you would like to save extracted strings. You can use path expansion, glob
patterns and multiple paths [array] [required]
Examples:
ngx-translate-extract -i ./src-a/ -i ./src-b/ -o strings.json Extract (ts, html) from multiple paths
ngx-translate-extract -i './{src-a,src-b}/' -o strings.json Extract (ts, html) from multiple paths using brace
expansion
ngx-translate-extract -i ./src/ -o ./i18n/da.json -o ./i18n/en.json Extract (ts, html) and save to da.json and en.json
ngx-translate-extract -i ./src/ -o './i18n/{en,da}.json' Extract (ts, html) and save to da.json and en.json
using brace expansion
ngx-translate-extract -i './src/**/*.{ts,tsx,html}' -o strings.json Extract from ts, tsx and html
ngx-translate-extract -i './src/**/!(*.spec).{ts,html}' -o Extract from ts, html, excluding files with ".spec"
strings.json

2278
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,6 +1,6 @@
{ {
"name": "@biesbjerg/ngx-translate-extract", "name": "@biesbjerg/ngx-translate-extract",
"version": "4.1.0", "version": "5.0.1",
"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",
@@ -14,10 +14,27 @@
"scripts": { "scripts": {
"build": "npm run clean && tsc", "build": "npm run clean && tsc",
"watch": "npm run clean && tsc --watch", "watch": "npm run clean && tsc --watch",
"clean": "rm -rf ./dist", "clean": "rimraf ./dist",
"lint": "tslint --force './src/**/*.ts'", "lint": "tslint --force './src/**/*.ts'",
"test": "mocha -r ts-node/register tests/**/*.spec.ts" "test": "mocha -r ts-node/register tests/**/*.spec.ts"
}, },
"husky": {
"hooks": {
"pre-commit": "lint-staged && npm test"
}
},
"prettier": {
"trailingComma": "none",
"printWidth": 145,
"useTabs": true,
"singleQuote": true
},
"lint-staged": {
"{src,tests}/**/*.{ts}": [
"tslint --project tsconfig.json -c tslint.commit.json --fix",
"prettier --write"
]
},
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://github.com/biesbjerg/ngx-translate-extract.git" "url": "https://github.com/biesbjerg/ngx-translate-extract.git"
@@ -40,38 +57,43 @@
}, },
"homepage": "https://github.com/biesbjerg/ngx-translate-extract", "homepage": "https://github.com/biesbjerg/ngx-translate-extract",
"engines": { "engines": {
"node": ">=8" "node": ">=12"
}, },
"config": {}, "config": {},
"devDependencies": { "devDependencies": {
"@types/chai": "^4.2.2", "@types/braces": "^3.0.0",
"@types/flat": "^0.0.28", "@types/chai": "^4.2.11",
"@types/flat": "^5.0.0",
"@types/glob": "^7.1.1", "@types/glob": "^7.1.1",
"@types/mkdirp": "^0.5.2", "@types/mkdirp": "^1.0.0",
"@types/mocha": "^5.2.7", "@types/mocha": "^7.0.2",
"@types/node": "^12.7.5", "@types/node": "^12.12.30",
"@types/yargs": "^13.0.2", "@types/yargs": "^15.0.4",
"braces": "^3.0.2",
"chai": "^4.2.0", "chai": "^4.2.0",
"mocha": "^6.2.0", "husky": "^4.2.3",
"ts-node": "^8.4.1", "lint-staged": "^10.0.8",
"tslint": "^5.20.0", "mocha": "^7.1.1",
"tslint-eslint-rules": "^5.4.0" "prettier": "^1.19.1",
"ts-node": "^8.7.0",
"tslint": "^6.1.0",
"tslint-config-prettier": "^1.18.0",
"tslint-eslint-rules": "^5.4.0",
"tslint-etc": "^1.10.1",
"rimraf": "^3.0.2"
}, },
"bundledDependencies": [
"flat"
],
"dependencies": { "dependencies": {
"@angular/compiler": "^8.2.6", "@angular/compiler": "^9.0.7",
"@phenomnomnominal/tsquery": "^3.0.0", "@phenomnomnominal/tsquery": "^4.0.0",
"boxen": "^4.1.0", "boxen": "^4.2.0",
"colorette": "^1.1.0", "colorette": "^1.1.0",
"flat": "github:lenchvolodymyr/flat#ffe77ef", "flat": "^5.0.0",
"gettext-parser": "^4.0.2", "gettext-parser": "^4.0.3",
"glob": "^7.1.4", "glob": "^7.1.6",
"mkdirp": "^0.5.1", "mkdirp": "^1.0.3",
"path": "^0.12.7", "path": "^0.12.7",
"terminal-link": "^2.0.0", "terminal-link": "^2.1.1",
"typescript": "^3.6.3", "typescript": "^3.8.3",
"yargs": "^14.0.0" "yargs": "^15.3.1"
} }
} }

View File

@@ -1,4 +1,3 @@
import * as fs from 'fs';
import * as yargs from 'yargs'; import * as yargs from 'yargs';
import { ExtractTask } from './tasks/extract.task'; import { ExtractTask } from './tasks/extract.task';
@@ -11,12 +10,26 @@ import { PostProcessorInterface } from '../post-processors/post-processor.interf
import { SortByKeyPostProcessor } from '../post-processors/sort-by-key.post-processor'; import { SortByKeyPostProcessor } from '../post-processors/sort-by-key.post-processor';
import { KeyAsDefaultValuePostProcessor } from '../post-processors/key-as-default-value.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 { NullAsDefaultValuePostProcessor } from '../post-processors/null-as-default-value.post-processor';
import { StringAsDefaultValuePostProcessor } from '../post-processors/string-as-default-value.post-processor';
import { PurgeObsoleteKeysPostProcessor } from '../post-processors/purge-obsolete-keys.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 { normalizePaths } from '../utils/fs-helpers';
import { donateMessage } from '../utils/donate'; import { donateMessage } from '../utils/donate';
export const cli = yargs // First parsing pass to be able to access pattern argument for use input/output arguments
const y = yargs
.option('patterns', {
alias: 'p',
describe: 'Default patterns',
type: 'array',
default: ['/**/*.html', '/**/*.ts'],
hidden: true
});
const parsed = y.parse();
export const cli = y
.usage('Extract strings from files for translation.\nUsage: $0 [options]') .usage('Extract strings from files for translation.\nUsage: $0 [options]')
.version(require(__dirname + '/../../package.json').version) .version(require(__dirname + '/../../package.json').version)
.alias('version', 'v') .alias('version', 'v')
@@ -25,24 +38,14 @@ export const cli = yargs
.option('input', { .option('input', {
alias: 'i', alias: 'i',
describe: 'Paths you would like to extract strings from. You can use path expansion, glob patterns and multiple paths', describe: 'Paths you would like to extract strings from. You can use path expansion, glob patterns and multiple paths',
default: process.env.PWD, default: [process.env.PWD],
type: 'array', type: 'array',
normalize: true normalize: true,
required: true
}) })
.check(options => { .coerce('input', (input: string[]) => {
(options.input as unknown as string[]).forEach((dir: string) => { const paths = normalizePaths(input, parsed.patterns);
if (!fs.existsSync(dir) || !fs.statSync(dir).isDirectory()) { return paths;
throw new Error(`The path you supplied was not found: '${dir}'`);
}
});
return true;
})
.option('patterns', {
alias: 'p',
describe: 'Extract strings from the following file patterns',
type: 'array',
default: ['/**/*.html', '/**/*.ts']
}) })
.option('output', { .option('output', {
alias: 'o', alias: 'o',
@@ -51,65 +54,75 @@ export const cli = yargs
normalize: true, normalize: true,
required: true required: true
}) })
.coerce('output', (output: string[]) => {
const paths = normalizePaths(output, parsed.patterns);
return paths;
})
.option('format', { .option('format', {
alias: 'f', alias: 'f',
describe: 'Output format', describe: 'Format',
default: 'json', default: 'json',
type: 'string', type: 'string',
choices: ['json', 'namespaced-json', 'pot'] choices: ['json', 'namespaced-json', 'pot']
}) })
.option('format-indentation', { .option('format-indentation', {
alias: 'fi', alias: 'fi',
describe: 'Output format indentation', describe: 'Format indentation (JSON/Namedspaced JSON)',
default: '\t', default: '\t',
type: 'string' type: 'string'
}) })
.option('replace', { .option('replace', {
alias: 'r', alias: 'r',
describe: 'Replace the contents of output file if it exists (Merges by default)', describe: 'Replace the contents of output file if it exists (Merges by default)',
default: false,
type: 'boolean' type: 'boolean'
}) })
.option('sort', { .option('sort', {
alias: 's', alias: 's',
describe: 'Sort strings in alphabetical order when saving', describe: 'Sort strings in alphabetical order',
default: false,
type: 'boolean' type: 'boolean'
}) })
.option('clean', { .option('clean', {
alias: 'c', alias: 'c',
describe: 'Remove obsolete strings when merging', describe: 'Remove obsolete strings after merge',
default: false,
type: 'boolean' type: 'boolean'
}) })
.option('key-as-default-value', { .option('key-as-default-value', {
alias: 'k', alias: 'k',
describe: 'Use key as default value for translations', describe: 'Use key as default value',
default: false, type: 'boolean',
type: 'boolean' conflicts: ['null-as-default-value', 'string-as-default-value']
}) })
.option('null-as-default-value', { .option('null-as-default-value', {
alias: 'n', alias: 'n',
describe: 'Use null as default value for translations', describe: 'Use null as default value',
default: false, type: 'boolean',
type: 'boolean' conflicts: ['key-as-default-value', 'string-as-default-value']
}) })
.option('string-as-default-value', {
alias: 'd',
describe: 'Use string as default value',
type: 'string',
conflicts: ['null-as-default-value', 'key-as-default-value']
})
.group(['format', 'format-indentation', 'sort', 'clean', 'replace'], 'Output')
.group(['key-as-default-value', 'null-as-default-value', 'string-as-default-value'], 'Extracted key value (defaults to empty string)')
.conflicts('key-as-default-value', 'null-as-default-value') .conflicts('key-as-default-value', 'null-as-default-value')
.example(`$0 -i ./src-a/ -i ./src-b/ -o strings.json`, 'Extract (ts, html) from multiple paths')
.example(`$0 -i './{src-a,src-b}/' -o strings.json`, 'Extract (ts, html) from multiple paths using brace expansion')
.example(`$0 -i ./src/ -o ./i18n/da.json -o ./i18n/en.json`, 'Extract (ts, html) and save to da.json and en.json')
.example(`$0 -i ./src/ -o './i18n/{en,da}.json'`, 'Extract (ts, html) and save to da.json and en.json using brace expansion')
.example(`$0 -i './src/**/*.{ts,tsx,html}' -o strings.json`, 'Extract from ts, tsx and html')
.example(`$0 -i './src/**/!(*.spec).{ts,html}' -o strings.json`, 'Extract from ts, html, excluding files with ".spec" in filename')
.wrap(110)
.exitProcess(true) .exitProcess(true)
.parse(process.argv); .parse(process.argv);
const extractTask = new ExtractTask(cli.input as unknown as string[], cli.output, { const extractTask = new ExtractTask(cli.input, cli.output, {
replace: cli.replace, replace: cli.replace
patterns: cli.patterns
}); });
// Parsers // Parsers
const parsers: ParserInterface[] = [ const parsers: ParserInterface[] = [new PipeParser(), new DirectiveParser(), new ServiceParser(), new MarkerParser()];
new PipeParser(),
new DirectiveParser(),
new ServiceParser(),
new MarkerParser()
];
extractTask.setParsers(parsers); extractTask.setParsers(parsers);
// Post processors // Post processors
@@ -121,7 +134,10 @@ if (cli.keyAsDefaultValue) {
postProcessors.push(new KeyAsDefaultValuePostProcessor()); postProcessors.push(new KeyAsDefaultValuePostProcessor());
} else if (cli.nullAsDefaultValue) { } else if (cli.nullAsDefaultValue) {
postProcessors.push(new NullAsDefaultValuePostProcessor()); postProcessors.push(new NullAsDefaultValuePostProcessor());
} else if (cli.stringAsDefaultValue) {
postProcessors.push(new StringAsDefaultValuePostProcessor({ defaultValue: cli.stringAsDefaultValue as string }));
} }
if (cli.sort) { if (cli.sort) {
postProcessors.push(new SortByKeyPostProcessor()); postProcessors.push(new SortByKeyPostProcessor());
} }

View File

@@ -12,14 +12,11 @@ import * as mkdirp from 'mkdirp';
export interface ExtractTaskOptionsInterface { export interface ExtractTaskOptionsInterface {
replace?: boolean; replace?: boolean;
patterns?: string[];
} }
export class ExtractTask implements TaskInterface { export class ExtractTask implements TaskInterface {
protected options: ExtractTaskOptionsInterface = { protected options: ExtractTaskOptionsInterface = {
replace: false, replace: false
patterns: []
}; };
protected parsers: ParserInterface[] = []; protected parsers: ParserInterface[] = [];
@@ -101,13 +98,13 @@ export class ExtractTask implements TaskInterface {
*/ */
protected extract(): TranslationCollection { protected extract(): TranslationCollection {
let collection: TranslationCollection = new TranslationCollection(); let collection: TranslationCollection = new TranslationCollection();
this.inputs.forEach(dir => { this.inputs.forEach(pattern => {
this.readDir(dir, this.options.patterns).forEach(path => { this.getFiles(pattern).forEach(filePath => {
this.out(dim('- %s'), path); this.out(dim('- %s'), filePath);
const contents: string = fs.readFileSync(path, 'utf-8'); const contents: string = fs.readFileSync(filePath, 'utf-8');
this.parsers.forEach(parser => { this.parsers.forEach(parser => {
const extracted = parser.extract(contents, path); const extracted = parser.extract(contents, filePath);
if (extracted) { if (extracted instanceof TranslationCollection) {
collection = collection.union(extracted); collection = collection.union(extracted);
} }
}); });
@@ -139,14 +136,12 @@ export class ExtractTask implements TaskInterface {
} }
/** /**
* Get all files in dir matching patterns * Get all files matching pattern
*/ */
protected readDir(dir: string, patterns: string[]): string[] { protected getFiles(pattern: string): string[] {
return patterns.reduce((results, pattern) => { return glob
return glob.sync(dir + pattern) .sync(pattern)
.filter(path => fs.statSync(path).isFile()) .filter(filePath => fs.statSync(filePath).isFile());
.concat(results);
}, []);
} }
protected out(...args: any[]): void { protected out(...args: any[]): void {
@@ -178,5 +173,4 @@ export class ExtractTask implements TaskInterface {
this.out(cyan(dim(`- ${this.compiler.constructor.name}`))); this.out(cyan(dim(`- ${this.compiler.constructor.name}`)));
this.out(); this.out();
} }
} }

View File

@@ -4,14 +4,16 @@ import { NamespacedJsonCompiler } from '../compilers/namespaced-json.compiler';
import { PoCompiler } from '../compilers/po.compiler'; import { PoCompiler } from '../compilers/po.compiler';
export class CompilerFactory { export class CompilerFactory {
public static create(format: string, options?: {}): CompilerInterface { public static create(format: string, options?: {}): CompilerInterface {
switch (format) { switch (format) {
case 'pot': return new PoCompiler(options); case 'pot':
case 'json': return new JsonCompiler(options); return new PoCompiler(options);
case 'namespaced-json': return new NamespacedJsonCompiler(options); case 'json':
default: throw new Error(`Unknown format: ${format}`); return new JsonCompiler(options);
case 'namespaced-json':
return new NamespacedJsonCompiler(options);
default:
throw new Error(`Unknown format: ${format}`);
} }
} }
} }

View File

@@ -1,11 +1,9 @@
import { TranslationCollection } from '../utils/translation.collection'; import { TranslationCollection } from '../utils/translation.collection';
export interface CompilerInterface { export interface CompilerInterface {
extension: string; extension: string;
compile(collection: TranslationCollection): string; compile(collection: TranslationCollection): string;
parse(contents: string): TranslationCollection; parse(contents: string): TranslationCollection;
} }

View File

@@ -5,7 +5,6 @@ import { stripBOM } from '../utils/utils';
import { flatten } 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: string = 'json'; public extension: string = 'json';
@@ -31,5 +30,4 @@ export class JsonCompiler implements CompilerInterface {
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');
} }
} }

View File

@@ -5,7 +5,6 @@ import { stripBOM } from '../utils/utils';
import { flatten, unflatten } from 'flat'; import { flatten, unflatten } from 'flat';
export class NamespacedJsonCompiler implements CompilerInterface { export class NamespacedJsonCompiler implements CompilerInterface {
public indentation: string = '\t'; public indentation: string = '\t';
public extension = 'json'; public extension = 'json';
@@ -27,5 +26,4 @@ export class NamespacedJsonCompiler implements CompilerInterface {
const values: {} = flatten(JSON.parse(stripBOM(contents))); const values: {} = flatten(JSON.parse(stripBOM(contents)));
return new TranslationCollection(values); return new TranslationCollection(values);
} }
} }

View File

@@ -4,7 +4,6 @@ import { TranslationCollection, TranslationType } from '../utils/translation.col
import * as gettext from 'gettext-parser'; import * as gettext from 'gettext-parser';
export class PoCompiler implements CompilerInterface { export class PoCompiler implements CompilerInterface {
public extension: string = 'po'; public extension: string = 'po';
/** /**
@@ -23,13 +22,18 @@ export class PoCompiler implements CompilerInterface {
'content-transfer-encoding': '8bit' 'content-transfer-encoding': '8bit'
}, },
translations: { translations: {
[this.domain]: Object.keys(collection.values).reduce((translations, key) => { [this.domain]: Object.keys(collection.values).reduce(
translations[key] = { (translations, key) => {
msgid: key, return {
msgstr: collection.get(key) ...translations,
}; [key]: {
return translations; msgid: key,
}, {} as any) msgstr: collection.get(key)
}
};
},
{} as any
)
} }
}; };
@@ -46,12 +50,16 @@ export class PoCompiler implements CompilerInterface {
const values = Object.keys(po.translations[this.domain]) const values = Object.keys(po.translations[this.domain])
.filter(key => key.length > 0) .filter(key => key.length > 0)
.reduce((values, key) => { .reduce(
values[key] = po.translations[this.domain][key].msgstr.pop(); (result, key) => {
return values; return {
}, {} as TranslationType); ...result,
[key]: po.translations[this.domain][key].msgstr.pop()
};
},
{} as TranslationType
);
return new TranslationCollection(values); return new TranslationCollection(values);
} }
} }

View File

@@ -5,15 +5,14 @@ import { isPathAngularComponent, extractComponentInlineTemplate } from '../utils
import { parseTemplate, TmplAstNode, TmplAstElement, TmplAstTextAttribute } from '@angular/compiler'; import { parseTemplate, TmplAstNode, TmplAstElement, TmplAstTextAttribute } from '@angular/compiler';
export class DirectiveParser implements ParserInterface { export class DirectiveParser implements ParserInterface {
public extract(source: string, filePath: string): TranslationCollection | null {
public extract(template: string, path: string): TranslationCollection { if (filePath && isPathAngularComponent(filePath)) {
if (path && isPathAngularComponent(path)) { source = extractComponentInlineTemplate(source);
template = extractComponentInlineTemplate(template);
} }
let collection: TranslationCollection = new TranslationCollection(); let collection: TranslationCollection = new TranslationCollection();
const nodes: TmplAstNode[] = this.parseTemplate(template, path); const nodes: TmplAstNode[] = this.parseTemplate(source, filePath);
this.getTranslatableElements(nodes).forEach(element => { this.getTranslatableElements(nodes).forEach(element => {
const key = this.getElementTranslateAttrValue(element) || this.getElementContents(element); const key = this.getElementTranslateAttrValue(element) || this.getElementContents(element);
collection = collection.add(key); collection = collection.add(key);
@@ -42,13 +41,16 @@ export class DirectiveParser implements ParserInterface {
return [node]; return [node];
} }
return node.children.reduce((result: TmplAstElement[], childNode: TmplAstNode) => { return node.children.reduce(
if (this.isElement(childNode)) { (result: TmplAstElement[], childNode: TmplAstNode) => {
const children = this.findChildrenElements(childNode); if (this.isElement(childNode)) {
return result.concat(children); const children = this.findChildrenElements(childNode);
} return result.concat(children);
return result; }
}, [node]); return result;
},
[node]
);
} }
protected parseTemplate(template: string, path: string): TmplAstNode[] { protected parseTemplate(template: string, path: string): TmplAstNode[] {
@@ -56,9 +58,7 @@ export class DirectiveParser implements ParserInterface {
} }
protected isElement(node: any): node is TmplAstElement { protected isElement(node: any): node is TmplAstElement {
return node return node?.attributes && node?.children;
&& node.attributes !== undefined
&& node.children !== undefined;
} }
protected isTranslatable(node: TmplAstNode): boolean { protected isTranslatable(node: TmplAstNode): boolean {
@@ -70,7 +70,7 @@ export class DirectiveParser implements ParserInterface {
protected getElementTranslateAttrValue(element: TmplAstElement): string { protected getElementTranslateAttrValue(element: TmplAstElement): string {
const attr: TmplAstTextAttribute = element.attributes.find(attribute => attribute.name === 'translate'); const attr: TmplAstTextAttribute = element.attributes.find(attribute => attribute.name === 'translate');
return attr && attr.value || ''; return attr?.value ?? '';
} }
protected getElementContents(element: TmplAstElement): string { protected getElementContents(element: TmplAstElement): string {
@@ -79,5 +79,4 @@ export class DirectiveParser implements ParserInterface {
const end = element.endSourceSpan.start.offset; const end = element.endSourceSpan.start.offset;
return contents.substring(start, end).trim(); return contents.substring(start, end).trim();
} }
} }

View File

@@ -4,31 +4,29 @@ import { ParserInterface } from './parser.interface';
import { TranslationCollection } from '../utils/translation.collection'; import { TranslationCollection } from '../utils/translation.collection';
import { getNamedImportAlias, findFunctionCallExpressions, getStringsFromExpression } from '../utils/ast-helpers'; import { getNamedImportAlias, findFunctionCallExpressions, getStringsFromExpression } from '../utils/ast-helpers';
const MARKER_PACKAGE_MODULE_NAME = '@biesbjerg/ngx-translate-extract-marker'; const MARKER_MODULE_NAME = '@biesbjerg/ngx-translate-extract-marker';
const MARKER_PACKAGE_IMPORT_NAME = 'marker'; const MARKER_IMPORT_NAME = 'marker';
export class MarkerParser implements ParserInterface { export class MarkerParser implements ParserInterface {
public extract(source: string, filePath: string): TranslationCollection | null {
const sourceFile = tsquery.ast(source, filePath);
public extract(contents: string, filePath: string): TranslationCollection | null { const markerImportName = getNamedImportAlias(sourceFile, MARKER_MODULE_NAME, MARKER_IMPORT_NAME);
const sourceFile = tsquery.ast(contents, filePath); if (!markerImportName) {
return null;
const markerFnName = getNamedImportAlias(sourceFile, MARKER_PACKAGE_MODULE_NAME, MARKER_PACKAGE_IMPORT_NAME);
if (!markerFnName) {
return;
} }
let collection: TranslationCollection = new TranslationCollection(); let collection: TranslationCollection = new TranslationCollection();
const callNodes = findFunctionCallExpressions(sourceFile, markerFnName); const callExpressions = findFunctionCallExpressions(sourceFile, markerImportName);
callNodes.forEach(callNode => { callExpressions.forEach(callExpression => {
const [firstArgNode] = callNode.arguments; const [firstArg] = callExpression.arguments;
if (!firstArgNode) { if (!firstArg) {
return; return;
} }
const strings = getStringsFromExpression(firstArgNode); const strings = getStringsFromExpression(firstArg);
collection = collection.addKeys(strings); collection = collection.addKeys(strings);
}); });
return collection; return collection;
} }
} }

View File

@@ -1,7 +1,5 @@
import { TranslationCollection } from '../utils/translation.collection'; import { TranslationCollection } from '../utils/translation.collection';
export interface ParserInterface { export interface ParserInterface {
extract(source: string, filePath: string): TranslationCollection | null; extract(source: string, filePath: string): TranslationCollection | null;
} }

View File

@@ -1,27 +1,100 @@
import { TmplAstNode, parseTemplate, BindingPipe, LiteralPrimitive, Conditional, TmplAstTextAttribute } from '@angular/compiler';
import { ParserInterface } from './parser.interface'; import { ParserInterface } from './parser.interface';
import { TranslationCollection } from '../utils/translation.collection'; import { TranslationCollection } from '../utils/translation.collection';
import { isPathAngularComponent, extractComponentInlineTemplate } from '../utils/utils'; import { isPathAngularComponent, extractComponentInlineTemplate } from '../utils/utils';
const TRANSLATE_PIPE_NAME = 'translate';
export class PipeParser implements ParserInterface { export class PipeParser implements ParserInterface {
public extract(source: string, filePath: string): TranslationCollection | null {
public extract(template: string, path: string): TranslationCollection { if (filePath && isPathAngularComponent(filePath)) {
if (path && isPathAngularComponent(path)) { source = extractComponentInlineTemplate(source);
template = extractComponentInlineTemplate(template);
} }
return this.parseTemplate(template);
}
protected parseTemplate(template: string): TranslationCollection {
let collection: TranslationCollection = new TranslationCollection(); let collection: TranslationCollection = new TranslationCollection();
const nodes: TmplAstNode[] = this.parseTemplate(source, filePath);
const regExp: RegExp = /(['"`])((?:(?!\1).|\\\1)+)\1\s*\|\s*translate/g; const pipes: BindingPipe[] = nodes.map(node => this.findPipesInNode(node)).flat();
let matches: RegExpExecArray; pipes.forEach(pipe => {
while (matches = regExp.exec(template)) { this.parseTranslationKeysFromPipe(pipe).forEach((key: string) => {
collection = collection.add(matches[2].split('\\\'').join('\'')); collection = collection.add(key);
} });
});
return collection; return collection;
} }
protected findPipesInNode(node: any): BindingPipe[] {
let ret: BindingPipe[] = [];
if (node?.children) {
ret = node.children.reduce(
(result: BindingPipe[], childNode: TmplAstNode) => {
const children = this.findPipesInNode(childNode);
return result.concat(children);
},
[ret]
);
}
if (node?.value?.ast?.expressions) {
const translateables = node.value.ast.expressions.filter((exp: any) => this.expressionIsOrHasBindingPipe(exp));
ret.push(...translateables);
}
if (node?.attributes) {
const translateableAttributes = node.attributes.filter((attr: TmplAstTextAttribute) => {
return attr.name === TRANSLATE_PIPE_NAME;
});
ret = [...ret, ...translateableAttributes];
}
if (node?.inputs) {
node.inputs.forEach((input: any) => {
// <element [attrib]="'identifier' | translate">
if (input?.value?.ast && this.expressionIsOrHasBindingPipe(input.value.ast)) {
ret.push(input.value.ast);
}
// <element attrib="{{'identifier' | translate}}>"
if (input?.value?.ast?.expressions) {
input.value.ast.expressions.forEach((exp: BindingPipe) => {
if (this.expressionIsOrHasBindingPipe(exp)) {
ret.push(exp);
}
});
}
});
}
return ret;
}
protected parseTranslationKeysFromPipe(pipeContent: BindingPipe | LiteralPrimitive | Conditional): string[] {
const ret: string[] = [];
if (pipeContent instanceof LiteralPrimitive) {
ret.push(pipeContent.value);
} else if (pipeContent instanceof Conditional) {
const trueExp: LiteralPrimitive | Conditional = pipeContent.trueExp as any;
ret.push(...this.parseTranslationKeysFromPipe(trueExp));
const falseExp: LiteralPrimitive | Conditional = pipeContent.falseExp as any;
ret.push(...this.parseTranslationKeysFromPipe(falseExp));
} else if (pipeContent instanceof BindingPipe) {
ret.push(...this.parseTranslationKeysFromPipe(pipeContent.exp as any));
}
return ret;
}
protected expressionIsOrHasBindingPipe(exp: any): boolean {
if (exp.name && exp.name === TRANSLATE_PIPE_NAME) {
return true;
}
if (exp.exp && exp.exp instanceof BindingPipe) {
return this.expressionIsOrHasBindingPipe(exp.exp);
}
return false;
}
protected parseTemplate(template: string, path: string): TmplAstNode[] {
return parseTemplate(template, path).nodes;
}
} }

View File

@@ -2,40 +2,38 @@ import { tsquery } from '@phenomnomnominal/tsquery';
import { ParserInterface } from './parser.interface'; import { ParserInterface } from './parser.interface';
import { TranslationCollection } from '../utils/translation.collection'; import { TranslationCollection } from '../utils/translation.collection';
import { findClasses, findClassPropertyByType, findMethodCallExpressions, getStringsFromExpression } from '../utils/ast-helpers'; import { findClassDeclarations, findClassPropertyByType, findMethodCallExpressions, getStringsFromExpression } from '../utils/ast-helpers';
const TRANSLATE_SERVICE_TYPE_REFERENCE = 'TranslateService'; const TRANSLATE_SERVICE_TYPE_REFERENCE = 'TranslateService';
const TRANSLATE_SERVICE_METHOD_NAMES = ['get', 'instant', 'stream']; const TRANSLATE_SERVICE_METHOD_NAMES = ['get', 'instant', 'stream'];
export class ServiceParser implements ParserInterface { export class ServiceParser implements ParserInterface {
public extract(source: string, filePath: string): TranslationCollection | null { public extract(source: string, filePath: string): TranslationCollection | null {
const sourceFile = tsquery.ast(source, filePath); const sourceFile = tsquery.ast(source, filePath);
const classNodes = findClasses(sourceFile); const classDeclarations = findClassDeclarations(sourceFile);
if (!classNodes) { if (!classDeclarations) {
return; return null;
} }
let collection: TranslationCollection = new TranslationCollection(); let collection: TranslationCollection = new TranslationCollection();
classNodes.forEach(classNode => { classDeclarations.forEach(classDeclaration => {
const propName: string = findClassPropertyByType(classNode, TRANSLATE_SERVICE_TYPE_REFERENCE); const propName: string = findClassPropertyByType(classDeclaration, TRANSLATE_SERVICE_TYPE_REFERENCE);
if (!propName) { if (!propName) {
return; return;
} }
const callNodes = findMethodCallExpressions(classNode, propName, TRANSLATE_SERVICE_METHOD_NAMES); const callExpressions = findMethodCallExpressions(classDeclaration, propName, TRANSLATE_SERVICE_METHOD_NAMES);
callNodes.forEach(callNode => { callExpressions.forEach(callExpression => {
const [firstArgNode] = callNode.arguments; const [firstArg] = callExpression.arguments;
if (!firstArgNode) { if (!firstArg) {
return; return;
} }
const strings = getStringsFromExpression(firstArgNode); const strings = getStringsFromExpression(firstArg);
collection = collection.addKeys(strings); collection = collection.addKeys(strings);
}); });
}); });
return collection; return collection;
} }
} }

View File

@@ -2,11 +2,9 @@ import { TranslationCollection } from '../utils/translation.collection';
import { PostProcessorInterface } from './post-processor.interface'; import { PostProcessorInterface } from './post-processor.interface';
export class KeyAsDefaultValuePostProcessor implements PostProcessorInterface { export class KeyAsDefaultValuePostProcessor implements PostProcessorInterface {
public name: string = 'KeyAsDefaultValue'; public name: string = 'KeyAsDefaultValue';
public process(draft: TranslationCollection, extracted: TranslationCollection, existing: TranslationCollection): TranslationCollection { public process(draft: TranslationCollection, extracted: TranslationCollection, existing: TranslationCollection): TranslationCollection {
return draft.map((key, val) => val === '' ? key : val); return draft.map((key, val) => (val === '' ? key : val));
} }
} }

View File

@@ -2,11 +2,9 @@ import { TranslationCollection } from '../utils/translation.collection';
import { PostProcessorInterface } from './post-processor.interface'; import { PostProcessorInterface } from './post-processor.interface';
export class NullAsDefaultValuePostProcessor implements PostProcessorInterface { export class NullAsDefaultValuePostProcessor implements PostProcessorInterface {
public name: string = 'NullAsDefaultValue'; public name: string = 'NullAsDefaultValue';
public process(draft: TranslationCollection, extracted: TranslationCollection, existing: TranslationCollection): TranslationCollection { public process(draft: TranslationCollection, extracted: TranslationCollection, existing: TranslationCollection): TranslationCollection {
return draft.map((key, val) => existing.get(key) === undefined ? null : val); return draft.map((key, val) => (existing.get(key) === undefined ? null : val));
} }
} }

View File

@@ -1,9 +1,7 @@
import { TranslationCollection } from '../utils/translation.collection'; import { TranslationCollection } from '../utils/translation.collection';
export interface PostProcessorInterface { export interface PostProcessorInterface {
name: string; name: string;
process(draft: TranslationCollection, extracted: TranslationCollection, existing: TranslationCollection): TranslationCollection; process(draft: TranslationCollection, extracted: TranslationCollection, existing: TranslationCollection): TranslationCollection;
} }

View File

@@ -2,11 +2,9 @@ import { TranslationCollection } from '../utils/translation.collection';
import { PostProcessorInterface } from './post-processor.interface'; import { PostProcessorInterface } from './post-processor.interface';
export class PurgeObsoleteKeysPostProcessor implements PostProcessorInterface { export class PurgeObsoleteKeysPostProcessor implements PostProcessorInterface {
public name: string = 'PurgeObsoleteKeys'; public name: string = 'PurgeObsoleteKeys';
public process(draft: TranslationCollection, extracted: TranslationCollection, existing: TranslationCollection): TranslationCollection { public process(draft: TranslationCollection, extracted: TranslationCollection, existing: TranslationCollection): TranslationCollection {
return draft.intersect(extracted); return draft.intersect(extracted);
} }
} }

View File

@@ -2,11 +2,9 @@ import { TranslationCollection } from '../utils/translation.collection';
import { PostProcessorInterface } from './post-processor.interface'; import { PostProcessorInterface } from './post-processor.interface';
export class SortByKeyPostProcessor implements PostProcessorInterface { export class SortByKeyPostProcessor implements PostProcessorInterface {
public name: string = 'SortByKey'; public name: string = 'SortByKey';
public process(draft: TranslationCollection, extracted: TranslationCollection, existing: TranslationCollection): TranslationCollection { public process(draft: TranslationCollection, extracted: TranslationCollection, existing: TranslationCollection): TranslationCollection {
return draft.sort(); return draft.sort();
} }
} }

View File

@@ -0,0 +1,16 @@
import { TranslationCollection } from '../utils/translation.collection';
import { PostProcessorInterface } from './post-processor.interface';
interface Options {
defaultValue: string;
}
export class StringAsDefaultValuePostProcessor implements PostProcessorInterface {
public name: string = 'StringAsDefaultValue';
public constructor(protected options: Options) {}
public process(draft: TranslationCollection, extracted: TranslationCollection, existing: TranslationCollection): TranslationCollection {
return draft.map((key, val) => (existing.get(key) === undefined ? this.options.defaultValue : val));
}
}

View File

@@ -22,7 +22,7 @@ export function getNamedImports(node: Node, moduleName: string): NamedImports[]
export function getNamedImportAlias(node: Node, moduleName: string, importName: string): string | null { export function getNamedImportAlias(node: Node, moduleName: string, importName: string): string | null {
const [namedImportNode] = getNamedImports(node, moduleName); const [namedImportNode] = getNamedImports(node, moduleName);
if (!namedImportNode) { if (!namedImportNode) {
return; return null;
} }
const query = `ImportSpecifier:has(Identifier[name="${importName}"]) > Identifier`; const query = `ImportSpecifier:has(Identifier[name="${importName}"]) > Identifier`;
@@ -36,7 +36,7 @@ export function getNamedImportAlias(node: Node, moduleName: string, importName:
return null; return null;
} }
export function findClasses(node: Node): ClassDeclaration[] { export function findClassDeclarations(node: Node): ClassDeclaration[] {
const query = 'ClassDeclaration'; const query = 'ClassDeclaration';
return tsquery<ClassDeclaration>(node, query); return tsquery<ClassDeclaration>(node, query);
} }
@@ -77,7 +77,7 @@ export function findMethodCallExpressions(node: Node, prop: string, fnName: stri
fnName = fnName.join('|'); fnName = fnName.join('|');
} }
const query = `CallExpression > PropertyAccessExpression:has(Identifier[name=/^(${fnName})$/]):has(PropertyAccessExpression:has(Identifier[name="${prop}"]):has(ThisKeyword))`; 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); const nodes = tsquery<PropertyAccessExpression>(node, query).map(n => n.parent as CallExpression);
return nodes; return nodes;
} }
@@ -88,17 +88,14 @@ export function getStringsFromExpression(expression: Expression): string[] {
if (isArrayLiteralExpression(expression)) { if (isArrayLiteralExpression(expression)) {
return expression.elements.reduce((result: string[], element: Expression) => { return expression.elements.reduce((result: string[], element: Expression) => {
const strings = this.getStringsFromExpression(element); const strings = getStringsFromExpression(element);
return [ return [...result, ...strings];
...result,
...strings
];
}, []); }, []);
} }
if (isBinaryExpression(expression)) { if (isBinaryExpression(expression)) {
const [left] = this.getStringsFromExpression(expression.left); const [left] = getStringsFromExpression(expression.left);
const [right] = this.getStringsFromExpression(expression.right); const [right] = getStringsFromExpression(expression.right);
if (expression.operatorToken.kind === SyntaxKind.PlusToken) { if (expression.operatorToken.kind === SyntaxKind.PlusToken) {
if (typeof left === 'string' && typeof right === 'string') { if (typeof left === 'string' && typeof right === 'string') {
@@ -119,8 +116,8 @@ export function getStringsFromExpression(expression: Expression): string[] {
} }
if (isConditionalExpression(expression)) { if (isConditionalExpression(expression)) {
const [whenTrue] = this.getStringsFromExpression(expression.whenTrue); const [whenTrue] = getStringsFromExpression(expression.whenTrue);
const [whenFalse] = this.getStringsFromExpression(expression.whenFalse); const [whenFalse] = getStringsFromExpression(expression.whenFalse);
const result = []; const result = [];
if (typeof whenTrue === 'string') { if (typeof whenTrue === 'string') {

32
src/utils/fs-helpers.ts Normal file
View File

@@ -0,0 +1,32 @@
import * as os from 'os';
import * as fs from 'fs';
import * as braces from 'braces';
declare module 'braces' {
interface Options {
keepEscaping?: boolean; // Workaround for option not present in @types/braces 3.0.0
}
}
export function normalizeHomeDir(path: string): string {
if (path.substring(0, 1) === '~') {
return `${os.homedir()}/${path.substring(1)}`;
}
return path;
}
export function expandPattern(pattern: string): string[] {
return braces(pattern, { expand: true, keepEscaping: true });
}
export function normalizePaths(patterns: string[], defaultPatterns: string[] = []): string[] {
return patterns.map(pattern =>
expandPattern(pattern).map(path => {
path = normalizeHomeDir(path);
if (fs.existsSync(path) && fs.statSync(path).isDirectory()) {
return defaultPatterns.map(defaultPattern => path + defaultPattern);
}
return path;
}).flat()
).flat();
}

View File

@@ -3,7 +3,6 @@ export interface TranslationType {
} }
export class TranslationCollection { export class TranslationCollection {
public values: TranslationType = {}; public values: TranslationType = {};
public constructor(values: TranslationType = {}) { public constructor(values: TranslationType = {}) {
@@ -15,10 +14,12 @@ export class TranslationCollection {
} }
public addKeys(keys: string[]): TranslationCollection { public addKeys(keys: string[]): TranslationCollection {
const values = keys.reduce((results, key) => { const values = keys.reduce(
results[key] = ''; (results, key) => {
return results; return { ...results, [key]: '' };
}, {} as TranslationType); },
{} as TranslationType
);
return new TranslationCollection({ ...this.values, ...values }); return new TranslationCollection({ ...this.values, ...values });
} }
@@ -32,8 +33,8 @@ export class TranslationCollection {
} }
public filter(callback: (key?: string, val?: string) => boolean): TranslationCollection { public filter(callback: (key?: string, val?: string) => boolean): TranslationCollection {
let values: TranslationType = {}; const values: TranslationType = {};
this.forEach((key: string, val: string) => { this.forEach((key, val) => {
if (callback.call(this, key, val)) { if (callback.call(this, key, val)) {
values[key] = val; values[key] = val;
} }
@@ -42,8 +43,8 @@ export class TranslationCollection {
} }
public map(callback: (key?: string, val?: string) => string): TranslationCollection { public map(callback: (key?: string, val?: string) => string): TranslationCollection {
let values: TranslationType = {}; const values: TranslationType = {};
this.forEach((key: string, val: string) => { this.forEach((key, val) => {
values[key] = callback.call(this, key, val); values[key] = callback.call(this, key, val);
}); });
return new TranslationCollection(values); return new TranslationCollection(values);
@@ -54,11 +55,10 @@ export class TranslationCollection {
} }
public intersect(collection: TranslationCollection): TranslationCollection { public intersect(collection: TranslationCollection): TranslationCollection {
let values: TranslationType = {}; const values: TranslationType = {};
this.filter(key => collection.has(key)) this.filter(key => collection.has(key)).forEach((key, val) => {
.forEach((key: string, val: string) => { values[key] = val;
values[key] = val; });
});
return new TranslationCollection(values); return new TranslationCollection(values);
} }
@@ -84,10 +84,12 @@ export class TranslationCollection {
} }
public sort(compareFn?: (a: string, b: string) => number): TranslationCollection { public sort(compareFn?: (a: string, b: string) => number): TranslationCollection {
let values: TranslationType = {}; const values: TranslationType = {};
this.keys().sort(compareFn).forEach((key) => { this.keys()
values[key] = this.get(key); .sort(compareFn)
}); .forEach(key => {
values[key] = this.get(key);
});
return new TranslationCollection(values); return new TranslationCollection(values);
} }

View File

@@ -2,7 +2,7 @@
* Assumes file is an Angular component if type is javascript/typescript * Assumes file is an Angular component if type is javascript/typescript
*/ */
export function isPathAngularComponent(path: string): boolean { export function isPathAngularComponent(path: string): boolean {
return (/\.ts|js$/i).test(path); return /\.ts|js$/i.test(path);
} }
/** /**

View File

@@ -4,7 +4,6 @@ import { TranslationCollection } from '../../src/utils/translation.collection';
import { NamespacedJsonCompiler } from '../../src/compilers/namespaced-json.compiler'; import { NamespacedJsonCompiler } from '../../src/compilers/namespaced-json.compiler';
describe('NamespacedJsonCompiler', () => { describe('NamespacedJsonCompiler', () => {
let compiler: NamespacedJsonCompiler; let compiler: NamespacedJsonCompiler;
beforeEach(() => { beforeEach(() => {
@@ -23,7 +22,10 @@ describe('NamespacedJsonCompiler', () => {
} }
`; `;
const collection: TranslationCollection = compiler.parse(contents); const collection: TranslationCollection = compiler.parse(contents);
expect(collection.values).to.deep.equal({'NAMESPACE.KEY.FIRST_KEY': '', 'NAMESPACE.KEY.SECOND_KEY': 'VALUE' }); expect(collection.values).to.deep.equal({
'NAMESPACE.KEY.FIRST_KEY': '',
'NAMESPACE.KEY.SECOND_KEY': 'VALUE'
});
}); });
it('should unflatten keys on compile', () => { it('should unflatten keys on compile', () => {
@@ -59,11 +61,10 @@ describe('NamespacedJsonCompiler', () => {
it('should not reorder keys when compiled', () => { it('should not reorder keys when compiled', () => {
const collection = new TranslationCollection({ const collection = new TranslationCollection({
'BROWSE': '', BROWSE: '',
'LOGIN': '' LOGIN: ''
}); });
const result: string = compiler.compile(collection); const result: string = compiler.compile(collection);
expect(result).to.equal('{\n\t"BROWSE": "",\n\t"LOGIN": ""\n}'); expect(result).to.equal('{\n\t"BROWSE": "",\n\t"LOGIN": ""\n}');
}); });
}); });

View File

@@ -3,7 +3,6 @@ import { expect } from 'chai';
import { DirectiveParser } from '../../src/parsers/directive.parser'; import { DirectiveParser } from '../../src/parsers/directive.parser';
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';
@@ -86,5 +85,4 @@ describe('DirectiveParser', () => {
const keys = parser.extract(contents, componentFilename).keys(); const keys = parser.extract(contents, componentFilename).keys();
expect(keys).to.deep.equal([]); expect(keys).to.deep.equal([]);
}); });
}); });

View File

@@ -3,7 +3,6 @@ import { expect } from 'chai';
import { MarkerParser } from '../../src/parsers/marker.parser'; import { MarkerParser } from '../../src/parsers/marker.parser';
describe('MarkerParser', () => { describe('MarkerParser', () => {
const componentFilename: string = 'test.component.ts'; const componentFilename: string = 'test.component.ts';
let parser: MarkerParser; let parser: MarkerParser;
@@ -12,7 +11,6 @@ describe('MarkerParser', () => {
parser = new MarkerParser(); parser = new MarkerParser();
}); });
it('should extract strings using marker function', () => { it('should extract strings using marker function', () => {
const contents = ` const contents = `
import { marker } from '@biesbjerg/ngx-translate-extract-marker'; import { marker } from '@biesbjerg/ngx-translate-extract-marker';
@@ -35,11 +33,6 @@ describe('MarkerParser', () => {
_('Mix ' + \`of \` + 'different ' + \`types\`); _('Mix ' + \`of \` + 'different ' + \`types\`);
`; `;
const keys = parser.extract(contents, componentFilename).keys(); const keys = parser.extract(contents, componentFilename).keys();
expect(keys).to.deep.equal([ expect(keys).to.deep.equal(['Hello world', 'This is a very very very very long line.', 'Mix of different types']);
'Hello world',
'This is a very very very very long line.',
'Mix of different types'
]);
}); });
}); });

View File

@@ -3,7 +3,6 @@ import { expect } from 'chai';
import { PipeParser } from '../../src/parsers/pipe.parser'; import { PipeParser } from '../../src/parsers/pipe.parser';
describe('PipeParser', () => { describe('PipeParser', () => {
const templateFilename: string = 'test.template.html'; const templateFilename: string = 'test.template.html';
let parser: PipeParser; let parser: PipeParser;
@@ -30,12 +29,42 @@ 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', () => { it('should extract interpolated strings when translate pipe is used before other pipes', () => {
const contents = `Hello {{ 'World' | translate | upper }}`; const contents = `Hello {{ 'World' | translate | upper }}`;
const keys = parser.extract(contents, templateFilename).keys(); const keys = parser.extract(contents, templateFilename).keys();
expect(keys).to.deep.equal(['World']); expect(keys).to.deep.equal(['World']);
}); });
it('should extract interpolated strings when translate pipe is used after other pipes', () => {
const contents = `Hello {{ 'World' | upper | translate }}`;
const keys = parser.extract(contents, templateFilename).keys();
expect(keys).to.deep.equal(['World']);
});
it('should extract strings from ternary operators inside interpolations', () => {
const contents = `{{ (condition ? 'Hello' : 'World') | translate }}`;
const keys = parser.extract(contents, templateFilename).keys();
expect(keys).to.deep.equal(['Hello', 'World']);
});
it('should extract strings from ternary operators inside attribute bindings', () => {
const contents = `<span [attr]="(condition ? 'Hello' : 'World') | translate"></span>`;
const keys = parser.extract(contents, templateFilename).keys();
expect(keys).to.deep.equal(['Hello', 'World']);
});
it('should extract strings from nested ternary operators ', () => {
const contents = `<h3>{{ (condition ? 'Hello' : anotherCondition ? 'Nested' : 'World' ) | translate }}</h3>`;
const keys = parser.extract(contents, templateFilename).keys();
expect(keys).to.deep.equal(['Hello', 'Nested', 'World']);
});
it('should extract strings from ternary operators inside attribute interpolations', () => {
const contents = `<span attr="{{(condition ? 'Hello' : 'World') | translate}}"></span>`;
const keys = parser.extract(contents, templateFilename).keys();
expect(keys).to.deep.equal(['Hello', '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();
@@ -60,7 +89,7 @@ describe('PipeParser', () => {
expect(keys).to.deep.equal(['Hello World']); expect(keys).to.deep.equal(['Hello World']);
}); });
it('should not use a greedy regular expression', () => { it('should extract multiple entries from nodes', () => {
const contents = ` const contents = `
<ion-header> <ion-header>
<ion-navbar color="brand"> <ion-navbar color="brand">
@@ -118,5 +147,4 @@ describe('PipeParser', () => {
const keys = parser.extract(contents, templateFilename).keys(); const keys = parser.extract(contents, templateFilename).keys();
expect(keys).to.deep.equal(['message']); expect(keys).to.deep.equal(['message']);
}); });
}); });

View File

@@ -2,18 +2,13 @@ import { expect } from 'chai';
import { ServiceParser } from '../../src/parsers/service.parser'; import { ServiceParser } from '../../src/parsers/service.parser';
class TestServiceParser extends ServiceParser {
}
describe('ServiceParser', () => { describe('ServiceParser', () => {
const componentFilename: string = 'test.component.ts'; const componentFilename: string = 'test.component.ts';
let parser: TestServiceParser; let parser: ServiceParser;
beforeEach(() => { beforeEach(() => {
parser = new TestServiceParser(); parser = new ServiceParser();
}); });
it('should support extracting binary expressions', () => { it('should support extracting binary expressions', () => {
@@ -44,7 +39,7 @@ describe('ServiceParser', () => {
expect(keys).to.deep.equal(['Fallback message']); 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 = `
@Component({ }) @Component({ })
export class AppComponent { export class AppComponent {
@@ -57,7 +52,7 @@ describe('ServiceParser', () => {
expect(keys).to.deep.equal(['Hello World']); expect(keys).to.deep.equal(['Hello World']);
}); });
it('should extract strings in TranslateService\'s instant() method', () => { it("should extract strings in TranslateService's instant() method", () => {
const contents = ` const contents = `
@Component({ }) @Component({ })
export class AppComponent { export class AppComponent {
@@ -70,7 +65,7 @@ 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', () => { it("should extract strings in TranslateService's stream() method", () => {
const contents = ` const contents = `
@Component({ }) @Component({ })
export class AppComponent { export class AppComponent {
@@ -83,7 +78,7 @@ describe('ServiceParser', () => {
expect(keys).to.deep.equal(['Hello World']); 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({ })
export class AppComponent { export class AppComponent {
@@ -96,7 +91,7 @@ describe('ServiceParser', () => {
expect(keys).to.deep.equal(['Hello', 'World']); expect(keys).to.deep.equal(['Hello', 'World']);
}); });
it('should extract array of strings in TranslateService\'s instant() method', () => { it("should extract array of strings in TranslateService's instant() method", () => {
const contents = ` const contents = `
@Component({ }) @Component({ })
export class AppComponent { export class AppComponent {
@@ -109,7 +104,7 @@ describe('ServiceParser', () => {
expect(key).to.deep.equal(['Hello', 'World']); expect(key).to.deep.equal(['Hello', 'World']);
}); });
it('should extract array of strings in TranslateService\'s stream() method', () => { it("should extract array of strings in TranslateService's stream() method", () => {
const contents = ` const contents = `
@Component({ }) @Component({ })
export class AppComponent { export class AppComponent {
@@ -298,5 +293,4 @@ describe('ServiceParser', () => {
const keys = parser.extract(contents, componentFilename).keys(); const keys = parser.extract(contents, componentFilename).keys();
expect(keys).to.deep.equal(['Back']); expect(keys).to.deep.equal(['Back']);
}); });
}); });

View File

@@ -3,7 +3,6 @@ import { expect } from 'chai';
import { isPathAngularComponent, extractComponentInlineTemplate } from '../../src/utils/utils'; import { isPathAngularComponent, extractComponentInlineTemplate } from '../../src/utils/utils';
describe('Utils', () => { describe('Utils', () => {
it('should recognize js extension as angular component', () => { it('should recognize js extension as angular component', () => {
const result = isPathAngularComponent('test.js'); const result = isPathAngularComponent('test.js');
expect(result).to.equal(true); expect(result).to.equal(true);
@@ -63,5 +62,4 @@ describe('Utils', () => {
const template = extractComponentInlineTemplate(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');
}); });
}); });

View File

@@ -5,7 +5,6 @@ import { KeyAsDefaultValuePostProcessor } from '../../src/post-processors/key-as
import { TranslationCollection } from '../../src/utils/translation.collection'; import { TranslationCollection } from '../../src/utils/translation.collection';
describe('KeyAsDefaultValuePostProcessor', () => { describe('KeyAsDefaultValuePostProcessor', () => {
let processor: PostProcessorInterface; let processor: PostProcessorInterface;
beforeEach(() => { beforeEach(() => {
@@ -27,5 +26,4 @@ describe('KeyAsDefaultValuePostProcessor', () => {
'Use this key as value as well': 'Use this key as value as well' 'Use this key as value as well': 'Use this key as value as well'
}); });
}); });
}); });

View File

@@ -5,7 +5,6 @@ import { NullAsDefaultValuePostProcessor } from '../../src/post-processors/null-
import { TranslationCollection } from '../../src/utils/translation.collection'; import { TranslationCollection } from '../../src/utils/translation.collection';
describe('NullAsDefaultValuePostProcessor', () => { describe('NullAsDefaultValuePostProcessor', () => {
let processor: PostProcessorInterface; let processor: PostProcessorInterface;
beforeEach(() => { beforeEach(() => {
@@ -38,5 +37,4 @@ describe('NullAsDefaultValuePostProcessor', () => {
'String A': 'Streng A' 'String A': 'Streng A'
}); });
}); });
}); });

View File

@@ -5,15 +5,14 @@ import { PurgeObsoleteKeysPostProcessor } from '../../src/post-processors/purge-
import { TranslationCollection } from '../../src/utils/translation.collection'; import { TranslationCollection } from '../../src/utils/translation.collection';
describe('PurgeObsoleteKeysPostProcessor', () => { describe('PurgeObsoleteKeysPostProcessor', () => {
let postProcessor: PostProcessorInterface;
let processor: PostProcessorInterface;
beforeEach(() => { beforeEach(() => {
processor = new PurgeObsoleteKeysPostProcessor(); postProcessor = new PurgeObsoleteKeysPostProcessor();
}); });
it('should purge obsolete keys', () => { it('should purge obsolete keys', () => {
const collection = new TranslationCollection({ const draft = new TranslationCollection({
'I am completely new': '', 'I am completely new': '',
'I already exist': '', 'I already exist': '',
'I already exist but was not present in extract': '' 'I already exist but was not present in extract': ''
@@ -27,10 +26,9 @@ describe('PurgeObsoleteKeysPostProcessor', () => {
'I already exist but was not present in extract': '' 'I already exist but was not present in extract': ''
}); });
expect(processor.process(collection, extracted, existing).values).to.deep.equal({ expect(postProcessor.process(draft, extracted, existing).values).to.deep.equal({
'I am completely new': '', 'I am completely new': '',
'I already exist': '' 'I already exist': ''
}); });
}); });
}); });

View File

@@ -5,7 +5,6 @@ import { SortByKeyPostProcessor } from '../../src/post-processors/sort-by-key.po
import { TranslationCollection } from '../../src/utils/translation.collection'; import { TranslationCollection } from '../../src/utils/translation.collection';
describe('SortByKeyPostProcessor', () => { describe('SortByKeyPostProcessor', () => {
let processor: PostProcessorInterface; let processor: PostProcessorInterface;
beforeEach(() => { beforeEach(() => {
@@ -14,20 +13,19 @@ describe('SortByKeyPostProcessor', () => {
it('should sort keys alphanumerically', () => { it('should sort keys alphanumerically', () => {
const collection = new TranslationCollection({ const collection = new TranslationCollection({
'z': 'last value', z: 'last value',
'a': 'a value', a: 'a value',
'9': 'a numeric key', '9': 'a numeric key',
'b': 'another value' b: 'another value'
}); });
const extracted = new TranslationCollection(); const extracted = new TranslationCollection();
const existing = new TranslationCollection(); const existing = new TranslationCollection();
expect(processor.process(collection, extracted, existing).values).to.deep.equal({ expect(processor.process(collection, extracted, existing).values).to.deep.equal({
'9': 'a numeric key', '9': 'a numeric key',
'a': 'a value', a: 'a value',
'b': 'another value', b: 'another value',
'z': 'last value' z: 'last value'
}); });
}); });
}); });

View File

@@ -0,0 +1,40 @@
import { expect } from 'chai';
import { PostProcessorInterface } from '../../src/post-processors/post-processor.interface';
import { StringAsDefaultValuePostProcessor } from '../../src/post-processors/string-as-default-value.post-processor';
import { TranslationCollection } from '../../src/utils/translation.collection';
describe('StringAsDefaultValuePostProcessor', () => {
let processor: PostProcessorInterface;
beforeEach(() => {
processor = new StringAsDefaultValuePostProcessor({ defaultValue: 'default' });
});
it('should use string 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': 'default'
});
});
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'
});
});
});

View File

@@ -3,7 +3,6 @@ import { expect } from 'chai';
import { TranslationCollection } from '../../src/utils/translation.collection'; import { TranslationCollection } from '../../src/utils/translation.collection';
describe('StringCollection', () => { describe('StringCollection', () => {
let collection: TranslationCollection; let collection: TranslationCollection;
beforeEach(() => { beforeEach(() => {
@@ -64,12 +63,15 @@ describe('StringCollection', () => {
it('should merge with other collection', () => { it('should merge with other collection', () => {
collection = collection.add('oldKey', 'oldVal'); collection = collection.add('oldKey', 'oldVal');
const newCollection = new TranslationCollection({ newKey: 'newVal' }); const newCollection = new TranslationCollection({ newKey: 'newVal' });
expect(collection.union(newCollection).values).to.deep.equal({ oldKey: 'oldVal', newKey: 'newVal' }); expect(collection.union(newCollection).values).to.deep.equal({
oldKey: 'oldVal',
newKey: 'newVal'
});
}); });
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: '' });
}); });
@@ -88,7 +90,10 @@ describe('StringCollection', () => {
it('should map values', () => { it('should map values', () => {
collection = new TranslationCollection({ red: 'rød', green: 'grøn', blue: 'blå' }); collection = new TranslationCollection({ red: 'rød', green: 'grøn', blue: 'blå' });
collection = collection.map((key, val) => 'mapped value'); collection = collection.map((key, val) => 'mapped value');
expect(collection.values).to.deep.equal({ red: 'mapped value', green: 'mapped value', blue: 'mapped value' }); expect(collection.values).to.deep.equal({
red: 'mapped value',
green: 'mapped value',
blue: 'mapped value'
});
}); });
}); });

View File

@@ -3,21 +3,25 @@
"allowSyntheticDefaultImports": true, "allowSyntheticDefaultImports": true,
"noUnusedLocals": true, "noUnusedLocals": true,
"noImplicitAny": true, "noImplicitAny": true,
"noImplicitReturns": true,
"noImplicitThis": true,
"noImplicitUseStrict": true,
"removeComments": true, "removeComments": true,
"declaration": true, "declaration": true,
"target": "es2015", "target": "es2015",
"lib": [ "lib": [
"dom", "dom",
"es2018" "esnext.array"
], ],
"module": "commonjs", "module": "commonjs",
"outDir": "./dist/", "outDir": "dist",
"sourceMap": true "sourceMap": true,
"typeRoots" : [
"node_modules/@types"
]
}, },
"include": [ "include": [
"src/**/*.ts" "src/**/*.ts"
], ],
"exclude": [ "exclude": []
"node_modules"
]
} }

8
tslint.commit.json Normal file
View File

@@ -0,0 +1,8 @@
{
"extends": ["./tslint.json", "tslint-etc"],
"jsRules": {},
"rules": {
"ordered-imports": false,
"no-unused-declaration": true
}
}

View File

@@ -1,53 +1,117 @@
{ {
"rulesDirectory": [ "defaultSeverity": "error",
"node_modules/tslint-eslint-rules/dist/rules" "extends": [
], "tslint-config-prettier"
"rules": { ],
"indent": [true, "tabs"], "rules": {
"semicolon": [true, "always", "ignore-interfaces"], "arrow-return-shorthand": true,
"quotemark": [true, "single", "avoid-escape"], "callable-types": true,
"only-arrow-functions": false, "class-name": true,
"no-duplicate-variable": true, "comment-format": [
"member-access": true, true,
"member-ordering": [ "check-space"
true, ],
{ "curly": true,
"order": [ "deprecation": {
"public-static-field", "severity": "warn"
"public-static-method", },
"protected-static-field", "eofline": true,
"protected-static-method", "forin": true,
"private-static-field", "import-spacing": true,
"private-static-method", "indent": [
"public-instance-field", true,
"protected-instance-field", "tabs"
"private-instance-field", ],
"constructor", "interface-over-type-literal": true,
"public-instance-method", "label-position": true,
"protected-instance-method", "max-line-length": [
"private-instance-method" true,
] 220
} ],
], "member-access": false,
"curly": true, "member-ordering": [
"eofline": true, true,
"no-trailing-whitespace": true, {
"trailing-comma": [ "order": [
true, "static-field",
{ "instance-field",
"multiline": "never", "static-method",
"singleline": "never" "instance-method"
} ]
], }
"whitespace": [ ],
true, "no-arg": true,
"check-branch", "no-bitwise": true,
"check-decl", "no-console": [
"check-operator", true,
"check-module", "debug",
"check-separator", "info",
"check-type", "time",
"check-typecast" "timeEnd",
] "trace"
} ],
} "no-construct": true,
"no-debugger": true,
"no-duplicate-super": true,
"no-empty": false,
"no-empty-interface": true,
"no-eval": true,
"no-inferrable-types": [
false,
"ignore-params"
],
"no-misused-new": true,
"no-non-null-assertion": true,
"no-shadowed-variable": true,
"no-string-literal": false,
"no-string-throw": true,
"no-switch-case-fall-through": true,
"no-trailing-whitespace": true,
"no-unnecessary-initializer": true,
"no-unused-expression": true,
"no-var-keyword": true,
"object-literal-sort-keys": false,
"one-line": [
true,
"check-open-brace",
"check-catch",
"check-else",
"check-whitespace"
],
"prefer-const": true,
"radix": true,
"semicolon": [
true,
"always"
],
"triple-equals": [
true,
"allow-null-check"
],
"typedef-whitespace": [
true,
{
"call-signature": "nospace",
"index-signature": "nospace",
"parameter": "nospace",
"property-declaration": "nospace",
"variable-declaration": "nospace"
}
],
"unified-signatures": true,
"variable-name": [
true,
"ban-keywords",
"allow-pascal-case",
"check-format"
],
"whitespace": [
true,
"check-branch",
"check-decl",
"check-operator",
"check-separator",
"check-type"
]
}
}