@dittowords/cli 2.5.0 → 2.5.2

package/lib/add-project.js

@@ -1,30 +0,0 @@
-const { collectAndSaveProject } = require("./init/project");
-const projectsToText = require("./utils/projectsToText");
-const getSelectedProjects = require("./utils/getSelectedProjects");
-
-function quit(exitCode = 2) {
-  console.log("Project selection was not updated.");
-  process.exitCode = exitCode;
-  process.exit();
-}
-
-const addProject = async () => {
-  const projects = getSelectedProjects();
-
-  try {
-    console.log(
-      `\nYou're currently set up to sync text from the following projects: ${projectsToText(
-        projects
-      )}`
-    );
-    await collectAndSaveProject(false);
-  } catch (error) {
-    console.log(
-      `\nSorry, there was an error adding a project to your workspace: `,
-      error
-    );
-    quit();
-  }
-};
-
-module.exports = addProject;

package/lib/api.js

@@ -1,18 +0,0 @@
-const axios = require("axios").default;
-
-const config = require("./config");
-const consts = require("./consts");
-
-function create(token) {
-  return axios.create({
-    baseURL: consts.API_HOST,
-    headers: {
-      Authorization: `token ${token}`,
-    },
-  });
-}
-
-module.exports = { create };
-module.exports.default = create(
-  config.getToken(consts.CONFIG_FILE, consts.API_HOST)
-);

package/lib/config.js

