i18n-helpers - npm Package Compare versions

Comparing version 0.0.1 to 0.1.0

common.json

@@ -28,8 +28,3 @@ {
   "pl_PL": "Polski",
-  "en_US": "English",
-  "total": "Total",
-  "team": "Team",
-  "admin": "Admin",
-  "errors": "Errors",
-  "error": "Error"
+  "en_US": "English"
 }

package.json

 {
   "name": "i18n-helpers",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Helper to search for i18n occurences",
@@ -15,3 +15,2 @@ "main": "index.js",
     "prepublish": "npm run build",
-    "serve": "nodemon src/main.js --exec babel-node",
     "test": "jest"
@@ -27,4 +26,10 @@ },
   "dependencies": {
-    "inquirer": "^3.2.0",
-    "lodash": "^4.17.4"
+    "babel-runtime": "^6.23.0",
+    "bluebird": "^3.5.0",
+    "chalk": "^2.0.1",
+    "cli-table": "^0.3.1",
+    "command-line-commands": "^2.0.1",
+    "lodash": "^4.17.4",
+    "minimist": "^1.2.0",
+    "table": "^4.0.1"
   },
@@ -35,2 +40,3 @@ "devDependencies": {
     "babel-jest": "^20.0.3",
+    "babel-plugin-transform-runtime": "^6.23.0",
     "babel-preset-env": "^1.6.0",
@@ -37,0 +43,0 @@ "codacy-coverage": "^2.0.2",

README.md

@@ -1,1 +0,67 @@
-# i18n-helper
+# i18n-helpers
+
+A set of helpers useful when introducing `i18n` internationalization to the application.
+
+## Merge
+
+Merges original internationalization file (usually english) and translation file. Both files have to be in `JSON` format.
+
+This module is useful when searching for missing keys or when one wants to provide placeholders for missing keys. It also finds any keys that are existing in the translation and are missing in the original.
+
+Generates either report or explicit list of keys.
+
+### Usage
+
+```
+
+i18-helpers merge [-a | -p | -v | -i] original translation
+
+```
+
+### Minimal example
+
+To run the merge in the simplest way, just provide paths to the original internationalization file and the translated one.
+
+```
+
+i18-helpers merge 'original.json' 'translation.json'
+
+```
+
+### Flags
+
+The tool can be run with different flags:
+
+| `-a,--append-original`            | Flag depicting that the original translation should be appended after the placeholder                         |
+|-----------------------------------|---------------------------------------------------------------------------------------------------------------|
+| `-i,--indent [value]`             | Indentation value used for building the resulting file. Check `JSON.stringify` documentation for the details. |
+| `-p,--placeholder [placeholder]`  | Custom placeholder. Default placeholder is `__I18N_MISSING__`                                                 |
+| `-v,--verbose`                    | Generates verbose report containing list of keys in particular groups                                         |
+
+### Example output
+
+Merge command generates simple report about performed operations. Example below:
+
+```
+
+╔═════════════════════════╤═════╗
+║ New keys                │ 126 ║
+╟─────────────────────────┼─────╢
+║ Existing keys           │ 422 ║
+╟─────────────────────────┼─────╢
+║ Skipped keys            │ 0   ║
+╟─────────────────────────┼─────╢
+║ Missing in the original │ 0   ║
+╟─────────────────────────┼─────╢
+║ Total                   │ 548 ║
+╚═════════════════════════╧═════╝
+
+```
+
+* `New keys` is related to the keys missing in the translation
+* `Existing keys` are the ones that are probably already translated and exist in the translation file
+* `Skipped keys` are related to the ones that are inconsistent between original and translation (e.g. key in the original holds an object and in the translation is just a plain value)
+* `Missing in the original` holds the number of the keys missing in the original that are existing in the translation
+* `Total` is the sum of keys generated in the output
+
+If the output indicates that some inconsistencies occurred (number of `skipped` or `missing` keys different than `0`), one can use `-v` flag to investigate problems.

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

137511

increased by1334.5%

Number of package files

16

increased by60%

Lines of code

478

increased by129.81%

Number of lines in readme file

68

increased by6700%

Worsened metrics

Dependency count

8

increased by300%

Dev dependency count

9

increased by12.5%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedbabel-runtime@^6.23.0

• + Addedbluebird@^3.5.0

• + Addedchalk@^2.0.1

• + Addedcli-table@^0.3.1

• + Addedcommand-line-commands@^2.0.1

• + Addedminimist@^1.2.0

• + Addedtable@^4.0.1

• + Addedajv@6.12.6(transitive)

• + Addedajv-keywords@3.5.2(transitive)

• + Addedarray-back@2.0.0(transitive)

• + Addedbabel-runtime@6.26.0(transitive)

• + Addedbluebird@3.7.2(transitive)

• + Addedcli-table@0.3.11(transitive)

• + Addedcolors@1.0.3(transitive)

• + Addedcommand-line-commands@2.0.1(transitive)

• + Addedcore-js@2.6.12(transitive)

• + Addedfast-deep-equal@3.1.3(transitive)

• + Addedfast-json-stable-stringify@2.1.0(transitive)

• + Addedjson-schema-traverse@0.4.1(transitive)

• + Addedminimist@1.2.8(transitive)

• + Addedpunycode@2.3.1(transitive)

• + Addedregenerator-runtime@0.11.1(transitive)

• + Addedslice-ansi@1.0.0(transitive)

• + Addedtable@4.0.3(transitive)

• + Addedtypical@2.6.1(transitive)

• + Addeduri-js@4.4.1(transitive)

• - Removedinquirer@^3.2.0

• - Removedansi-escapes@3.2.0(transitive)

• - Removedchardet@0.4.2(transitive)

• - Removedcli-cursor@2.1.0(transitive)

• - Removedcli-width@2.2.1(transitive)

• - Removedexternal-editor@2.2.0(transitive)

• - Removedfigures@2.0.0(transitive)

• - Removediconv-lite@0.4.24(transitive)

• - Removedinquirer@3.3.0(transitive)

• - Removedmimic-fn@1.2.0(transitive)

• - Removedmute-stream@0.0.7(transitive)

• - Removedonetime@2.0.1(transitive)

• - Removedos-tmpdir@1.0.2(transitive)

• - Removedrestore-cursor@2.0.0(transitive)

• - Removedrun-async@2.4.1(transitive)

• - Removedrx-lite@4.0.8(transitive)

• - Removedrx-lite-aggregates@4.0.8(transitive)

• - Removedsafer-buffer@2.1.2(transitive)

• - Removedsignal-exit@3.0.7(transitive)

• - Removedthrough@2.3.8(transitive)

• - Removedtmp@0.0.33(transitive)