@lingual/i18n-check 0.8.4 → 0.8.6

package/dist/errorReporters.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/errorReporters.test.js

@@ -1,165 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const errorReporters_1 = require("./errorReporters");
-describe('formatTable', () => {
-    test('single col and row', () => {
-        expect((0, errorReporters_1.formatTable)([[['lorem ipsum']]])).toEqual(`
-┌─────────────┐
-│ lorem ipsum │
-└─────────────┘
-  `.trim());
-    });
-    test('single col and two rows', () => {
-        expect((0, errorReporters_1.formatTable)([[['lorem ipsum'], ['foo bar']]])).toEqual(`
-┌─────────────┐
-│ lorem ipsum │
-│ foo bar     │
-└─────────────┘
-    `.trim());
-    });
-    test('with two columns and two row groups', () => {
-        expect((0, errorReporters_1.formatTable)([
-            [['col1', 'col2']],
-            [
-                ['lorem ipsum dolor', 'foobar'],
-                ['baz', 'more text'],
-            ],
-        ])).toEqual(`
-┌───────────────────┬───────────┐
-│ col1              │ col2      │
-├───────────────────┼───────────┤
-│ lorem ipsum dolor │ foobar    │
-│ baz               │ more text │
-└───────────────────┴───────────┘
-`.trim());
-    });
-    test('with two columns and three row groups', () => {
-        expect((0, errorReporters_1.formatTable)([
-            [['one', 'two']],
-            [
-                ['lorem ipsum dolor', 'foobar'],
-                ['baz', 'more text'],
-            ],
-            [['hello world', 'here is more text for testing']],
-        ])).toEqual(`
-┌───────────────────┬───────────────────────────────┐
-│ one               │ two                           │
-├───────────────────┼───────────────────────────────┤
-│ lorem ipsum dolor │ foobar                        │
-│ baz               │ more text                     │
-├───────────────────┼───────────────────────────────┤
-│ hello world       │ here is more text for testing │
-└───────────────────┴───────────────────────────────┘
-  `.trim());
-    });
-});
-describe('formatCheckResultTable', () => {
-    test('with one file and two keys', () => {
-        expect((0, errorReporters_1.formatCheckResultTable)({
-            'some/file.json': ['key.one', 'key.two'],
-        })).toEqual(`
-┌────────────────┬─────────┐
-│ file           │ key     │
-├────────────────┼─────────┤
-│ some/file.json │ key.one │
-│ some/file.json │ key.two │
-└────────────────┴─────────┘
-`.trim());
-    });
-    test('with two files and three keys', () => {
-        expect((0, errorReporters_1.formatCheckResultTable)({
-            'some/de.json': ['key.one', 'key.two'],
-            'some/en.json': ['key.three'],
-        })).toEqual(`
-┌──────────────┬───────────┐
-│ file         │ key       │
-├──────────────┼───────────┤
-│ some/de.json │ key.one   │
-│ some/de.json │ key.two   │
-│ some/en.json │ key.three │
-└──────────────┴───────────┘
-`.trim());
-    });
-});
-describe('formatInvalidTranslationsResultTable', () => {
-    test('with one file and one key', () => {
-        expect((0, errorReporters_1.formatInvalidTranslationsResultTable)({
-            'some/en.json': [{ key: 'key.one', msg: 'key one error msg' }],
-        })).toEqual(`
-┌──────┬───────────────────┐
-│ info │ result            │
-├──────┼───────────────────┤
-│ file │ some/en.json      │
-│ key  │ key.one           │
-│ msg  │ key one error msg │
-└──────┴───────────────────┘
-`.trim());
-    });
-    test('with two files and three keys', () => {
-        expect((0, errorReporters_1.formatInvalidTranslationsResultTable)({
-            'some/en-US.json': [
-                { key: 'key.one', msg: 'key one error msg' },
-                { key: 'key.two', msg: 'another msg' },
-            ],
-            'some/de.json': [{ key: 'key.three', msg: 'key three msg' }],
-        })).toEqual(`
-┌──────┬───────────────────┐
-│ info │ result            │
-├──────┼───────────────────┤
-│ file │ some/en-US.json   │
-│ key  │ key.one           │
-│ msg  │ key one error msg │
-├──────┼───────────────────┤
-│ file │ some/en-US.json   │
-│ key  │ key.two           │
-│ msg  │ another msg       │
-├──────┼───────────────────┤
-│ file │ some/de.json      │
-│ key  │ key.three         │
-│ msg  │ key three msg     │
-└──────┴───────────────────┘
-`.trim());
-    });
-});
-describe('formatSummaryTable', () => {
-    test('with CheckResult with single file and key', () => {
-        expect((0, errorReporters_1.formatSummaryTable)({
-            'some/file.json': ['key.one'],
-        })).toEqual(`
-┌────────────────┬───────┐
-│ file           │ total │
-├────────────────┼───────┤
-│ some/file.json │ 1     │
-└────────────────┴───────┘
-`.trim());
-    });
-    test('with CheckResult with two files and three keys', () => {
-        expect((0, errorReporters_1.formatSummaryTable)({
-            'some/de.json': ['key.one', 'key.two'],
-            'some/en.json': ['key.three'],
-        })).toEqual(`
-┌──────────────┬───────┐
-│ file         │ total │
-├──────────────┼───────┤
-│ some/de.json │ 2     │
-│ some/en.json │ 1     │
-└──────────────┴───────┘
-`.trim());
-    });
-    test('with InvalidTranslationsResult with two files and three keys', () => {
-        expect((0, errorReporters_1.formatSummaryTable)({
-            'some/en-US.json': [
-                { key: 'key.one', msg: 'key one error msg' },
-                { key: 'key.two', msg: 'another msg' },
-            ],
-            'some/de.json': [{ key: 'key.three', msg: 'key three msg' }],
-        })).toEqual(`
-┌─────────────────┬───────┐
-│ file            │ total │
-├─────────────────┼───────┤
-│ some/en-US.json │ 2     │
-│ some/de.json    │ 1     │
-└─────────────────┴───────┘
-`.trim());
-    });
-});

