cht-conf 3.10.2 → 3.11.0

package/.eslintignore

@@ -1 +1,2 @@
-**/build
+**/build
+test/data/**

package/.releaserc.json

@@ -18,5 +18,5 @@
       }
     ]
   ],
-  "branches": ["master"]
+  "branches": ["main"]
 }

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [3.11.0](https://github.com/medic/cht-conf/compare/v3.10.2...v3.11.0) (2022-04-19)
+
+
+### Features
+
+* **#477:** adds watch-project action ([7a3efc5](https://github.com/medic/cht-conf/commit/7a3efc5efcbd98d8a6b03e801945201ed17ac00f)), closes [#477](https://github.com/medic/cht-conf/issues/477)
+
 ## [3.10.2](https://github.com/medic/cht-conf/compare/v3.10.1...v3.10.2) (2022-03-29)
 
 
@@ -199,7 +206,7 @@ As of this release no docs on the server will be touched unless some configurati
 
 ### New action to bulk-edit contacts
 
-You can now bulk edit contacts at once by providing a CSV. For more information, read [the documentation](https://github.com/medic/cht-conf/blob/master/README.md#editing-contacts-across-the-hierarchy).
+You can now bulk edit contacts at once by providing a CSV. For more information, read [the documentation](https://github.com/medic/cht-conf/blob/main/README.md#editing-contacts-across-the-hierarchy).
 
 [#297](https://github.com/medic/cht-conf/issues/297)
 

package/README.md

@@ -317,7 +317,7 @@ Breaking| perf(#2): remove reporting rates feature <br/> BREAKING CHANGE: report
 
 ### Releasing betas
 
-1. Checkout `master`
+1. Checkout the default branch, for example `main`
 1. Run `npm version --no-git-tag-version <major>.<minor>.<patch>-beta.1`. This will only update the versions in `package.json` and `package-lock.json`. It will not create a git tag and not create an associated commit.
 1. Run `npm publish --tag beta`. This will publish your beta tag to npm's beta channel.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cht-conf",
-  "version": "3.10.2",
+  "version": "3.11.0",
   "description": "Configure CHT deployments",
   "main": "./src/lib/main.js",
   "engines": {
@@ -8,7 +8,7 @@
   },
   "scripts": {
     "clean": "rm -rf ./build/",
-    "eslint": "eslint src/**/*.js test/*.js test/**/*.js",
+    "eslint": "eslint 'src/**/*.js' test/*.js 'test/**/*.js'",
     "docker-start-couchdb": "npm run docker-stop-couchdb && docker run -d -p 6984:5984 --rm --name cht-conf-couchdb couchdb:2.3.1 && sh test/scripts/wait_for_response_code.sh 6984 200 CouchDB",
     "docker-stop-couchdb": "docker stop cht-conf-couchdb || true",
     "test": "npm run eslint && npm run docker-start-couchdb && npm run clean && mkdir -p build/test && cp -r test/data build/test/data && cd build/test && nyc --reporter=html mocha --forbid-only ../../test/**/*.spec.js && cd ../.. && npm run docker-stop-couchdb",
@@ -37,6 +37,7 @@
   "dependencies": {
     "@hapi/joi": "^16.1.8",
     "@medic/translation-checker": "^1.0.1",
+    "@parcel/watcher": "^2.0.5",
     "canonical-json": "0.0.4",
     "csv-parse": "^4.16.0",
     "dom-compare": "^0.6.0",
@@ -56,6 +57,7 @@
     "pouchdb-core": "^7.2.2",
     "pouchdb-mapreduce": "^7.2.2",
     "properties": "^1.2.1",
+    "queue-promise": "^2.2.1",
     "readline-sync": "^1.4.10",
     "redact-basic-auth": "^1.0.1",
     "request": "^2.88.2",
@@ -86,6 +88,7 @@
     "pouchdb-adapter-memory": "^7.2.2",
     "rewire": "^5.0.0",
     "semantic-release": "^18.0.0",
-    "sinon": "^7.3.2"
+    "sinon": "^7.3.2",
+    "fs-extra": "8.1.0"
   }
 }

package/release-notes.md

@@ -134,7 +134,7 @@ As of this release no docs on the server will be touched unless some configurati
 
 ### New action to bulk-edit contacts
 
