@dittowords/cli 2.7.1 → 3.0.0

package/lib/utils/generateJsDriver.ts

@@ -0,0 +1,68 @@
+import fs from "fs";
+import path from "path";
+import consts from "../consts";
+import output from "../output";
+import { Source } from "../types";
+import { cleanFileName } from "./cleanFileName";
+
+// compatability with legacy method of specifying project ids
+// that is still used by the default format
+const stringifySourceId = (projectId: string) =>
+  projectId === "ditto_component_library" ? projectId : `project_${projectId}`;
+
+/**
+ * Generates an index.js file that can be consumed
+ * by an SDK - this is a big DX improvement because
+ * it provides a single entry point to get all data
+ * (including variants) instead of having to import
+ * each generated file individually.
+ *
+ * The generated file will have a unified format
+ * independent of the CLI configuration used to fetch
+ * data from Ditto.
+ */
+
+// TODO: support ESM
+export function generateJsDriver(sources: Source[]) {
+  const fileNames = fs
+    .readdirSync(consts.TEXT_DIR)
+    .filter((fileName) => /\.json$/.test(fileName));
+
+  const sourceIdsByName: Record<string, string> = sources.reduce(
+    (agg, source) => {
+      if (source.fileName) {
+        return { ...agg, [cleanFileName(source.fileName)]: source.id };
+      }
+
+      return agg;
+    },
+    {}
+  );
+
+  const data = fileNames.reduce(
+    (obj: Record<string, Record<string, string>>, fileName) => {
+      const [sourceId, rest] = fileName.split("__");
+      const [variantApiId] = rest.split(".");
+
+      const projectId = sourceIdsByName[sourceId];
+      const projectIdStr = stringifySourceId(projectId);
+
+      if (!obj[projectIdStr]) {
+        obj[projectIdStr] = {};
+      }
+
+      obj[projectIdStr][variantApiId] = `require('./${fileName}')`;
+      return obj;
+    },
+    {}
+  );
+
+  let dataString = `module.exports = ${JSON.stringify(data, null, 2)}`
+    // remove quotes around require statements
+    .replace(/"require\((.*)\)"/g, "require($1)");
+
+  const filePath = path.resolve(consts.TEXT_DIR, "index.js");
+  fs.writeFileSync(filePath, dataString, { encoding: "utf8" });
+
+  return `Generated .js SDK driver at ${output.info(filePath)}`;
+}

package/lib/utils/getSelectedProjects.ts

@@ -3,6 +3,7 @@ import yaml, { YAMLException } from "js-yaml";
 
 import { PROJECT_CONFIG_FILE } from "../consts";
 import { ConfigYAML, Project } from "../types";
+import Config, { DEFAULT_CONFIG_JSON } from "../config";
 
 function jsonIsConfigYAML(json: unknown): json is ConfigYAML {
   return typeof json === "object";
@@ -28,28 +29,8 @@ function yamlToJson(_yaml: string): ConfigYAML | null {
  * 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 [];
+export const getSelectedProjects = (configFile = PROJECT_CONFIG_FILE) =>
+  Config.parseSourceInformation(configFile).validProjects;
 
-  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;
-};
+export const getIsUsingComponents = (configFile = PROJECT_CONFIG_FILE) =>
+  Config.parseSourceInformation(configFile).shouldFetchComponentLibrary;

package/lib/utils/projectsToText.ts

@@ -1,6 +1,16 @@
 import output from "../output";
 import { Project } from "../types";
 
+export const getSourceUrl = (sourceId: string) => {
+  let base = "https://app.dittowords.com";
+
+  if (sourceId === "ditto_component_library") {
+    return `${base}/components`;
+  }
+
+  return `${base}/doc/${sourceId}`;
+};
+
 const projectsToText = (projects: Project[]) => {
   return (
     (projects || []).reduce(
@@ -10,7 +20,7 @@ const projectsToText = (projects: Project[]) => {
           "- " +
           output.info(name) +
           " " +
-          output.subtle("https://app.dittowords.com/doc/" + id)),
+          output.subtle(getSourceUrl(id))),
       ""
     ) + "\n"
   );

package/lib/utils/promptForProject.ts

@@ -2,12 +2,11 @@ const { AutoComplete } = require("enquirer");
 
 import output from "../output";
 import { Project } from "../types";
+import { getSourceUrl } from "./projectsToText";
 
 function formatProjectChoice(project: Project) {
   return (
-    project.name +
-    " " +
-    output.subtle(project.url || `https://app.dittowords.com/doc/${project.id}`)
+    project.name + " " + output.subtle(project.url || getSourceUrl(project.id))
   );
 }
 

package/lib/utils/quit.ts

@@ -0,0 +1,5 @@
+export function quit(message: string, exitCode = 2) {
+  console.log(`\n${message}\n`);
+  process.exitCode = exitCode;
+  process.exit();
+}

package/package.json

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

package/tsconfig.json

@@ -6,7 +6,8 @@
     "allowSyntheticDefaultImports": true,
     "resolveJsonModule": true,
     "strictNullChecks": true,
-    "sourceMap": true
+    "sourceMap": true,
+    "strict": true
   },
   "include": ["lib/ditto.ts"]
 }