package/dist/utils/findInvalidTranslations.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/utils/findInvalidTranslations.test.js

@@ -1,83 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const findInvalidTranslations_1 = require("./findInvalidTranslations");
-const flattenTranslations_1 = require("./flattenTranslations");
-const sourceFile = require('../../translations/messageExamples/en-us.json');
-const secondaryFile = require('../../translations/messageExamples/de-de.json');
-describe('findInvalidTranslations:compareTranslationFiles', () => {
-    it('should return empty array if files are identical', () => {
-        expect((0, findInvalidTranslations_1.compareTranslationFiles)((0, flattenTranslations_1.flattenTranslations)(sourceFile), (0, flattenTranslations_1.flattenTranslations)(sourceFile))).toEqual([]);
-    });
-    it('should return the invalid keys in the target file', () => {
-        expect((0, findInvalidTranslations_1.compareTranslationFiles)((0, flattenTranslations_1.flattenTranslations)({
-            ...sourceFile,
-            'ten.eleven.twelve': 'ten eleven twelve',
-        }), (0, flattenTranslations_1.flattenTranslations)(secondaryFile))).toEqual([{ key: 'multipleVariables', msg: 'Unexpected date element' }]);
-    });
-    it('should return empty array if placeholders are identical but in different positions', () => {
-        expect((0, findInvalidTranslations_1.compareTranslationFiles)({
-            basic: 'added {this} and {that} should work.',
-        }, {
-            basic: 'It is {this} with different position {that}',
-        })).toEqual([]);
-    });
-});
-describe('findInvalidTranslations', () => {
-    it('should return an empty object if all files have no invalid keys', () => {
-        expect((0, findInvalidTranslations_1.findInvalidTranslations)(sourceFile, { de: sourceFile })).toEqual({});
-    });
-    it('should return an object containing the keys for the missing language', () => {
-        expect((0, findInvalidTranslations_1.findInvalidTranslations)({ ...sourceFile, 'ten.eleven.twelve': 'ten eleven twelve' }, { de: secondaryFile })).toEqual({
-            de: [{ key: 'multipleVariables', msg: 'Unexpected date element' }],
-        });
-    });
-    it('should return an object containing the keys for every language with missing key', () => {
-        expect((0, findInvalidTranslations_1.findInvalidTranslations)({ ...sourceFile, 'ten.eleven.twelve': 'ten eleven twelve' }, {
-            de: secondaryFile,
-            fr: {
-                'four.five.six': 'four five six',
-                'seven.eight.nine': 'seven eight nine',
-                'message.text-format': 'yo,<p><b>John</b></p>!',
-            },
-        })).toEqual({
-            de: [{ key: 'multipleVariables', msg: 'Unexpected date element' }],
-            fr: [
-                {
-                    key: 'message.text-format',
-                    msg: 'Expected tag to contain "b" but received "p"',
-                },
-            ],
-        });
-    });
-    it('should allow for different types of keys per locale', () => {
-        expect((0, findInvalidTranslations_1.findInvalidTranslations)(sourceFile, {
-            de: {
-                ...secondaryFile,
-                'message.plural': '{count, plural, other {# of {total} items}}',
-            },
-        })).toEqual({
-            de: [
-                {
-                    key: 'multipleVariables',
-                    msg: 'Unexpected date element',
-                },
-            ],
-        });
-    });
-    it('should fail if a variable is changed in one of the translations', () => {
-        expect((0, findInvalidTranslations_1.findInvalidTranslations)(sourceFile, {
-            de: {
-                ...secondaryFile,
-                'message.plural': '{count, plural, other {# of {cargado} items}}',
-            },
-        })).toEqual({
-            de: [
-                {
-                    key: 'message.plural',
-                    msg: 'Error in plural: Expected argument to contain "total" but received "cargado"',
-                },
-                { key: 'multipleVariables', msg: 'Unexpected date element' },
-            ],
-        });
-    });
-});

