Version 2

README.md

@@ -1,11 +1,5 @@
 # @connectedcars/react-i18n
 
-Work in progress.
-
-## Todo
-- [ ] fuzzy translations
-- [ ] improve documentation
-
 ## Installation
 
 `npm install @connectedcars/react-i18n`
@@ -28,6 +22,42 @@ Translate text containing a variable:
 
 `t('This {word} is in a translated sentence.', { word: 'Variable'})`
 
+Translate plurals (`n` is injected into the data object, but can be overwritten):
+
+`tn(count, '{n} time', '{n} times')`
+
+Multiple lines are also supported using template strings (however, **DO NOT** use `${}` variables!):
+
+```
+t(`Foo
+   bar
+   baz`)
+```
+
+*Please note, however, that these translations will not be rendered on multiple lines in HTML!*
+
+Translate with React:
+
+```
+// Use `tnx` for plurals with JSX!
+tx(`
+  <p>Hello, <strong>{name}</strong><p>
+  <p>Today is {day}</p>
+`, {
+  p: content => <p>{content}</p>,
+  strong: content => <strong>{content}</strong>,
+  name: 'John Doe',
+  day: 'Monday'
+})
+```
+
+*Please note, by default translations are in strict mode which means an error will be thrown on undefined types*
+*Please note, it is possible to add a whitelist/default by setting `jsxWhitelist` on the `I18nPovider`.*
+
+You can also add a context to your translations:
+
+`t('Hello', null, 'context here')`
+
 ## Import and Export
 
 First you need to set up the import and export scripts in your `package.json`
@@ -41,6 +71,7 @@ First you need to set up the import and export scripts in your `package.json`
 
 ...
 ```
+
 Then you can run the following commands:
 * `npm run export` creates a POT file with the extracted translations in `./locales/template.pot`
 * `npm run import` creates a json file containing your all your translations in `./src/translations.json`
@@ -50,4 +81,4 @@ Then you can run the following commands:
 To get output for CI, add the following script:
 ```
   "ci-translation": "i18n-translation-status"
-```
+```

bin/export.js

@@ -1,16 +1,22 @@
 #!/usr/bin/env node
-const { GettextExtractor, JsExtractors, HtmlExtractors } = require('gettext-extractor')
+const { GettextExtractor, JsExtractors } = require('gettext-extractor')
 
 let extractor = new GettextExtractor()
 
+const content = {
+  trimWhiteSpace: true,
+  preserveIndentation: false
+}
+
 extractor
   .createJsParser([
     JsExtractors.callExpression(['t', 'props.t', '[this].context.t'], {
       arguments: {
         text: 0,
         // data
-        context: 2
-      }
+        context: 2,
+      },
+      content,
     }),
 
     JsExtractors.callExpression(['tn', 'props.tn', '[this].context.tn'], {
@@ -19,13 +25,33 @@ extractor
         text: 1,
         textPlural: 2,
         // data
-        context: 4
-      }
+        context: 4,
+      },
+      content,
+    }),
+
+    JsExtractors.callExpression(['tx', 'props.tx', '[this].context.tx'], {
+      arguments: {
+        text: 0,
+        // data
+        context: 2,
+      },
+      content,
+    }),
+
+    JsExtractors.callExpression(['tnx', 'props.tnx', '[this].context.tnx'], {
+      arguments: {
+        // count
+        text: 1,
+        textPlural: 2,
+        // data
+        context: 4,
+      },
+      content,
     })
   ])
   .parseFilesGlob('./src/**/*.@(ts|js|tsx|jsx)')
 
 extractor.savePotFile('./locales/template.pot')
 
 extractor.printStats()
-

example/.gitignore

@@ -1 +1,23 @@
-/node_modules
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

example/README.md

@@ -1,14 +1,44 @@
-# Example App
+This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
 
-This is a demo app showing how to use the `ReduxProvider` with `create-react-app`.
+## Available Scripts
 
-## Getting started
+In the project directory, you can run:
 
-```
-$ cd example
-$ npm install
-$ npm start
-```
+### `npm start`
 
-If your browser doesn't automatically open, then go to `localhost:3000`.
+Runs the app in the development mode.<br>
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
 
+The page will reload if you make edits.<br>
+You will also see any lint errors in the console.
+
+### `npm test`
+
+Launches the test runner in the interactive watch mode.<br>
+See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+
+### `npm run build`
+
+Builds the app for production to the `build` folder.<br>
+It correctly bundles React in production mode and optimizes the build for the best performance.
+
+The build is minified and the filenames include the hashes.<br>
+Your app is ready to be deployed!
+
+See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+
+### `npm run eject`
+
+**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+
+If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+
+Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+
+You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+
+## Learn More
+
+You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+
+To learn React, check out the [React documentation](https://reactjs.org/).

example/locales/da.po

@@ -1,27 +1,22 @@
 msgid ""
 msgstr ""
+"Content-Type: text/plain; charset=UTF-8\n"
 "Project-Id-Version: \n"
 "POT-Creation-Date: \n"
 "PO-Revision-Date: \n"
-"Last-Translator: \n"
 "Language-Team: \n"
-"Language: da\n"
 "MIME-Version: 1.0\n"
-"Content-Type: text/plain; charset=UTF-8\n"
 "Content-Transfer-Encoding: 8bit\n"
-"X-Generator: Poedit 2.0.5\n"
+"X-Generator: Poedit 2.0.6\n"
+"Last-Translator: \n"
 "Plural-Forms: nplurals=2; plural=(n != 1);\n"
+"Language: da\n"
 
-#: src/App.tsx:16
-msgid "{n} day ago"
-msgid_plural "{n} days ago"
-msgstr[0] "{n} dag siden"
-msgstr[1] "{n} dage siden"
-
-#: src/App.tsx:30
-msgid "Current language:"
-msgstr "Valgt sprog:"
-
-#: src/App.tsx:22
+#: src/index.tsx:21
+#: src/index.tsx:38
 msgid "Hello {name}"
 msgstr "Hej {name}"
+
+#: src/index.tsx:45
+msgid "Set language to <lang />"
+msgstr "Skift sprog til <lang />"

example/locales/template.pot

@@ -2,16 +2,11 @@ msgid ""
 msgstr ""
 "Content-Type: text/plain; charset=UTF-8\n"
 
-#: src/App.tsx:17
-msgid "{n} day ago"
-msgid_plural "{n} days ago"
-msgstr[0] ""
-msgstr[1] ""
-
-#: src/App.tsx:30
-msgid "Current language:"
+#: src/index.tsx:21
+#: src/index.tsx:38
+msgid "Hello {name}"
 msgstr ""
 
-#: src/App.tsx:23
-msgid "Hello {name}"
+#: src/index.tsx:45
+msgid "Set language to <lang />"
 msgstr ""