chatgpt-to-markdown 1.0.0 → 1.2.0

package/README.md

@@ -65,13 +65,15 @@ const json = [
 ];
 
 const sourceDir = "./output";
-
+const options = {
+  dateFormat: (d) => d.toLocaleString(),
+};
 chatgptToMarkdown(json, sourceDir);
 ```
 
 ## Options
 
-Currently, there are no additional options. Feel free to open an issue or submit a PR if there's a feature you'd like to see added!
+- `dateFormat`: A function that takes a `Date` object and returns a string. Defaults to a string format like "1 Jan 2023 11:30 PM".
 
 ## Contributing
 
@@ -95,6 +97,8 @@ git push --follow-tags
 
 ## Release notes
 
+- 1.2.0: 28 Sep 2023. Added test cases
+- 1.1.0: 26 Sep 2023. Add date format option
 - 1.0.0: 26 Sep 2023. Initial release
 
 ## License

package/index.js

@@ -37,12 +37,37 @@ function indent(str) {
     .join("\n");
 }
 
+/**
+ * Formats a date to a string like "1 Jan 2021".
+ * @param {Date} date - The date to format.
+ * @returns {string} - The formatted date.
+ * @example
+ * formatDate(new Date());
+ * //=> "1 Jan 2021"
+ */
+function formatDate(date) {
+  const month = date.toLocaleString("en", { month: "short" });
+  const min = date.getMinutes().toString().padStart(2, "0");
+  let hours = date.getHours();
+  let ampm = hours >= 12 ? "PM" : "AM";
+  hours = hours % 12;
+  hours = hours ? hours : 12; // the hour '0' should be '12'
+  return `${date.getDate()} ${month} ${date.getFullYear()} ${hours}:${min} ${ampm}`;
+}
+
 /**
  * Converts a JSON object to markdown and saves it to a file.
  * @param {Object[]} json - The JSON object to convert.
  * @param {string} sourceDir - The directory to save the markdown files in.
+ * @param {Object} [options] - The options object.
+ * @param {Function} [options.dateFormat] - The function to format dates with.
+ * @returns {Promise<void>} - A promise that resolves when the file is saved.
+ * @example
+ * const json = [ ... ];
+ * await convertToMarkdown(json, "./output");
+ * //=> Creates a markdown file for each conversation in the output directory
  */
-async function chatgptToMarkdown(json, sourceDir) {
+async function chatgptToMarkdown(json, sourceDir, { dateFormat } = { dateFormat: formatDate }) {
   if (!Array.isArray(json)) {
     throw new TypeError("The first argument must be an array.");
   }
@@ -56,8 +81,8 @@ async function chatgptToMarkdown(json, sourceDir) {
     const filePath = path.join(sourceDir, fileName);
     const title = `# ${wrapHtmlTagsInBackticks(conversation.title)}\n`;
     const metadata = [
-      `- Created: ${new Date(conversation.create_time * 1000).toLocaleString()}\n`,
-      `- Updated: ${new Date(conversation.update_time * 1000).toLocaleString()}\n`,
+      `- Created: ${dateFormat(new Date(conversation.create_time * 1000))}\n`,
+      `- Updated: ${dateFormat(new Date(conversation.update_time * 1000))}\n`,
     ].join("");
     const messages = Object.values(conversation.mapping)
       .map((node) => {

package/index.test.js

@@ -0,0 +1,152 @@
+// index.test.js
+
+import { promises as fs } from "fs";
+import path from "path";
+import os from "os";
+import chatgptToMarkdown from "./index";
+
+describe("chatgptToMarkdown", () => {
+  let tempDir;
+
+  beforeEach(async () => {
+    tempDir = await fs.mkdtemp(path.join(os.tmpdir(), "chatgptToMarkdown-"));
+  });
+
+  afterEach(async () => {
+    await fs.rm(tempDir, { recursive: true, force: true });
+  });
+
+  it("should write a markdown file for each conversation", async () => {
+    const json = [
+      {
+        title: "Test Conversation",
+        create_time: 1630454400,
+        update_time: 1630458000,
+        mapping: {
+          0: {
+            message: {
+              author: { role: "user", name: "John" },
+              content: { content_type: "text", parts: ["Hello"] },
+            },
+          },
+        },
+      },
+    ];
+
+    await chatgptToMarkdown(json, tempDir);
+
+    const filePath = path.join(tempDir, "Test Conversation.md");
+    const fileContent = await fs.readFile(filePath, "utf8");
+
+    expect(fileContent).toBe(`# Test Conversation
+
+- Created: 1 Sep 2021 5:30 AM
+- Updated: 1 Sep 2021 6:30 AM
+
+## user (John)
+
+    Hello
+
+`);
+  });
+
+  it("should handle titles with HTML tags", async () => {
+    const json = [
+      {
+        title: "<h1>Test Conversation</h1>",
+        create_time: 1630454400,
+        update_time: 1630458000,
+        mapping: {},
+      },
+    ];
+    await chatgptToMarkdown(json, tempDir);
+    const fileContent = await fs.readFile(path.join(tempDir, "h1 Test Conversation h1.md"), "utf8");
+    expect(fileContent).toContain("# `<h1>`Test Conversation`</h1>`\n");
+  });
+
+  it("should sanitize titles with invalid filename characters", async () => {
+    const json = [
+      {
+        title: ":/In\\<>*valid|?",
+        create_time: 1630454400,
+        update_time: 1630458000,
+        mapping: {},
+      },
+    ];
+    await chatgptToMarkdown(json, tempDir);
+    // Check that the file exists with the sanitized title
+    await expect(fs.access(path.join(tempDir, "In valid.md"))).resolves.not.toThrow();
+  });
+
+  it("should handle custom date format functions", async () => {
+    const json = [
+      {
+        title: "Test Conversation",
+        create_time: 1630454400,
+        update_time: 1630458000,
+        mapping: {},
+      },
+    ];
+    const customDateFormat = (date) => date.toISOString();
+    await chatgptToMarkdown(json, tempDir, { dateFormat: customDateFormat });
+    const fileContent = await fs.readFile(path.join(tempDir, "Test Conversation.md"), "utf8");
+    expect(fileContent).toContain("- Created: 2021-09-01T00:00:00.000Z\n");
+  });
+
+  it("should ignore messages with no content", async () => {
+    const json = [
+      {
+        title: "Test Conversation",
+        create_time: 1630454400,
+        update_time: 1630458000,
+        mapping: {
+          0: {
+            message: {
+              /* no content property */
+            },
+          },
+        },
+      },
+    ];
+    await chatgptToMarkdown(json, tempDir);
+    const fileContent = await fs.readFile(path.join(tempDir, "Test Conversation.md"), "utf8");
+    expect(fileContent).not.toContain("## user (John)");
+  });
+
+  it("should ignore messages with empty content", async () => {
+    const json = [
+      {
+        title: "Test Conversation",
+        create_time: 1630454400,
+        update_time: 1630458000,
+        mapping: {
+          0: { message: { content: { content_type: "text", parts: [] } } },
+        },
+      },
+    ];
+    await chatgptToMarkdown(json, tempDir);
+    const fileContent = await fs.readFile(path.join(tempDir, "Test Conversation.md"), "utf8");
+    expect(fileContent).not.toContain("## user (John)");
+  });
+
+  it("should indent messages with tool role that contain ``` fenced code blocks", async () => {
+    const json = [
+      {
+        title: "Test Conversation",
+        create_time: 1630454400,
+        update_time: 1630458000,
+        mapping: {
+          0: {
+            message: {
+              author: { role: "tool" },
+              content: { content_type: "code", language: "javascript", text: 'console.log("Hello, world!");' },
+            },
+          },
+        },
+      },
+    ];
+    await chatgptToMarkdown(json, tempDir);
+    const fileContent = await fs.readFile(path.join(tempDir, "Test Conversation.md"), "utf8");
+    expect(fileContent).toContain('```javascript\nconsole.log("Hello, world!");\n```\n');
+  });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chatgpt-to-markdown",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "Convert ChatGPT exported conversations.json to Markdown",
   "main": "index.js",
   "type": "module",
@@ -8,8 +8,8 @@
     "chatgpt-to-markdown": "cli.js"
   },
   "scripts": {
-    "prepublishOnly": "npx prettier --write *.js *.md package.json",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "prepublishOnly": "npx prettier --write *.js *.md package.json && npm test",
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js"
   },
   "keywords": [
     "chatgpt",
@@ -22,6 +22,7 @@
     "printWidth": 120
   },
   "devDependencies": {
+    "jest": "^29.7.0",
     "prettier": "^3.0.3"
   }
 }