package/dist/utils/findInvalidi18nTranslations.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/utils/findInvalidi18nTranslations.test.js

@@ -1,206 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const findInvalidi18nTranslations_1 = require("./findInvalidi18nTranslations");
-const flattenTranslations_1 = require("./flattenTranslations");
-const sourceFile = require('../../translations/i18NextMessageExamples/en-us.json');
-const targetFile = require('../../translations/i18NextMessageExamples/de-de.json');
-describe('findInvalid18nTranslations:compareTranslationFiles', () => {
-    it('should return empty array if files are identical', () => {
-        expect((0, findInvalidi18nTranslations_1.compareTranslationFiles)((0, flattenTranslations_1.flattenTranslations)(sourceFile), (0, flattenTranslations_1.flattenTranslations)(sourceFile))).toEqual([]);
-    });
-    it('should return the invalid keys in the target file', () => {
-        expect((0, findInvalidi18nTranslations_1.compareTranslationFiles)((0, flattenTranslations_1.flattenTranslations)({
-            ...sourceFile,
-            'ten.eleven.twelve': 'ten eleven twelve',
-        }), (0, flattenTranslations_1.flattenTranslations)(targetFile))).toEqual([
-            {
-                key: 'key_with_broken_de',
-                msg: 'Error in interpolation: Expected value but received val',
-            },
-            {
-                key: 'intlNumber_broken_de',
-                msg: 'Missing element interpolation',
-            },
-        ]);
-    });
-    it('should return an empty array if the strings contain paranthesis that have different content', () => {
-        expect((0, findInvalidi18nTranslations_1.compareTranslationFiles)((0, flattenTranslations_1.flattenTranslations)({
-            keyText: 'Key(s)',
-        }), (0, flattenTranslations_1.flattenTranslations)({ keyText: 'Taste(n)' }))).toEqual([]);
-    });
-    it('should return empty array if placeholders are identical but in different positions', () => {
-        expect((0, findInvalidi18nTranslations_1.compareTranslationFiles)({
-            basic: 'added {{this}} and {{that}} should work.',
-        }, {
-            basic: 'It is {{this}} with different position {{that}}',
-        })).toEqual([]);
-    });
-    it('should return the invalid key if tags are not identical', () => {
-        expect((0, findInvalidi18nTranslations_1.compareTranslationFiles)({
-            tag: 'This is some <b>bold text</b> and some <i>italic</i> text.',
-        }, {
-            tag: 'There is some <b>bold text</b> and some other <span>italic</span> text.',
-        })).toEqual([
-            {
-                key: 'tag',
-                msg: 'Expected tag "</i>" but received "</span>", Expected tag "<i>" but received "<span>"',
-            },
-        ]);
-    });
-    it('should return empty array if tags are identical', () => {
-        expect((0, findInvalidi18nTranslations_1.compareTranslationFiles)({
-            tag: 'This is some <b>bold text</b> and some <i>italic</i> text.',
-        }, {
-            tag: 'There is some <b>bold text</b> and some other <i>italic</i> text.',
-        })).toEqual([]);
-    });
-});
-describe('findInvalidTranslations', () => {
-    it('should return an empty object if all files have no invalid keys', () => {
-        expect((0, findInvalidi18nTranslations_1.findInvalid18nTranslations)(sourceFile, { de: sourceFile })).toEqual({});
-    });
-    it('should return an object containing the keys for the missing language', () => {
-        expect((0, findInvalidi18nTranslations_1.findInvalid18nTranslations)({ ...sourceFile, 'ten.eleven.twelve': 'ten eleven twelve' }, { de: targetFile })).toEqual({
-            de: [
-                {
-                    key: 'key_with_broken_de',
-                    msg: 'Error in interpolation: Expected value but received val',
-                },
-                {
-                    key: 'intlNumber_broken_de',
-                    msg: 'Missing element interpolation',
-                },
-            ],
-        });
-    });
-    it('should return an object containing the keys for every language with missing key', () => {
-        expect((0, findInvalidi18nTranslations_1.findInvalid18nTranslations)({ ...sourceFile, 'ten.eleven.twelve': 'ten eleven twelve' }, {
-            de: targetFile,
-            fr: {
-                key_with_broken_de: 'Some format {{value, formatname}} and some other format {{value, formatname}}',
-            },
-        })).toEqual({
-            de: [
-                {
-                    key: 'key_with_broken_de',
-                    msg: 'Error in interpolation: Expected value but received val',
-                },
-                {
-                    key: 'intlNumber_broken_de',
-                    msg: 'Missing element interpolation',
-                },
-            ],
-            fr: [
-                {
-                    key: 'key_with_broken_de',
-                    msg: 'Unexpected interpolation element',
-                },
-            ],
-        });
-    });
-    it('should find invalid interval', () => {
-        expect((0, findInvalidi18nTranslations_1.findInvalid18nTranslations)({
-            key1_interval: '(1)[one item];(2-7)[a few items];(7-inf)[a lot of items];',
-        }, {
-            de: {
-                key1_interval: '(1-2)[one or two items];(3-7)[a few items];(7-inf)[a lot of items];',
-            },
-        })).toEqual({
-            de: [
-                {
-                    key: 'key1_interval',
-                    msg: 'Error in plural: Expected 1 but received 1-2, Error in plural: Expected 2-7 but received 3-7',
-                },
-            ],
-        });
-    });
-    it('should find invalid nested interpolation', () => {
-        expect((0, findInvalidi18nTranslations_1.findInvalid18nTranslations)({
-            'tree.one': 'added {{something}}',
-        }, {
-            de: {
-                'tree.one': 'added {{somethings}}',
-            },
-        })).toEqual({
-            de: [
-                {
-                    key: 'tree.one',
-                    msg: 'Error in interpolation: Expected something but received somethings',
-                },
-            ],
-        });
-    });
-    it('should find invalid relative time formatting', () => {
-        expect((0, findInvalidi18nTranslations_1.findInvalid18nTranslations)({
-            intlRelativeTimeWithOptionsExplicit: 'Lorem {{val, relativetime(range: quarter; style: narrow;)}}',
-        }, {
-            de: {
-                intlRelativeTimeWithOptionsExplicit: 'Lorem {{val, relativetime(range: quarter; style: long;)}}',
-            },
-        })).toEqual({
-            de: [
-                {
-                    key: 'intlRelativeTimeWithOptionsExplicit',
-                    msg: 'Error in interpolation: Expected relativetime(range: quarter; style: narrow;) but received relativetime(range: quarter; style: long;)',
-                },
-            ],
-        });
-    });
-    it('should find invalid key with options', () => {
-        expect((0, findInvalidi18nTranslations_1.findInvalid18nTranslations)({
-            keyWithOptions: 'Some format {{value, formatname(option1Name: option1Value; option2Name: option2Value)}}',
-        }, {
-            de: {
-                keyWithOptions: 'Some format {{value, formatname(option3Name: option3Value; option4Name: option4Value)}}',
-            },
-        })).toEqual({
-            de: [
-                {
-                    key: 'keyWithOptions',
-                    msg: 'Error in interpolation: Expected formatname(option1Name: option1Value; option2Name: option2Value) but received formatname(option3Name: option3Value; option4Name: option4Value)',
-                },
-            ],
-        });
-    });
-    it('should find invalid nesting', () => {
-        expect((0, findInvalidi18nTranslations_1.findInvalid18nTranslations)({
-            nesting1: '1 $t(nesting2)',
-        }, {
-            de: {
-                nesting1: '1 $t(nesting3)',
-            },
-        })).toEqual({
-            de: [
-                {
-                    key: 'nesting1',
-                    msg: 'Error in nesting: Expected nesting2 but received nesting3',
-                },
-            ],
-        });
-    });
-    it('should find invalid tags', () => {
-        expect((0, findInvalidi18nTranslations_1.findInvalid18nTranslations)({
-            tag: 'This is some <b>bold text</b> and some <i>italic</i> text.',
-        }, {
-            de: {
-                tag: 'There is some <b>bold text</b> and some other <span>text inside a span</span>!',
-            },
-        })).toEqual({
-            de: [
-                {
-                    key: 'tag',
-                    msg: 'Expected tag "</i>" but received "</span>", Expected tag "<i>" but received "<span>"',
-                },
-            ],
-        });
-    });
-    it('should recognize special characters', () => {
-        expect((0, findInvalidi18nTranslations_1.findInvalid18nTranslations)({
-            key: 'Test < {{a}} and > {{max_a}}',
-        }, {
-            de: {
-                key: 'Test < {{a}} und > {{max_a}}',
-            },
-        })).toEqual({});
-    });
-});