-You can now bulk edit contacts at once by providing a CSV. For more information, read [the documentation](https://github.com/medic/cht-conf/blob/master/README.md#editing-contacts-across-the-hierarchy).
+You can now bulk edit contacts at once by providing a CSV. For more information, read [the documentation](https://github.com/medic/cht-conf/blob/main/README.md#editing-contacts-across-the-hierarchy).
 
 [#297](https://github.com/medic/cht-conf/issues/297)
 

package/src/fn/compile-app-settings.js

@@ -8,6 +8,21 @@ const parseTargets = require('../lib/parse-targets');
 const { warn } = require('../lib/log');
 const parsePurge = require('../lib/parse-purge');
 const validateAppSettings = require('../lib/validate-app-settings');
+const { APP_SETTINGS_DIR_PATH, APP_SETTINGS_JSON_PATH } = require('../lib/project-paths');
+
+// we can't used named capture groups yet
+const JS_FILE_MATCHER = /^(.+)(\.js)$/; // 2 groups get the file name and extension
+const JSON_FILE_MATCHER = /^(.+)(\.json)$/;
+const configFileMatcher = (fileName) => {
+  const jsFileMatchResult = fileName.match(JS_FILE_MATCHER);
+  // the first element is always the whole matched string, then our first file name group
+  if (jsFileMatchResult) return jsFileMatchResult[1];
+
+  const jsonFileMatchResult = fileName.match(JSON_FILE_MATCHER);
+  if (jsonFileMatchResult) return jsonFileMatchResult[1];
+
+  return null;
+};
 
 const compileAppSettings = async () => {
   const options = parseExtraArgs(environment.extraArgs);
@@ -23,7 +38,7 @@ const compileAppSettings = async () => {
     appSettings = await compileAppSettingsForProject(projectDir, options);
   }
 
-  fs.writeJson(path.join(projectDir, 'app_settings.json'), appSettings);
+  fs.writeJson(path.join(projectDir, APP_SETTINGS_JSON_PATH), appSettings);
 };
 
 const compileAppSettingsForProject = async (projectDir, options) => {
@@ -41,8 +56,8 @@ const compileAppSettingsForProject = async (projectDir, options) => {
 
   const readOptionalJson = path => fs.exists(path) ? fs.readJson(path) : undefined;
   let appSettings;
-  const baseSettingsPath = path.join(projectDir, 'app_settings/base_settings.json');
-  const appSettingsPath = path.join(projectDir, 'app_settings.json');
+  const baseSettingsPath = path.join(projectDir, `${APP_SETTINGS_DIR_PATH}/base_settings.json`);
+  const appSettingsPath = path.join(projectDir, APP_SETTINGS_JSON_PATH);
   const esLintFilePath = path.join(projectDir, '.eslintrc');
 
   // Fail if no eslintrc file is found
@@ -56,10 +71,10 @@ const compileAppSettingsForProject = async (projectDir, options) => {
   if (fs.exists(baseSettingsPath)) {
     // using modular config so should override anything already defined in app_settings.json
     appSettings = fs.readJson(baseSettingsPath);
-    if(appSettings.forms) {
+    if (appSettings.forms) {
       warn('forms should be defined in a separate <config_repo>/app_settings/forms.json file.');
     }
-    if(appSettings.schedules) {
+    if (appSettings.schedules) {
       warn('schedules should be defined in a separate <config_repo>/app_settings/schedules.json file.');
     }
     const formSettings = readOptionalJson(path.join(projectDir, 'app_settings/forms.json'));
@@ -107,7 +122,7 @@ function applyTransforms(app_settings, inherited) {
     rules.forEach(k => {
       const parts = k.split('.');
       let t = target;
-      while(parts.length > 1) {
+      while (parts.length > 1) {
         t = t[parts[0]];
         parts.shift();
       }
@@ -122,7 +137,7 @@ function applyTransforms(app_settings, inherited) {
       .forEach(k => {
         const parts = k.split('.');
         let t = target;
-        while(parts.length > 1) {
+        while (parts.length > 1) {
           t = t[parts[0]];
           parts.shift();
         }
@@ -146,7 +161,7 @@ function applyTransforms(app_settings, inherited) {
       .forEach(k => {
         const parts = k.split('.');
         let t = target;
-        while(parts.length > 1) {
+        while (parts.length > 1) {
           t = t[parts[0]];
           parts.shift();
         }
@@ -178,5 +193,7 @@ const parseExtraArgs = (extraArgs = []) => {
 
 module.exports = {
   requiresInstance: false,
+  APP_SETTINGS_DIR_PATH,
+  configFileMatcher,
   execute: compileAppSettings
 };

package/src/fn/compress-svgs.js

@@ -16,6 +16,6 @@ module.exports = {
           .then(() => svgo.optimize(fs.read(path), { path }))
           .then(result => fs.write(path, result.data))
           .then(() => trace('Compressed', path))
-          .then(() => warn('Make sure you compare the content of your SVG files before merging to the master branch - sometimes optimising can change their contents!')),
+          .then(() => warn('Make sure you compare the content of your SVG files before merging to the default branch - sometimes optimising can change their contents!')),
         Promise.resolve())
 };

package/src/fn/convert-app-forms.js

@@ -1,11 +1,18 @@
-const convertForms = require('../lib/convert-forms');
+const convertForms = require('../lib/convert-forms').execute;
 const environment = require('../lib/environment');
+const { APP_FORMS_PATH } = require('../lib/project-paths');
 
-module.exports = {
-  requiresInstance: false,
-  execute: () => convertForms(environment.pathToProject, 'app', {
+const convertAppForms = (forms) => {
+  return convertForms(environment.pathToProject, 'app', {
     enketo: true,
-    forms: environment.extraArgs,
+    forms: forms,
     transformer: xml => xml.replace('</instance>', '</instance>\n      <instance id="contact-summary"/>'),
-  })
+  });
+};
+
+module.exports = {
+  requiresInstance: false,
+  convertAppForms,
+  APP_FORMS_PATH,
+  execute: () => convertAppForms(environment.extraArgs)
 };

package/src/fn/convert-collect-forms.js

@@ -1,9 +1,16 @@
-const convertForms = require('../lib/convert-forms');
+const convertForms = require('../lib/convert-forms').execute;
 const environment = require('../lib/environment');
+const { COLLECT_FORMS_PATH } = require('../lib/project-paths');
+
+const convertCollectForms = (forms) => {
+  return convertForms(environment.pathToProject, 'collect', {
+    forms: forms,
+  });
+};
 
 module.exports = {
   requiresInstance: false,
-  execute: () => convertForms(environment.pathToProject, 'collect', {
-    forms: environment.extraArgs,
-  })
+  COLLECT_FORMS_PATH,
+  convertCollectForms,
+  execute: () => convertCollectForms(environment.extraArgs)
 };

package/src/fn/convert-contact-forms.js

@@ -1,92 +1,95 @@
-const convertForms = require('../lib/convert-forms');
+const convertForms = require('../lib/convert-forms').execute;
 const environment = require('../lib/environment');
 const fs = require('../lib/sync-fs');
+const { CONTACT_FORMS_PATH } = require('../lib/project-paths');
 
-const execute = () => {
-  const dir = `${environment.pathToProject}/forms/contact`;
+const convertContactForm = (forms) => {
+  const dir = `${environment.pathToProject}/${CONTACT_FORMS_PATH}`;
   const placeTypesJson = `${dir}/place-types.json`;
 
   let PLACE_TYPES;
-  if(fs.exists(placeTypesJson)) {
+  if (fs.exists(placeTypesJson)) {
     PLACE_TYPES = fs.readJson(placeTypesJson);
     Object.keys(PLACE_TYPES)
       .forEach(type => {
-        fs.copy(`${dir}/PLACE_TYPE-create.xlsx`, `${dir}/${type}-create.xlsx`,{ overwrite: false });
+        fs.copy(`${dir}/PLACE_TYPE-create.xlsx`, `${dir}/${type}-create.xlsx`, { overwrite: false });
         fs.copy(`${dir}/PLACE_TYPE-edit.xlsx`, `${dir}/${type}-edit.xlsx`, { overwrite: false });
       });
   }
 
   return convertForms(environment.pathToProject, 'contact', {
-      enketo: true,
-      force_data_node: 'data',
-      forms: environment.extraArgs,
-      transformer: (xml, path) => {
-        const type = path.replace(/.*\/(.*?)(-(create|edit))?\.xml/, '$1');
+    enketo: true,
+    force_data_node: 'data',
+    forms: forms,
+    transformer: (xml, path) => {
+      const type = path.replace(/.*\/(.*?)(-(create|edit))?\.xml/, '$1');
 
-        if(PLACE_TYPES) {
-          xml = xml
-              .replace(/PLACE_TYPE/g, type)
-              .replace(/PLACE_NAME/g, PLACE_TYPES[type]);
-        }
+      if (PLACE_TYPES) {
+        xml = xml
+          .replace(/PLACE_TYPE/g, type)
+          .replace(/PLACE_NAME/g, PLACE_TYPES[type]);
+      }
 
-        // The ordering of elements in the <model> has an arcane affect on the
-        // order that docs are saved in the database when processing a form.
-        // Move the main doc's element down to the bottom.
-        // For templated PLACE_TYPE forms, shifting must be done _after_ templating.
-        if(xml.includes('</inputs>')) {
-          let matchedBlock;
-          const matcher = new RegExp(`\\s*<${type}>[\\s\\S]*</${type}>\\s*(\\r|\\n)`);
+      // The ordering of elements in the <model> has an arcane affect on the
+      // order that docs are saved in the database when processing a form.
+      // Move the main doc's element down to the bottom.
+      // For templated PLACE_TYPE forms, shifting must be done _after_ templating.
+      if (xml.includes('</inputs>')) {
+        let matchedBlock;
+        const matcher = new RegExp(`\\s*<${type}>[\\s\\S]*</${type}>\\s*(\\r|\\n)`);
 
-          xml = xml.replace(matcher, match => {
-            matchedBlock = match;
-            return '\n';
-          });
+        xml = xml.replace(matcher, match => {
+          matchedBlock = match;
+          return '\n';
+        });
 
-          if(matchedBlock) {
-            xml = xml.replace(/<\/inputs>(\r|\n)/, '</inputs>' + matchedBlock);
-          }
+        if (matchedBlock) {
+          xml = xml.replace(/<\/inputs>(\r|\n)/, '</inputs>' + matchedBlock);
         }
+      }
 
-        if(xml.includes('/data/init/custom_place_name')) {
-          let matchedBlock;
-          xml = xml.replace(/\s*<input ref="\/data\/init\/custom_place_name">[^]*?<\/input>/, match => {
-            matchedBlock = match;
-            return '';
-          });
+      if (xml.includes('/data/init/custom_place_name')) {
+        let matchedBlock;
+        xml = xml.replace(/\s*<input ref="\/data\/init\/custom_place_name">[^]*?<\/input>/, match => {
+          matchedBlock = match;
+          return '';
+        });
 
-          if(matchedBlock) {
-            const targetMatcher = new RegExp(`\\s*<input ref="/data/${type}/external_id">\\s*(\\r|\\n)`);
-            xml = xml.replace(targetMatcher, match => matchedBlock + match);
-          }
+        if (matchedBlock) {
+          const targetMatcher = new RegExp(`\\s*<input ref="/data/${type}/external_id">\\s*(\\r|\\n)`);
+          xml = xml.replace(targetMatcher, match => matchedBlock + match);
         }
+      }
 
-        if(xml.includes('ref="/data/contact"')) {
-          const groupRegex = name => new RegExp(`(\\s*)<group(\\s.*)?\\sref="${name}"(\\s.*)?>[^]*?</group>`);
-          let matchedBlock;
+      if (xml.includes('ref="/data/contact"')) {
+        const groupRegex = name => new RegExp(`(\\s*)<group(\\s.*)?\\sref="${name}"(\\s.*)?>[^]*?</group>`);
+        let matchedBlock;
 
-          if(xml.match(groupRegex('/data/init'))) {
-            xml = xml.replace(groupRegex('/data/contact'), match => {
-              matchedBlock = match;
-              return '';
-            });
+        if (xml.match(groupRegex('/data/init'))) {
+          xml = xml.replace(groupRegex('/data/contact'), match => {
+            matchedBlock = match;
+            return '';
+          });
 
-            if(matchedBlock) {
-              const stripTrailingGroup = s => s.replace(/[\r\n\s]*<\/group>$/, '');
-              xml = xml.replace(groupRegex('/data/init'), match => {
-                return stripTrailingGroup(match) +
-                       stripTrailingGroup(matchedBlock).replace(/\n/g, '\n  ') +
-                       '\n        </group>\n      </group>';
-              });
-            }
+          if (matchedBlock) {
+            const stripTrailingGroup = s => s.replace(/[\r\n\s]*<\/group>$/, '');
+            xml = xml.replace(groupRegex('/data/init'), match => {
+              return stripTrailingGroup(match) +
+                stripTrailingGroup(matchedBlock).replace(/\n/g, '\n  ') +
+                '\n        </group>\n      </group>';
+            });
           }
         }
+      }
 
-        return xml;
-      },
-    });
+      return xml;
+    },
+  });
 };
 
 module.exports = {
   requiresInstance: false,
-  execute
+  convertContactForm,
+  CONTACT_FORMS_PATH,
+  execute: () => convertContactForm(environment.extraArgs)
 };

package/src/fn/delete-forms.js

@@ -2,22 +2,23 @@ const environment = require('../lib/environment');
 const { info, warn } = require('../lib/log');
 const pouch = require('../lib/db');
 
+const deleteForms = (forms) => {
+  if (!forms || !forms.length) {
+    warn('No forms specified for deleting.');
+    return;
+  }
+  const db = pouch();
+  return Promise.all(forms.map(formName => {
+    const docId = `form:${formName}`;
+    return db.get(docId)
+      .then(doc => db.remove(doc))
+      .then(() => info('Deleted form:', formName))
+      .catch(e => warn(`Failed to remove form with doc ID ${docId}`, e));
+  }));
+};
+
 module.exports = {
   requiresInstance: true,
-  execute: () => {
-    const db = pouch();
-    const { extraArgs } = environment;
-    if (!extraArgs || !extraArgs.length) {
-      warn('No forms specified for deleting.');
-      return;
-    }
-
-    return Promise.all(extraArgs.map(formName => {
-      const docId = `form:${formName}`;
-      return db.get(docId)
-        .then(doc => db.remove(doc))
-        .then(() => info('Deleted form:', formName))
-        .catch(e => warn(`Failed to remove form with doc ID ${docId}`, e));
-    }));
-  }
+  execute: () => deleteForms(environment.extraArgs),
+  deleteForms,
 };

package/src/fn/upload-app-forms.js

@@ -1,9 +1,16 @@
 const environment = require('../lib/environment');
-const uploadForms = require('../lib/upload-forms');
+const uploadForms = require('../lib/upload-forms').execute;
+const { APP_FORMS_PATH } = require('../lib/project-paths');
+
+const uploadAppForms = (forms) => {
+  return uploadForms(environment.pathToProject, 'app', {
+    forms: forms,
+  });
+};
 
 module.exports = {
   requiresInstance: true,
-  execute: () => uploadForms(environment.pathToProject, 'app', {
-    forms: environment.extraArgs,
-  })
+  uploadAppForms,
+  APP_FORMS_PATH: APP_FORMS_PATH,
+  execute: () => uploadAppForms(environment.extraArgs)
 };

package/src/fn/upload-app-settings.js

@@ -2,29 +2,35 @@ const api = require('../lib/api');
 const environment = require('../lib/environment');
 const fs = require('../lib/sync-fs');
 const { info } = require('../lib/log');
+const { APP_SETTINGS_DIR_PATH, APP_SETTINGS_JSON_PATH } = require('../lib/project-paths');
 
-module.exports = {
-  requiresInstance: true,
-  execute: () => {
-    const settings = fs.read(`${environment.pathToProject}/app_settings.json`);
-    return api().updateAppSettings(settings)
-      .then(JSON.parse)
-      .then(json => {
-        // As per https://github.com/medic/cht-core/issues/3674, this endpoint
-        // will return 200 even when upload fails.
-        if (!json.success) {
-          throw new Error(json.error);
-        }
+const uploadAppSettings = (api) => {
+  const settings = fs.read(`${environment.pathToProject}/${APP_SETTINGS_JSON_PATH}`);
+  return api.updateAppSettings(settings)
+    .then(JSON.parse)
+    .then(json => {
+      // As per https://github.com/medic/cht-core/issues/3674, this endpoint
+      // will return 200 even when upload fails.
+      if (!json.success) {
+        throw new Error(json.error);
+      }
 
-        if ('updated' in json) {
-          // the `updated` param was added in 3.9
-          // https://github.com/medic/cht-core/issues/6315
-          if (!json.updated) {
-            info('Settings not updated - no changes detected');
-          } else {
-            info('Settings updated successfully');
-          }
+      if ('updated' in json) {
+        // the `updated` param was added in 3.9
+        // https://github.com/medic/cht-core/issues/6315
+        if (!json.updated) {
+          info('Settings not updated - no changes detected');
+        } else {
+          info('Settings updated successfully');
         }
-      });
-  }
+      }
+    });
+};
+
+module.exports = {
+  uploadAppSettings,
+  APP_SETTINGS_DIR_PATH,
+  APP_SETTINGS_JSON_PATH,
+  requiresInstance: true,
+  execute: () => uploadAppSettings(api())
 };

package/src/fn/upload-collect-forms.js

@@ -1,10 +1,15 @@
 const environment = require('../lib/environment');
-const uploadForms = require('../lib/upload-forms');
+const uploadForms = require('../lib/upload-forms').execute;
+
+const uploadCollectForms = (forms) => {
+  return uploadForms(environment.pathToProject, 'collect', {
+    forms: forms,
+    default_context: { collect: true },
+  });
+};
 
 module.exports = {
   requiresInstance: true,
-  execute: () => uploadForms(environment.pathToProject, 'collect', {
-    forms: environment.extraArgs,
-    default_context: { collect:true },
-  })
+  uploadCollectForms,
+  execute: () => uploadCollectForms(environment.extraArgs)
 };

package/src/fn/upload-contact-forms.js

@@ -1,11 +1,18 @@
 const environment = require('../lib/environment');
-const uploadForms = require('../lib/upload-forms');
+const uploadForms = require('../lib/upload-forms').execute;
+const CONTACT_FORMS_PATH = require('../lib/project-paths');
+
+const uploadContactForms = (forms) => {
+  return uploadForms(environment.pathToProject, 'contact', {
+    id_prefix: 'contact:',
+    forms: forms,
+    default_context: { person: false, place: false },
+  });
+};
 
 module.exports = {
   requiresInstance: true,
-  execute: () => uploadForms(environment.pathToProject, 'contact', {
-    id_prefix: 'contact:',
-    forms: environment.extraArgs,
-    default_context: { person:false, place:false },
-  })
+  uploadContactForms,
+  CONTACT_FORMS_PATH,
+  execute: () => uploadContactForms(environment.extraArgs)
 };

package/src/fn/upload-custom-translations.js

@@ -13,10 +13,12 @@ const {
   TranslationException
 } = require('@medic/translation-checker');
 
+const { TRANSLATIONS_DIR_PATH } = require('../lib/project-paths');
+
 const execute = async () => {
   const db = pouch(environment.apiUrl);
 
-  const dir = `${environment.pathToProject}/translations`;
+  const dir = `${environment.pathToProject}/${TRANSLATIONS_DIR_PATH}`;
 
   let fileNames;
   let formatErrorsFound = 0;
@@ -85,7 +87,7 @@ const execute = async () => {
       languageName = 'TODO: please ask admin to set this in settings UI';
     } else {
       let languageNativeName = iso639.getNativeName(languageCode);
-      if (languageNativeName !== languageName){
+      if (languageNativeName !== languageName) {
         languageName = `${languageNativeName} (${languageName})`;
       }
     }
@@ -95,7 +97,7 @@ const execute = async () => {
     let doc;
     try {
       doc = await db.get(id);
-    } catch(e) {
+    } catch (e) {
       if (e.status === 404) {
         doc = await newDocFor(fileName, db, languageName, languageCode);
       }
@@ -127,7 +129,7 @@ function parse(filePath, options) {
 }
 
 function overwriteProperties(doc, props) {
-  if(doc.generic) {
+  if (doc.generic) {
     // 3.4.0 translation structure
     doc.custom = props;
   } else if (doc.values) {
@@ -179,5 +181,6 @@ async function genericTranslationsStructure(db) {
 
 module.exports = {
   requiresInstance: true,
+  TRANSLATIONS_DIR_PATH,
   execute
 };

package/src/fn/upload-resources.js

@@ -6,13 +6,17 @@ const processJson = (json) => {
     resources: json
   };
 };
+const { RESOURCE_CONFIG_PATH, RESOURCES_DIR_PATH } = require('../lib/project-paths');
 
 module.exports = {
   requiresInstance: true,
+  RESOURCE_CONFIG_PATH,
+  RESOURCES_DIR_PATH,
   execute: () => {
-    const configurationPath = `${environment.pathToProject}/resources.json`;
-    const directoryPath = `${environment.pathToProject}/resources`;
+    const configurationPath = `${environment.pathToProject}/${RESOURCE_CONFIG_PATH}`;
+    const directoryPath = `${environment.pathToProject}/${RESOURCES_DIR_PATH}`;
 
     return uploadConfigurationDocs(configurationPath, directoryPath, 'resources', processJson);
   }
 };
+

package/src/fn/watch-project.js

@@ -0,0 +1,271 @@
+const environment = require('../lib/environment');
+const process = require('process');
+const path = require('path');
+const fs = require('fs');
+const { error, warn, info } = require('../lib/log');
+const Queue = require('queue-promise');
+const watcher = require('@parcel/watcher');
+const { uploadAppForms } = require('./upload-app-forms');
+const { uploadContactForms } = require('./upload-contact-forms');
+const { uploadCollectForms } = require('./upload-collect-forms');
+const convertForms = require('../lib/convert-forms');
+const uploadForms = require('../lib/upload-forms');
+const { deleteForms } = require('../fn/delete-forms');
+const { convertAppForms, APP_FORMS_PATH } = require('./convert-app-forms');
+const { convertContactForm, CONTACT_FORMS_PATH } = require('./convert-contact-forms');
+const { convertCollectForms, COLLECT_FORMS_PATH } = require('./convert-collect-forms');
+const { uploadAppSettings, APP_SETTINGS_DIR_PATH, APP_SETTINGS_JSON_PATH } = require('./upload-app-settings');
+const { execute: compileAppSettings, configFileMatcher } = require('./compile-app-settings');
+const { execute: uploadCustomTranslations, TRANSLATIONS_DIR_PATH } = require('./upload-custom-translations');
+const { execute: uploadResources, RESOURCES_DIR_PATH, RESOURCE_CONFIG_PATH } = require('./upload-resources');
+
+const watcherEvents = {
+    CreateEvent: 'create',
+    DeleteEvent: 'delete',
+    UpdateEvent: 'update'
+};
+
+const uploadInitialState = async (api) => {
+    await uploadResources();
+    await uploadAppForms(environment.extraArgs);
+    await uploadContactForms(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;
+    }
+};
+
+const waitForKillSignal = () => {
+    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}`);
+    return false;
+};
+
+const processAppForm = (eventType, fileName) => {
+    if (eventType === watcherEvents.DeleteEvent && deleteForm(fileName, APP_FORMS_PATH)) {
+        return true;
+    }
+    let form = uploadForms.formFileMatcher(fileName);
+    if (form) {
+        eventQueue.enqueue(async () => {
+            await uploadAppForms([form]);
+            return fileName;
+        });
+        return true;
+    }
+
+    form = convertForms.formFileMatcher(fileName);
+    if (form) {
+        eventQueue.enqueue(async () => {
+            await convertAppForms([form]);
+            return fileName;
+        });
+        return true;
+    }
+    return false;
+};
+
+const processAppFormMedia = (formMediaDir, fileName) => {
+    const form = uploadForms.formMediaMatcher(formMediaDir);
+    if (form) {
+        eventQueue.enqueue(async () => {
+            await uploadAppForms([form]);
+            return fileName;
+        });
+        return true;
+    }
+    return false;
+};
+
+const processContactForm = (eventType, fileName) => {
+    if (eventType === watcherEvents.DeleteEvent && deleteForm(fileName, CONTACT_FORMS_PATH)) {
+        return true;
+    }
+    let form = convertForms.formFileMatcher(fileName);
+    if (form) {
+        eventQueue.enqueue(async () => {
+            await convertContactForm([form]);
+            return fileName;
+        });
+        return true;
+    }
+
+    form = uploadForms.formFileMatcher(fileName);
+    if (form) {
+        eventQueue.enqueue(async () => {
+            await uploadContactForms([form]);
+            return fileName;
+        });
+        return true;
+    }
+    return false;
+};
+
+const processCollectForm = (eventType, fileName) => {
+    if (eventType === watcherEvents.DeleteEvent && deleteForm(fileName, COLLECT_FORMS_PATH)) {
+        return true;
+    }
+    let form = uploadForms.formFileMatcher(fileName);
+    if (form) {
+        eventQueue.enqueue(async () => {
+            await uploadCollectForms([form]);
+            return fileName;
+        });
+        return true;
+    }
+
+    form = convertForms.formFileMatcher(fileName);
+    if (form) {
+        eventQueue.enqueue(async () => {
+            await convertCollectForms([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;
+};
+
+const watchProject = {
+    watch: async (api, blockFn, callback = {}, uploadStateOnStart = false) => {
+        if (uploadStateOnStart) {
+            await uploadInitialState(api);
+            info('Initial State Uploaded');
+        }
+
+        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;
+
+                if (parsedPath.dir === path.join(environment.pathToProject, APP_FORMS_PATH)) {
+                    processAppForm(event.type, fileName);
+                    continue;
+                }
+
+                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
+                    const dirName = path.parse(parsedPath.dir).base;
+                    processAppFormMedia(dirName, fileName);
+                    continue;
+                }
+
+                if (parsedPath.dir === path.join(environment.pathToProject, CONTACT_FORMS_PATH)) {
+                    processContactForm(event.type, fileName);
+                    continue;
+                }
+
+                if (parsedPath.dir === path.join(environment.pathToProject, COLLECT_FORMS_PATH)) {
+                    processCollectForm(event.type, 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 === 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;
+                }
+            }
+        });
+
+        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();
+    }
+};
+
+const api = require('../lib/api');
+module.exports = {
+    watchProject,
+    requiresInstance: true,
+    execute: () => watchProject.watch(api(), waitForKillSignal, false, true)
+};

package/src/lib/convert-forms.js

@@ -20,25 +20,34 @@ E
 E	pip uninstall pyxform-medic
 E` + INSTALLATION_INSTRUCTIONS;
 
-module.exports = async (projectDir, subDirectory, options) => {
-  if(!options) options = {};
+const FORM_EXTENSION = '.xlsx';
+const formFileMatcher = (fileName) => {
+  if (fileName.endsWith(FORM_EXTENSION) &&
+    !fileName.startsWith('~$') // ignore Excel "owner files"
+    && fileName !== 'PLACE_TYPE-create.xlsx' && fileName !== 'PLACE_TYPE-edit.xlsx') {
+    return fileName.slice(0, fileName.length - FORM_EXTENSION.length);
+  }
+  return null;
+};
+
+const execute = async (projectDir, subDirectory, options) => {
+  if (!options) options = {};
 
   const formsDir = getFormDir(projectDir, subDirectory);
 
-  if(!fs.exists(formsDir)) {
+  if (!fs.exists(formsDir)) {
     warn(`Forms dir not found: ${formsDir}`);
     return Promise.resolve();
   }
 
-  const filesToConvert = argsFormFilter(formsDir, '.xlsx', options)
-    .filter(name => !name.startsWith('~$')) // ignore Excel "owner files"
-    .filter(name => name !== 'PLACE_TYPE-create.xlsx' && name !== 'PLACE_TYPE-edit.xlsx');
+  const filesToConvert = argsFormFilter(formsDir, FORM_EXTENSION, options)
+    .filter(name => formFileMatcher(name));
 
   for (let xls of filesToConvert) {
     const originalSourcePath = `${formsDir}/${xls}`;
     let sourcePath;
 
-    if(options.force_data_node) {
+    if (options.force_data_node) {
       const temporaryPath = `${fs.mkdtemp()}/${options.force_data_node}.xlsx`;
       fs.copy(originalSourcePath, temporaryPath);
       sourcePath = temporaryPath;
@@ -54,15 +63,21 @@ module.exports = async (projectDir, subDirectory, options) => {
   }
 };
 
+module.exports = {
+  SUPPORTED_EXTENSIONS: [FORM_EXTENSION],
+  formFileMatcher,
+  execute
+};
+
 const xls2xform = (sourcePath, targetPath) =>
-    exec([XLS2XFORM, '--skip_validate', sourcePath, targetPath])
-      .catch(e => {
-        if(executableAvailable()) {
-          if(e.includes('unrecognized arguments: --skip_validate')) {
-            throw new Error('Your xls2xform installation appears to be out of date.' + UPDATE_INSTRUCTIONS);
-          } else throw e;
-        } else throw new Error('There was a problem executing xls2xform.  It may not be installed.' + INSTALLATION_INSTRUCTIONS);
-      });
+  exec([XLS2XFORM, '--skip_validate', sourcePath, targetPath])
+    .catch(e => {
+      if (executableAvailable()) {
+        if (e.includes('unrecognized arguments: --skip_validate')) {
+          throw new Error('Your xls2xform installation appears to be out of date.' + UPDATE_INSTRUCTIONS);
+        } else throw e;
+      } else throw new Error('There was a problem executing xls2xform.  It may not be installed.' + INSTALLATION_INSTRUCTIONS);
+    });
 
 // here we fix the form content in arcane ways.  Seeing as we have out own fork
 // of pyxform, we should probably be doing this fixing there.
@@ -72,33 +87,33 @@ const fixXml = (path, hiddenFields, transformer, enketo) => {
   // future changes to the output of xls2xform.
   let xml = fs.read(path)
 
-      // The following copies behaviour from old bash scripts, and will create a
-      // second <meta> element if one already existed.  We may want to actually
-      // merge the two instead.
-      .replace(/<inputs>/, META_XML_SECTION)
+    // The following copies behaviour from old bash scripts, and will create a
+    // second <meta> element if one already existed.  We may want to actually
+    // merge the two instead.
+    .replace(/<inputs>/, META_XML_SECTION)
 
-      // XLSForm does not allow converting a field without a label, so we use
-      // the placeholder NO_LABEL.
-      .replace(/NO_LABEL/g, '')
+    // XLSForm does not allow converting a field without a label, so we use
+    // the placeholder NO_LABEL.
+    .replace(/NO_LABEL/g, '')
 
-      // No comment.
-      .replace(/.*DELETE_THIS_LINE.*(\r|\n)/g, '')
-      ;
+    // No comment.
+    .replace(/.*DELETE_THIS_LINE.*(\r|\n)/g, '')
+    ;
 
   // Enketo _may_ not work with forms which define a default language - see
   // https://github.com/medic/cht-core/issues/3174
-  if(enketo) xml = xml.replace(/ default="true\(\)"/g, '');
+  if (enketo) xml = xml.replace(/ default="true\(\)"/g, '');
 
-  if(hiddenFields) {
+  if (hiddenFields) {
     const r = new RegExp(`<(${hiddenFields.join('|')})(/?)>`, 'g');
     xml = xml.replace(r, '<$1 tag="hidden"$2>');
   }
 
-  if(transformer) xml = transformer(xml, path);
+  if (transformer) xml = transformer(xml, path);
 
 
   // Check for deprecations
-  if(xml.includes('repeat-relevant')) {
+  if (xml.includes('repeat-relevant')) {
     warn('From webapp version 2.14.0, repeat-relevant is no longer required.  See https://github.com/medic/cht-core/issues/3449 for more info.');
   }
 
@@ -106,7 +121,7 @@ const fixXml = (path, hiddenFields, transformer, enketo) => {
 };
 
 function getHiddenFields(propsJson) {
-  if(!fs.exists(propsJson)) return [];
+  if (!fs.exists(propsJson)) return [];
   else return fs.readJson(propsJson).hidden_fields;
 }
 
@@ -116,7 +131,7 @@ function executableAvailable() {
       stdio: ['ignore', 'ignore', 'ignore'],
     });
     return true;
-  } catch(e) {
+  } catch (e) {
     return false;
   }
 }

package/src/lib/git-exec.js

@@ -64,7 +64,7 @@ module.exports.getDefaultRemote = async () => {
 
 /**
  * Returns the upstream of the current branch,
- * in the form of repo/branch, eg. 'origin/master'.
+ * in the form of repo/branch, eg. 'origin/main'.
  *
  * Returns `null` if there are no upstreams repos configured.
  */

package/src/lib/project-paths.js

@@ -0,0 +1,12 @@
+const path = require('path');
+// Paths Relative to the Project
+module.exports = {
+    APP_SETTINGS_DIR_PATH: 'app_settings',
+    APP_SETTINGS_JSON_PATH: 'app_settings.json',
+    APP_FORMS_PATH: path.join('forms', 'app'),
+    CONTACT_FORMS_PATH: path.join('forms', 'contact'),
+    COLLECT_FORMS_PATH: path.join('forms', 'collect'),
+    TRANSLATIONS_DIR_PATH: 'translations',
+    RESOURCE_CONFIG_PATH: 'resources.json',
+    RESOURCES_DIR_PATH: 'resources'
+};

package/src/lib/upload-forms.js

@@ -16,18 +16,40 @@ const {
 const validateForms = require('./validate-forms');
 
 const SUPPORTED_PROPERTIES = ['context', 'icon', 'title', 'xml2sms', 'subject_key', 'hidden_fields'];
+const FORM_EXTENSTION = '.xml';
+const FORM_PROPERTIES_EXTENSION = '.properties.json';
+const FORM_MEDIA_MATCHER = /(.+)-media$/;
+const SUPPORTED_EXTENSIONS = [FORM_EXTENSTION, FORM_PROPERTIES_EXTENSION];
+
+const formFileMatcher = (fileName) => {
+  if (fileName.endsWith(FORM_EXTENSTION)) {
+    return fileName.slice(0, fileName.length - FORM_EXTENSTION.length);
+  }
+  if (fileName.endsWith(FORM_PROPERTIES_EXTENSION)) {
+    return fileName.slice(0, fileName.length - FORM_PROPERTIES_EXTENSION.length);
+  }
+  return null;
+};
+
+const formMediaMatcher = (formMediaDir) => {
+  const matchResult = formMediaDir.match(FORM_MEDIA_MATCHER);
+  if (matchResult) {
+    return matchResult[1]; // return the captured form name
+  }
+  return null;
+};
 
-module.exports = async (projectDir, subDirectory, options) => {
+const execute = async (projectDir, subDirectory, options) => {
   await validateForms(projectDir, subDirectory, options);
   const db = pouch();
   if (!options) options = {};
   const formsDir = getFormDir(projectDir, subDirectory);
-  if(!fs.exists(formsDir)) {
+  if (!fs.exists(formsDir)) {
     log.info(`Forms dir not found: ${formsDir}`);
     return;
   }
 
-  const fileNames = argsFormFilter(formsDir, '.xml', options);
+  const fileNames = argsFormFilter(formsDir, FORM_EXTENSTION, options);
   for (const fileName of fileNames) {
     log.info(`Preparing form for upload: ${fileName}…`);
 
@@ -35,7 +57,7 @@ module.exports = async (projectDir, subDirectory, options) => {
     const baseDocId = (options.id_prefix || '') + baseFileName.replace(/-/g, ':');
 
     const mediaDirExists = fs.exists(mediaDir);
-    if(!mediaDirExists) {
+    if (!mediaDirExists) {
       log.info(`No media directory found at ${mediaDir} for form ${xformPath}`);
     }
 
@@ -48,7 +70,7 @@ module.exports = async (projectDir, subDirectory, options) => {
     };
 
     const internalId = readIdFrom(xml);
-    if(internalId !== baseDocId) log.warn('DEPRECATED', 'Form:', fileName, 'Bad ID set in XML.  Expected:', baseDocId, 'but saw:', internalId, ' Support for setting these values differently will be dropped.  Please see https://github.com/medic/cht-core/issues/3342.');
+    if (internalId !== baseDocId) log.warn('DEPRECATED', 'Form:', fileName, 'Bad ID set in XML.  Expected:', baseDocId, 'but saw:', internalId, ' Support for setting these values differently will be dropped.  Please see https://github.com/medic/cht-core/issues/3342.');
 
     const docId = `form:${baseDocId}`;
     const doc = {
@@ -60,7 +82,7 @@ module.exports = async (projectDir, subDirectory, options) => {
       context: options.default_context,
     };
 
-    const propertiesPath = `${formsDir}/${baseFileName}.properties.json`;
+    const propertiesPath = `${formsDir}/${baseFileName}${FORM_PROPERTIES_EXTENSION}`;
     updateFromPropertiesFile(doc, propertiesPath);
 
     doc._attachments = mediaDirExists ? attachmentsFromDir(mediaDir) : {};
@@ -80,6 +102,14 @@ module.exports = async (projectDir, subDirectory, options) => {
   }
 };
 
+module.exports = {
+  SUPPORTED_EXTENSIONS,
+  FORM_MEDIA_MATCHER,
+  formFileMatcher,
+  formMediaMatcher,
+  execute
+};
+
 const updateFromPropertiesFile = (doc, path) => {
   if (fs.exists(path)) {