@dittowords/cli 2.5.0 → 2.5.2

package/lib/{pull.js → pull.ts}

@@ -1,20 +1,20 @@
-const fs = require("fs");
-const path = require("path");
+import fs from "fs";
+import path from "path";
 
-const ora = require("ora");
+import ora from "ora";
 
-const api = require("./api").default;
-const config = require("./config");
-const consts = require("./consts");
-const output = require("./output");
-const { collectAndSaveToken } = require("./init/token");
-const projectsToText = require("./utils/projectsToText");
-const sourcesToText = require("./utils/sourcesToText");
+import api from "./api";
+import config from "./config";
+import consts from "./consts";
+import output from "./output";
+import { collectAndSaveToken } from "./init/token";
+import sourcesToText from "./utils/sourcesToText";
+import { SourceInformation, Token, Project } from "./types";
 
 const NON_DEFAULT_FORMATS = ["flat", "structured"];
 
 const DEFAULT_FORMAT_KEYS = ["projects", "exported_at"];
-const hasVariantData = (data) => {
+const hasVariantData = (data: any) => {
   const hasTopLevelKeys =
     Object.keys(data).filter((key) => !DEFAULT_FORMAT_KEYS.includes(key))
       .length > 0;
@@ -38,15 +38,22 @@ async function askForAnotherToken() {
  * - if format is `flat` or `structured`, fetch data for each project from `/project/:project_id` and
  * save in `{projectName}-${variantApiId}.json`
  */
-async function downloadAndSaveVariant(variantApiId, projects, format, token) {
-  const params = { variant: variantApiId };
+async function downloadAndSaveVariant(
+  variantApiId: string | null,
+  projects: Project[],
+  format: string | undefined,
+  token?: Token
+) {
+  const params: Record<string, string | null> = {
+    variant: variantApiId,
+  };
   if (format) {
     params.format = format;
   }
 
-  if (NON_DEFAULT_FORMATS.includes(format)) {
+  if (format && NON_DEFAULT_FORMATS.includes(format)) {
     const savedMessages = await Promise.all(
-      projects.map(async ({ id, fileName }) => {
+      projects.map(async ({ id, fileName }: Project) => {
         const { data } = await api.get(`/projects/${id}`, {
           params,
           headers: { Authorization: `token ${token}` },
@@ -89,10 +96,12 @@ async function downloadAndSaveVariant(variantApiId, projects, format, token) {
   }
 }
 
-/**
- * @param {{ meta: Object.<string, string> }} options
- */
-async function downloadAndSaveVariants(projects, format, token, options) {
+async function downloadAndSaveVariants(
+  projects: Project[],
+  format: string | undefined,
+  token?: Token,
+  options?: PullOptions
+) {
   const meta = options ? options.meta : {};
 
   const { data: variants } = await api.get("/variants", {
@@ -105,7 +114,7 @@ async function downloadAndSaveVariants(projects, format, token, options) {
 
   const messages = await Promise.all([
     downloadAndSaveVariant(null, projects, format, token),
-    ...variants.map(({ apiID }) =>
+    ...variants.map(({ apiID }: { apiID: string }) =>
       downloadAndSaveVariant(apiID, projects, format, token)
     ),
   ]);
@@ -113,10 +122,12 @@ async function downloadAndSaveVariants(projects, format, token, options) {
   return messages.join("");
 }
 
-/**
- @param {{ meta: Object.<string, string> }} options
- */
-async function downloadAndSaveBase(projects, format, token, options) {
+async function downloadAndSaveBase(
+  projects: Project[],
+  format: string | undefined,
+  token?: Token,
+  options?: PullOptions
+) {
   const meta = options ? options.meta : {};
 
   const params = {
@@ -126,9 +137,9 @@ async function downloadAndSaveBase(projects, format, token, options) {
     params.format = format;
   }
 
-  if (NON_DEFAULT_FORMATS.includes(format)) {
+  if (format && NON_DEFAULT_FORMATS.includes(format)) {
     const savedMessages = await Promise.all(
-      projects.map(async ({ id, fileName }) => {
+      projects.map(async ({ id, fileName }: Project) => {
         const { data } = await api.get(`/projects/${id}`, {
           params,
           headers: { Authorization: `token ${token}` },
@@ -160,7 +171,7 @@ async function downloadAndSaveBase(projects, format, token, options) {
   }
 }
 
-function getSavedMessage(file) {
+function getSavedMessage(file: string) {
   return `Successfully saved to ${output.info(file)}\n`;
 }
 
@@ -181,7 +192,7 @@ function cleanOutputFiles() {
 
 // compatability with legacy method of specifying project ids
 // that is still used by the default format
-const stringifyProjectId = (projectId) =>
+const stringifyProjectId = (projectId: string) =>
   projectId === "ditto_component_library" ? projectId : `project_${projectId}`;
 
 /**
@@ -195,74 +206,88 @@ const stringifyProjectId = (projectId) =>
  * independent of the CLI configuration used to fetch
  * data from Ditto.
  */
-function generateJsDriver(projects, variants, format) {
+function generateJsDriver(
+  projects: Project[],
+  variants: boolean,
+  format: string | undefined
+) {
   const fileNames = fs
     .readdirSync(consts.TEXT_DIR)
     .filter((fileName) => /\.json$/.test(fileName));
 
-  const projectIdsByName = projects.reduce(
-    (agg, project) => ({ ...agg, [project.fileName]: project.id }),
+  const projectIdsByName: Record<string, string> = projects.reduce(
+    (agg, project) => {
+      if (project.fileName) {
+        return { ...agg, [project.fileName]: project.id };
+      }
+      return agg;
+    },
     {}
   );
 
-  const data = fileNames.reduce((obj, fileName) => {
-    // filename format: {project-name}__{variant-api-id}.json
-    // file format: flat or structured
-    if (variants && format) {
-      const [projectName, rest] = fileName.split("__");
-      const [variantApiId] = rest.split(".");
+  const data = fileNames.reduce(
+    (obj: Record<string, Record<string, string>>, fileName) => {
+      // filename format: {project-name}__{variant-api-id}.json
+      // file format: flat or structured
+      if (variants && format) {
+        const [projectName, rest] = fileName.split("__");
+        const [variantApiId] = rest.split(".");
+
+        const projectId = projectIdsByName[projectName];
+        if (!projectId) {
+          throw new Error(`Couldn't find id for ${projectName}`);
+        }
 
-      const projectId = projectIdsByName[projectName];
-      if (!projectId) {
-        throw new Error(`Couldn't find id for ${projectName}`);
-      }
+        const projectIdStr = stringifyProjectId(projectId);
 
-      const projectIdStr = stringifyProjectId(projectId);
+        if (!obj[projectIdStr]) {
+          obj[projectIdStr] = {};
+        }
 
-      if (!obj[projectIdStr]) {
-        obj[projectIdStr] = {};
+        obj[projectIdStr][variantApiId] = `require('./${fileName}')`;
       }
-
-      obj[projectIdStr][variantApiId] = `require('./${fileName}')`;
-    }
-    // filename format: {variant-api-id}.json
-    // file format: default
-    else if (variants) {
-      const file = require(path.resolve(consts.TEXT_DIR, `./${fileName}`));
-      const [variantApiId] = fileName.split(".");
-
-      Object.keys(file.projects).forEach((projectId) => {
-        if (!obj[projectId]) {
-          obj[projectId] = {};
+      // filename format: {variant-api-id}.json
+      // file format: default
+      else if (variants) {
+        const file = require(path.resolve(consts.TEXT_DIR, `./${fileName}`));
+        const [variantApiId] = fileName.split(".");
+
+        Object.keys(file.projects).forEach((projectId) => {
+          if (!obj[projectId]) {
+            obj[projectId] = {};
+          }
+
+          const project = file.projects[projectId];
+          obj[projectId][variantApiId] = project.frames || project.components;
+        });
+      }
+      // filename format: {project-name}.json
+      // file format: flat or structured
+      else if (format) {
+        const [projectName] = fileName.split(".");
+        const projectId = projectIdsByName[projectName];
+        if (!projectId) {
+          throw new Error(`Couldn't find id for ${projectName}`);
         }
 
-        const project = file.projects[projectId];
-        obj[projectId][variantApiId] = project.frames || project.components;
-      });
-    }
-    // filename format: {project-name}.json
-    // file format: flat or structured
-    else if (format) {
-      const [projectName] = fileName.split(".");
-      const projectId = projectIdsByName[projectName];
-      if (!projectId) {
-        throw new Error(`Couldn't find id for ${projectName}`);
+        obj[stringifyProjectId(projectId)] = {
+          base: `require('./${fileName}')`,
+        };
+      }
+      // filename format: text.json (single file)
+      // file format: default
+      else {
+        const file = require(path.resolve(consts.TEXT_DIR, `./${fileName}`));
+        Object.keys(file.projects).forEach((projectId) => {
+          const project = file.projects[projectId];
+          obj[projectId] = { base: project.frames || project.components };
+        });
       }
 
-      obj[stringifyProjectId(projectId)] = { base: `require('./${fileName}')` };
-    }
-    // filename format: text.json (single file)
-    // file format: default
-    else {
-      const file = require(path.resolve(consts.TEXT_DIR, `./${fileName}`));
-      Object.keys(file.projects).forEach((projectId) => {
-        const project = file.projects[projectId];
-        obj[projectId] = { base: project.frames || project.components };
-      });
-    }
-
-    return obj;
-  }, {});
+      return obj;
+    },
+    {}
+  );
 
   let dataString = `module.exports = ${JSON.stringify(data, null, 2)}`
     // remove quotes around require statements
@@ -274,10 +299,11 @@ function generateJsDriver(projects, variants, format) {
   return `Generated .js SDK driver at ${output.info(filePath)}`;
 }
 
-/**
- * @param {{ meta: Object.<string, string> }} options
- */
-async function downloadAndSave(sourceInformation, token, options) {
+async function downloadAndSave(
+  sourceInformation: SourceInformation,
+  token?: Token,
+  options?: PullOptions
+) {
   const { validProjects, variants, format, shouldFetchComponentLibrary } =
     sourceInformation;
 
@@ -314,7 +340,7 @@ async function downloadAndSave(sourceInformation, token, options) {
 
     spinner.stop();
     return console.log(msg);
-  } catch (e) {
+  } catch (e: any) {
     spinner.stop();
     let error = e.message;
     if (e.response && e.response.status === 404) {
@@ -351,18 +377,19 @@ async function downloadAndSave(sourceInformation, token, options) {
   }
 }
 
-/**
- * @param {{ meta: Object.<string, string> }} options
- */
-function pull(options) {
+interface PullOptions {
+  meta?: Record<string, string>;
+}
+
+export const pull = (options?: PullOptions) => {
   const meta = options ? options.meta : {};
   const token = config.getToken(consts.CONFIG_FILE, consts.API_HOST);
   const sourceInformation = config.parseSourceInformation();
 
   return downloadAndSave(sourceInformation, token, { meta });
-}
+};
 
-module.exports = {
+export default {
   pull,
   _testing: {
     cleanOutputFiles,

package/lib/remove-project.ts

@@ -0,0 +1,50 @@
+import config from "./config";
+import consts from "./consts";
+import output from "./output";
+import {
+  getSelectedProjects,
+  getIsUsingComponents,
+} from "./utils/getSelectedProjects";
+import promptForProject from "./utils/promptForProject";
+
+async function removeProject() {
+  const projects = getSelectedProjects();
+  const isUsingComponents = getIsUsingComponents();
+  if (!projects.length && !isUsingComponents) {
+    console.log(
+      "\n" +
+        "No projects found in your current configuration.\n" +
+        `Try adding one with: ${output.info("ditto-cli project add")}\n`
+    );
+    return;
+  }
+
+  const allProjects = isUsingComponents
+    ? [{ id: "components", name: "Ditto Component Library" }, ...projects]
+    : projects;
+
+  const projectToRemove = await promptForProject({
+    projects: allProjects,
+    message: isUsingComponents
+      ? "Select a project or library to remove"
+      : "Select a project to remove",
+  });
+  if (!projectToRemove) return;
+
+  config.writeProjectConfigData(consts.PROJECT_CONFIG_FILE, {
+    components: isUsingComponents && projectToRemove.id !== "components",
+    projects: projects.filter(({ id }) => id !== projectToRemove.id),
+  });
+
+  console.log(
+    `\n${output.info(
+      projectToRemove.name
+    )} has been removed from your selected projects. ` +
+      `\nWe saved your updated configuration to: ${output.info(
+        consts.PROJECT_CONFIG_FILE
+      )}` +
+      "\n"
+  );
+}
+
+export default removeProject;

package/lib/types.ts

@@ -0,0 +1,23 @@
+export interface Project {
+  name: string;
+  id: string;
+  url?: string;
+  fileName?: string;
+}
+
+export interface ConfigYAML {
+  components?: boolean;
+  projects?: Project[];
+  format?: string;
+  variants?: boolean;
+}
+
+export interface SourceInformation {
+  hasSourceData: boolean;
+  validProjects: Project[];
+  shouldFetchComponentLibrary: boolean;
+  variants: boolean;
+  format: string | undefined;
+}
+
+export type Token = string | undefined;

package/lib/utils/getSelectedProjects.ts

@@ -0,0 +1,55 @@
+import fs from "fs";
+import yaml, { YAMLException } from "js-yaml";
+
+import { PROJECT_CONFIG_FILE } from "../consts";
+import { ConfigYAML, Project } from "../types";
+
+function jsonIsConfigYAML(json: unknown): json is ConfigYAML {
+  return typeof json === "object";
+}
+
+function yamlToJson(_yaml: string): ConfigYAML | null {
+  try {
+    let configYaml = yaml.load(_yaml);
+    if (!jsonIsConfigYAML(configYaml)) {
+      return {};
+    }
+    return configYaml;
+  } catch (e) {
+    if (e instanceof YAMLException) {
+      return null;
+    } else {
+      throw e;
+    }
+  }
+}
+
+/**
+ * Returns an array containing all valid projects ({ id, name })
+ * currently contained in the project config file.
+ */
+export const getSelectedProjects = (
+  configFile = PROJECT_CONFIG_FILE
+): Project[] => {
+  if (!fs.existsSync(configFile)) return [];
+
+  const contentYaml = fs.readFileSync(configFile, "utf8");
+  const contentJson = yamlToJson(contentYaml);
+
+  if (!(contentJson && contentJson.projects)) {
+    return [];
+  }
+
+  return contentJson.projects.filter(({ name, id }) => name && id);
+};
+
+export const getIsUsingComponents = (
+  configFile = PROJECT_CONFIG_FILE
+): boolean => {
+  if (!fs.existsSync(configFile)) return false;
+
+  const contentYaml = fs.readFileSync(configFile, "utf8");
+  const contentJson = yamlToJson(contentYaml);
+
+  return !!contentJson && !!contentJson.components;
+};

package/lib/utils/processMetaOption.test.ts

@@ -0,0 +1,18 @@
+import processMetaOption from "./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/processMetaOption.ts

@@ -0,0 +1,16 @@
+const processMetaOption = (inputArr: string[] | null) => {
+  const res: Record<string, string> = {};
+
+  if (!Array.isArray(inputArr)) {
+    return res;
+  }
+
+  inputArr.forEach((element) => {
+    const [key, value] = element.split(":");
+    res[key] = value;
+  });
+
+  return res;
+};
+
+export default processMetaOption;

package/lib/utils/{projectsToText.js → projectsToText.ts}

@@ -1,6 +1,7 @@
-const output = require("../output");
+import output from "../output";
+import { Project } from "../types";
 
-function projectsToText(projects) {
+const projectsToText = (projects: Project[]) => {
   return (
     (projects || []).reduce(
       (outputString, { name, id }) =>
@@ -13,6 +14,6 @@ function projectsToText(projects) {
       ""
     ) + "\n"
   );
-}
+};
 
-module.exports = projectsToText;
+export default projectsToText;

package/lib/utils/{promptForProject.js → promptForProject.ts}

@@ -1,18 +1,17 @@
 const { AutoComplete } = require("enquirer");
 
-const output = require("../output");
+import output from "../output";
+import { Project } from "../types";
 
-function formatProjectChoice(project) {
+function formatProjectChoice(project: Project) {
   return (
     project.name +
     " " +
-    output.subtle(
-      project.url || `https://app.dittowords.com/doc/${project.id}`
-    )
+    output.subtle(project.url || `https://app.dittowords.com/doc/${project.id}`)
   );
 }
 
-function parseResponse(response) {
+function parseResponse(response: string) {
   if (!response) {
     return null;
   }
@@ -26,7 +25,17 @@ function parseResponse(response) {
   return { name, id };
 }
 
-async function promptForProject({ message, projects, limit = 10 }) {
+interface ProjectPromptParams {
+  message: string;
+  projects: Project[];
+  limit?: number;
+}
+
+const promptForProject = async ({
+  message,
+  projects,
+  limit = 10,
+}: ProjectPromptParams) => {
   output.nl();
 
   const choices = projects.map(formatProjectChoice);
@@ -48,6 +57,6 @@ async function promptForProject({ message, projects, limit = 10 }) {
   }
 
   return parseResponse(response);
-}
+};
 
-module.exports = promptForProject;
+export default promptForProject;

package/lib/utils/{sourcesToText.js → sourcesToText.ts}

@@ -1,7 +1,8 @@
-const output = require("../output");
-const projectsToText = require("./projectsToText");
+import output from "../output";
+import projectsToText from "./projectsToText";
+import { Project } from "../types";
 
-function sourcesToText(projects, componentLibrary) {
+const sourcesToText = (projects: Project[], componentLibrary: boolean) => {
   let message = "";
 
   if (componentLibrary) {
@@ -19,6 +20,6 @@ function sourcesToText(projects, componentLibrary) {
   }
 
   return message;
-}
+};
 
-module.exports = sourcesToText;
+export default sourcesToText;

package/package.json

@@ -1,11 +1,14 @@
 {
   "name": "@dittowords/cli",
-  "version": "2.5.0",
+  "version": "2.5.2",
   "description": "Command Line Interface for Ditto (dittowords.com).",
   "main": "bin/index.js",
   "scripts": {
+    "prepublish": "tsc",
     "prepare": "husky install",
-    "sync": "node bin/ditto.js pull"
+    "start": "tsc && node bin/ditto.js",
+    "sync": "tsc && node bin/ditto.js pull",
+    "dev": "tsc --watch"
   },
   "repository": {
     "type": "git",
@@ -25,36 +28,38 @@
     "cli",
     "api"
   ],
+  "types": "bin/ditto.d.ts",
   "bin": {
-    "ditto-cli": "./bin/ditto.js"
+    "ditto-cli": "bin/ditto.js"
   },
   "devDependencies": {
     "@babel/core": "^7.11.4",
-    "@babel/preset-env": "^7.11.0",
+    "@babel/preset-env": "^7.20.2",
+    "@babel/preset-typescript": "^7.18.6",
+    "@tsconfig/node16": "^1.0.3",
     "@types/jest": "^26.0.9",
-    "babel-jest": "^26.3.0",
-    "eslint": "^7.6.0",
+    "@types/js-yaml": "^4.0.5",
+    "@types/node": "^18.0.0",
+    "babel-jest": "^29.3.1",
+    "eslint": "^8.27.0",
     "eslint-config-airbnb-base": "^14.2.0",
-    "eslint-plugin-import": "^2.22.0",
-    "eslint-plugin-jest": "^23.20.0",
     "husky": "^7.0.4",
+    "jest": "^29.3.1",
     "lint-staged": "^11.2.4",
     "prettier": "2.4.1",
-    "jest": "^27.3.1",
-    "rewire": "^5.0.0",
+    "rewire": "^6.0.0",
     "source-map": "^0.7.3",
     "tempy": "^0.6.0",
-    "tsconfig-paths": "^3.9.0",
-    "typescript": "^4.0.2"
+    "typescript": "^4.7.4"
   },
   "dependencies": {
-    "axios": "^0.19.2",
-    "boxen": "^4.2.0",
+    "axios": "^0.27.2",
+    "boxen": "^5.1.2",
     "chalk": "^4.1.0",
     "commander": "^6.1.0",
     "enquirer": "^2.3.6",
     "faker": "^5.1.0",
-    "js-yaml": "^3.14.0",
+    "js-yaml": "^4.1.0",
     "ora": "^5.0.0",
     "v8-compile-cache": "^2.1.1"
   },

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "extends": "@tsconfig/node16/tsconfig.json",
+  "compilerOptions": {
+    "allowJs": true,
+    "outDir": "bin",
+    "allowSyntheticDefaultImports": true,
+    "resolveJsonModule": true,
+    "strictNullChecks": true,
+    "sourceMap": true
+  },
+  "include": ["lib/ditto.ts"]
+}