@dittowords/cli 4.5.2 → 5.0.0-beta.0

package/lib/config.ts

@@ -1,279 +0,0 @@
-import fs from "fs";
-import path from "path";
-import url from "url";
-import yaml from "js-yaml";
-import * as Sentry from "@sentry/node";
-
-import consts from "./consts";
-import { createSentryContext } from "./utils/createSentryContext";
-import { Project, ConfigYAML, SourceInformation, Source } from "./types";
-
-export const DEFAULT_CONFIG_JSON: ConfigYAML = {
-  sources: {
-    components: true,
-  },
-  variants: true,
-  format: "flat",
-};
-
-export const DEFAULT_CONFIG = yaml.dump(DEFAULT_CONFIG_JSON);
-
-function createFileIfMissing(filename: string, defaultContents?: any) {
-  const dir = path.dirname(filename);
-
-  // create the directory if it doesn't already exist
-  if (!fs.existsSync(dir)) fs.mkdirSync(dir);
-
-  // create the file if it doesn't already exist
-  if (!fs.existsSync(filename)) {
-    // create the file, writing the `defaultContents` if provided
-    fs.writeFileSync(filename, defaultContents || "", "utf-8");
-  }
-}
-
-function jsonIsConfigYAML(json: unknown): json is ConfigYAML {
-  return typeof json === "object";
-}
-
-function jsonIsGlobalYAML(
-  json: unknown
-): json is Record<string, { token: string }[]> {
-  return (
-    !!json &&
-    typeof json === "object" &&
-    Object.values(json).every(
-      (arr) =>
-        (arr as any).every &&
-        arr.every(
-          (val: any) =>
-            typeof val === "object" && Object.keys(val).includes("token")
-        )
-    )
-  );
-}
-
-/**
- * Read data from a project config file
- * @param {string} file defaults to `PROJECT_CONFIG_FILE` defined in `constants.js`
- * @param {*} defaultData defaults to `{}`
- * @returns { ConfigYAML }
- */
-function readProjectConfigData(
-  file = consts.PROJECT_CONFIG_FILE,
-  defaultData = {}
-): ConfigYAML {
-  createFileIfMissing(file, DEFAULT_CONFIG);
-  const fileContents = fs.readFileSync(file, "utf8");
-  const yamlData = yaml.load(fileContents);
-  if (jsonIsConfigYAML(yamlData)) {
-    return yamlData;
-  }
-  return defaultData;
-}
-
-/**
- * Read data from a global config file
- * @param {string} file defaults to `CONFIG_FILE` defined in `constants.js`
- * @param {*} defaultData defaults to `{}`
- * @returns { Record<string, { token: string }[]> }
- */
-function readGlobalConfigData(
-  file = consts.CONFIG_FILE,
-  defaultData = {}
-): Record<string, { token: string }[]> {
-  createFileIfMissing(file);
-  const fileContents = fs.readFileSync(file, "utf8");
-  const yamlData = yaml.load(fileContents);
-  if (jsonIsGlobalYAML(yamlData)) {
-    return yamlData;
-  }
-  return defaultData;
-}
-
-function writeProjectConfigData(file: string, data: Partial<ConfigYAML>) {
-  createFileIfMissing(file, DEFAULT_CONFIG);
-  const existingData = readProjectConfigData(file);
-
-  const configData: ConfigYAML = {
-    ...existingData,
-    ...data,
-    sources: {
-      ...existingData.sources,
-      ...data.sources,
-    },
-  };
-
-  const yamlStr = yaml.dump(configData);
-  fs.writeFileSync(file, yamlStr, "utf8");
-}
-
-function writeGlobalConfigData(file: string, data: object) {
-  createFileIfMissing(file);
-  const existingData = readGlobalConfigData(file);
-  const yamlStr = yaml.dump({ ...existingData, ...data });
-  fs.writeFileSync(file, yamlStr, "utf8");
-}
-
-function justTheHost(host: string) {
-  if (!host.includes("://")) return host;
-  return url.parse(host).hostname || "";
-}
-
-function deleteToken(file: string, host: string) {
-  const data = readGlobalConfigData(file);
-  const hostParsed = justTheHost(host);
-  data[hostParsed] = [];
-  data[hostParsed][0] = { token: "" };
-  writeGlobalConfigData(file, data);
-}
-
-function saveToken(file: string, host: string, token: string) {
-  const data = readGlobalConfigData(file);
-  const hostParsed = justTheHost(host);
-  data[hostParsed] = []; // only allow one token per host
-  data[hostParsed][0] = { token };
-  writeGlobalConfigData(file, data);
-}
-
-function getTokenFromEnv() {
-  return process.env.DITTO_API_KEY;
-}
-
-/**
- *
- * @param {string} file
- * @param {string} host
- * @returns {Token}
- */
-function getToken(file: string, host: string) {
-  const tokenFromEnv = getTokenFromEnv();
-  if (tokenFromEnv) {
-    return tokenFromEnv;
-  }
-
-  const data = readGlobalConfigData(file);
-  const hostEntry = data[justTheHost(host)];
-  if (!hostEntry) return undefined;
-  const { length } = hostEntry;
-
-  return hostEntry[length - 1].token;
-}
-
-const IS_DUPLICATE = /-(\d+$)/;
-
-function dedupeProjectName(projectNames: Set<string>, projectName: string) {
-  let dedupedName = projectName;
-
-  if (projectNames.has(dedupedName)) {
-    while (projectNames.has(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(file?: string): SourceInformation {
-  const {
-    sources,
-    variants,
-    format,
-    status,
-    richText,
-    iosLocales,
-    projects: projectsRoot,
-    components: componentsRoot,
-    disableJsDriver,
-  } = readProjectConfigData(file);
-
-  const projects = sources?.projects || [];
-
-  const projectNames = new Set<string>();
-  const validProjects: Project[] = [];
-  let hasComponentLibraryInProjects = false;
-
-  (projects || []).forEach((project) => {
-    const isValid = project.id && project.name;
-    if (!isValid) {
-      return;
-    }
-
-    if (project.id === "ditto_component_library") {
-      hasComponentLibraryInProjects = true;
-      return;
-    }
-
-    project.fileName = dedupeProjectName(projectNames, project.name);
-    projectNames.add(project.fileName);
-
-    validProjects.push(project);
-  });
-
-  const shouldFetchComponentLibrary = Boolean(sources?.components);
-  const componentRoot =
-    typeof sources?.components === "object"
-      ? sources.components.root
-      : undefined;
-  const componentFolders =
-    typeof sources?.components === "object"
-      ? sources.components.folders
-      : undefined;
-
-  /**
-   * If it's not specified to fetch projects or the component library, then there
-   * is no source data to pull.
-   */
-  const hasSourceData = !!validProjects.length || shouldFetchComponentLibrary;
-
-  const result: SourceInformation = {
-    hasSourceData,
-    validProjects,
-    shouldFetchComponentLibrary,
-    variants: variants || false,
-    format,
-    status,
-    richText,
-    hasTopLevelProjectsField: !!projectsRoot,
-    hasTopLevelComponentsField: !!componentsRoot,
-    hasComponentLibraryInProjects,
-    componentRoot,
-    componentFolders,
-    localeByVariantApiId: iosLocales
-      ? iosLocales.reduce((acc, e) => ({ ...acc, ...e }), {} as any)
-      : undefined,
-    disableJsDriver,
-  };
-
-  Sentry.setContext("config", createSentryContext(result));
-
-  return result;
-}
-
-export default {
-  createFileIfMissing,
-  readProjectConfigData,
-  readGlobalConfigData,
-  writeGlobalConfigData,
-  writeProjectConfigData,
-  justTheHost,
-  saveToken,
-  deleteToken,
-  getToken,
-  getTokenFromEnv,
-  parseSourceInformation,
-};

package/lib/consts.ts

@@ -1,22 +0,0 @@
-import { homedir } from "os";
-import path from "path";
-
-export default new (class {
-  get API_HOST() {
-    return process.env.DITTO_API_HOST || "https://api.dittowords.com";
-  }
-  get CONFIG_FILE() {
-    return (
-      process.env.DITTO_CONFIG_FILE || path.join(homedir(), ".config", "ditto")
-    );
-  }
-  get PROJECT_CONFIG_FILE() {
-    return path.normalize(path.join("ditto", "config.yml"));
-  }
-  get TEXT_DIR() {
-    return process.env.DITTO_TEXT_DIR || "ditto";
-  }
-  get TEXT_FILE() {
-    return path.normalize(path.join(this.TEXT_DIR, "text.json"));
-  }
-})();

package/lib/ditto.ts

@@ -1,285 +0,0 @@
-#!/usr/bin/env node
-// This is the main entry point for the ditto-cli command.
-import { program } from "commander";
-// to use V8's code cache to speed up instantiation time
-import "v8-compile-cache";
-import fs from "fs";
-import path from "path";
-import * as Sentry from "@sentry/node";
-import { version as release } from "../package.json";
-import { init, needsTokenOrSource } from "./init/init";
-import { pull } from "./pull";
-import { quit } from "./utils/quit";
-import addProject from "./add-project";
-import removeProject from "./remove-project";
-import { replace } from "./replace";
-import { generateSuggestions } from "./generate-suggestions";
-import processMetaOption from "./utils/processMetaOption";
-import { importComponents } from "./importComponents";
-import { showComponentFolders } from "./component-folders";
-
-const environment = process.env.ENV || "development";
-Sentry.init({ dsn: process.env.SENTRY_DSN, environment, release });
-
-function getVersion(): string {
-  const packageJsonPath = path.join(__dirname, "..", "package.json");
-  const packageJsonContent = fs.readFileSync(packageJsonPath, "utf8");
-  const packageJson = JSON.parse(packageJsonContent) as { version: string };
-  return packageJson.version;
-}
-
-const VERSION = getVersion();
-
-const CONFIG_FILE_RELIANT_COMMANDS = [
-  "pull",
-  "none",
-  "project",
-  "project add",
-  "project remove",
-];
-
-type Command =
-  | "pull"
-  | "project"
-  | "project add"
-  | "project remove"
-  | "component-folders"
-  | "generate-suggestions"
-  | "replace"
-  | "import-components";
-
-interface CommandConfig<T extends Command | "add" | "remove"> {
-  name: T;
-  description: string;
-  commands?: CommandConfig<"add" | "remove">[];
-  flags?: {
-    [flag: string]: { description: string; processor?: (value: string) => any };
-  };
-}
-
-const COMMANDS: CommandConfig<Command>[] = [
-  {
-    name: "pull",
-    description: "Sync copy from Ditto into the current working directory",
-    flags: {
-      "--sample-data": {
-        description: "Include sample data. Currently only supports variants.",
-      },
-    },
-  },
-  {
-    name: "project",
-    description: "Add a Ditto project to sync copy from",
-    commands: [
-      {
-        name: "add",
-        description: "Add a Ditto project to sync copy from",
-      },
-      {
-        name: "remove",
-        description: "Stop syncing copy from a Ditto project",
-      },
-    ],
-  },
-  {
-    name: "component-folders",
-    description:
-      "List component folders in your workspace. More information about component folders can be found here: https://www.dittowords.com/docs/component-folders.",
-    flags: {
-      "-s, --sample-data": {
-        description: "Includes the sample components folder in the output",
-      },
-    },
-  },
-  {
-    name: "generate-suggestions",
-    description: "Find text that can be potentially replaced with Ditto text",
-    flags: {
-      "-d, --directory [value]": {
-        description: "Directory to search for text",
-      },
-      "-f, --files [value]": {
-        description: "Files to search for text (will override -d)",
-        processor: (value: string) => value.split(","),
-      },
-      "-cf, --component-folder [value]": {
-        description: "Component folder to search for matches",
-      },
-    },
-  },
-  {
-    name: "replace",
-    description: "Find and replace Ditto text with code",
-    flags: {
-      "-ln, --line-numbers [value]": {
-        description: "Only replace text on a specific line number",
-        processor: (value: string) => value.split(",").map(Number),
-      },
-    },
-  },
-  {
-    name: "import-components",
-    description:
-      "Import components via a file. For more information please see: https://www.dittowords.com/docs/importing-string-files.",
-    flags: {
-      "-t, --text [value]": {
-        description: "Text column index (.csv format only)",
-      },
-      "-n, --component-name [value]": {
-        description: "Name column indexes (comma separated) (.csv format only)",
-      },
-      "-no, --notes [value]": {
-        description: "Notes column index (.csv format only)",
-      },
-      "-t, --tags [value]": {
-        description: "Tags column index (.csv format only)",
-      },
-      "-s, --status [value]": {
-        description: "Status column index (.csv format only)",
-      },
-      "-c, --component-id [value]": {
-        description: "Component ID column index (.csv format only)",
-      },
-    },
-  },
-];
-
-const setupCommands = () => {
-  program.name("ditto-cli");
-
-  COMMANDS.forEach((commandConfig) => {
-    const cmd = program
-      .command(commandConfig.name)
-      .description(commandConfig.description)
-      .action((options) => {
-        return executeCommand(commandConfig.name, options);
-      });
-
-    if (commandConfig.flags) {
-      Object.entries(commandConfig.flags).forEach(
-        ([flags, { description, processor }]) => {
-          if (processor) {
-            cmd.option(flags, description, processor);
-          } else {
-            cmd.option(flags, description);
-          }
-        }
-      );
-    }
-
-    if ("commands" in commandConfig && commandConfig.commands) {
-      commandConfig.commands.forEach((nestedCommand) => {
-        cmd
-          .command(nestedCommand.name)
-          .description(nestedCommand.description)
-          .action((str, options) => {
-            if (commandConfig.name === "project") {
-              const command =
-                `${commandConfig.name} ${nestedCommand.name}` as Command;
-
-              return executeCommand(command, options);
-            }
-          });
-      });
-    }
-  });
-};
-
-const setupOptions = () => {
-  program.option(
-    "-m, --meta <data...>",
-    "Include arbitrary data in requests to the Ditto API. Ex: -m githubActionRequest:true trigger:manual"
-  );
-  program.version(VERSION, "-v, --version", "Output the current version");
-};
-
-const executeCommand = async (
-  command: Command | "none",
-  options: any
-): Promise<void> => {
-  const needsInitialization =
-    CONFIG_FILE_RELIANT_COMMANDS.includes(command) && needsTokenOrSource();
-
-  if (needsInitialization) {
-    try {
-      await init();
-    } catch (error) {
-      await quit("Exiting Ditto CLI...");
-      return;
-    }
-  }
-
-  const { meta } = program.opts();
-  switch (command) {
-    case "none":
-    case "pull": {
-      return pull({
-        meta: processMetaOption(meta),
-        includeSampleData: options.sampleData || false,
-      });
-    }
-    case "project":
-    case "project add": {
-      // initialization already includes the selection of a source,
-      // so if `project add` is called during initialization, don't
-      // prompt the user to select a source again
-      if (needsInitialization) return;
-
-      return addProject();
-    }
-    case "project remove": {
-      return removeProject();
-    }
-    case "component-folders": {
-      return showComponentFolders({
-        showSampleData: options.sampleData,
-      });
-    }
-    case "generate-suggestions": {
-      return generateSuggestions({
-        directory: options.directory,
-        files: options.files,
-        componentFolder: options.componentFolder,
-      });
-    }
-    case "replace": {
-      return replace(options.args, {
-        ...(options?.lineNumbers ? { lineNumbers: options.lineNumbers } : {}),
-      });
-    }
-    case "import-components": {
-      if (options.args.length === 0) {
-        console.info("Please provide a file path.");
-        return;
-      }
-      return importComponents(options.args[0], {
-        csvColumnMapping: {
-          name: options.componentName,
-          text: options.text,
-          notes: options.notes,
-          tags: options.tags,
-          status: options.status,
-          componentId: options.componentId,
-        },
-      });
-    }
-    default: {
-      await quit("Exiting Ditto CLI...");
-      return;
-    }
-  }
-};
-
-const main = async () => {
-  setupCommands();
-  setupOptions();
-
-  if (process.argv.length <= 2 && process.argv[1].includes("ditto-cli")) {
-    await executeCommand("none", []);
-    return;
-  }
-
-  program.parse(process.argv);
-};
-
-main();