@dittowords/cli 1.2.6-beta → 2.1.0

package/README.md

@@ -89,6 +89,8 @@ If you run the CLI in a directory that does not contain a `ditto/` folder, the f
 
   An automatically generated driver file that simplifies the process of passing text data to Ditto JavaScript SDKs. This file has a standardized format that is always the same independent of the CLI configuration used to generate it.
 
+  **Since this file is designed to be consumed by other internal Ditto libraries, it is not recommended that you depend on it - its format may change between major releases.**
+
   ```ts
   interface DriverFile {
     [projectId: string]: {

package/lib/config.js

@@ -1,9 +1,10 @@
 const fs = require("fs");
 const path = require("path");
 const url = require("url");
-
 const yaml = require("js-yaml");
 
+const consts = require("./consts");
+
 function createFileIfMissing(filename) {
   const dir = path.dirname(filename);
 
@@ -14,7 +15,13 @@ function createFileIfMissing(filename) {
   }
 }
 
-function readData(file, defaultData = {}) {
+/**
+ * Read data from a file
+ * @param {*} file defaults to `PROJECT_CONFIG_FILE` defined in `constants.js`
+ * @param {*} defaultData defaults to `{}`
+ * @returns
+ */
+function readData(file = consts.PROJECT_CONFIG_FILE, defaultData = {}) {
   createFileIfMissing(file);
   const fileContents = fs.readFileSync(file, "utf8");
   return yaml.safeLoad(fileContents) || defaultData;
@@ -72,6 +79,73 @@ function save(file, key, value) {
   writeData(file, data);
 }
 
+const IS_DUPLICATE = /-(\d+$)/;
+function dedupeProjectName(projectNames, projectName) {
+  let dedupedName = projectName;
+
+  if (projectNames[dedupedName]) {
+    while (projectNames[dedupedName]) {
+      const [_, numberStr] = dedupedName.match(IS_DUPLICATE) || [];
+      if (numberStr && !isNaN(parseInt(numberStr))) {
+        dedupedName = `${dedupedName.replace(IS_DUPLICATE, "")}-${
+          parseInt(numberStr) + 1
+        }`;
+      } else {
+        dedupedName = `${dedupedName}-1`;
+      }
+    }
+  }
+
+  return dedupedName;
+}
+
+/**
+ * Reads from the config file, filters out
+ * invalid projects, dedupes those remaining, and returns:
+ * - whether or not the data required to `pull` is present
+ * - whether or not the component library should be fetched
+ * - an array of valid, deduped projects
+ * - the `variants` and `format` config options
+ */
+function parseSourceInformation() {
+  const { projects, components, variants, format } = readData();
+
+  const projectNames = {};
+  const validProjects = [];
+
+  let componentLibraryInProjects = false;
+
+  (projects || []).forEach((project) => {
+    const isValid = project.id && project.name;
+    if (!isValid) {
+      return;
+    }
+
+    if (project.id === "ditto_component_library") {
+      componentLibraryInProjects = true;
+      return;
+    }
+
+    project.fileName = dedupeProjectName(projectNames, project.name);
+    projectNames[project.fileName] = true;
+
+    validProjects.push(project);
+  });
+
+  const shouldFetchComponentLibrary =
+    !!components || componentLibraryInProjects;
+
+  const hasSourceData = validProjects.length || shouldFetchComponentLibrary;
+
+  return {
+    hasSourceData,
+    validProjects,
+    shouldFetchComponentLibrary,
+    variants,
+    format,
+  };
+}
+
 module.exports = {
   createFileIfMissing,
   readData,
@@ -81,4 +155,5 @@ module.exports = {
   deleteToken,
   getToken,
   save,
+  parseSourceInformation,
 };

package/lib/init/init.js

@@ -2,13 +2,16 @@
 // expected to be run once per project.
 const boxen = require("boxen");
 const chalk = require("chalk");
-const getSelectedProjects = require("../utils/getSelectedProjects");
 const projectsToText = require("../utils/projectsToText");
 
-const { needsProjects, collectAndSaveProject } = require("./project");
+const { needsSource, collectAndSaveProject } = require("./project");
 const { needsToken, collectAndSaveToken } = require("./token");
 
-const needsInit = () => needsToken() || needsProjects();
+const config = require("../config");
+const output = require("../output");
+const sourcesToText = require("../utils/sourcesToText");
+
+const needsInit = () => needsToken() || needsSource();
 
 function welcome() {
   const msg = chalk.white(`${chalk.bold(
@@ -22,19 +25,24 @@ We're glad to have you here.`);
 
 async function init() {
   welcome();
+
   if (needsToken()) {
     await collectAndSaveToken();
   }
-  const selectedProjects = getSelectedProjects();
-  if (selectedProjects.length) {
-    console.log(
-      `You're currently set up to sync text from the following projects: ${projectsToText(
-        selectedProjects
-      )}\n`
-    );
-  } else {
+
+  const { hasSourceData, validProjects, shouldFetchComponentLibrary } =
+    config.parseSourceInformation();
+
+  if (!hasSourceData) {
     await collectAndSaveProject(true);
+    return;
   }
+
+  const message =
+    "You're currently set up to sync text from " +
+    sourcesToText(validProjects, shouldFetchComponentLibrary);
+
+  console.log(message);
 }
 
 module.exports = { needsInit, init };

package/lib/init/project.js

@@ -20,9 +20,8 @@ function saveProject(file, name, id) {
   config.writeData(file, { projects });
 }
 
-function needsProjects(configFile) {
-  const projects = getSelectedProjects(configFile);
-  return !(projects && projects.length);
+function needsSource() {
+  return !config.parseSourceInformation().hasSourceData;
 }
 
 async function askForAnotherToken() {
@@ -60,7 +59,7 @@ async function collectProject(token, initialize) {
   const path = process.cwd();
   if (initialize) {
     console.log(
-      `Looks like are no Ditto projects selected for your current directory: ${output.info(
+      `Looks like there are no Ditto projects selected for your current directory: ${output.info(
         path
       )}.`
     );
@@ -113,4 +112,4 @@ async function collectAndSaveProject(initialize = false) {
   }
 }
 
-module.exports = { needsProjects, collectAndSaveProject };
+module.exports = { needsSource, collectAndSaveProject };

package/lib/pull.js

@@ -9,6 +9,7 @@ const consts = require("./consts");
 const output = require("./output");
 const { collectAndSaveToken } = require("./init/token");
 const projectsToText = require("./utils/projectsToText");
+const sourcesToText = require("./utils/sourcesToText");
 
 const NON_DEFAULT_FORMATS = ["flat", "structured"];
 
@@ -30,54 +31,6 @@ async function askForAnotherToken() {
   await collectAndSaveToken(message);
 }
 
-function cleanProjectName(projectName) {
-  return (
-    projectName
-      .replace(/\s/g, "-")
-      // replace double underscore since this is what we use
-      // to separate project names and API IDs
-      .replace(/__/g, "_")
-      .toLowerCase()
-      .trim()
-  );
-}
-
-/**
- * Return the passed array of projects with `project.name` modified
- * to be `${project.name}-${duplicate_number}` for each project
- * that has the same name as another project in the original array.
- */
-const IS_DUPLICATE = /-(\d+$)/;
-function getProjectsWithDedupedNames(projects) {
-  const projectsWithDedupedNames = [];
-  const projectNames = {};
-
-  projects.forEach(({ id, name }) => {
-    let dedupedName = name;
-
-    if (projectNames[dedupedName]) {
-      while (projectNames[dedupedName]) {
-        const [_, numberStr] = dedupedName.match(IS_DUPLICATE) || [];
-        if (numberStr && !isNaN(parseInt(numberStr))) {
-          dedupedName = `${dedupedName.replace(IS_DUPLICATE, "")}-${
-            parseInt(numberStr) + 1
-          }`;
-        } else {
-          dedupedName = `${dedupedName}-1`;
-        }
-      }
-    }
-
-    projectNames[dedupedName] = true;
-    projectsWithDedupedNames.push({
-      id,
-      name: cleanProjectName(dedupedName),
-    });
-  });
-
-  return projectsWithDedupedNames;
-}
-
 /**
  * For a given variant:
  * - if format is unspecified, fetch data for all projects from `/projects` and
@@ -93,7 +46,7 @@ async function downloadAndSaveVariant(variantApiId, projects, format, token) {
 
   if (NON_DEFAULT_FORMATS.includes(format)) {
     const savedMessages = await Promise.all(
-      projects.map(async ({ id, name }) => {
+      projects.map(async ({ id, fileName }) => {
         const { data } = await api.get(`/projects/${id}`, {
           params,
           headers: { Authorization: `token ${token}` },
@@ -103,7 +56,7 @@ async function downloadAndSaveVariant(variantApiId, projects, format, token) {
           return "";
         }
 
-        const filename = name + ("__" + (variantApiId || "base")) + ".json";
+        const filename = fileName + ("__" + (variantApiId || "base")) + ".json";
         const filepath = path.join(consts.TEXT_DIR, filename);
 
         const dataString = JSON.stringify(data, null, 2);
@@ -162,13 +115,13 @@ async function downloadAndSaveBase(projects, format, token) {
 
   if (NON_DEFAULT_FORMATS.includes(format)) {
     const savedMessages = await Promise.all(
-      projects.map(async ({ id, name }) => {
+      projects.map(async ({ id, fileName }) => {
         const { data } = await api.get(`/projects/${id}`, {
           params,
           headers: { Authorization: `token ${token}` },
         });
 
-        const filename = `${name}.json`;
+        const filename = `${fileName}.json`;
         const filepath = path.join(consts.TEXT_DIR, filename);
 
         const dataString = JSON.stringify(data, null, 2);
@@ -195,36 +148,20 @@ async function downloadAndSaveBase(projects, format, token) {
 }
 
 function getSavedMessage(file) {
-  return `Successfully saved to ${output.info(file)}.\n`;
+  return `Successfully saved to ${output.info(file)}\n`;
 }
 
-async function cleanOutputFiles() {
-  const exists = await new Promise((resolve) => {
-    fs.exists(consts.TEXT_DIR, (exists) => resolve(exists));
-  });
-
-  if (!exists) {
-    await new Promise((resolve) => fs.mkdir(consts.TEXT_DIR, () => resolve()));
+function cleanOutputFiles() {
+  if (!fs.existsSync(consts.TEXT_DIR)) {
+    fs.mkdirSync(consts.TEXT_DIR);
   }
 
-  const fileNames = await new Promise((resolve) =>
-    fs.readdir(consts.TEXT_DIR, (err, fileNames) => {
-      if (err) throw err;
-      resolve(fileNames);
-    })
-  );
-
-  await Promise.all(
-    fileNames.map((fileName) => {
-      if (/\.js(on)?$/.test(fileName)) {
-        return new Promise((resolve) => {
-          fs.unlink(path.resolve(consts.TEXT_DIR, fileName), () => resolve());
-        });
-      }
-
-      return Promise.resolve();
-    })
-  );
+  const fileNames = fs.readdirSync(consts.TEXT_DIR);
+  fileNames.forEach((fileName) => {
+    if (/\.js(on)?$/.test(fileName)) {
+      fs.unlinkSync(path.resolve(consts.TEXT_DIR, fileName));
+    }
+  });
 
   return "Cleaning old output files..\n";
 }
@@ -251,7 +188,7 @@ function generateJsDriver(projects, variants, format) {
     .filter((fileName) => /\.json$/.test(fileName));
 
   const projectIdsByName = projects.reduce(
-    (agg, project) => ({ ...agg, [project.name]: project.id }),
+    (agg, project) => ({ ...agg, [project.fileName]: project.id }),
     {}
   );
 
@@ -321,28 +258,40 @@ function generateJsDriver(projects, variants, format) {
   const filePath = path.resolve(consts.TEXT_DIR, "index.js");
   fs.writeFileSync(filePath, dataString, { encoding: "utf8" });
 
-  return `Generated .js SDK driver at ${output.info(filePath)}..`;
+  return `Generated .js SDK driver at ${output.info(filePath)}`;
 }
 
-async function downloadAndSave(projectConfig, token) {
-  const { projects, variants, format } = projectConfig;
-  const projectsDeduped = getProjectsWithDedupedNames(projects);
+async function downloadAndSave(sourceInformation, token) {
+  const { validProjects, variants, format, shouldFetchComponentLibrary } =
+    sourceInformation;
 
-  let msg = `\nFetching the latest text from your selected projects: ${projectsToText(
-    projects
+  let msg = `\nFetching the latest text from ${sourcesToText(
+    validProjects,
+    shouldFetchComponentLibrary
   )}\n`;
 
   const spinner = ora(msg);
   spinner.start();
 
+  // We'll need to move away from this solution if at some
+  // point down the road we stop allowing the component
+  // library to be returned from the /projects endpoint
+  if (shouldFetchComponentLibrary) {
+    validProjects.push({
+      id: "ditto_component_library",
+      name: "Ditto Component Library",
+      fileName: "ditto-component-library",
+    });
+  }
+
   try {
-    msg += await cleanOutputFiles();
+    msg += cleanOutputFiles();
 
     msg += variants
-      ? await downloadAndSaveVariants(projectsDeduped, format, token)
-      : await downloadAndSaveBase(projectsDeduped, format, token);
+      ? await downloadAndSaveVariants(validProjects, format, token)
+      : await downloadAndSaveBase(validProjects, format, token);
 
-    msg += generateJsDriver(projectsDeduped, variants, format);
+    msg += generateJsDriver(validProjects, variants, format);
 
     msg += `\n${output.success("Done")}!`;
 
@@ -387,15 +336,15 @@ async function downloadAndSave(projectConfig, token) {
 
 function pull() {
   const token = config.getToken(consts.CONFIG_FILE, consts.API_HOST);
-  const pConfig = config.readData(consts.PROJECT_CONFIG_FILE);
-  return downloadAndSave(pConfig, token);
+  const sourceInformation = config.parseSourceInformation();
+
+  return downloadAndSave(sourceInformation, token);
 }
 
 module.exports = {
   pull,
   _testing: {
     cleanOutputFiles,
-    getProjectsWithDedupedNames,
     downloadAndSaveVariant,
     downloadAndSaveVariants,
     downloadAndSaveBase,

package/lib/utils/getSelectedProjects.js

@@ -29,7 +29,7 @@ function getSelectedProjects(configFile = PROJECT_CONFIG_FILE) {
     return [];
   }
 
-  return contentJson.projects.filter(({ name, id }) => name && id);
+  return contentjson.projects.filter(({ name, id }) => name && id);
 }
 
 module.exports = getSelectedProjects;

package/lib/utils/projectsToText.js

@@ -2,7 +2,7 @@ const output = require("../output");
 
 function projectsToText(projects) {
   return (
-    projects.reduce(
+    (projects || []).reduce(
       (outputString, { name, id }) =>
         outputString +
         ("\n" +

package/lib/utils/sourcesToText.js

@@ -0,0 +1,24 @@
+const output = require("../output");
+const projectsToText = require("./projectsToText");
+
+function sourcesToText(projects, componentLibrary) {
+  let message = "";
+
+  if (componentLibrary) {
+    message += `the ${output.info("Ditto Component Library")}`;
+
+    if ((projects || []).length) {
+      message += " and ";
+    } else {
+      message += "..";
+    }
+  }
+
+  if ((projects || []).length) {
+    message += ` the following projects: ${projectsToText(projects)}\n`;
+  }
+
+  return message;
+}
+
+module.exports = sourcesToText;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dittowords/cli",
-  "version": "1.2.6-beta",
+  "version": "2.1.0",
   "description": "Command Line Interface for Ditto (dittowords.com).",
   "main": "bin/index.js",
   "scripts": {