chatgpt-to-markdown 1.5.3 → 1.5.5

package/README.md

@@ -97,6 +97,8 @@ git push --follow-tags
 
 ## Release notes
 
+- 1.5.5: 02 Nov 2024. Add conversation link. Use conversation ID as fallback title if title is empty.
+- 1.5.4: 02 Nov 2024. Skip `user_editable_context` to avoid polluting Markdown with custom instructions
 - 1.5.3: 05 Aug 2024. Show text from multimodal prompts
 - 1.5.2: 05 Aug 2024. Show tether_browsing_display summary
 - 1.5.1: 22 Mar 2024. Handle unicode filenames

package/cli.js

@@ -10,15 +10,10 @@ async function run() {
     process.exit(1);
   }
 
-  try {
-    const data = await fs.readFile(filePath, "utf8");
-    const json = JSON.parse(data);
-    const sourceDir = path.dirname(filePath);
-    await chatgptToMarkdown(json, sourceDir);
-  } catch (err) {
-    console.error("Error:", err.message);
-    process.exit(1);
-  }
+  const data = await fs.readFile(filePath, "utf8");
+  const json = JSON.parse(data);
+  const sourceDir = path.dirname(filePath);
+  await chatgptToMarkdown(json, sourceDir);
 }
 
 run();

package/index.js

