Add first files WIP

Author: Gertjan Reynaert

dist/.keep

@@ -0,0 +1,93 @@
+# React-intl-translations-manager
+
+## Installing
+
+```
+npm install --save-dev react-intl-translations-manager
+```
+
+## Usage
+
+Since you need the `babel-plugin-react-intl` to extract the messages, I'll assume you're using babel in your project.
+
+This is an example of the most basic usage of this plugin, in the API documentation below you can find more options.
+
+Create a script in your package.json
+```json
+{
+  "scripts": {
+    "manage:translations": "babel-node ./translationRunner.js"
+  }
+}
+```
+Create a file with your config you can run with the npm script
+```js
+// translationRunner.js
+import { createTranslationManager } from 'react-intl-translations-manager';
+
+const translationManager = createTranslationManager({
+  messagesDirectory: 'src/translations/extractedMessages',
+  translationsDirectory: 'src/translations/locales/',
+  languages: ['nl'], // any language you need
+});
+
+translationManager.run();
+```
+
+Run the translation manager with your new npm script
+
+```
+npm run manage:translations
+```
+
+## API
+
+### createTranslationManager
+
+This will create a new translationManager based on the config you gave in. On
+itself this won't do anything unless you run any of the commands below.
+
+#### Config
+
+- `messagesDirectory` (required),
+  - Directory where the babel plugin puts the extracted messages. This path is
+  relative to your projects root.
+  - example: `src/locales/extractedMessages`
+- `translationsDirectory` (required),
+  - Directory of the translation files the translation manager needs to maintain.
+  - example: `src/locales/lang`
+- `singleMessagesFile` (optional, default: `false`)
+  - Option to output a single file containing the aggregate of all extracted messages,
+  grouped by the file they were extracted from.
+  - example:
+  ```json
+    [
+      {
+        "path": "src/components/foo.json",
+        "descriptors": [
+          {
+            "id": "bar",
+            "description": "Text for bar",
+            "defaultMessage": "Bar",
+          }
+        ]
+      }
+    ]
+  ```
+- `whitelistsDirectory` (optional, default: `translationsDirectory`)
+  - Directory of the whitelist files the translation manager needs to maintain.
+  These files contain the key of translations that have the exact same text in a specific language as the defaultMessage. Specifying this key will suppress
+  `unmaintained translation` warnings.
+  - example: `Dashboard` in english is also accepted as a valid translation for
+  dutch.
+- `languages` (optional, default: `[]`)
+  - What languages the translation manager needs to maintain. Specifying no
+  languages actually doesn't make sense, but won't break the translationManager
+  either.
+  - example: for `['nl', 'fr']` the translation manager will maintain a `nl.json`, `fr.json`, `whitelist_nl.json` and a `whitelist_fr.json` file
+- `detectDuplicateIds` (optional, default: `true`)
+  - If you want the translationManager to detect duplicate message ids or not
+
+### run
+
+This will maintain all translation files. Based on your config you will get output for duplicate ids, and per specified language you will get the deleted translations, added messages (new messages that need to be translated), and not translated messages.

src/README.md

@@ -0,0 +1,19 @@
+import Path from 'path';
+import { writeFileSync } from 'fs';
+
+export default ({
+  messages,
+  directory,
+  fileName = 'defaultMessages.json',
+  jsonSpaceIndentation = 2,
+}) => {
+  if (!messages) throw new Error('messages are required');
+
+  if (!directory || typeof directory !== 'string' || directory.length === 0) {
+    throw new Error('directory is required');
+  }
+
+  const DIR = Path.join('./', directory, fileName);
+
+  writeFileSync(DIR, JSON.stringify(messages, null, jsonSpaceIndentation));
+};

src/createSingleMessagesFile.js

@@ -0,0 +1,57 @@
+// FROM:
+//
+// const files = [
+//   {
+//     path: 'src/components/Foo.json',
+//     descriptors: [
+//       {
+//         id: 'foo_ok',
+//         description: 'Ok text',
+//         defaultMessage: 'OK',
+//       },
+//       {
+//         id: 'foo_ok',
+//         description: 'Submit text',
+//         defaultMessage: 'Submit',
+//       },
+//       {
+//         id: 'foo_cancel',
+//         description: 'Cancel text',
+//         defaultMessage: 'Cancel',
+//       },
+//     ],
+//   },
+// ];
+//
+// TO:
+//
+// TODO: figure out what message gets returned for duplicate ids
+//
+// const result = {
+//   messages: {
+//     foo_ok: 'OK | Submit',
+//     foo_cancel: 'Cancel',
+//   },
+//   duplicateIds: [
+//     'foo_ok',
+//   ],
+// };
+
+export default files => {
+  if (!files) throw new Error('files are required');
+
+  return files.reduce((fileAcc, { descriptors }) => {
+    const duplicateIds = fileAcc.duplicateIds;
+    return {
+      messages: descriptors.reduce((descAcc, { id, defaultMessage }) => {
+        if (descAcc.hasOwnProperty(id)) { duplicateIds.push(id); }
+
+        return { ...descAcc, [id]: defaultMessage };
+      }, fileAcc.messages),
+      duplicateIds,
+    };
+  }, {
+    messages: {},
+    duplicateIds: [],
+  });
+};

