cht-conf 4.4.1 → 4.5.0

package/src/fn/watch-project.js

@@ -26,269 +26,277 @@ const { execute: uploadCustomTranslations, TRANSLATIONS_DIR_PATH } = require('./
 const { execute: uploadResources, RESOURCES_DIR_PATH, RESOURCE_CONFIG_PATH } = require('./upload-resources');
 
 const watcherEvents = {
-    CreateEvent: 'create',
-    DeleteEvent: 'delete',
-    UpdateEvent: 'update'
+  CreateEvent: 'create',
+  DeleteEvent: 'delete',
+  UpdateEvent: 'update'
 };
 
 const runValidation = (validation, forms) => {
-    if(environment.skipValidate) {
-        return;
-    }
-    return validation(forms);
+  if(environment.skipValidate) {
+    return;
+  }
+  return validation(forms);
 };
 
 const uploadInitialState = async (api) => {
-    await uploadResources();
-    await runValidation(validateAppForms, environment.extraArgs);
-    await runValidation(validateContactForms, environment.extraArgs);
-    await runValidation(validateTrainingForms, environment.extraArgs);
-    await uploadAppForms(environment.extraArgs);
-    await uploadContactForms(environment.extraArgs);
-    await uploadTrainingForms(environment.extraArgs);
-    await uploadCustomTranslations();
-    await uploadAppSettings(api);
+  await uploadResources();
+  await runValidation(validateAppForms, environment.extraArgs);
+  await runValidation(validateContactForms, environment.extraArgs);
+  await runValidation(validateTrainingForms, environment.extraArgs);
+  await uploadAppForms(environment.extraArgs);
+  await uploadContactForms(environment.extraArgs);
+  await uploadTrainingForms(environment.extraArgs);
+  await uploadCustomTranslations();
+  await uploadAppSettings(api);
 };
 
 let fsEventsSubscription;
 let eventQueue;
 
 const cleanUp = async () => {
-    if (fsEventsSubscription) {
-        await fsEventsSubscription.unsubscribe();
-        fsEventsSubscription = undefined;
-    }
-    if (eventQueue) {
-        await eventQueue.clear();
-        eventQueue = undefined;
-    }
+  if (fsEventsSubscription) {
+    await fsEventsSubscription.unsubscribe();
+    fsEventsSubscription = undefined;
+  }
+  if (eventQueue) {
+    await eventQueue.clear();
+    eventQueue = undefined;
+  }
 };
 
 const waitForKillSignal = () => {
-    return new Promise((resolve) => {
-        process.on('SIGINT', async () => {
-            await cleanUp();
-            resolve();
-        });
+  return new Promise((resolve) => {
+    process.on('SIGINT', async () => {
+      await cleanUp();
+      resolve();
     });
+  });
 };
 
 const deleteForm = (fileName, formDir) => {
-    const form = uploadForms.formFileMatcher(fileName) || convertForms.formFileMatcher(fileName);
-    if (!form) {
-        return false;
-    }
-    const absFormDirPath = path.join(environment.pathToProject, formDir);
-    const formFiles = fs.readdirSync(absFormDirPath).map(file => (uploadForms.formFileMatcher(file) || convertForms.formFileMatcher(file))).filter(_form => _form === form);
-    const canDelete = formFiles.length <= 0;
-    if (canDelete) {
-        eventQueue.enqueue(async () => {
-            await deleteForms([form]);
-            return fileName;
-        });
-        return true;
-    }
-    warn(`You have to delete all form files (.xlsx, .properties.json, .xml) associated with the ${form} form to delete it from ${environment.apiUrl}`);
+  const form = uploadForms.formFileMatcher(fileName) || convertForms.formFileMatcher(fileName);
+  if (!form) {
     return false;
+  }
+  const absFormDirPath = path.join(environment.pathToProject, formDir);
+  const formFiles = fs
+    .readdirSync(absFormDirPath)
+    .map(file => (uploadForms.formFileMatcher(file) || convertForms.formFileMatcher(file)))
+    .filter(_form => _form === form);
+  const canDelete = formFiles.length <= 0;
+  if (canDelete) {
+    eventQueue.enqueue(async () => {
+      await deleteForms([form]);
+      return fileName;
+    });
+    return true;
+  }
+  warn(
+    `You have to delete all form files (.xlsx, .properties.json, .xml) associated with the ${form} form `
+    + `to delete it from ${environment.apiUrl}`
+  );
+  return false;
 };
 
 const getFormCommandContext = (parsedPath) => {
-    if (parsedPath.dir === path.join(environment.pathToProject, APP_FORMS_PATH)) {
-        return {
-            path: APP_FORMS_PATH,
-            validateForms: validateAppForms,
-            uploadForms: uploadAppForms,
-            convertForms: convertAppForms,
-        };
-    }
+  if (parsedPath.dir === path.join(environment.pathToProject, APP_FORMS_PATH)) {
+    return {
+      path: APP_FORMS_PATH,
+      validateForms: validateAppForms,
+      uploadForms: uploadAppForms,
+      convertForms: convertAppForms,
+    };
+  }
 
-    if (parsedPath.dir === path.join(environment.pathToProject, TRAINING_FORMS_PATH)) {
-        return {
-            path: TRAINING_FORMS_PATH,
-            validateForms: validateTrainingForms,
-            uploadForms: uploadTrainingForms,
-            convertForms: convertTrainingForms,
-        };
-    }
+  if (parsedPath.dir === path.join(environment.pathToProject, TRAINING_FORMS_PATH)) {
+    return {
+      path: TRAINING_FORMS_PATH,
+      validateForms: validateTrainingForms,
+      uploadForms: uploadTrainingForms,
+      convertForms: convertTrainingForms,
+    };
+  }
 
-    if (parsedPath.dir === path.join(environment.pathToProject, CONTACT_FORMS_PATH)) {
-        return {
-            path: CONTACT_FORMS_PATH,
-            validateForms: validateContactForms,
-            uploadForms: uploadContactForms,
-            convertForms: convertContactForm,
-        };
-    }
+  if (parsedPath.dir === path.join(environment.pathToProject, CONTACT_FORMS_PATH)) {
+    return {
+      path: CONTACT_FORMS_PATH,
+      validateForms: validateContactForms,
+      uploadForms: uploadContactForms,
+      convertForms: convertContactForm,
+    };
+  }
 
-    if (parsedPath.dir === path.join(environment.pathToProject, COLLECT_FORMS_PATH)) {
-        return {
-            path: COLLECT_FORMS_PATH,
-            validateForms: validateCollectForms,
-            uploadForms: uploadCollectForms,
-            convertForms: convertCollectForms,
-        };
-    }
+  if (parsedPath.dir === path.join(environment.pathToProject, COLLECT_FORMS_PATH)) {
+    return {
+      path: COLLECT_FORMS_PATH,
+      validateForms: validateCollectForms,
+      uploadForms: uploadCollectForms,
+      convertForms: convertCollectForms,
+    };
+  }
 
-    return;
+  return;
 };
 
 const processForm = (eventType, fileName, commandContext) => {
-    if (eventType === watcherEvents.DeleteEvent && deleteForm(fileName, commandContext.path)) {
-        return true;
-    }
-    let form = uploadForms.formFileMatcher(fileName);
-    if (form) {
-        eventQueue.enqueue(async () => {
-            await runValidation(commandContext.validateForms, [form]);
-            await commandContext.uploadForms([form]);
-            return fileName;
-        });
-        return true;
-    }
+  if (eventType === watcherEvents.DeleteEvent && deleteForm(fileName, commandContext.path)) {
+    return true;
+  }
+  let form = uploadForms.formFileMatcher(fileName);
+  if (form) {
+    eventQueue.enqueue(async () => {
+      await runValidation(commandContext.validateForms, [form]);
+      await commandContext.uploadForms([form]);
+      return fileName;
+    });
+    return true;
+  }
 
-    form = convertForms.formFileMatcher(fileName);
-    if (form) {
-        eventQueue.enqueue(async () => {
-            await commandContext.convertForms([form]);
-            return fileName;
-        });
-        return true;
-    }
-    return false;
+  form = convertForms.formFileMatcher(fileName);
+  if (form) {
+    eventQueue.enqueue(async () => {
+      await commandContext.convertForms([form]);
+      return fileName;
+    });
+    return true;
+  }
+  return false;
 };
 
 const getFormMediaCommandContext = (parsedPath) => {
-    if (parsedPath.dir.startsWith(path.join(environment.pathToProject, APP_FORMS_PATH))
+  if (parsedPath.dir.startsWith(path.join(environment.pathToProject, APP_FORMS_PATH))
       && path.parse(parsedPath.dir).dir.endsWith(APP_FORMS_PATH)) {
-        // Check if the directory's immediate parent is forms/app
-        return {
-            validateForms: validateAppForms,
-            uploadForms: uploadAppForms,
-        };
-    }
+    // Check if the directory's immediate parent is forms/app
+    return {
+      validateForms: validateAppForms,
+      uploadForms: uploadAppForms,
+    };
+  }
 
-    if (parsedPath.dir.startsWith(path.join(environment.pathToProject, TRAINING_FORMS_PATH))
+  if (parsedPath.dir.startsWith(path.join(environment.pathToProject, TRAINING_FORMS_PATH))
       && path.parse(parsedPath.dir).dir.endsWith(TRAINING_FORMS_PATH)) {
-        // Check if the directory's immediate parent is forms/training
-        return {
-            validateForms: validateTrainingForms,
-            uploadForms: uploadTrainingForms,
-        };
-    }
+    // Check if the directory's immediate parent is forms/training
+    return {
+      validateForms: validateTrainingForms,
+      uploadForms: uploadTrainingForms,
+    };
+  }
 
-    return;
+  return;
 };
 
 const processFormMedia = (formMediaDir, fileName, commandContext) => {
-    const form = uploadForms.formMediaMatcher(formMediaDir);
-    if (form) {
-        eventQueue.enqueue(async () => {
-            await runValidation(commandContext.validateForms,[form]);
-            await commandContext.uploadForms([form]);
-            return fileName;
-        });
-        return true;
-    }
-    return false;
+  const form = uploadForms.formMediaMatcher(formMediaDir);
+  if (form) {
+    eventQueue.enqueue(async () => {
+      await runValidation(commandContext.validateForms,[form]);
+      await commandContext.uploadForms([form]);
+      return fileName;
+    });
+    return true;
+  }
+  return false;
 };
 
 const processConfigFiles = (api, fileName) => {
-    if (fileName === APP_SETTINGS_JSON_PATH) {
-        eventQueue.enqueue(async () => {
-            await uploadAppSettings(api);
-            return fileName;
-        });
-        return true;
-    }
-    if (configFileMatcher(fileName)) {
-        eventQueue.enqueue(async () => {
-            await compileAppSettings();
-            return fileName;
-        });
-        return true;
-    }
-    return false;
+  if (fileName === APP_SETTINGS_JSON_PATH) {
+    eventQueue.enqueue(async () => {
+      await uploadAppSettings(api);
+      return fileName;
+    });
+    return true;
+  }
+  if (configFileMatcher(fileName)) {
+    eventQueue.enqueue(async () => {
+      await compileAppSettings();
+      return fileName;
+    });
+    return true;
+  }
+  return false;
 };
 
 const watchProject = {
-    watch: async (api, blockFn, callback = {}, uploadStateOnStart = false) => {
-        if (uploadStateOnStart) {
-            await uploadInitialState(api);
-            info('Initial State Uploaded');
-        }
+  watch: async (api, blockFn, callback = {}, uploadStateOnStart = false) => {
+    if (uploadStateOnStart) {
+      await uploadInitialState(api);
+      info('Initial State Uploaded');
+    }
 
-        eventQueue = new Queue({ concurrent: 1, start: true });
+    eventQueue = new Queue({ concurrent: 1, start: true });
 
-        fsEventsSubscription = await watcher.subscribe(environment.pathToProject, async (err, events) => {
-            if (err) {
-                error(err);
-                return;
-            }
-            for (const event of events) {
-                const changePath = event.path;
-                const parsedPath = path.parse(changePath);
-                const fileName = parsedPath.base;
+    fsEventsSubscription = await watcher.subscribe(environment.pathToProject, async (err, events) => {
+      if (err) {
+        error(err);
+        return;
+      }
+      for (const event of events) {
+        const changePath = event.path;
+        const parsedPath = path.parse(changePath);
+        const fileName = parsedPath.base;
 
-                const formContext = getFormCommandContext(parsedPath);
-                if (formContext) {
-                    processForm(event.type, fileName, formContext);
-                    continue;
-                }
+        const formContext = getFormCommandContext(parsedPath);
+        if (formContext) {
+          processForm(event.type, fileName, formContext);
+          continue;
+        }
 
-                const formMediaContext = getFormMediaCommandContext(parsedPath);
-                if (formMediaContext) {
-                    const dirName = path.parse(parsedPath.dir).base;
-                    processFormMedia(dirName, fileName, formMediaContext);
-                    continue;
-                }
+        const formMediaContext = getFormMediaCommandContext(parsedPath);
+        if (formMediaContext) {
+          const dirName = path.parse(parsedPath.dir).base;
+          processFormMedia(dirName, fileName, formMediaContext);
+          continue;
+        }
 
-                if (parsedPath.dir === path.join(environment.pathToProject, TRANSLATIONS_DIR_PATH)) {
-                    eventQueue.enqueue(async () => {
-                        await uploadCustomTranslations();
-                        return fileName;
-                    });
-                    continue;
-                }
+        if (parsedPath.dir === path.join(environment.pathToProject, TRANSLATIONS_DIR_PATH)) {
+          eventQueue.enqueue(async () => {
+            await uploadCustomTranslations();
+            return fileName;
+          });
+          continue;
+        }
 
-                if (parsedPath.dir === path.join(environment.pathToProject, APP_SETTINGS_DIR_PATH)) {
-                    processConfigFiles(api, fileName);
-                    continue;
-                }
+        if (parsedPath.dir === path.join(environment.pathToProject, APP_SETTINGS_DIR_PATH)) {
+          processConfigFiles(api, fileName);
+          continue;
+        }
 
-                if (parsedPath.dir === environment.pathToProject && parsedPath.base !== RESOURCE_CONFIG_PATH) {
-                    processConfigFiles(api, fileName);
-                    continue;
-                }
+        if (parsedPath.dir === environment.pathToProject && parsedPath.base !== RESOURCE_CONFIG_PATH) {
+          processConfigFiles(api, fileName);
+          continue;
+        }
 
-                if (parsedPath.base === RESOURCE_CONFIG_PATH || parsedPath.dir === path.join(environment.pathToProject, RESOURCES_DIR_PATH)) {
-                    eventQueue.enqueue(async () => {
-                        await uploadResources();
-                        return fileName;
-                    });
-                    continue;
-                }
-            }
-        });
+        if (parsedPath.base === RESOURCE_CONFIG_PATH
+          || parsedPath.dir === path.join(environment.pathToProject, RESOURCES_DIR_PATH)
+        ) {
+          eventQueue.enqueue(async () => {
+            await uploadResources();
+            return fileName;
+          });
+          continue;
+        }
+      }
+    });
 
-        eventQueue.on('resolve', file => {
-            if (callback) {
-                callback(file);
-            }
-        });
-        eventQueue.on('reject', err => error('watch-mode: Error while processing change,', err));
+    eventQueue.on('resolve', file => {
+      if (callback) {
+        callback(file);
+      }
+    });
+    eventQueue.on('reject', err => error('watch-mode: Error while processing change,', err));
 
-        info('watching', environment.pathToProject, 'for changes');
-        await blockFn();
-    },
-    close: async () => {
-        info('stopping watchers');
-        await cleanUp();
-    }
+    info('watching', environment.pathToProject, 'for changes');
+    await blockFn();
+  },
+  close: async () => {
+    info('stopping watchers');
+    await cleanUp();
+  }
 };
 
 const api = require('../lib/api');
 module.exports = {
-    watchProject,
-    requiresInstance: true,
-    execute: () => watchProject.watch(api(), waitForKillSignal, false, true)
+  watchProject,
+  requiresInstance: true,
+  execute: () => watchProject.watch(api(), waitForKillSignal, false, true)
 };

package/src/lib/api.js

@@ -210,28 +210,28 @@ const api = {
       headers: { 'Content-Type': 'application/xml' },
       body: formXml,
     })
-    .then(resp => {
-      try {
-        return JSON.parse(resp);
-      } catch (e) {
-        throw new Error('Invalid JSON response validating XForm against the API: ' + resp);
-      }
-    })
-    .catch(err => {
-      if (err.statusCode === 404) {
-        // The endpoint doesn't exist in the API (old CHT version), so
-        // we assume the form is valid but return special JSON
-        // highlighting the situation, and remembering the lack
-        // of the endpoint so next call there is no need
-        // to call the missed endpoint again
-        this._formsValidateEndpointFound = false;
-        return {ok: true, formsValidateEndpointFound: false};
-      }
-      if (err.statusCode === 400 && err.error) {
-        throw new Error(JSON.parse(err.error).error);
-      }
-      throw err;
-    });
+      .then(resp => {
+        try {
+          return JSON.parse(resp);
+        } catch (e) {
+          throw new Error('Invalid JSON response validating XForm against the API: ' + resp);
+        }
+      })
+      .catch(err => {
+        if (err.statusCode === 404) {
+          // The endpoint doesn't exist in the API (old CHT version), so
+          // we assume the form is valid but return special JSON
+          // highlighting the situation, and remembering the lack
+          // of the endpoint so next call there is no need
+          // to call the missed endpoint again
+          this._formsValidateEndpointFound = false;
+          return {ok: true, formsValidateEndpointFound: false};
+        }
+        if (err.statusCode === 400 && err.error) {
+          throw new Error(JSON.parse(err.error).error);
+        }
+        throw err;
+      });
   },
 
   async getCompressibleTypes () {

package/src/lib/args-form-filter.js

@@ -16,4 +16,4 @@ module.exports = (formsDir, extension, options) => {
   }
 
   return filteredFiles;
-};
+};