@@ -34,7 +34,7 @@ function wrapHtmlTagsInBackticks(text) {
 function indent(str) {
   return str
     .split("\n")
-    .map((v) => `    ${v}\n`)
+    .map((v) => (v.trim() ? `    ${v}\n` : ""))
     .join("");
 }
 
@@ -69,13 +69,14 @@ async function chatgptToMarkdown(json, sourceDir, { dateFormat } = { dateFormat:
   }
 
   for (const conversation of json) {
-    const sanitizedTitle = sanitizeFileName(conversation.title);
+    const sanitizedTitle = sanitizeFileName(conversation.title) || conversation.conversation_id;
     const fileName = `${sanitizedTitle}.md`;
     const filePath = path.join(sourceDir, fileName);
     const title = `# ${wrapHtmlTagsInBackticks(conversation.title)}\n`;
     const metadata = [
       `- Created: ${dateFormat(new Date(conversation.create_time * 1000))}\n`,
       `- Updated: ${dateFormat(new Date(conversation.update_time * 1000))}\n`,
+      `- Link: https://chatgpt.com/c/${conversation.conversation_id}\n`,
     ].join("");
     const messages = Object.values(conversation.mapping)
       .map((node) => {
@@ -113,6 +114,11 @@ async function chatgptToMarkdown(json, sourceDir, { dateFormat } = { dateFormat:
           case "system_error":
             body = `${content.name}\n\n${content.text}\n\n`;
             break;
+          case "user_editable_context":
+            // We don't want to pollute all Markdown with custom instuctions
+            // in content.user_instructions. So skip it
+            body = "";
+            break;
           default:
             body = content;
             break;

package/index.test.js

@@ -22,6 +22,7 @@ describe("chatgptToMarkdown", () => {
         title: "Test Conversation",
         create_time: 1630454400,
         update_time: 1630458000,
+        conversation_id: "abc123",
         mapping: {
           0: {
             message: {
@@ -42,6 +43,7 @@ describe("chatgptToMarkdown", () => {
 
 - Created: ${formatDate(1630454400 * 1000)}
 - Updated: ${formatDate(1630458000 * 1000)}
+- Link: https://chatgpt.com/c/abc123
 
 ## user (John)
 
@@ -226,4 +228,153 @@ describe("chatgptToMarkdown", () => {
     const fileContent = await fs.readFile(path.join(tempDir, "Test Conversation.md"), "utf8");
     expect(fileContent).toContain('```javascript\nconsole.log("Hello, world!");\n```\n');
   });
+
+  it("should skip user_editable_context content", async () => {
+    const json = [
+      {
+        title: "Test Conversation",
+        create_time: 1630454400,
+        update_time: 1630458000,
+        mapping: {
+          0: {
+            message: {
+              author: { role: "user" },
+              content: {
+                content_type: "user_editable_context",
+                user_profile: "test profile",
+                user_instructions: "test instructions",
+              },
+            },
+          },
+        },
+      },
+    ];
+    await chatgptToMarkdown(json, tempDir);
+    const fileContent = await fs.readFile(path.join(tempDir, "Test Conversation.md"), "utf8");
+    expect(fileContent).not.toContain("test profile");
+    expect(fileContent).not.toContain("test instructions");
+  });
+
+  it("should handle system_error content", async () => {
+    const json = [
+      {
+        title: "Test Conversation",
+        create_time: 1630454400,
+        update_time: 1630458000,
+        mapping: {
+          0: {
+            message: {
+              author: { role: "system" },
+              content: {
+                content_type: "system_error",
+                name: "Error Name",
+                text: "Error details",
+              },
+            },
+          },
+        },
+      },
+    ];
+
+    await chatgptToMarkdown(json, tempDir);
+    const fileContent = await fs.readFile(path.join(tempDir, "Test Conversation.md"), "utf8");
+    expect(fileContent).toContain("Error Name\n\nError details\n\n");
+  });
+
+  it("should handle execution_output content", async () => {
+    const json = [
+      {
+        title: "Test Conversation",
+        create_time: 1630454400,
+        update_time: 1630458000,
+        mapping: {
+          0: {
+            message: {
+              author: { role: "assistant" },
+              content: {
+                content_type: "execution_output",
+                text: "Program output",
+              },
+            },
+          },
+        },
+      },
+    ];
+
+    await chatgptToMarkdown(json, tempDir);
+    const fileContent = await fs.readFile(path.join(tempDir, "Test Conversation.md"), "utf8");
+    expect(fileContent).toContain("```\nProgram output\n```");
+  });
+
+  it("should handle code content with unknown language", async () => {
+    const json = [
+      {
+        title: "Test Conversation",
+        create_time: 1630454400,
+        update_time: 1630458000,
+        mapping: {
+          0: {
+            message: {
+              author: { role: "assistant" },
+              content: {
+                content_type: "code",
+                language: "unknown",
+                text: "some code",
+              },
+            },
+          },
+        },
+      },
+    ];
+
+    await chatgptToMarkdown(json, tempDir);
+    const fileContent = await fs.readFile(path.join(tempDir, "Test Conversation.md"), "utf8");
+    expect(fileContent).toContain("```\nsome code\n```");
+  });
+
+  it("should handle tether_browsing_display with summary", async () => {
+    const json = [
+      {
+        title: "Test Conversation",
+        create_time: 1630454400,
+        update_time: 1630458000,
+        mapping: {
+          0: {
+            message: {
+              author: { role: "tool" },
+              content: {
+                content_type: "tether_browsing_display",
+                summary: "Page Summary",
+                result: "Search Result",
+              },
+            },
+          },
+        },
+      },
+    ];
+
+    await chatgptToMarkdown(json, tempDir);
+    const fileContent = await fs.readFile(path.join(tempDir, "Test Conversation.md"), "utf8");
+    expect(fileContent).toContain("```\nPage Summary\nSearch Result\n```");
+  });
+
+  it("should throw TypeError for invalid arguments", async () => {
+    await expect(chatgptToMarkdown("not an array", tempDir)).rejects.toThrow(TypeError);
+    await expect(chatgptToMarkdown([], 123)).rejects.toThrow(TypeError);
+  });
+
+  it("should use conversation_id as filename when sanitized title is empty", async () => {
+    const json = [
+      {
+        title: "?????", // Will be sanitized to empty string
+        conversation_id: "abc123",
+        create_time: 1630454400,
+        update_time: 1630458000,
+        mapping: {},
+      },
+    ];
+
+    await chatgptToMarkdown(json, tempDir);
+    await expect(fs.access(path.join(tempDir, "abc123.md"))).resolves.not.toThrow();
+  });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chatgpt-to-markdown",
-  "version": "1.5.3",
+  "version": "1.5.5",
   "description": "Convert ChatGPT exported conversations.json to Markdown",
   "main": "index.js",
   "type": "module",