update forked version to match

cli/copyedit.js

@@ -4,20 +4,25 @@ var path = require("path");
 var sheets = require("../lib/sheetOps");
 var processHTML = require("../lib/processHTML");
 var readJSON = require("../lib/readJSON");
+var { completeSlug } = require("./util");
 
 module.exports = async function(config, argv, slugs) {
   var template = path.join(config.templatePath, "copyedit.html");
   config.user = await sheets.testConnection();
   for (var slug of slugs) {
-    var manifest = await readJSON(path.join(config.graphicsPath, slug, "manifest.json"));
-    var { sheet } = manifest;
-    var COPY = await sheets.getSheet(sheet);
-    var email = await processHTML(template, { sheet, slug, COPY, config })
-    console.log(`
+    try {
+      slug = await completeSlug(config.root, slug);
+      var manifest = await readJSON(path.join(config.graphicsPath, slug, "manifest.json"));
+      var { sheet } = manifest;
+      var COPY = await sheets.getSheet(sheet);
+      var email = await processHTML(template, { sheet, slug, COPY, config })
+      console.log(`
 GRAPHIC FOR COPY EDIT: ${slug}
 =============
 ${email}
-
 `);
+    } catch (err) {
+      console.log(err);
+    }
   }
 }

cli/deploy.js

@@ -1,7 +1,13 @@
 var deploy = require("../lib/deployGraphic");
+var { completeSlug } = require("./util");
 
 module.exports = async function(config, argv, slugs) {
   for (var slug of slugs) {
-    await deploy(config, slug);
+    try {
+      slug = await completeSlug(config.root, slug);
+      await deploy(config, slug);
+    } catch (err) {
+      console.error(err);
+    }
   }
 };

cli/index.js

@@ -7,11 +7,14 @@ var configuration = require("../lib/configuration");
 var help = function() {
   console.log(`
 Commands available from the command line:
-  - ${chalk.blue("create TYPE SLUG [SHEET]")} - create a graphic named SLUG from the template TYPE. SHEET is optional.
+  - ${chalk.blue("create TYPE SLUG [SHEET]")} - create a graphic named SLUG from the template TYPE.
   - ${chalk.blue("copy ORIGINAL SLUG")} - copy ORIGINAL into a new graphic named SLUG, with a new backing sheet
   - ${chalk.blue("deploy SLUGS")} - deploy the chosen graphics to S3
+  - ${chalk.blue("sync SLUGS [--push|--pull] [--target live|--target stage]")} - sync assets for graphics with S3
   - ${chalk.blue("copyedit SLUGS")} - display the copy edit e-mail for the chosen SLUGS
   - ${chalk.blue("help")} - you're looking at it
+
+[BRACES] signal optional arguments.
   `);
 };
 
@@ -20,7 +23,9 @@ var commands = {
   create: require("./create"),
   deploy: require("./deploy"),
   copy: require("./copy"),
-  copyedit: require("./copyedit")
+  copyedit: require("./copyedit"),
+  sync: require("./sync"),
+  "try": require("./try")
 };
 
 var run = async function() {
@@ -29,6 +34,8 @@ var run = async function() {
 
   var config = await configuration.load("config.json");
 
+  if (!(script in commands)) script = "help";
+
   var command = commands[script];
   command(config, argv, positional);
 };

cli/sync.js

@@ -0,0 +1,13 @@
+var sync = require("../lib/syncAssets");
+var { completeSlug } = require("./util");
+
+module.exports = async function(config, argv, slugs) {
+  for (var slug of slugs) {
+    try {
+      slug = await completeSlug(config.root, slug);
+      await sync(config, slug);
+    } catch (err) {
+      console.log(err);
+    }
+  }
+};

cli/try.js

@@ -0,0 +1,12 @@
+var { completeSlug } = require("./util");
+
+module.exports = async function(config, argv, slugs) {
+  for (var slug of slugs) {
+    try {
+      slug = await completeSlug(config.root, slug)
+    } catch (err) {
+      // failed to complete
+      console.log(err);
+    }
+  }
+};

cli/util.js

@@ -0,0 +1,21 @@
+var fs = require("fs").promises;
+
+var completeSlug = async function(folder, fragment) {
+  var folders = await fs.readdir(folder);
+  var pattern = new RegExp(`^${fragment}`, "i");
+  var matched = folders.filter(f => f.match(pattern));
+  if (matched.length > 1) {
+    throw `Multiple possible matches for ${fragment}:
+${matched.map(m => `  - ${m}`).join("\n")}`;
+  }
+  if (matched.length == 0) throw `Unable to find matching slug for ${fragment}`;
+  var [ completed ] = matched;
+  if (completed != fragment) {
+    console.log(`(Autocompleted "${fragment}" as ${completed})`);
+  }
+  return completed;
+}
+
+module.exports = {
+  completeSlug
+};

config.json.example

@@ -13,6 +13,7 @@
       "prefix": "dailygraphics/graphics"
     }
   },
-  // this is the NPR Visuals Google Analytics property. update to use your own.
-  "analyticsID": "UA-5828686-75"
+    // this is the NPR Visuals Google Analytics property. update to use your own.
+  "ga4ID": "G-LLLW9F9XPC",
+  "analyticsID": "UA-5828686-75" //legacy UA ID
 }

index.js

@@ -5,18 +5,18 @@ var init = async function() {
 
   var config = await configuration.load("./config.json");
 
-  var environmentWhitelist = [];
+  var envRequirements = [];
   if (!process.env.GOOGLE_APPLICATION_CREDENTIALS) {
-    environmentalWhitelist = ["GOOGLE_OAUTH_CLIENT_ID", "GOOGLE_OAUTH_CONSUMER_SECRET"];
+    envRequirements = ["GOOGLE_OAUTH_CLIENT_ID", "GOOGLE_OAUTH_CONSUMER_SECRET"];
   }
 
   if (!config.deployTo || config.deployTo == "s3") {
-    environmentWhitelist.push("AWS_ACCESS_KEY_ID", "AWS_SECRET_ACCESS_KEY");
+    envRequirements.push("AWS_ACCESS_KEY_ID", "AWS_SECRET_ACCESS_KEY");
   }
 
   var allSet = true;
-  environmentWhitelist.forEach(function(env) {
-    if (!process.env[env]) {
+  envRequirements.forEach(function(env) {
+    if (!(env in process.env)) {
       console.log(`Missing environment variable: ${env}`);
       allSet = false;
     }

lib/configuration.js

@@ -1,3 +1,15 @@
+/*
+
+Loads the config.json file and then augments it with extra information:
+
+- sets the absolute paths for the graphics and template folders
+- validates those paths
+- loads a deployment config (S3 vs local)
+- adds command line arguments to the config object
+
+*/
+
+var fs = require("fs").promises;
 var readJSON = require("./readJSON");
 var path = require("path");
 var minimist = require("minimist");
@@ -10,6 +22,16 @@ var load = async function(configPath) {
   config.root = path.join(process.cwd(), config.graphicsPath);
   config.templateRoot = path.join(process.cwd(), config.templatePath);
 
+  // check for existence of these folders
+  try {
+    await fs.stat(config.root);
+    await fs.stat(config.templateRoot);
+  } catch (err) {
+    console.log("Unable to load one of the source directories - check your paths in config.json!");
+    console.log(`Folder does not exist: ${err.path}`);
+    process.exit();
+  }
+
   var deployTo = argv.deployTo || config.deployTo || "s3";
   var target = argv.target || "live";
 

lib/copyDirectory.js

@@ -1,3 +1,10 @@
+/*
+
+Recursive copy for folders
+Usually used to create a graphic by merging the graphic template with the _base folder
+
+*/
+
 var fs = require("fs").promises;
 var path = require("path");
 

lib/createGraphic.js

@@ -1,3 +1,15 @@
+/*
+
+Creates a graphic from the template:
+
+- generates the final slug and creates the folder
+- copies the base files, then adds the template-specific files
+- loads the manifest and creates a Google Sheet if requested
+- takes a snapshot of the installed node_modules in the graphics folder for archiving purposes
+- saves out the updated manifest
+
+*/
+
 var fs = require("fs").promises;
 var path = require("path");
 

lib/deployGraphic.js

@@ -1,3 +1,14 @@
+/*
+
+Publishes a graphic, either to S3 or a local folder:
+
+- Instantiates an "exporter" function from the factory for writing contents to the destination
+- Creates a list of files to deploy from the manifest glob pattern
+- Processes and deploys each file, based on its extension
+- Publishes the preview page
+
+*/
+
 var fs = require("fs").promises;
 var path = require("path");
 
@@ -9,11 +20,12 @@ var readJSON = require("./readJSON");
 var s3 = require("./s3");
 var sheetOps = require("./sheetOps");
 
+// factory functions for functions that do the actual deployment of file contents
 var exporters = {
   s3: function(config) {
     return function(file, contents) {
       var { prefix, bucket } = config.deployment;
-      var s3Path = path.join(prefix, file);
+      var s3Path = path.posix.join(prefix, file);
       return s3.upload(bucket, s3Path, contents);
     };
   },
@@ -49,6 +61,8 @@ module.exports = async function(config, slug) {
     "*.geojson",
     "*.csv"
   ];
+  // exclude synced files
+  patterns.push("!**/synced/**/*");
 
   var exporter = (exporters[config.argv.deployTo || config.deployTo] || exporters.s3)(config);
 
@@ -64,12 +78,14 @@ module.exports = async function(config, slug) {
         production: true,
         root: config.root
       });
+      // add source map reference
+      src += `\n//# sourceMappingURL=./graphic.js.map`;
       // upload the main file
       var sourcePath = path.join(slug, relative);
       var sourceUpload = exporter(sourcePath, src);
       // upload the source map
       var mapPath = sourcePath + ".map";
-      var mapUpload = exporter(mapPath, map);
+      var mapUpload = exporter(mapPath, JSON.stringify(map));
       return Promise.all([sourceUpload, mapUpload]);
     },
     ".html": async function({ full, relative }) {
@@ -114,4 +130,7 @@ module.exports = async function(config, slug) {
   var previewHTML = await processHTML(parent, previewData);
   await exporter(previewPath, previewHTML);
   console.log("Deploy complete!");
+  if (COPY && COPY.metadata && COPY.metadata.seamus_id) {
+    console.log(`This graphic is embedded at Seamus ID ${COPY.metadata.seamus_id}`);
+  }
 };

lib/duplicateGraphic.js

@@ -1,9 +1,15 @@
+/*
+
+Makes a copy of a graphic, including a copy of the Google Sheet in its manifest
+
+*/
+
 var fs = require("fs").promises;
 var path = require("path");
 
 var copyDir = require("./copyDirectory");
 var readJSON = require("./readJSON");
-var { copySheet } = require("./sheetOps");
+var { copySheet, clearSheet } = require("./sheetOps");
 
 module.exports = async function(config, original, slug) {
   var now = new Date();
@@ -30,6 +36,7 @@ module.exports = async function(config, original, slug) {
     try {
       var duplicateSheet = await copySheet(sheet, fullSlug, config.driveFolder);
       manifest.sheet = duplicateSheet.id;
+      await clearSheet(duplicateSheet.id, "metadata!B2:B");
     } catch (err) {
       console.log(`Unable to make a copy of ${sheet}: "${err.message}"`);
     }

lib/expandMatch.js

@@ -1,38 +1,58 @@
+/*
+
+Used to find files based on a glob pattern.
+Primarily used for the manifest deployment list.
+
+*/
+
 var fs = require("fs").promises;
 var minimatch = require("minimatch");
 var path = require("path");
 
+// check if a file matches any or all (strict mode) patterns in a list
 var filterFile = function(file, patterns, strict) {
   return patterns[strict ? "every" : "some"](function(p) {
     return minimatch(file, p, { matchBase: true });
   });
 };
 
+// implements glob matching for a directory based on a list of patterns
+// returns all files that match
 var expand = async function(from, dir, patterns) {
   var fullDir = path.join(from, dir);
-  var files = await fs.readdir(fullDir);
+  try {
+    var files = await fs.readdir(fullDir);
+  } catch (err) {
+    console.log(`Unable to read directory ${fullDir} - does it exist?`);
+    return [];
+  }
   var matching = [];
   var affirmative = patterns.filter(p => p[0] != "!");
   var negative = patterns.filter(p => p[0] == "!");
   for (var i = 0; i < files.length; i++) {
     var f = files[i];
     var full = path.join(from, dir, f);
     var relative = path.relative(from, full);
-    var stat = await fs.stat(full);
-    if (stat.isDirectory()) {
-      var children = await expand(from, relative, patterns);
-      matching.push(...children);
-    } else {
-      var matched = filterFile(relative, affirmative);
-      var notExcluded = filterFile(relative, negative, true);
-      if (matched && notExcluded) {
-        matching.push(full);
+    try {
+      var stat = await fs.stat(full);
+      if (stat.isDirectory()) {
+        var children = await expand(from, relative, patterns);
+        matching.push(...children);
+      } else {
+        var matched = filterFile(relative, affirmative);
+        var notExcluded = filterFile(relative, negative, true);
+        if (matched && notExcluded) {
+          matching.push(full);
+        }
       }
+    } catch (err) {
+      console.log(`Unable to expand matches for path ${f}`);
     }
   }
   return matching;
 };
 
+// expand a directory, then return objects with the full and relative paths for each
 var expandMatch = async function(from, dir, patterns) {
   var paths = await expand(from, dir, patterns);
   return paths.map(f => ({

lib/googleAuth.js

@@ -1,3 +1,10 @@
+/*
+
+Loads our token file and attempts to use it to authenticate against Google's OAuth endpoint
+This could (should?) be replaced with @nprapps/google-login
+
+*/
+
 var fs = require("fs").promises;
 var os = require("os");
 var path = require("path");