docs: update README.md

i18next · Jul 8, 2022 · 308a15b · 308a15b
1 parent ec38239
commit 308a15b
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -123,6 +123,8 @@ module.exports = {
             fallbackKey: function(ns, value) {
                 return value;
             },
+            supportBasicHtmlNodes: true,
+            keepBasicHtmlNodesFor: ['br', 'strong', 'i', 'p'],
             acorn: {
                 ecmaVersion: 2020,
                 sourceType: 'module', // defaults to 'module'
@@ -148,7 +150,9 @@ module.exports = {
         interpolation: {
             prefix: '{{',
             suffix: '}}'
-        }
+        },
+        metadata: {},
+        allowDynamicKeys: false,
     },
     transform: function customTransform(file, enc, done) {
         "use strict";
@@ -498,18 +502,25 @@ Below are the configuration options with their default values:
     sort: false,
     attr: {
         list: ['data-i18n'],
-        extensions: ['.html', '.htm']
+        extensions: ['.html', '.htm'],
     },
     func: {
         list: ['i18next.t', 'i18n.t'],
-        extensions: ['.js', '.jsx']
+        extensions: ['.js', '.jsx'],
     },
     trans: {
         component: 'Trans',
         i18nKey: 'i18nKey',
         defaultsKey: 'defaults',
         extensions: ['.js', '.jsx'],
-        fallbackKey: false
+        fallbackKey: false,
+        supportBasicHtmlNodes: true,
+        keepBasicHtmlNodesFor: ['br', 'strong', 'i', 'p'],
+        acorn: {
+            ecmaVersion: 2020,
+            sourceType: 'module', // defaults to 'module'
+            // Check out https://github.com/acornjs/acorn/tree/master/acorn#interface for additional options
+        },
     },
     lngs: ['en'],
     ns: ['translation'],
@@ -520,7 +531,7 @@ Below are the configuration options with their default values:
         loadPath: 'i18n/{{lng}}/{{ns}}.json',
         savePath: 'i18n/{{lng}}/{{ns}}.json',
         jsonIndent: 2,
-        lineEnding: '\n'
+        lineEnding: '\n',
     },
     nsSeparator: ':',
     keySeparator: '.',
@@ -529,8 +540,10 @@ Below are the configuration options with their default values:
     contextDefaultValues: [],
     interpolation: {
         prefix: '{{',
-        suffix: '}}'
-    }
+        suffix: '}}',
+    },
+    metadata: {},
+    allowDynamicKeys: false,
 }
 ```
 
@@ -606,7 +619,14 @@ If an `Object` is supplied, you can specify a list of extensions, or override th
         i18nKey: 'i18nKey',
         defaultsKey: 'defaults',
         extensions: ['.js', '.jsx'],
-        fallbackKey: false
+        fallbackKey: false,
+        supportBasicHtmlNodes: true, // Enables keeping the name of simple nodes (e.g. <br/>) in translations instead of indexed keys.
+        keepBasicHtmlNodesFor: ['br', 'strong', 'i', 'p'], // Which nodes are allowed to be kept in translations during defaultValue generation of <Trans>.
+        acorn: {
+            ecmaVersion: 2020,
+            sourceType: 'module', // defaults to 'module'
+            // Check out https://github.com/acornjs/acorn/tree/master/acorn#interface for additional options
+        },
     }
 }
 ```
@@ -819,9 +839,6 @@ interpolation options
 }
 ```
 
-## Integration Guide
-Checkout [Integration Guide](https://github.com/i18next/i18next-scanner/wiki/Integration-Guide) to learn how to integrate with [React](https://github.com/i18next/i18next-scanner/wiki/Integration-Guide#react), [Gettext Style I18n](https://github.com/i18next/i18next-scanner/wiki/Integration-Guide#gettext-style-i18n), and [Handlebars](https://github.com/i18next/i18next-scanner/wiki/Integration-Guide#handlebars).
-
 #### metadata
 
 Type: `Object` Default: `{}`
@@ -881,6 +898,9 @@ Example Usage:
     done();
 ```
 
+## Integration Guide
+Checkout [Integration Guide](https://github.com/i18next/i18next-scanner/wiki/Integration-Guide) to learn how to integrate with [React](https://github.com/i18next/i18next-scanner/wiki/Integration-Guide#react), [Gettext Style I18n](https://github.com/i18next/i18next-scanner/wiki/Integration-Guide#gettext-style-i18n), and [Handlebars](https://github.com/i18next/i18next-scanner/wiki/Integration-Guide#handlebars).
+
 ## License
 
 MIT
diff --git a/src/parser.js b/src/parser.js
@@ -43,13 +43,13 @@ const defaults = {
     defaultsKey: 'defaults',
     extensions: ['.js', '.jsx'],
     fallbackKey: false,
+    supportBasicHtmlNodes: true, // Enables keeping the name of simple nodes (e.g. <br/>) in translations instead of indexed keys.
+    keepBasicHtmlNodesFor: ['br', 'strong', 'i', 'p'], // Which nodes are allowed to be kept in translations during defaultValue generation of <Trans>.
     acorn: {
       ecmaVersion: 2020, // defaults to 2020
       sourceType: 'module', // defaults to 'module'
       // Check out https://github.com/acornjs/acorn/tree/master/acorn#interface for additional options
     },
-    supportBasicHtmlNodes: true, // Enables keeping the name of simple nodes (e.g. <br/>) in translations instead of indexed keys
-    keepBasicHtmlNodesFor: ['br', 'strong', 'i', 'p'], // Which nodes are allowed to be kept in translations during defaultValue generation of <Trans>.
   },
 
   lngs: ['en'], // array of supported languages