feat: csv picker

Author: JDIZM

package-lock.json

@@ -1,11 +1,11 @@
 {
-  "name": "compound-interest",
+  "name": "csv-picker",
   "version": "1.0.0",
   "description": "",
   "main": "dist/src/index.js",
   "module": "dist/src/index.esm.js",
   "bin": {
-    "pkg-name": "./dist/src/index.js"
+    "csv-picker": "./dist/src/index.js"
   },
   "scripts": {
     "dev": "npx vite-node ./src/index.ts",
@@ -21,6 +21,8 @@
   "author": "",
   "license": "ISC",
   "devDependencies": {
+    "cac": "^6.7.14",
+    "chalk": "^4.1.2",
     "@types/node": "^20.2.1",
     "@typescript-eslint/eslint-plugin": "^5.57.0",
     "@typescript-eslint/parser": "^5.57.0",

package.json

@@ -0,0 +1,12 @@
+import { logger } from "./logger";
+
+export const checkColumns = (columns: string[]) => {
+  logger.info("checking csv columns...");
+  const requiredColumns = ["product_code", "quantity", "pick_location"];
+  const missingColumns = requiredColumns.filter((requiredColumn) => !columns.includes(requiredColumn));
+  if (missingColumns.length) {
+    logger.error(`Missing columns: ${missingColumns.join(", ")}`);
+    process.exit(1);
+  }
+  logger.success("all columns present");
+};

src/exampleFunction.test.ts

@@ -0,0 +1,20 @@
+import { writeFileSync } from "fs";
+import { logger } from "./logger";
+
+export const formatRow = (row: string[]) => row.join(",");
+export const formatCsv = (data: string[][]) => data.map(formatRow).join("\r\n");
+
+export const createCsvFile = (path: string, data: string[][]) => {
+  try {
+    logger.info("creating csv file...");
+    const csv = formatCsv(data);
+    const file = writeFileSync(path, csv);
+    logger.success(`csv file created in ${path}`);
+    return file;
+  } catch (err) {
+    if (err instanceof Error) {
+      logger.error(err.message);
+      process.exit(1);
+    }
+  }
+};

src/exampleFunction.ts

@@ -0,0 +1,82 @@
+import { describe, expect, it, vi } from "vitest";
+import { writeFileSync } from "fs";
+import { formatRow, formatCsv, createCsvFile } from "./createFile";
+import { parseCsv } from "./parseCsv";
+
+vi.mock("fs", async () => ({
+  default: vi.fn(),
+  writeFileSync: vi.fn().mockReturnValue("foo")
+}));
+
+describe("createCsvFile", () => {
+  const data = [
+    ["product_code", "quantity", "pick_location"],
+    ["B1234", "2", "A1"],
+    ["B1235", "3", "A2"],
+    ["B1236", "4", "A3"]
+  ];
+
+  describe("formatRow", () => {
+    it("should format a row", () => {
+      const row = ["product_code", "quantity", "pick_location"];
+      const formatted = formatRow(row);
+      expect(formatted).toBe("product_code,quantity,pick_location");
+    });
+  });
+
+  describe("formatCsv", () => {
+    it("should format a csv", () => {
+      const formatted = formatCsv(data);
+      expect(formatted).toBe("product_code,quantity,pick_location\r\nB1234,2,A1\r\nB1235,3,A2\r\nB1236,4,A3");
+    });
+  });
+
+  it("should create a csv file", () => {
+    const csv = createCsvFile("./src/output.csv", data);
+    const formatted = formatCsv(data);
+    expect(writeFileSync).toBeCalled();
+    expect(writeFileSync).toHaveBeenCalledWith("./src/output.csv", formatted);
+    expect(csv).toBe("foo");
+  });
+});
+
+describe("parseCsv", () => {
+  it("should return an array of arrays", () => {
+    const csv = `product_code,quantity,pick_location\r\n
+                  B1234,2,A1\r\n
+                  B1235,3,A2\r\n
+                  B1236,4,A3\r\n`;
+    const parsed = parseCsv(csv);
+    expect(parsed).toEqual([
+      ["product_code", "quantity", "pick_location"],
+      ["B1234", "2", "A1"],
+      ["B1235", "3", "A2"],
+      ["B1236", "4", "A3"]
+    ]);
+  });
+  it("should trim whitespace and trailing commas", () => {
+    const csv = `product_code,quantity,pick_location,   \r\n  
+                  B1234,2,A1 \r\n 
+                  B1235,3,A2,  \r\n
+                  B1236,4,A3    \r\n`;
+    const parsed = parseCsv(csv);
+    expect(parsed).toEqual([
+      ["product_code", "quantity", "pick_location"],
+      ["B1234", "2", "A1"],
+      ["B1235", "3", "A2"],
+      ["B1236", "4", "A3"]
+    ]);
+  });
+});
+
+describe("readCsv", () => {
+  it.todo("should read a csv file");
+});
+
+describe("logger", () => {
+  it.todo("should log messages to the console");
+});
+
+describe("checkColumns", () => {
+  it.todo("should check for required columns in csv file");
+});

src/helpers/checkColumns.ts

@@ -0,0 +1,5 @@
+export { createCsvFile } from "./createFile";
+export { parseCsv } from "./parseCsv";
+export { logger } from "./logger";
+export { checkColumns } from "./checkColumns";
+export { readCsvSync } from "./readCsv";

src/helpers/createFile.ts

@@ -0,0 +1,10 @@
+import chalk from "chalk";
+
+export const logger = {
+  info: (message: string) => console.log(chalk.blue(message)),
+  error: (message: string) => console.log(chalk.red(message)),
+  warn: (message: string) => console.log(chalk.yellow(message)),
+  success: (message: string) => console.log(chalk.green(message))
+};
+
+export default logger;

src/helpers/helpers.test.ts

@@ -0,0 +1,18 @@
+import { ProductTuple } from "./sort";
+
+export const parseCsv = (csv: string): ProductTuple[] => {
+  const rows = csv.split("\r");
+
+  const trimmedRows = rows.map((row) => {
+    const trimmed = row.trim();
+    if (!trimmed.length) {
+      return [];
+    }
+    const [productCode, qty, pickLocation] = trimmed.split(",");
+    return [productCode, qty, pickLocation];
+  });
+
+  const result = trimmedRows.filter((row) => row.length === 3) as ProductTuple[];
+
+  return result;
+};