package/dist/utils/findMissingKeys.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/utils/findMissingKeys.test.js

@@ -1,41 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const findMissingKeys_1 = require("./findMissingKeys");
-const sourceFile = {
-    'one.two.three': 'one two three',
-    'four.five.six': 'four five six',
-    'seven.eight.nine': 'seven eight nine',
-};
-const secondaryFile = {
-    'one.two.three': 'one two three',
-    'four.five.six': 'four five six',
-    'seven.eight.nine': 'seven eight nine',
-};
-describe('findMissingKeys:compareTranslationFiles', () => {
-    it('should return empty array if files are identical', () => {
-        expect((0, findMissingKeys_1.compareTranslationFiles)(sourceFile, secondaryFile)).toEqual([]);
-    });
-    it('should return the missing keys in the secondary file', () => {
-        expect((0, findMissingKeys_1.compareTranslationFiles)({ ...sourceFile, 'ten.eleven.twelve': 'ten eleven twelve' }, secondaryFile)).toEqual(['ten.eleven.twelve']);
-    });
-});
-describe('findMissingKeys', () => {
-    it('should return an empty object if all files have no missing keys', () => {
-        expect((0, findMissingKeys_1.findMissingKeys)(sourceFile, { de: secondaryFile })).toEqual({});
-    });
-    it('should return an object containing the keys for the missing language', () => {
-        expect((0, findMissingKeys_1.findMissingKeys)({ ...sourceFile, 'ten.eleven.twelve': 'ten eleven twelve' }, { de: secondaryFile })).toEqual({ de: ['ten.eleven.twelve'] });
-    });
-    it('should return an object containing the keys for every language with missing key', () => {
-        expect((0, findMissingKeys_1.findMissingKeys)({ ...sourceFile, 'ten.eleven.twelve': 'ten eleven twelve' }, {
-            de: secondaryFile,
-            fr: {
-                'four.five.six': 'four five six',
-                'seven.eight.nine': 'seven eight nine',
-            },
-        })).toEqual({
-            de: ['ten.eleven.twelve'],
-            fr: ['one.two.three', 'ten.eleven.twelve'],
-        });
-    });
-});

