@dittowords/cli 2.5.1 → 2.6.0

package/lib/{remove-project.js → remove-project.ts}

@@ -1,11 +1,11 @@
-const config = require("./config");
-const consts = require("./consts");
-const output = require("./output");
-const {
+import config from "./config";
+import consts from "./consts";
+import output from "./output";
+import {
   getSelectedProjects,
   getIsUsingComponents,
-} = require("./utils/getSelectedProjects");
-const promptForProject = require("./utils/promptForProject");
+} from "./utils/getSelectedProjects";
+import promptForProject from "./utils/promptForProject";
 
 async function removeProject() {
   const projects = getSelectedProjects();
@@ -13,17 +13,14 @@ async function removeProject() {
   if (!projects.length && !isUsingComponents) {
     console.log(
       "\n" +
-        "No projects found in your workspace.\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: "ditto_component_library", name: "Ditto Component Library" },
-        ...projects,
-      ]
+    ? [{ id: "components", name: "Ditto Component Library" }, ...projects]
     : projects;
 
   const projectToRemove = await promptForProject({
@@ -34,9 +31,8 @@ async function removeProject() {
   });
   if (!projectToRemove) return;
 
-  config.writeData(consts.PROJECT_CONFIG_FILE, {
-    components:
-      isUsingComponents && projectToRemove.id !== "ditto_component_library",
+  config.writeProjectConfigData(consts.PROJECT_CONFIG_FILE, {
+    components: isUsingComponents && projectToRemove.id !== "components",
     projects: projects.filter(({ id }) => id !== projectToRemove.id),
   });
 
@@ -51,4 +47,4 @@ async function removeProject() {
   );
 }
 
-module.exports = removeProject;
+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.1",
+  "version": "2.6.0",
   "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"]
+}