Change ignoreEmptyKeys default to true

Author: ewlsh

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 # Unreleased
 
-- Add `ignoreEmptyKeys` option to ignore empty keys when scanning source files #634
+- Add `ignoreEmptyKeys` option (default: true) to ignore empty keys when scanning source files #634
 
 # 9.3.0
 

README.md

@@ -253,10 +253,10 @@ export default {
   // {
   //   lineWidth: -1,
 
-  ignoreEmptyKeys: false,
-  // Set to true to ignore empty keys when scanning source files.
+  ignoreEmptyKeys: true,
+  // When true (default), ignores empty keys when scanning source files.
   // This allows using t('') which is useful with i18next's "returnEmptyString: false" setting.
-  // When false (default), empty keys are included in the translation files and will fail with --fail-on-update.
+  // When false, empty keys are included in the translation files and will fail with --fail-on-update.
 }
 ```
 

src/transform.js

@@ -40,7 +40,7 @@ export default class i18nTransform extends Transform {
       customValueTemplate: null,
       failOnWarnings: false,
       yamlOptions: null,
-      ignoreEmptyKeys: false,
+      ignoreEmptyKeys: true,
     }
 
     this.options = { ...this.defaults, ...options }

test/helpers/dotPathToHash.test.js

@@ -36,15 +36,37 @@ describe('dotPathToHash helper function', () => {
   })
 
   it('handles an empty namespace', (done) => {
-    const { target, duplicate } = dotPathToHash({
-      keyWithNamespace: 'ns.',
-      namespace: 'ns',
-    })
+    const { target, duplicate } = dotPathToHash(
+      {
+        keyWithNamespace: 'ns.',
+        namespace: 'ns',
+      },
+      {},
+      {
+        ignoreEmptyKeys: true,
+      }
+    )
     assert.deepEqual(target, { ns: {} })
     assert.equal(duplicate, false)
     done()
   })
 
+  it('handles an empty namespace when ignoreEmptyKeys is false', (done) => {
+    const { target, duplicate } = dotPathToHash(
+      {
+        keyWithNamespace: 'ns.',
+        namespace: 'ns',
+      },
+      {},
+      {
+        ignoreEmptyKeys: false,
+      }
+    )
+    assert.deepEqual(target, { ns: { '': '' } })
+    assert.equal(duplicate, false)
+    done()
+  })
+
   it('handles a target hash', (done) => {
     const { target, duplicate } = dotPathToHash(
       { keyWithNamespace: 'one.two.three' },

test/parser.test.js

@@ -308,7 +308,6 @@ describe('parser', () => {
     const i18nextParser = new i18nTransform({
       locales: ['en'],
       defaultNamespace: 'default',
-      ignoreEmptyKeys: true,
     })
     const fakeFile = new Vinyl({
       contents: Buffer.from("t('empty:');"),
@@ -341,7 +340,6 @@ describe('parser', () => {
     const i18nextParser = new i18nTransform({
       locales: ['en'],
       defaultNamespace: 'test_empty',
-      ignoreEmptyKeys: true,
     })
     const fakeFile = new Vinyl({
       contents: Buffer.from("t('key'); t('');"),
@@ -361,7 +359,7 @@ describe('parser', () => {
     i18nextParser.end(fakeFile)
   })
 
-  it('includes empty keys by default', (done) => {
+  it('ignores empty keys by default', (done) => {
     let resultContent
     const i18nextParser = new i18nTransform({
       locales: ['en'],
@@ -378,19 +376,19 @@ describe('parser', () => {
       }
     })
     i18nextParser.on('end', () => {
-      assert.deepEqual(resultContent, { key: '', '': '' })
+      assert.deepEqual(resultContent, { key: '' })
       done()
     })
 
     i18nextParser.end(fakeFile)
   })
 
-  it('ignores empty keys when scanning source files when ignoreEmptyKeys is true', (done) => {
+  it('includes empty keys when ignoreEmptyKeys is false', (done) => {
     let resultContent
     const i18nextParser = new i18nTransform({
       locales: ['en'],
       defaultNamespace: 'test_ignore_empty',
-      ignoreEmptyKeys: true,
+      ignoreEmptyKeys: false,
     })
     const fakeFile = new Vinyl({
       contents: Buffer.from("t('key'); t('');"),
@@ -403,7 +401,7 @@ describe('parser', () => {
       }
     })
     i18nextParser.on('end', () => {
-      assert.deepEqual(resultContent, { key: '' })
+      assert.deepEqual(resultContent, { key: '', '': '' })
       done()
     })