Merge pull request #1 from FRSgit/feat--add-possibility-to-customize-push-&-pull-requests

feat: add possibility to customize pull & push requests & syncTerms

Author: ov3rk1ll

CHANGELOG.md

@@ -1,3 +1,10 @@
+## 1.15.0
+
+`2021-09-02`
+
+- 🌟 Added possibility to pass custom parameters to pull or push API requests
+- 🌟 Added syncTerms option support
+
 ## 1.14.0
 
 `2021-03-11`

README.md

@@ -37,7 +37,11 @@ Create a **poeditor-config.json** in the root directory, and config information
   "apiToken": "",                     // POEditor api token
   "projectId": 0,                     // project id
   "fileType": "",                     // fileType to upload or download, supports files format (po, pot, mo, xls, csv, resw, resx, android_strings, apple_strings, xliff, properties, key_value_json, json, xmb, xtb)
-  "targetDir": ""                     // directory where translated files live
+  "targetDir": "",                    // directory where translated files live
+  "syncTerms": true,                  // (optional) set it to true if you want to sync your terms (terms that are not found in the uploaded file will be deleted from project and the new ones added)
+  "sourceLang": "en-US",              // (optional, required when syncTerms set to true) language to sync the terms from
+  "pullParams": {},                   // (optional) allows to pass any parameters available on the POEditor's export endpoint, full list here: https://poeditor.com/docs/api#projects_export
+  "pushParams": {}                    // (optional) allows to pass any parameters available on the POEditor's upload endpoint, full list here: https://poeditor.com/docs/api#projects_upload
 }
 ```
 

packages/commands/pull.js

@@ -64,6 +64,7 @@ async function getTermFiles(config) {
       id: config.projectId,
       language: lang.code,
       type: tempFileType,
+      ...(config.pullParams || {})
     };
 
     try {

packages/commands/push.js

@@ -60,7 +60,7 @@ function push() {
 
 async function putTermFiles(config) {
   const targetDir = path.resolve(cwd, config.targetDir);
-  const paths = await globby([targetDir]);
+  let paths = await globby([targetDir]);
   const sleep = (func, timeout) => {
     return new Promise(async (resolve) => {
       setTimeout(() => {
@@ -69,12 +69,24 @@ async function putTermFiles(config) {
       }, timeout);
     });
   };
+  
+  paths = paths.map(url => ({ url, parsedUrl: path.parse(url) }));
+
+  if (config.syncTerms) {
+    // if syncTerms === true make sure sourceLang will be the last in the paths array
+    // (we want to sourceLang terms be synced as a last request so they won't get overwritten by terms from other locale files)
+    paths.sort((a, b) => {
+      if (a.parsedUrl.name === config.sourceLang) return 1;
+      if (b.parsedUrl.name === config.sourceLang) return -1;
+      return 0;
+    });
+  }
 
-  const promises = paths.map((url, index) => {
+  const promises = paths.map(({ url, parsedUrl }, index) => {
     return new Promise(async (resolve, reject) => {
-      let timeout = index * 30000 + 10;
+      const timeout = index * 30000 + 10;
       return sleep(async () => {
-        if (path.parse(url).ext.slice(1) !== fileTypeMap[config.fileType]) {
+        if (parsedUrl.ext.slice(1) !== fileTypeMap[config.fileType]) {
           console.log(
             chalk.red(
               `\n 😭  Incorrect fileType, ${
@@ -89,7 +101,7 @@ async function putTermFiles(config) {
           await putTermFile({
             ...config,
             file: url,
-            language: path.parse(url).name,
+            language: parsedUrl.name,
           });
           resolve(null);
         } catch (err) {
@@ -121,6 +133,15 @@ async function putTermFile(config) {
   formData.append("file", fs.createReadStream(config.file));
   formData.append("overwrite", "1");
 
+  if (config.syncTerms && config.sourceLang && config.language === config.sourceLang) {
+    formData.append('sync_terms', '1');
+  }
+
+  if (config.pushParams) {
+    Object.keys(config.pushParams)
+      .forEach(paramName => formData.set(paramName, config.pushParams[paramName]))
+  }
+
   const res = await api.post("/projects/upload", formData, {
     headers: {
       "Content-Type": `multipart/form-data; boundary=${formData._boundary}`,