src/getDefaultMessages.js

@@ -0,0 +1,73 @@
+// returns stats for a specific language
+// - added: contains all added messages
+// - untranslated: contains all untranslated messages
+// - deleted: contains all deleted messages
+// - fileOutput: contains output for the new language file
+//               a single object with all added and untranslated messages
+//               in a key (messageKey) value (message) format
+// - whitelistOutput: contains output for the new languageWhitelist file
+//                    all previously whitelisted keys, without the deleted keys
+//
+// {
+//   added: [],
+//   untranslated: [],
+//   deleted: [],
+//   fileOutput: {},
+//   whitelistOutput: [],
+// }
+//
+// every message is declared in the following format
+// {
+//   key: 'unique_message_key',
+//   message: 'specific_message',
+// }
+
+export default (defaultMessages, languageMessages, languageWhitelist) => {
+  const result = {
+    added: [],
+    untranslated: [],
+    deleted: [],
+    fileOutput: {},
+    whitelistOutput: [],
+  };
+
+  const defaultMessageKeys = Object.keys(defaultMessages);
+
+  defaultMessageKeys.forEach(key => {
+    const oldMessage = languageMessages[key];
+    const defaultMessage = defaultMessages[key];
+
+    if (oldMessage) {
+      result.fileOutput[key] = oldMessage;
+
+      if (oldMessage === defaultMessage) {
+        if (languageWhitelist.indexOf(key) === -1) {
+          result.untranslated.push({
+            key,
+            message: defaultMessage,
+          });
+        } else {
+          result.whitelistOutput.push(key);
+        }
+      }
+    } else {
+      result.fileOutput[key] = defaultMessage;
+
+      result.added.push({
+        key,
+        message: defaultMessage,
+      });
+    }
+  });
+
+  // if the key is still in the language file but no longer in the
+  // defaultMessages file, then the key was deleted.
+  result.deleted = Object.keys(languageMessages)
+  .filter(key => defaultMessageKeys.indexOf(key) === -1)
+  .map(key => ({
+    key,
+    message: languageMessages[key],
+  }));
+
+  return result;
+};

src/getLanguageReport.js

@@ -0,0 +1,2 @@
+// returns a collection of reports for all languages
+// getReports: () => console.log('Not yet supported'),

src/getReports.js

@@ -0,0 +1,27 @@
+export { default as readMessageFiles } from './readMessageFiles';
+export { default as createSingleMessagesFile } from './createSingleMessagesFile';
+export { default as getDefaultMessages } from './getDefaultMessages';
+
+import run from './run';
+
+export const createTranslationManager = ({
+  messagesDirectory,
+  translationsDirectory,
+  singleMessagesFile = false,
+  whitelistsDirectory = translationsDirectory,
+  languages = [],
+  detectDuplicateIds = true,
+}) => {
+  if (!messagesDirectory || !translationsDirectory) {
+    throw new Error('messagesDirectory and translationsDirectory are required');
+  }
+
+  return () => run({
+    messagesDirectory,
+    translationsDirectory,
+    singleMessagesFile,
+    whitelistsDirectory,
+    languages,
+    detectDuplicateIds,
+  });
+};

src/index.js

@@ -0,0 +1,32 @@
+import { green, yellow, red, cyan } from 'chalk';
+
+import { newLine, subheader, header } from './printer';
+
+export default ({
+  deleted,
+  untranslated,
+  added,
+}) => {
+  if (!(deleted.length || added.length || untranslated.length)) {
+    console.log('  ', green('  Perfectly maintained, no remarks!'));
+    newLine();
+  } else {
+    if (deleted.length) {
+      subheader('Deleted keys:');
+      deleted.forEach(({ key, message }) => console.log(`  ${red(key)}: ${cyan(message)}`));
+      newLine();
+    }
+
+    if (untranslated.length) {
+      subheader('Untranslated keys:');
+      untranslated.forEach(({ key, message }) => console.log(`  ${yellow(key)}: ${cyan(message)}`));
+      newLine();
+    }
+
+    if (added.length) {
+      subheader('Added keys:');
+      added.forEach(({ key, message }) => console.log(`  ${green(key)}: ${cyan(message)}`));
+      newLine();
+    }
+  }
+};

src/printResults.js

@@ -0,0 +1,14 @@
+import { bold } from 'chalk';
+
+export const newLine = () => console.log(' ');
+
+export const header = title => {
+  console.log(bold.underline(title));
+  newLine();
+};
+
+export const subheader = title => console.log(title);
+
+export const footer = () => {
+  newLine();
+};

src/printer.js

@@ -0,0 +1,9 @@
+import { readFileSync } from 'fs';
+
+export default filename => {
+  try {
+    return readFileSync(filename, 'utf8');
+  } catch (err) {
+    return undefined;
+  }
+};