package/src/lib/attachments-from-dir.js

@@ -3,7 +3,9 @@ const fs = require('./sync-fs');
 const warn = require('./log').warn;
 
 module.exports = dir => {
-  if(!fs.exists(dir)) return warn('Cannot build list of attachments from non-existent dir:', dir);
+  if(!fs.exists(dir)) {
+    return warn('Cannot build list of attachments from non-existent dir:', dir);
+  }
 
   const attachments = {};
   fs.recurseFiles(dir)

package/src/lib/check-cht-conf-dependency-version.js

@@ -19,8 +19,8 @@ module.exports = projectDir => {
   const majorRunningVersion = semver.major(runningVersion);
   let upgradeDowngradeLocalMsg = '';
   let upgradeDowngradeProjectMsg = '';
-  let satisfiesLessThanMajorRunningVersion = semver.satisfies(projectVersion, `<${majorRunningVersion}.x`);
-  let satisifiesGreaterThanRunningVersion = semver.satisfies(projectVersion, `>${runningVersion}`);
+  const satisfiesLessThanMajorRunningVersion = semver.satisfies(projectVersion, `<${majorRunningVersion}.x`);
+  const satisifiesGreaterThanRunningVersion = semver.satisfies(projectVersion, `>${runningVersion}`);
 
   if(satisfiesLessThanMajorRunningVersion || satisifiesGreaterThanRunningVersion) {
 
@@ -34,6 +34,7 @@ module.exports = projectDir => {
       upgradeDowngradeProjectMsg = 'downgrade';
     }
 
+    /* eslint-disable max-len */
     throw new Error(`Your cht-conf version is incompatible with the project's cht-conf version:
     Your local cht-conf version:   ${runningVersion}
     The project cht-conf version: ${projectVersion}
@@ -44,6 +45,7 @@ module.exports = projectDir => {
         npm i -g cht-conf@${projectVersion}
     and try again, or ${upgradeDowngradeProjectMsg} the project cht-conf version to ${runningVersion}, or ignore this warning with --skip-dependency-check
     `);
+    /* eslint-enable max-len */
 
   }
 };

package/src/lib/check-for-updates.js

@@ -6,7 +6,9 @@ module.exports = (options) => {
   const current = require('../../package').version;
   info(`Current version: ${current}.  Checking NPM for updates…`);
 
-  if (!options) options = {};
+  if (!options) {
+    options = {};
+  }
 
   return request
     .get('https://registry.npmjs.org/cht-conf')
@@ -33,6 +35,5 @@ module.exports = (options) => {
       } else {
         warn(`Could not check NPM for updates. Error: ${err.message}`);
       }
-    })
-    ;
+    });
 };

