xliff - npm Package Compare versions

Comparing version 5.6.2 to 5.7.0

CHANGELOG.md

@@ -0,1 +1,5 @@
+### 5.7.0
+
+- expose noteKeys on createjs and createxliff function
+
 ### 5.6.2
@@ -2,0 +6,0 @@

cjs/createjs.js

@@ -8,3 +8,3 @@ "use strict";
 
-var createjsClb = function createjsClb(srcLng, trgLng, srcKeys, trgKeys, ns, cb) {
+var createjsClb = function createjsClb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, cb) {
   var js = {
@@ -28,2 +28,6 @@ sourceLanguage: srcLng,
       };
+
+      if (ntKeys && ntKeys[srcKey]) {
+        js.resources[ns][srcKey].note = ntKeys[srcKey];
+      }
     });
@@ -41,2 +45,6 @@ if (cb) cb(null, js);
       };
+
+      if (ntKeys && ntKeys[ns] && ntKeys[ns][srcKey]) {
+        js.resources[ns][srcKey].note = ntKeys[ns][srcKey];
+      }
     });
@@ -48,6 +56,6 @@ });
 
-var createjs = function createjs(srcLng, trgLng, srcKeys, trgKeys, ns, cb) {
+var createjs = function createjs(srcLng, trgLng, srcKeys, trgKeys, ns, cb, ntKeys) {
   if (!cb && ns === undefined) {
     return new Promise(function (resolve, reject) {
-      return createjsClb(srcLng, trgLng, srcKeys, trgKeys, ns, function (err, ret) {
+      return createjsClb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, function (err, ret) {
         return err ? reject(err) : resolve(ret);
@@ -60,3 +68,3 @@ });
     return new Promise(function (resolve, reject) {
-      return createjsClb(srcLng, trgLng, srcKeys, trgKeys, ns, function (err, ret) {
+      return createjsClb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, function (err, ret) {
         return err ? reject(err) : resolve(ret);
@@ -67,3 +75,3 @@ });
 
-  return createjsClb(srcLng, trgLng, srcKeys, trgKeys, ns, cb);
+  return createjsClb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, cb);
 };
@@ -70,0 +78,0 @@

cjs/createxliff.js

@@ -17,3 +17,3 @@ "use strict";
 
-var createxliffClb = function createxliffClb(srcLng, trgLng, srcKeys, trgKeys, ns, cb) {
+var createxliffClb = function createxliffClb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, cb) {
   if (!ns || typeof ns !== 'string') {
@@ -25,6 +25,6 @@ cb = ns;
   if (!cb) {
-    return js2xliff(createjs(srcLng, trgLng, srcKeys, trgKeys, ns));
+    return js2xliff(createjs(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns));
   }
 
-  createjs(srcLng, trgLng, srcKeys, trgKeys, ns, function (err, res) {
+  createjs(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, function (err, res) {
     if (err) return cb(err);
@@ -35,6 +35,6 @@ js2xliff(res, cb);
 
-function createxliff(srcLng, trgLng, srcKeys, trgKeys, ns, cb) {
+function createxliff(srcLng, trgLng, srcKeys, trgKeys, ns, cb, ntKeys) {
   if (!cb && ns === undefined) {
     return new Promise(function (resolve, reject) {
-      return createxliffClb(srcLng, trgLng, srcKeys, trgKeys, ns, function (err, ret) {
+      return createxliffClb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, function (err, ret) {
         return err ? reject(err) : resolve(ret);
@@ -47,3 +47,3 @@ });
     return new Promise(function (resolve, reject) {
-      return createxliffClb(srcLng, trgLng, srcKeys, trgKeys, ns, function (err, ret) {
+      return createxliffClb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, function (err, ret) {
         return err ? reject(err) : resolve(ret);
@@ -54,5 +54,5 @@ });
 
-  return createxliffClb(srcLng, trgLng, srcKeys, trgKeys, ns, cb);
+  return createxliffClb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, cb);
 }
 
 module.exports = exports.default;

cjs/createxliff12.js

@@ -17,3 +17,3 @@ "use strict";
 
-var createxliff12Clb = function createxliff12Clb(srcLng, trgLng, srcKeys, trgKeys, ns, cb) {
+var createxliff12Clb = function createxliff12Clb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, cb) {
   if (!ns || typeof ns !== 'string') {
@@ -25,6 +25,6 @@ cb = ns;
   if (!cb) {
-    return jsToXliff12(createjs(srcLng, trgLng, srcKeys, trgKeys, ns));
+    return jsToXliff12(createjs(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns));
   }
 
-  createjs(srcLng, trgLng, srcKeys, trgKeys, ns, function (err, res) {
+  createjs(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, function (err, res) {
     if (err) return cb(err);
@@ -35,6 +35,6 @@ jsToXliff12(res, cb);
 
-function createxliff12(srcLng, trgLng, srcKeys, trgKeys, ns, cb) {
+function createxliff12(srcLng, trgLng, srcKeys, trgKeys, ns, cb, ntKeys) {
   if (!cb && ns === undefined) {
     return new Promise(function (resolve, reject) {
-      return createxliff12Clb(srcLng, trgLng, srcKeys, trgKeys, ns, function (err, ret) {
+      return createxliff12Clb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, function (err, ret) {
         return err ? reject(err) : resolve(ret);
@@ -47,3 +47,3 @@ });
     return new Promise(function (resolve, reject) {
-      return createxliff12Clb(srcLng, trgLng, srcKeys, trgKeys, ns, function (err, ret) {
+      return createxliff12Clb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, function (err, ret) {
         return err ? reject(err) : resolve(ret);
@@ -54,5 +54,5 @@ });
 
-  return createxliff12Clb(srcLng, trgLng, srcKeys, trgKeys, ns, cb);
+  return createxliff12Clb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, cb);
 }
 
 module.exports = exports.default;

esm/createjs.js

@@ -1,2 +0,2 @@
-var createjsClb = function createjsClb(srcLng, trgLng, srcKeys, trgKeys, ns, cb) {
+var createjsClb = function createjsClb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, cb) {
   var js = {
@@ -20,2 +20,6 @@ sourceLanguage: srcLng,
       };
+
+      if (ntKeys && ntKeys[srcKey]) {
+        js.resources[ns][srcKey].note = ntKeys[srcKey];
+      }
     });
@@ -33,2 +37,6 @@ if (cb) cb(null, js);
       };
+
+      if (ntKeys && ntKeys[ns] && ntKeys[ns][srcKey]) {
+        js.resources[ns][srcKey].note = ntKeys[ns][srcKey];
+      }
     });
@@ -40,6 +48,6 @@ });
 
-var createjs = function createjs(srcLng, trgLng, srcKeys, trgKeys, ns, cb) {
+var createjs = function createjs(srcLng, trgLng, srcKeys, trgKeys, ns, cb, ntKeys) {
   if (!cb && ns === undefined) {
     return new Promise(function (resolve, reject) {
-      return createjsClb(srcLng, trgLng, srcKeys, trgKeys, ns, function (err, ret) {
+      return createjsClb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, function (err, ret) {
         return err ? reject(err) : resolve(ret);
@@ -52,3 +60,3 @@ });
     return new Promise(function (resolve, reject) {
-      return createjsClb(srcLng, trgLng, srcKeys, trgKeys, ns, function (err, ret) {
+      return createjsClb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, function (err, ret) {
         return err ? reject(err) : resolve(ret);
@@ -59,3 +67,3 @@ });
 
-  return createjsClb(srcLng, trgLng, srcKeys, trgKeys, ns, cb);
+  return createjsClb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, cb);
 };
@@ -62,0 +70,0 @@

esm/createxliff.js

@@ -6,3 +6,3 @@ import createjsMod from './createjs.js';
 
-var createxliffClb = function createxliffClb(srcLng, trgLng, srcKeys, trgKeys, ns, cb) {
+var createxliffClb = function createxliffClb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, cb) {
   if (!ns || typeof ns !== 'string') {
@@ -14,6 +14,6 @@ cb = ns;
   if (!cb) {
-    return js2xliff(createjs(srcLng, trgLng, srcKeys, trgKeys, ns));
+    return js2xliff(createjs(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns));
   }
 
-  createjs(srcLng, trgLng, srcKeys, trgKeys, ns, function (err, res) {
+  createjs(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, function (err, res) {
     if (err) return cb(err);
@@ -24,6 +24,6 @@ js2xliff(res, cb);
 
-export default function createxliff(srcLng, trgLng, srcKeys, trgKeys, ns, cb) {
+export default function createxliff(srcLng, trgLng, srcKeys, trgKeys, ns, cb, ntKeys) {
   if (!cb && ns === undefined) {
     return new Promise(function (resolve, reject) {
-      return createxliffClb(srcLng, trgLng, srcKeys, trgKeys, ns, function (err, ret) {
+      return createxliffClb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, function (err, ret) {
         return err ? reject(err) : resolve(ret);
@@ -36,3 +36,3 @@ });
     return new Promise(function (resolve, reject) {
-      return createxliffClb(srcLng, trgLng, srcKeys, trgKeys, ns, function (err, ret) {
+      return createxliffClb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, function (err, ret) {
         return err ? reject(err) : resolve(ret);
@@ -43,3 +43,3 @@ });
 
-  return createxliffClb(srcLng, trgLng, srcKeys, trgKeys, ns, cb);
+  return createxliffClb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, cb);
 }

esm/createxliff12.js

@@ -6,3 +6,3 @@ import createjsMod from './createjs.js';
 
-var createxliff12Clb = function createxliff12Clb(srcLng, trgLng, srcKeys, trgKeys, ns, cb) {
+var createxliff12Clb = function createxliff12Clb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, cb) {
   if (!ns || typeof ns !== 'string') {
@@ -14,6 +14,6 @@ cb = ns;
   if (!cb) {
-    return jsToXliff12(createjs(srcLng, trgLng, srcKeys, trgKeys, ns));
+    return jsToXliff12(createjs(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns));
   }
 
-  createjs(srcLng, trgLng, srcKeys, trgKeys, ns, function (err, res) {
+  createjs(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, function (err, res) {
     if (err) return cb(err);
@@ -24,6 +24,6 @@ jsToXliff12(res, cb);
 
-export default function createxliff12(srcLng, trgLng, srcKeys, trgKeys, ns, cb) {
+export default function createxliff12(srcLng, trgLng, srcKeys, trgKeys, ns, cb, ntKeys) {
   if (!cb && ns === undefined) {
     return new Promise(function (resolve, reject) {
-      return createxliff12Clb(srcLng, trgLng, srcKeys, trgKeys, ns, function (err, ret) {
+      return createxliff12Clb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, function (err, ret) {
         return err ? reject(err) : resolve(ret);
@@ -36,3 +36,3 @@ });
     return new Promise(function (resolve, reject) {
-      return createxliff12Clb(srcLng, trgLng, srcKeys, trgKeys, ns, function (err, ret) {
+      return createxliff12Clb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, function (err, ret) {
         return err ? reject(err) : resolve(ret);
@@ -43,3 +43,3 @@ });
 
-  return createxliff12Clb(srcLng, trgLng, srcKeys, trgKeys, ns, cb);
+  return createxliff12Clb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, cb);
 }

lib/createjs.js

@@ -1,2 +0,2 @@
-const createjsClb = (srcLng, trgLng, srcKeys, trgKeys, ns, cb) => {
+const createjsClb = (srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, cb) => {
   const js = {
@@ -21,2 +21,6 @@ sourceLanguage: srcLng,
       }
+
+      if (ntKeys && ntKeys[srcKey]) {
+        js.resources[ns][srcKey].note = ntKeys[srcKey]
+      }
     })
@@ -36,2 +40,6 @@
       }
+
+      if (ntKeys && ntKeys[ns] && ntKeys[ns][srcKey]) {
+        js.resources[ns][srcKey].note = ntKeys[ns][srcKey]
+      }
     })
@@ -44,10 +52,10 @@ })
 
-const createjs = (srcLng, trgLng, srcKeys, trgKeys, ns, cb) => {
+const createjs = (srcLng, trgLng, srcKeys, trgKeys, ns, cb, ntKeys) => {
   if (!cb && ns === undefined) {
-    return new Promise((resolve, reject) => createjsClb(srcLng, trgLng, srcKeys, trgKeys, ns, (err, ret) => err ? reject(err) : resolve(ret)))
+    return new Promise((resolve, reject) => createjsClb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, (err, ret) => err ? reject(err) : resolve(ret)))
   }
   if (!cb && typeof ns !== 'function') {
-    return new Promise((resolve, reject) => createjsClb(srcLng, trgLng, srcKeys, trgKeys, ns, (err, ret) => err ? reject(err) : resolve(ret)))
+    return new Promise((resolve, reject) => createjsClb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, (err, ret) => err ? reject(err) : resolve(ret)))
   }
-  return createjsClb(srcLng, trgLng, srcKeys, trgKeys, ns, cb)
+  return createjsClb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, cb)
 }
@@ -54,0 +62,0 @@

lib/createxliff.js

@@ -6,3 +6,3 @@ import createjsMod from './createjs.js'
 
-const createxliffClb = (srcLng, trgLng, srcKeys, trgKeys, ns, cb) => {
+const createxliffClb = (srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, cb) => {
   if (!ns || typeof ns !== 'string') {
@@ -14,6 +14,6 @@ cb = ns
   if (!cb) {
-    return js2xliff(createjs(srcLng, trgLng, srcKeys, trgKeys, ns))
+    return js2xliff(createjs(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns))
   }
 
-  createjs(srcLng, trgLng, srcKeys, trgKeys, ns, (err, res) => {
+  createjs(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, (err, res) => {
     if (err) return cb(err)
@@ -24,10 +24,10 @@ js2xliff(res, cb)
 
-export default function createxliff (srcLng, trgLng, srcKeys, trgKeys, ns, cb) {
+export default function createxliff (srcLng, trgLng, srcKeys, trgKeys, ns, cb, ntKeys) {
   if (!cb && ns === undefined) {
-    return new Promise((resolve, reject) => createxliffClb(srcLng, trgLng, srcKeys, trgKeys, ns, (err, ret) => err ? reject(err) : resolve(ret)))
+    return new Promise((resolve, reject) => createxliffClb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, (err, ret) => err ? reject(err) : resolve(ret)))
   }
   if (!cb && typeof ns !== 'function') {
-    return new Promise((resolve, reject) => createxliffClb(srcLng, trgLng, srcKeys, trgKeys, ns, (err, ret) => err ? reject(err) : resolve(ret)))
+    return new Promise((resolve, reject) => createxliffClb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, (err, ret) => err ? reject(err) : resolve(ret)))
   }
-  return createxliffClb(srcLng, trgLng, srcKeys, trgKeys, ns, cb)
+  return createxliffClb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, cb)
 }

lib/createxliff12.js

@@ -6,3 +6,3 @@ import createjsMod from './createjs.js'
 
-const createxliff12Clb = (srcLng, trgLng, srcKeys, trgKeys, ns, cb) => {
+const createxliff12Clb = (srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, cb) => {
   if (!ns || typeof ns !== 'string') {
@@ -14,6 +14,6 @@ cb = ns
   if (!cb) {
-    return jsToXliff12(createjs(srcLng, trgLng, srcKeys, trgKeys, ns))
+    return jsToXliff12(createjs(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns))
   }
 
-  createjs(srcLng, trgLng, srcKeys, trgKeys, ns, (err, res) => {
+  createjs(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, (err, res) => {
     if (err) return cb(err)
@@ -24,10 +24,10 @@ jsToXliff12(res, cb)
 
-export default function createxliff12 (srcLng, trgLng, srcKeys, trgKeys, ns, cb) {
+export default function createxliff12 (srcLng, trgLng, srcKeys, trgKeys, ns, cb, ntKeys) {
   if (!cb && ns === undefined) {
-    return new Promise((resolve, reject) => createxliff12Clb(srcLng, trgLng, srcKeys, trgKeys, ns, (err, ret) => err ? reject(err) : resolve(ret)))
+    return new Promise((resolve, reject) => createxliff12Clb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, (err, ret) => err ? reject(err) : resolve(ret)))
   }
   if (!cb && typeof ns !== 'function') {
-    return new Promise((resolve, reject) => createxliff12Clb(srcLng, trgLng, srcKeys, trgKeys, ns, (err, ret) => err ? reject(err) : resolve(ret)))
+    return new Promise((resolve, reject) => createxliff12Clb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, (err, ret) => err ? reject(err) : resolve(ret)))
   }
-  return createxliff12Clb(srcLng, trgLng, srcKeys, trgKeys, ns, cb)
+  return createxliff12Clb(srcLng, trgLng, srcKeys, trgKeys, ntKeys, ns, cb)
 }

package.json

 {
   "name": "xliff",
-  "version": "5.6.2",
+  "version": "5.7.0",
   "description": "xliff2js and js2xliff converter xliff utils",
@@ -5,0 +5,0 @@ "type": "module",

README.md

@@ -148,3 +148,9 @@ [![travis](https://img.shields.io/travis/locize/xliff.svg)](https://travis-ci.org/locize/xliff) [![npm](https://img.shields.io/npm/v/xliff.svg)](https://npmjs.org/package/xliff)
   // res is like js
-})
+  }
+  // you can specify notes with this param (ntKeys)
+  // ,{
+  //    "key1": "custom note for key1",
+  //    "key.nested": "another note for nested key"
+  // }
+)
 // or without callback
@@ -170,4 +176,10 @@ //const res = await createjs(...
   (err, res) => {
-  // res is like xliff
-})
+  // res is like xliff  
+  }  
+  // you can specify notes with this param (ntKeys)
+  // ,{
+  //    "key1": "custom note for key1",
+  //    "key.nested": "another note for nested key"
+  // }
+)
 // or without callback
@@ -266,3 +278,9 @@ //const res = await createxliff(...
     // res is like xliff
-  })
+    }
+    // you can specify notes with this param (ntKeys)
+    // ,{
+    //    "key1": "custom note for key1",
+    //    "key.nested": "another note for nested key"
+    // }
+  )
   // or without callback
@@ -269,0 +287,0 @@ //const res = await createxliff12(...

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

545187

increased by0.41%

Lines of code

10984

increased by0.22%

Number of lines in readme file

568

increased by3.27%

No dependency changes