Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add entry value as a parameter to defaultValue function #676

Merged
merged 6 commits into from Nov 10, 2022
Merged

Add entry value as a parameter to defaultValue function #676

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
76ee3f3
Replace useKeysAsDefaultValue and skipDefaultValues with a function t…
JonathanSun Nov 8, 2022
30a61f2
Update readme
JonathanSun Nov 8, 2022
0d24717
Simplify test args
JonathanSun Nov 8, 2022
3ea0f4c
Add conditional test
JonathanSun Nov 8, 2022
8966ee4
Handle skipping default values
JonathanSun Nov 8, 2022
c9eb316
PR comments
JonathanSun Nov 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 2 additions & 11 deletions README.md
View file
Open in desktop
Expand Up @@ -127,8 +127,8 @@ export default {
// Default namespace used in your i18next config

defaultValue: '',
// Default value to give to empty keys
// You may also specify a function accepting the locale, namespace, and key as arguments
// Default value to give to keys with no value
// You may also specify a function accepting the locale, namespace, and key, and value as arguments
JonathanSun marked this conversation as resolved.
Show resolved Hide resolved

indentation: 2,
// Indentation of the catalog files
Expand Down Expand Up @@ -183,15 +183,6 @@ export default {
sort: false,
// Whether or not to sort the catalog. Can also be a [compareFunction](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#parameters)

skipDefaultValues: false,
// Whether to ignore default values
// You may also specify a function accepting the locale and namespace as arguments

useKeysAsDefaultValue: false,
// Whether to use the keys as the default value; ex. "Hello": "Hello", "World": "World"
// This option takes precedence over the `defaultValue` and `skipDefaultValues` options
// You may also specify a function accepting the locale and namespace as arguments

verbose: false,
// Display info about the parsing including some stats

Expand Down
29 changes: 4 additions & 25 deletions src/helpers.js
View file
Open in desktop
Expand Up @@ -35,33 +35,12 @@ function dotPathToHash(entry, target = {}, options = {}) {
}

const defaultValue =
typeof options.value === 'function'
? options.value(options.locale, entry.namespace, key)
: options.value

const skipDefaultValues =
typeof options.skipDefaultValues === 'function'
? options.skipDefaultValues(options.locale, entry.namespace)
: options.skipDefaultValues

const useKeysAsDefaultValue =
typeof options.useKeysAsDefaultValue === 'function'
? options.useKeysAsDefaultValue(options.locale, entry.namespace)
: options.useKeysAsDefaultValue
entry[`defaultValue${options.suffix}`] || entry.defaultValue || ''

let newValue =
entry[`defaultValue${options.suffix}`] ||
entry.defaultValue ||
defaultValue ||
''

if (skipDefaultValues) {
newValue = ''
}

if (useKeysAsDefaultValue) {
newValue = key
}
typeof options.value === 'function'
? options.value(options.locale, entry.namespace, key, defaultValue)
: options.value || defaultValue

if (path.endsWith(separator)) {
path = path.slice(0, -separator.length)
Expand Down
4 changes: 0 additions & 4 deletions src/transform.js
View file
Open in desktop
Expand Up @@ -36,9 +36,7 @@ export default class i18nTransform extends Transform {
output: 'locales/$LOCALE/$NAMESPACE.json',
resetDefaultValueLocale: null,
sort: false,
useKeysAsDefaultValue: false,
verbose: false,
skipDefaultValues: false,
customValueTemplate: null,
failOnWarnings: false,
yamlOptions: null,
Expand Down Expand Up @@ -171,8 +169,6 @@ export default class i18nTransform extends Transform {
separator: this.options.keySeparator,
pluralSeparator: this.options.pluralSeparator,
value: this.options.defaultValue,
useKeysAsDefaultValue: this.options.useKeysAsDefaultValue,
skipDefaultValues: this.options.skipDefaultValues,
customValueTemplate: this.options.customValueTemplate,
})

Expand Down
10 changes: 0 additions & 10 deletions test/helpers/dotPathToHash.test.js
View file
Open in desktop
Expand Up @@ -35,16 +35,6 @@ describe('dotPathToHash helper function', () => {
done()
})

it('supports custom separator when `useKeysAsDefaultValue` is true', (done) => {
const { target } = dotPathToHash(
{ keyWithNamespace: 'namespace-two-three' },
{},
{ separator: '-', useKeysAsDefaultValue: true }
)
assert.deepEqual(target, { namespace: { two: { three: 'two-three' } } })
done()
})

it('handles an empty namespace', (done) => {
const { target, duplicate } = dotPathToHash({
keyWithNamespace: 'ns.',
Expand Down
115 changes: 24 additions & 91 deletions test/parser.test.js
View file
Open in desktop
Expand Up @@ -1085,11 +1085,11 @@ describe('parser', () => {
it('supports a defaultValue function', (done) => {
let result
const i18nextParser = new i18nTransform({
defaultValue: (locale, namespace, key) =>
`${locale}:${namespace}:${key}`,
defaultValue: (locale, namespace, key, value) =>
`${locale}:${namespace}:${key}:${value}`,
})
const fakeFile = new Vinyl({
contents: Buffer.from("t('first')"),
contents: Buffer.from("t('first', 'myDefault')"),
path: 'file.js',
})

Expand All @@ -1099,63 +1099,57 @@ describe('parser', () => {
}
})
i18nextParser.once('end', () => {
assert.deepEqual(result, { first: 'en:translation:first' })
assert.deepEqual(result, { first: 'en:translation:first:myDefault' })
done()
})

i18nextParser.end(fakeFile)
})

it('supports a useKeysAsDefaultValue function', (done) => {
JonathanSun marked this conversation as resolved.
Show resolved Hide resolved
let enResult
let arResult
it('supports a defaultValue function with empty result', (done) => {
let result
const i18nextParser = new i18nTransform({
locales: ['en', 'ar'],
useKeysAsDefaultValue: (locale, namespace) => locale === 'en',
defaultValue: (locale, namespace, key, value) => '',
})
const fakeFile = new Vinyl({
contents: Buffer.from("t('first')"),
contents: Buffer.from("t('first', 'myDefault')"),
path: 'file.js',
})

i18nextParser.on('data', (file) => {
if (file.relative.endsWith(enLibraryPath)) {
enResult = JSON.parse(file.contents)
} else if (file.relative.endsWith(arLibraryPath)) {
arResult = JSON.parse(file.contents)
result = JSON.parse(file.contents)
}
})
i18nextParser.once('end', () => {
assert.deepEqual(enResult, { first: 'first' })
assert.deepEqual(arResult, { first: '' })
assert.deepEqual(result, { first: '' })
done()
})

i18nextParser.end(fakeFile)
})

it('supports a skipDefaultValues function', (done) => {
let enResult
let arResult
it('supports a defaultValue function with conditionals', (done) => {
let result
const i18nextParser = new i18nTransform({
locales: ['en', 'ar'],
skipDefaultValues: (locale, namespace) => locale === 'en',
defaultValue: (locale, namespace, key, value) =>
value ? value : `${key}`,
})
const fakeFile = new Vinyl({
contents: Buffer.from("t('first', { defaultValue: 'default' })"),
contents: Buffer.from("t('first', 'myDefault'); t('second')"),
path: 'file.js',
})

i18nextParser.on('data', (file) => {
if (file.relative.endsWith(enLibraryPath)) {
enResult = JSON.parse(file.contents)
} else if (file.relative.endsWith(arLibraryPath)) {
arResult = JSON.parse(file.contents)
result = JSON.parse(file.contents)
}
})
i18nextParser.once('end', () => {
assert.deepEqual(enResult, { first: '' })
assert.deepEqual(arResult, { first: 'default' })
assert.deepEqual(result, {
first: 'myDefault',
second: 'second',
})
done()
})

Expand Down Expand Up @@ -1527,37 +1521,6 @@ describe('parser', () => {
i18nextParser.end(fakeFile)
})

it('supports useKeysAsDefaultValue', (done) => {
let result
const i18nextParser = new i18nTransform({
useKeysAsDefaultValue: true,
})
const fakeFile = new Vinyl({
contents: Buffer.from(
"t('first'); \n t('second and third'); t('$fourth %fifth%'); t('six.seven');"
),
path: 'file.js',
})

i18nextParser.once('data', (file) => {
if (file.relative.endsWith(enLibraryPath)) {
result = JSON.parse(file.contents)
}
})
i18nextParser.on('end', () => {
assert.deepEqual(result, {
first: 'first',
'second and third': 'second and third',
'$fourth %fifth%': '$fourth %fifth%',
six: {
seven: 'six.seven',
},
})
done()
})
i18nextParser.end(fakeFile)
})

it('generates plurals', (done) => {
let result
const i18nextParser = new i18nTransform()
Expand Down Expand Up @@ -1719,10 +1682,10 @@ describe('parser', () => {
i18nextParser.end(fakeFile)
})

it('generates plurals with key as value', (done) => {
it('generates plurals for defaultValue function', (done) => {
let result
const i18nextParser = new i18nTransform({
useKeysAsDefaultValue: true,
defaultValue: (locale, namespace, key, value) => `${key}`,
})
const fakeFile = new Vinyl({
contents: Buffer.from("t('test {{count}}', { count: 1 })"),
Expand Down Expand Up @@ -1835,10 +1798,10 @@ describe('parser', () => {
i18nextParser.end(fakeFile)
})

it('generates plurals with key as value for languages with multiple plural forms', (done) => {
it('generates plurals for defaultValue function for languages with multiple plural forms', (done) => {
let result
const i18nextParser = new i18nTransform({
useKeysAsDefaultValue: true,
defaultValue: (locale, namespace, key, value) => `${key}`,
locales: ['ar'],
})
const fakeFile = new Vinyl({
Expand Down Expand Up @@ -1894,36 +1857,6 @@ describe('parser', () => {
i18nextParser.end(fakeFile)
})

it('supports skipDefaultValues option', (done) => {
let result
const i18nextParser = new i18nTransform({
skipDefaultValues: true,
})

const fakeFile = new Vinyl({
contents: Buffer.from(
"t('headline1', 'There will be a headline here.') \n" +
"t('headline2', {defaultValue: 'Another Headline here'}})"
),
path: 'file.js',
})

i18nextParser.on('data', (file) => {
result = JSON.parse(file.contents)
})

i18nextParser.on('end', () => {
assert.deepEqual(result, {
headline1: '',
headline2: '',
})

done()
})

i18nextParser.end(fakeFile)
})

it('supports customValueTemplate option', (done) => {
let result
const i18nextParser = new i18nTransform({
Expand Down