package/src/lib/compilation/compile-contact-summary.js

@@ -9,8 +9,18 @@ module.exports = async (projectDir, options) => {
   const freeformPathExists = fs.exists(freeformPath);
   const structuredPathExists = fs.exists(structuredPath);
 
-  if (!freeformPathExists && !structuredPathExists) throw new Error(`Could not find contact-summary javascript at either of ${freeformPath} or ${structuredPath}.  Please create one xor other of these files.`);
-  if (freeformPathExists && structuredPathExists) throw new Error(`Found contact-summary javascript at both ${freeformPath} and ${structuredPath}.  Only one of these files should exist.`);
+  if (!freeformPathExists && !structuredPathExists) {
+    throw new Error(
+      `Could not find contact-summary javascript at either of ${freeformPath} or ${structuredPath}.  `
+      + 'Please create one xor other of these files.'
+    );
+  }
+  if (freeformPathExists && structuredPathExists) {
+    throw new Error(
+      `Found contact-summary javascript at both ${freeformPath} and ${structuredPath}.  `
+      + 'Only one of these files should exist.'
+    );
+  }
 
   const baseEslintPath = path.join(__dirname, '../../contact-summary/.eslintrc');
   const pathToDeclarativeLib = path.join(__dirname, '../../contact-summary/lib.js');

package/src/lib/compilation/compile-tasks-and-targets.js

@@ -22,7 +22,10 @@ const compileTasksAndTargets = async (projectDir, options = {}) => {
   
   if (legacyRules !== undefined) {
     if (findMissingDeclarativeFiles(projectDir).length !== DECLARATIVE_NOOLS_FILES.length) {
-      throw new Error(`Both legacy and declarative files found. You should either have rules.nools.js xor ${DECLARATIVE_NOOLS_FILES} files.`);
+      throw new Error(
+        'Both legacy and declarative files found. '
+        + `You should either have rules.nools.js xor ${DECLARATIVE_NOOLS_FILES} files.`
+      );
     }
 
     const rules = options.minifyScripts ? nools.minify(legacyRules) : legacyRules;
@@ -54,4 +57,4 @@ const compileDeclarativeFiles = async (projectDir, options) => {
   return pack(projectDir, pathToDeclarativeLib, baseEslintPath, options);
 };
 
-module.exports = compileTasksAndTargets;
+module.exports = compileTasksAndTargets;

package/src/lib/compilation/package-lib.js

@@ -67,7 +67,8 @@ module.exports = (pathToProject, entry, baseEslintPath, options = {}) => {
         failOnError: false,
         failOnWarning: false,
       }),
-      new webpack.IgnorePlugin({ resourceRegExp: /^\.\/locale$/, contextRegExp: /moment$/ }), // Ignore all optional deps of moment.js
+      // Ignore all optional deps of moment.js
+      new webpack.IgnorePlugin({ resourceRegExp: /^\.\/locale$/, contextRegExp: /moment$/ }),
     ],
   });
 
@@ -89,7 +90,9 @@ module.exports = (pathToProject, entry, baseEslintPath, options = {}) => {
       }
 
       if (stats.hasWarnings()) {
-        const hasWarningsRelatedToLinting = stats.toJson().warnings.some(warning => warning.message.includes('warnings potentially fixable'));
+        const hasWarningsRelatedToLinting = stats
+          .toJson().warnings
+          .some(warning => warning.message.includes('warnings potentially fixable'));
         const shouldHalt = options.haltOnWebpackWarning ||
           options.haltOnLintMessage && hasWarningsRelatedToLinting;