@@ -1,169 +0,0 @@
-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);
-
-  if (!fs.existsSync(dir)) fs.mkdirSync(dir);
-
-  if (!fs.existsSync(filename)) {
-    fs.closeSync(fs.openSync(filename, "w"));
-  }
-}
-
-/**
- * Read data from a file
- * @param {string} 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;
-}
-
-function writeData(file, data) {
-  createFileIfMissing(file);
-  const existingData = readData(file);
-  const yamlStr = yaml.safeDump({ ...existingData, ...data });
-  fs.writeFileSync(file, yamlStr, "utf8");
-}
-
-function justTheHost(host) {
-  if (!host.includes("://")) return host;
-  return url.parse(host).hostname;
-}
-
-function deleteToken(file, host) {
-  const data = readData(file);
-  const hostParsed = justTheHost(host);
-  data[hostParsed] = [];
-  data[hostParsed][0] = {};
-  data[hostParsed][0].token = "";
-  writeData(file, data);
-}
-
-function saveToken(file, host, token) {
-  const data = readData(file);
-  const hostParsed = justTheHost(host);
-  data[hostParsed] = []; // only allow one token per host
-  data[hostParsed][0] = {};
-  data[hostParsed][0].token = token;
-  writeData(file, data);
-}
-
-function getTokenFromEnv() {
-  return process.env.DITTO_API_KEY;
-}
-
-function getToken(file, host) {
-  const tokenFromEnv = getTokenFromEnv();
-  if (tokenFromEnv) {
-    return tokenFromEnv;
-  }
-
-  const data = readData(file);
-  const hostEntry = data[justTheHost(host)];
-  if (!hostEntry) return undefined;
-  const { length } = hostEntry;
-  return hostEntry[length - 1].token;
-}
-
-function save(file, key, value) {
-  const data = readData(file);
-  let current = data;
-  const parts = key.split(".");
-  parts.slice(0, -1).forEach((part) => {
-    if (!(part in current)) {
-      current[part] = {};
-      current = current[part];
-    }
-  });
-  current[parts.slice(-1)] = value;
-  writeData(file, data);
-}
-
-const IS_DUPLICATE = /-(\d+$)/;
-function dedupeProjectName(projectNames, projectName) {
-  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() {
-  const { projects, components, variants, format } = readData();
-
-  const projectNames = new Set();
-  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.add(project.fileName);
-
-    validProjects.push(project);
-  });
-
-  const shouldFetchComponentLibrary =
-    !!components || componentLibraryInProjects;
-
-  const hasSourceData = validProjects.length || shouldFetchComponentLibrary;
-
-  return {
-    hasSourceData,
-    validProjects,
-    shouldFetchComponentLibrary,
-    variants,
-    format,
-  };
-}
-
-module.exports = {
-  createFileIfMissing,
-  readData,
-  writeData,
-  justTheHost,
-  saveToken,
-  deleteToken,
-  getToken,
-  getTokenFromEnv,
-  save,
-  parseSourceInformation,
-};

package/lib/consts.js

@@ -1,14 +0,0 @@
-const homedir = require("os").homedir();
-const path = require("path");
-
-const TEXT_DIR = process.env.DITTO_TEXT_DIR || "ditto"
-
-module.exports.API_HOST =
-  process.env.DITTO_API_HOST || "https://api.dittowords.com";
-module.exports.CONFIG_FILE =
-  process.env.DITTO_CONFIG_FILE || path.join(homedir, ".config", "ditto");
-module.exports.PROJECT_CONFIG_FILE = path.normalize(
-  path.join("ditto", "config.yml")
-);
-module.exports.TEXT_DIR = TEXT_DIR
-module.exports.TEXT_FILE = path.normalize(path.join(TEXT_DIR, "text.json"));

package/lib/init/project.test.js

@@ -1,99 +0,0 @@
-const fs = require("fs");
-const path = require("path");
-
-const rewire = require("rewire");
-const yaml = require("js-yaml");
-const { createFileIfMissing } = require("../config");
-
-const project = rewire("./project");
-
-const { needsProject } = project;
-
-const saveProject = project.__get__("saveProject");
-const parseResponse = project.__get__("parseResponse");
-
-const fakeProjectDir = path.join(__dirname, "../../testing/tmp");
-const badYaml = path.join(__dirname, "../../testing/fixtures/bad-yaml.yml");
-const configEmptyProjects = path.join(
-  __dirname,
-  "../../testing/fixtures/bad-yaml.yml"
-);
-const configMissingName = path.join(
-  __dirname,
-  "../../testing/fixtures/project-config-no-name.yml"
-);
-const configMissingId = path.join(
-  __dirname,
-  "../../testing/fixtures/project-config-no-id.yml"
-);
-const configLegit = path.join(
-  __dirname,
-  "../../testing/fixtures/project-config-working.yml"
-);
-
-describe("saveProject", () => {
-  const configFile = path.join(fakeProjectDir, "ditto/config.yml");
-  const projectName = "My Amazing Project";
-  const projectId = "5f284259ce1d451b2eb2e23c";
-
-  beforeEach(() => {
-    if (!fs.existsSync(fakeProjectDir)) fs.mkdirSync(fakeProjectDir);
-    saveProject(configFile, projectName, projectId);
-  });
-
-  afterEach(() => {
-    fs.rmdirSync(fakeProjectDir, { recursive: true });
-  });
-
-  it("creates a config file with config data", () => {
-    const fileContents = fs.readFileSync(configFile, "utf8");
-    const data = yaml.safeLoad(fileContents);
-    expect(data.projects).toBeDefined();
-    expect(data.projects[0].name).toEqual(projectName);
-    expect(data.projects[0].id).toEqual(projectId);
-  });
-});
-
-describe("needsProject()", () => {
-  const configFile = path.join(fakeProjectDir, "ditto/config.yml");
-  it("is true if there is no existing config file", () => {
-    expect(needsProject(configFile)).toBeTruthy();
-  });
-
-  describe("with a file that exists", () => {
-    beforeEach(() => {
-      if (!fs.existsSync(fakeProjectDir)) fs.mkdirSync(fakeProjectDir);
-      createFileIfMissing(configFile);
-    });
-
-    it("is true if the file has no projects", () => {
-      expect(needsProject(configFile)).toBeTruthy();
-    });
-
-    it.each([
-      ["the file is bad yaml", badYaml],
-      ["no entries exist under projects", configEmptyProjects],
-      ["an entry exists without a name", configMissingName],
-      ["an entry exists without an id", configMissingId],
-    ])("is true if %s", (_msg, file) => {
-      expect(fs.existsSync(file)).toBeTruthy();
-      expect(needsProject(file)).toBeTruthy();
-    });
-
-    it("is false if a file exists with a propper project", () => {
-      expect(fs.existsSync(configLegit)).toBeTruthy();
-      expect(needsProject(configLegit)).toBeFalsy();
-    });
-  });
-});
-
-describe("parseResponse", () => {
-  const result =
-    "Large file test http://localhost:3000/doc/5ea120d8b56b315ffddb0ef8";
-  it("returns the id, name for a project result", () => {
-    expect(parseResponse(result)).toEqual({
-      id: "5ea120d8b56b315ffddb0ef8",
-      name: "Large file test",
-    });
-  });
-});

package/lib/output.js

@@ -1,21 +0,0 @@
-const chalk = require("chalk");
-
-const errorText = (msg) => chalk.magenta(msg);
-const warnText = (msg) => chalk.yellow(msg);
-const info = (msg) => chalk.blueBright(msg);
-const success = (msg) => chalk.green(msg);
-const url = (msg) => chalk.blueBright.underline(msg);
-const subtle = (msg) => chalk.grey(msg);
-const write = (msg) => chalk.white(msg);
-const nl = () => console.log("\n");
-
-module.exports = {
-  errorText,
-  warnText,
-  url,
-  info,
-  write,
-  subtle,
-  nl,
-  success,
-};

package/lib/pull.test.js

@@ -1,173 +0,0 @@
-const fs = require("fs");
-const yaml = require("js-yaml");
-const path = require("path");
-const api = require("./api");
-
-const rewire = require("rewire");
-const rewireConfig = rewire("./config");
-rewireConfig.__set__("readData", () => {
-  const fileContents = fs.readFileSync(file, "utf8");
-  return yaml.safeLoad(fileContents) || defaultData;
-});
-
-jest.mock("./api");
-api.default.get.mockResolvedValue({ data: [] });
-
-jest.mock("./consts", () => ({
-  TEXT_DIR: ".testing",
-  API_HOST: "https://api.dittowords.com",
-  CONFIG_FILE: ".testing/ditto",
-  PROJECT_CONFIG_FILE: ".testing/config.yml",
-  TEXT_FILE: ".testing/text.json",
-  TEXT_DIR: ".testing",
-}));
-
-const consts = require("./consts");
-const {
-  pull,
-  _testing: {
-    cleanOutputFiles,
-    getProjectsWithDedupedNames,
-    downloadAndSaveVariant,
-    downloadAndSaveBase,
-  },
-} = require("./pull");
-
-const testProjects = [
-  {
-    id: 1,
-    name: "Project 1",
-  },
-  { id: 2, name: "Project 2" },
-];
-const variant = "english";
-
-const cleanOutputDir = () => {
-  if (fs.existsSync(consts.TEXT_DIR))
-    fs.rmdirSync(consts.TEXT_DIR, { force: true, recursive: true });
-
-  fs.mkdirSync(consts.TEXT_DIR);
-};
-
-afterAll(() => {
-  fs.rmdirSync(consts.TEXT_DIR, { force: true, recursive: true });
-});
-
-describe("cleanOutputFiles", () => {
-  it("removes .js and .json files", () => {
-    cleanOutputDir();
-
-    fs.writeFileSync(path.resolve(consts.TEXT_DIR, "test.json"), "test");
-    fs.writeFileSync(path.resolve(consts.TEXT_DIR, "test.js"), "test");
-    // this file shouldn't be deleted
-    fs.writeFileSync(path.resolve(consts.TEXT_DIR, "test.txt"), "test");
-
-    expect(fs.readdirSync(consts.TEXT_DIR).length).toEqual(3);
-
-    cleanOutputFiles();
-
-    expect(fs.readdirSync(consts.TEXT_DIR).length).toEqual(1);
-  });
-});
-
-describe("getProjectsWithDedupedNames", () => {
-  it("dedupes projects with the same name", () => {
-    const projects = [
-      { id: 1, name: "project" },
-      { id: 2, name: "project" },
-      { id: 3, name: "project" },
-      { id: 4, name: "project-other" },
-    ];
-
-    expect(getProjectsWithDedupedNames(projects)).toEqual([
-      { id: 1, name: "project" },
-      { id: 2, name: "project-1" },
-      { id: 3, name: "project-2" },
-      { id: 4, name: "project-other" },
-    ]);
-  });
-});
-
-describe("downloadAndSaveVariant", () => {
-  beforeAll(() => {
-    if (!fs.existsSync(consts.TEXT_DIR)) {
-      fs.mkdirSync(consts.TEXT_DIR);
-    }
-  });
-
-  it("writes a single file for default format", async () => {
-    cleanOutputDir();
-
-    const output = await downloadAndSaveVariant(variant, testProjects);
-
-    expect(/saved to.*english\.json/.test(output)).toEqual(true);
-    expect(output.match(/saved to/g).length).toEqual(1);
-    expect(fs.readdirSync(consts.TEXT_DIR).length).toEqual(1);
-  });
-
-  it("writes multiple files for flat format", async () => {
-    cleanOutputDir();
-
-    const output = await downloadAndSaveVariant(variant, testProjects, "flat");
-
-    expect(/saved to.*Project 1__english\.json/.test(output)).toEqual(true);
-    expect(/saved to.*Project 2__english\.json/.test(output)).toEqual(true);
-    expect(output.match(/saved to/g).length).toEqual(2);
-    expect(fs.readdirSync(consts.TEXT_DIR).length).toEqual(2);
-  });
-
-  it("writes multiple files for structured format", async () => {
-    cleanOutputDir();
-
-    const output = await downloadAndSaveVariant(
-      variant,
-      testProjects,
-      "structured"
-    );
-
-    expect(/saved to.*Project 1__english\.json/.test(output)).toEqual(true);
-    expect(/saved to.*Project 2__english\.json/.test(output)).toEqual(true);
-    expect(output.match(/saved to/g).length).toEqual(2);
-    expect(fs.readdirSync(consts.TEXT_DIR).length).toEqual(2);
-  });
-});
-
-describe("downloadAndSaveBase", () => {
-  beforeAll(() => {
-    if (!fs.existsSync(consts.TEXT_DIR)) {
-      fs.mkdirSync(consts.TEXT_DIR);
-    }
-  });
-
-  it("writes to text.json for default format", async () => {
-    cleanOutputDir();
-
-    const output = await downloadAndSaveBase(testProjects);
-
-    expect(/saved to.*text\.json/.test(output)).toEqual(true);
-    expect(output.match(/saved to/g).length).toEqual(1);
-    expect(fs.readdirSync(consts.TEXT_DIR).length).toEqual(1);
-  });
-
-  it("writes multiple files for flat format", async () => {
-    cleanOutputDir();
-
-    const output = await downloadAndSaveBase(testProjects, "flat");
-
-    expect(/saved to.*Project 1\.json/.test(output)).toEqual(true);
-    expect(/saved to.*Project 2\.json/.test(output)).toEqual(true);
-    expect(output.match(/saved to/g).length).toEqual(2);
-    expect(fs.readdirSync(consts.TEXT_DIR).length).toEqual(2);
-  });
-
-  it("writes multiple files for structured format", async () => {
-    cleanOutputDir();
-
-    const output = await downloadAndSaveBase(testProjects, "structured");
-
-    expect(/saved to.*Project 1\.json/.test(output)).toEqual(true);
-    expect(/saved to.*Project 2\.json/.test(output)).toEqual(true);
-    expect(output.match(/saved to/g).length).toEqual(2);
-    expect(fs.readdirSync(consts.TEXT_DIR).length).toEqual(2);
-  });
-});

package/lib/remove-project.js

@@ -1,39 +0,0 @@
-const config = require("./config");
-const consts = require("./consts");
-const output = require("./output");
-const getSelectedProjects = require("./utils/getSelectedProjects");
-const promptForProject = require("./utils/promptForProject");
-
-async function removeProject() {
-  const projects = getSelectedProjects();
-  if (!projects.length) {
-    console.log(
-      "\n" +
-        "No projects found in your workspace.\n" +
-        `Try adding one with: ${output.info("ditto-cli project add")}\n`
-    );
-    return;
-  }
-
-  const projectToRemove = await promptForProject({
-    projects,
-    message: "Select a project to remove",
-  });
-  if (!projectToRemove) return;
-
-  config.writeData(consts.PROJECT_CONFIG_FILE, {
-    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"
-  );
-}
-
-module.exports = removeProject;

package/lib/utils/getSelectedProjects.js

@@ -1,35 +0,0 @@
-const fs = require("fs");
-const yaml = require("js-yaml");
-
-const { PROJECT_CONFIG_FILE } = require("../consts");
-
-function yamlToJson(_yaml) {
-  try {
-    return yaml.safeLoad(_yaml);
-  } catch (e) {
-    if (e instanceof YAMLException) {
-      return "";
-    } else {
-      throw e;
-    }
-  }
-}
-
-/**
- * Returns an array containing all valid projects ({ id, name })
- * currently contained in the project config file.
- */
-function getSelectedProjects(configFile = PROJECT_CONFIG_FILE) {
-  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);
-}
-
-module.exports = getSelectedProjects;

package/lib/utils/processMetaOption.js

@@ -1,16 +0,0 @@
-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

@@ -1,16 +0,0 @@
-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,
-    });
-  });
-});