@dittowords/cli 2.3.0 → 2.5.1

package/README.md

@@ -16,7 +16,7 @@ npm install --global @dittowords/cli
 
 The installed binary is named `ditto-cli`. You can execute it directly in `node_modules/.bin/ditto-cli` or using [npx](https://www.npmjs.com/package/npx) (with or without installation) like `npx @dittowords/cli`.
 
-The first time you run the CLI, you'll be asked to provide an API key (found at [https://beta.dittowords.com/account/user](https://beta.dittowords.com/account/user) under **API Keys**):
+The first time you run the CLI, you'll be asked to provide an API key (found at [https://app.dittowords.com/account/user](https://app.dittowords.com/account/user) under **API Keys**):
 
 ```
 $ npx @dittowords/cli
@@ -41,8 +41,8 @@ Once you've successfully authenticated, you'll be asked to configure the CLI wit
 Looks like there are no Ditto projects selected for your current directory.
 
 ? Choose the project you'd like to sync text from:
-- Ditto Component Library https://beta.dittowords.com/components/all
-- NUX Onboarding Flow https://beta.dittowords.com/doc/609e9981c313f8018d0c346a
+- Ditto Component Library https://app.dittowords.com/components/all
+- NUX Onboarding Flow https://app.dittowords.com/doc/609e9981c313f8018d0c346a
 ...
 ```
 
@@ -85,6 +85,9 @@ For more details on files generated by the `pull` command, see [JSON Files](#jso
 
 **Action:** Removes a project from the list of Ditto projects stored in `config.yml`.
 
+## Options
+`-m, --meta <data...>` Optional metadata to send arbitrary data to the backend. Ex: `-m githubActionRequest:true trigger:manual`. Currently, this option should only be utilized when the CLI is ran within a GitHub action (see [Ditto GitHub Action](https://github.com/dittowords/ditto-github-action)) via `githubActionRequest:true`.
+
 ## Files
 
 ### `ditto/`

package/bin/ditto.js

@@ -9,6 +9,7 @@ const { pull } = require("../lib/pull");
 
 const addProject = require("../lib/add-project");
 const removeProject = require("../lib/remove-project");
+const processMetaOption = require("../lib/utils/processMetaOption");
 
 /**
  * Catch and report unexpected error.
@@ -45,6 +46,12 @@ const setupCommands = () => {
     .action(() => checkInit("project remove"));
 };
 
+const setupOptions = () => {
+  program
+    .option('-m, --meta <data...>',
+      'Optional metadata for this command to send arbitrary data to the backend. Ex: -m githubActionRequest:true trigger:manual');
+};
+
 const checkInit = async (command) => {
   if (needsInit() && command !== "project remove") {
     try {
@@ -54,9 +61,10 @@ const checkInit = async (command) => {
       quit();
     }
   } else {
+    const { meta } = program.opts();
     switch (command) {
       case "pull":
-        pull();
+        pull({ meta: processMetaOption(meta) });
         break;
       case "project":
       case "project add":
@@ -80,6 +88,7 @@ const main = async () => {
     await checkInit("none");
   } else {
     setupCommands();
+    setupOptions();
   }
   program.parse(process.argv);
 };

package/lib/add-project.js

@@ -1,6 +1,10 @@
 const { collectAndSaveProject } = require("./init/project");
 const projectsToText = require("./utils/projectsToText");
-const getSelectedProjects = require("./utils/getSelectedProjects");
+const {
+  getSelectedProjects,
+  getIsUsingComponents,
+} = require("./utils/getSelectedProjects");
+const output = require("./output");
 
 function quit(exitCode = 2) {
   console.log("Project selection was not updated.");
@@ -10,13 +14,30 @@ function quit(exitCode = 2) {
 
 const addProject = async () => {
   const projects = getSelectedProjects();
+  const usingComponents = getIsUsingComponents();
 
   try {
-    console.log(
-      `\nYou're currently set up to sync text from the following projects: ${projectsToText(
-        projects
-      )}`
-    );
+    if (usingComponents) {
+      if (projects.length) {
+        console.log(
+          `\nYou're currently set up to sync text from the ${output.info(
+            "Component Library"
+          )} and from the following projects: ${projectsToText(projects)}`
+        );
+      } else {
+        console.log(
+          `\nYou're currently only set up to sync text from the ${output.info(
+            "Component Library"
+          )}`
+        );
+      }
+    } else if (projects.length) {
+      console.log(
+        `\nYou're currently set up to sync text from the following projects: ${projectsToText(
+          projects
+        )}`
+      );
+    }
     await collectAndSaveProject(false);
   } catch (error) {
     console.log(

package/lib/init/project.js

@@ -5,7 +5,10 @@ const config = require("../config");
 const consts = require("../consts");
 const output = require("../output");
 const { collectAndSaveToken } = require("../init/token");
-const getSelectedProjects = require("../utils/getSelectedProjects");
+const {
+  getSelectedProjects,
+  getIsUsingComponents,
+} = require("../utils/getSelectedProjects");
 const promptForProject = require("../utils/promptForProject");
 
 function quit(exitCode = 2) {
@@ -15,10 +18,10 @@ function quit(exitCode = 2) {
 }
 
 function saveProject(file, name, id) {
-  // old functionality included "ditto_component_library" in the `projects`
+  // old functionality included "components" in the `projects`
   // array, but we want to always treat the component library as a separate
   // entity and use the new notation of a top-level `components` key
-  if (id === "ditto_component_library") {
+  if (id === "components") {
     config.writeData(file, { components: true });
     return;
   }
@@ -39,7 +42,11 @@ async function askForAnotherToken() {
   await collectAndSaveToken(message);
 }
 
-async function listProjects(token, projectsAlreadySelected) {
+async function listProjects(
+  token,
+  projectsAlreadySelected,
+  componentsSelected
+) {
   const spinner = ora("Fetching projects in your workspace...");
   spinner.start();
 
@@ -58,9 +65,13 @@ async function listProjects(token, projectsAlreadySelected) {
 
   spinner.stop();
 
-  return projects.data.filter(
-    ({ id }) => !projectsAlreadySelected.some((project) => project.id === id)
-  );
+  return projects.data.filter(({ id }) => {
+    if (id === "ditto_component_library") {
+      return !componentsSelected;
+    } else {
+      return !projectsAlreadySelected.some((project) => project.id === id);
+    }
+  });
 }
 
 async function collectProject(token, initialize) {
@@ -74,19 +85,32 @@ async function collectProject(token, initialize) {
   }
 
   const projectsAlreadySelected = getSelectedProjects();
-  const projects = await listProjects(token, projectsAlreadySelected);
+  const usingComponents = getIsUsingComponents();
+  const projects = await listProjects(
+    token,
+    projectsAlreadySelected,
+    usingComponents
+  );
 
   if (!(projects && projects.length)) {
     console.log("You're currently syncing all projects in your workspace.");
-    console.log(output.warnText("Not seeing a project that you were expecting? Verify that developer mode is enabled on that project. More info: https://www.dittowords.com/docs/ditto-developer-mode"));
+    console.log(
+      output.warnText(
+        "Not seeing a project that you were expecting? Verify that developer mode is enabled on that project. More info: https://www.dittowords.com/docs/ditto-developer-mode"
+      )
+    );
     return null;
   }
 
+  const nonInitPrompt = usingComponents
+    ? "Add a project"
+    : "Add a project or library";
+
   return promptForProject({
     projects,
     message: initialize
-      ? "Choose the project you'd like to sync text from"
-      : "Add a project",
+      ? "Choose the project or library you'd like to sync text from"
+      : nonInitPrompt,
   });
 }
 

package/lib/init/token.js

@@ -58,7 +58,7 @@ async function checkToken(token) {
 
 async function collectToken(message) {
   const blue = output.info;
-  const apiUrl = output.url("https://beta.dittowords.com/account/user");
+  const apiUrl = output.url("https://app.dittowords.com/account/user");
   const breadcrumbs = `${blue("User")}`;
   const tokenDescription =
     message ||

package/lib/pull.js

@@ -89,9 +89,15 @@ async function downloadAndSaveVariant(variantApiId, projects, format, token) {
   }
 }
 
-async function downloadAndSaveVariants(projects, format, token) {
+/**
+ * @param {{ meta: Object.<string, string> }} options
+ */
+async function downloadAndSaveVariants(projects, format, token, options) {
+  const meta = options ? options.meta : {};
+
   const { data: variants } = await api.get("/variants", {
     params: {
+      ...meta,
       projectIds: projects.map(({ id }) => id),
     },
     headers: { Authorization: `token ${token}` },
@@ -107,8 +113,15 @@ async function downloadAndSaveVariants(projects, format, token) {
   return messages.join("");
 }
 
-async function downloadAndSaveBase(projects, format, token) {
-  const params = {};
+/**
+ @param {{ meta: Object.<string, string> }} options
+ */
+async function downloadAndSaveBase(projects, format, token, options) {
+  const meta = options ? options.meta : {};
+
+  const params = {
+    ...meta,
+  };
   if (format) {
     params.format = format;
   }
@@ -261,7 +274,10 @@ function generateJsDriver(projects, variants, format) {
   return `Generated .js SDK driver at ${output.info(filePath)}`;
 }
 
-async function downloadAndSave(sourceInformation, token) {
+/**
+ * @param {{ meta: Object.<string, string> }} options
+ */
+async function downloadAndSave(sourceInformation, token, options) {
   const { validProjects, variants, format, shouldFetchComponentLibrary } =
     sourceInformation;
 
@@ -287,9 +303,10 @@ async function downloadAndSave(sourceInformation, token) {
   try {
     msg += cleanOutputFiles();
 
+    const meta = options ? options.meta : {};
     msg += variants
-      ? await downloadAndSaveVariants(validProjects, format, token)
-      : await downloadAndSaveBase(validProjects, format, token);
+      ? await downloadAndSaveVariants(validProjects, format, token, { meta })
+      : await downloadAndSaveBase(validProjects, format, token, { meta });
 
     msg += generateJsDriver(validProjects, variants, format);
 
@@ -334,11 +351,15 @@ async function downloadAndSave(sourceInformation, token) {
   }
 }
 
-function pull() {
+/**
+ * @param {{ meta: Object.<string, string> }} options
+ */
+function pull(options) {
+  const meta = options ? options.meta : {};
   const token = config.getToken(consts.CONFIG_FILE, consts.API_HOST);
   const sourceInformation = config.parseSourceInformation();
 
-  return downloadAndSave(sourceInformation, token);
+  return downloadAndSave(sourceInformation, token, { meta });
 }
 
 module.exports = {

package/lib/remove-project.js

@@ -1,12 +1,16 @@
 const config = require("./config");
 const consts = require("./consts");
 const output = require("./output");
-const getSelectedProjects = require("./utils/getSelectedProjects");
+const {
+  getSelectedProjects,
+  getIsUsingComponents,
+} = require("./utils/getSelectedProjects");
 const promptForProject = require("./utils/promptForProject");
 
 async function removeProject() {
   const projects = getSelectedProjects();
-  if (!projects.length) {
+  const isUsingComponents = getIsUsingComponents();
+  if (!projects.length && !isUsingComponents) {
     console.log(
       "\n" +
         "No projects found in your workspace.\n" +
@@ -15,13 +19,24 @@ async function removeProject() {
     return;
   }
 
+  const allProjects = isUsingComponents
+    ? [
+        { id: "ditto_component_library", name: "Ditto Component Library" },
+        ...projects,
+      ]
+    : projects;
+
   const projectToRemove = await promptForProject({
-    projects,
-    message: "Select a project to remove",
+    projects: allProjects,
+    message: isUsingComponents
+      ? "Select a project or library to remove"
+      : "Select a project to remove",
   });
   if (!projectToRemove) return;
 
   config.writeData(consts.PROJECT_CONFIG_FILE, {
+    components:
+      isUsingComponents && projectToRemove.id !== "ditto_component_library",
     projects: projects.filter(({ id }) => id !== projectToRemove.id),
   });
 

package/lib/utils/getSelectedProjects.js

@@ -32,4 +32,13 @@ function getSelectedProjects(configFile = PROJECT_CONFIG_FILE) {
   return contentJson.projects.filter(({ name, id }) => name && id);
 }
 
-module.exports = getSelectedProjects;
+const getIsUsingComponents = (configFile = PROJECT_CONFIG_FILE) => {
+  if (!fs.existsSync(configFile)) return [];
+
+  const contentYaml = fs.readFileSync(configFile, "utf8");
+  const contentJson = yamlToJson(contentYaml);
+
+  return contentJson && contentJson.components;
+};
+
+module.exports = { getSelectedProjects, getIsUsingComponents };

package/lib/utils/processMetaOption.js

@@ -0,0 +1,16 @@
+const processMetaOption = (inputArr) => {
+  const res = {};
+
+  if (!Array.isArray(inputArr)) {
+    return res;
+  }
+
+  inputArr.forEach((element) => {
+    const [key, value] = element.split(':');
+    res[key] = value;
+  });
+
+  return res;
+};
+
+module.exports = processMetaOption;

package/lib/utils/processMetaOption.test.js

@@ -0,0 +1,16 @@
+const processMetaOption = require('./processMetaOption');
+
+describe('processMetaOption tests', () => {
+  it('It parses correctly', () => {
+    expect(processMetaOption(['githubActionRequest:true', 'trigger:manual'])).toEqual({
+      githubActionRequest: 'true',
+      trigger: 'manual',
+    });
+  });
+  it('Malformed doesnt crash', () => {
+    expect(processMetaOption(['context:github-action', 'trigger'])).toEqual({
+      context: 'github-action',
+      trigger: undefined,
+    });
+  });
+});

package/lib/utils/projectsToText.js

@@ -9,7 +9,7 @@ function projectsToText(projects) {
           "- " +
           output.info(name) +
           " " +
-          output.subtle("https://beta.dittowords.com/doc/" + id)),
+          output.subtle("https://app.dittowords.com/doc/" + id)),
       ""
     ) + "\n"
   );

package/lib/utils/promptForProject.js

@@ -7,7 +7,7 @@ function formatProjectChoice(project) {
     project.name +
     " " +
     output.subtle(
-      project.url || `https://beta.dittowords.com/doc/${project.id}`
+      project.url || `https://app.dittowords.com/doc/${project.id}`
     )
   );
 }

package/package.json

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