package/dist/utils/flattenTranslations.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/utils/flattenTranslations.test.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const flattenTranslations_1 = require("./flattenTranslations");
-const flatStructure = require('../../translations/en-us.json');
-const nestedStructure = require('../../translations/flattenExamples/en-us.json');
-const expectedFlatStructure = {
-    'test.drive.one': 'testing one',
-    'test.drive.two': 'testing two',
-    'other.nested.three': 'testing three',
-    'other.nested.deep.more.final': 'nested translation',
-};
-describe('flattenTranslations', () => {
-    it('should do nothing if the file structure is flat', () => {
-        expect((0, flattenTranslations_1.flattenTranslations)(flatStructure)).toEqual(flatStructure);
-    });
-    describe('flattenEntry', () => {
-        it('should flatten a nested object', () => {
-            expect((0, flattenTranslations_1.flattenEntry)({
-                a: {
-                    b: { c: 'one' },
-                },
-            })).toEqual({ 'a.b.c': 'one' });
-        });
-    });
-    it('should do nothing if the file structure is flat', () => {
-        expect((0, flattenTranslations_1.flattenTranslations)(nestedStructure)).toEqual(expectedFlatStructure);
-    });
-});

package/dist/utils/i18NextParser.test.d.ts

@@ -1 +0,0 @@
-export {};