chatgpt-to-markdown 1.7.1 → 1.8.0

package/README.md

@@ -1,8 +1,9 @@
 # ChatGPT to Markdown
 
-Convert ChatGPT conversation JSON files to Markdown format with ease.
-
 [![npm version](https://badge.fury.io/js/chatgpt-to-markdown.svg)](https://badge.fury.io/js/chatgpt-to-markdown)
+[![license](https://img.shields.io/npm/l/smartart.svg)](https://github.com/sanand0/smartart/blob/main/LICENSE)
+
+Convert ChatGPT conversation JSON files to Markdown format with ease.
 
 ## Usage
 
@@ -18,29 +19,7 @@ npx chatgpt-to-markdown path/to/your/conversations.json
 
 This will generate one Markdown file for each chat same directory as the conversations JSON file. The file name will be the chat title, with invalid filename characters replaced by spaces.
 
-## Thinking Time Analysis
-
-Analyze thinking time statistics from your ChatGPT conversations:
-
-```bash
-npx -p chatgpt-to-markdown thinktime path/to/your/conversations.json
-```
-
-This will analyze all conversations and show statistics about thinking/reasoning time, including:
-
-- Total conversations with thinking
-- Total thinking time and blocks
-- Distribution of thinking times
-- Top conversations by thinking time
-- Top individual thinking blocks
-
-Optional flag:
-
-- `--save-details`: Save detailed results to `thinking_analysis_results_node.json`
-
-## Example
-
-Here's an example of the Markdown output for a chat with the title `Medium-Style Table CSS`:
+For example, the Markdown output for a chat with the title `Medium-Style Table CSS` might look like this:
 
 ````markdown
 # Medium-Style Table CSS
@@ -67,6 +46,26 @@ table {
 ```
 ````
 
+### Thinking Time Analysis
+
+Analyze thinking time statistics from your ChatGPT conversations:
+
+```bash
+npx -p chatgpt-to-markdown thinktime path/to/your/conversations.json
+```
+
+This will analyze all conversations and show statistics about thinking/reasoning time, including:
+
+- Total conversations with thinking
+- Total thinking time and blocks
+- Distribution of thinking times
+- Top conversations by thinking time
+- Top individual thinking blocks
+
+Optional flag:
+
+- `--save-details`: Save detailed results to `thinking_analysis_results_node.json`
+
 ## Installation
 
 ```bash
@@ -91,50 +90,40 @@ const options = {
 chatgptToMarkdown(json, sourceDir);
 ```
 
-## Options
+### Options
 
 - `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
-
-- Create a new branch for your feature or bugfix.
-- Make your changes.
-
-# Contributing
+## Development
 
-- Fork the repository on GitHub and clone the fork to your machine.
-- Run `npm install` to install dependencies
-- Edit [`index.js`](index.js) or [`cli.js`](cli.js), documenting your changes
-- Push your changes back to your fork on GitHub and submit a pull request to the main repository.
+```bash
+git clone https://github.com/sanand0/chatgpt-to-markdown.git
+cd chatgpt-to-markdown
 
-# Release
+npm install
+npm run lint && npm run build && npm test
 
-```shell
-npm version minor
 npm publish
-git push --follow-tags
+git commit . -m"$COMMIT_MSG"; git tag $VERSION; git push --follow-tags
 ```
 
 ## Release notes
 
-- 1.7.1: 29 Jun 2025. Add thinktime analysis tool as npx executable. Analyze thinking/reasoning time statistics from ChatGPT conversations.
-- 1.6.0: 18 Jul 2025. Handle `thoughts`, `reasoning_recap`, `sonic_webpage`. Include projects
-- 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
-- 1.5.0: 28 Nov 2023. Handle `tether_browsing_display`, `tether_quote` and `system_error`
-- 1.4.0: 29 Oct 2023. Handle multi-modal text from Dall-E
-- 1.3.0: 29 Sep 2023. Set create and update dates from chat
-- 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
+- [1.8.0](https://npmjs.com/package/chatgpt-to-markdown/v/1.8.0): 30 Jul 2025. Standardized package.json & README.md
+- [1.7.1](https://npmjs.com/package/chatgpt-to-markdown/v/1.7.1): 29 Jun 2025. Add thinktime analysis tool as npx executable. Analyze thinking/reasoning time statistics from ChatGPT conversations
+- [1.6.0](https://npmjs.com/package/chatgpt-to-markdown/v/1.6.0): 18 Jun 2025. Handle `thoughts`, `reasoning_recap`, `sonic_webpage`. Include projects
+- [1.5.5](https://npmjs.com/package/chatgpt-to-markdown/v/1.5.5): 2 Nov 2024. Add conversation link. Use conversation ID as fallback title if title is empty
+- [1.5.4](https://npmjs.com/package/chatgpt-to-markdown/v/1.5.4): 2 Nov 2024. Skip `user_editable_context` to avoid polluting Markdown with custom instructions
+- [1.5.3](https://npmjs.com/package/chatgpt-to-markdown/v/1.5.3): 5 Aug 2024. Show text from multimodal prompts
+- [1.5.2](https://npmjs.com/package/chatgpt-to-markdown/v/1.5.2): 5 Aug 2024. Show tether_browsing_display summary
+- [1.5.1](https://npmjs.com/package/chatgpt-to-markdown/v/1.5.1): 22 Mar 2024. Handle unicode filenames
+- [1.5.0](https://npmjs.com/package/chatgpt-to-markdown/v/1.5.0): 28 Nov 2023. Handle `tether_browsing_display`, `tether_quote` and `system_error`
+- [1.4.0](https://npmjs.com/package/chatgpt-to-markdown/v/1.4.0): 29 Oct 2023. Handle multi-modal text from Dall-E
+- [1.3.0](https://npmjs.com/package/chatgpt-to-markdown/v/1.3.0): 29 Sept 2023. Set create and update dates from chat
+- [1.2.0](https://npmjs.com/package/chatgpt-to-markdown/v/1.2.0): 28 Sept 2023. Added test cases
+- [1.1.0](https://npmjs.com/package/chatgpt-to-markdown/v/1.1.0): 26 Sept 2023. Add date format option
+- [1.0.0](https://npmjs.com/package/chatgpt-to-markdown/v/1.0.0): 26 Sept 2023. Initial release
 
 ## License
 
-MIT
-
-## Support
-
-If you encounter any problems or have suggestions, please [open an issue](https://github.com/sanand0/chatgpt-to-markdown/issues) or submit a pull request.
+[MIT](LICENSE)

package/chatgpt-to-markdown-cli.js

@@ -0,0 +1,22 @@
+#!/usr/bin/env node
+import path from "path";
+import { promises as fs } from "fs";
+import chatgptToMarkdown from "./chatgpt-to-markdown.js";
+
+async function run() {
+  const filePath = process.argv[2] || "conversations.json";
+  let json;
+  try {
+    const data = await fs.readFile(filePath, "utf8");
+    json = JSON.parse(data);
+  } catch {
+    console.error(`Error: File '${filePath}' must be a JSON file`);
+    console.error("Usage: node chatgpt-to-markdown-cli.js [conversations.json]");
+    process.exit(1);
+  }
+
+  const sourceDir = path.dirname(filePath);
+  await chatgptToMarkdown(json, sourceDir);
+}
+
+run();

package/{index.js → chatgpt-to-markdown.js}

@@ -8,7 +8,7 @@ import path from "path";
  */
 function sanitizeFileName(title) {
   return title
-    .replace(/[<>:"\/\\|?*\n]/g, " ")
+    .replace(/[<>:"/\\|?*\n]/g, " ")
     .replace(/[^\w\s]/gi, " ")
     .replace(/\s+/g, " ")
     .trim();

package/package.json

@@ -1,31 +1,43 @@
 {
   "name": "chatgpt-to-markdown",
-  "version": "1.7.1",
+  "version": "1.8.0",
   "description": "Convert ChatGPT exported conversations.json to Markdown",
-  "main": "index.js",
+  "homepage": "https://github.com/sanand0/chatgpt-to-markdown",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sanand0/chatgpt-to-markdown.git"
+  },
+  "license": "MIT",
+  "author": "Anand S <root.node@gmail.com>",
   "type": "module",
+  "module": "chatgpt-to-markdown.js",
+  "prettier": {
+    "printWidth": 120
+  },
   "files": [
-    "cli.js",
-    "index.js",
+    "LICENSE",
+    "README.md",
+    "chatgpt-to-markdown.js",
     "thinktime.js",
-    "README.md"
+    "chatgpt-to-markdown-cli.js",
+    "thinktime-cli.js"
   ],
+  "exports": "./chatgpt-to-markdown.js",
   "bin": {
-    "chatgpt-to-markdown": "cli.js",
-    "thinktime": "thinktime.js"
+    "chatgpt-to-markdown": "chatgpt-to-markdown-cli.js",
+    "thinktime": "thinktime-cli.js"
   },
   "scripts": {
-    "prepublishOnly": "npx -y prettier@3.5 --write *.js *.md package.json && npm test",
-    "test": "npx -y vitest@3 run --globals"
+    "lint:oxlint": "npx -y oxlint --fix",
+    "lint:js-md": "npx -y prettier@3.5 --print-width 120 --write '**/*.js' '!**/*.min.js' '!dist/**' '**/*.md'",
+    "lint:html": "npx -y js-beautify@1 '**/*.html' --type html --replace --indent-size 2 --max-preserve-newlines 1 --end-with-newline",
+    "lint": "npm run lint:oxlint && npm run lint:js-md && npm run lint:html",
+    "test": "npx -y vitest@3 run --globals",
+    "prepublishOnly": "npm run lint && npm test"
   },
   "keywords": [
     "chatgpt",
     "markdown",
     "converter"
-  ],
-  "author": "S Anand <root.node@gmail.com>",
-  "license": "MIT",
-  "prettier": {
-    "printWidth": 120
-  }
+  ]
 }

package/thinktime-cli.js

@@ -0,0 +1,105 @@
+#!/usr/bin/env node
+import { promises as fs } from "fs";
+import { analyzeAllConversations } from "./thinktime.js";
+
+function printResults(results) {
+  /**
+   * Print analysis results in a readable format.
+   */
+  console.log("\n" + "=".repeat(60));
+  console.log("THINKING TIME ANALYSIS RESULTS");
+  console.log("=".repeat(60));
+
+  const totalConvs = results.totalConversations;
+  const thinkingConvs = results.conversationsWithThinking;
+
+  console.log(`Total conversations: ${totalConvs.toLocaleString()}`);
+  console.log(
+    `Conversations with thinking: ${thinkingConvs.toLocaleString()} (${((thinkingConvs / totalConvs) * 100).toFixed(1)}%)`,
+  );
+  console.log(`Conversations without thinking: ${(totalConvs - thinkingConvs).toLocaleString()}`);
+
+  if (thinkingConvs > 0) {
+    console.log(`\nTHINKING TIME STATISTICS:`);
+    console.log(
+      `Total thinking time: ${results.totalThinkingTime.toFixed(1)} seconds (${(results.totalThinkingTime / 60).toFixed(1)} minutes)`,
+    );
+    console.log(`Total thinking blocks: ${results.totalThinkingBlocks.toLocaleString()}`);
+    console.log(
+      `Average thinking time per conversation: ${(results.totalThinkingTime / thinkingConvs).toFixed(1)} seconds`,
+    );
+    console.log(
+      `Average thinking blocks per conversation: ${(results.totalThinkingBlocks / thinkingConvs).toFixed(1)}`,
+    );
+
+    console.log(`\nTHINKING TIME DISTRIBUTION:`);
+    for (const [category, count] of Object.entries(results.thinkingDistribution)) {
+      const percentage = ((count / thinkingConvs) * 100).toFixed(1);
+      console.log(`  ${category}: ${count.toLocaleString()} conversations (${percentage}%)`);
+    }
+
+    console.log(`\nTOP 10 CONVERSATIONS BY THINKING TIME:`);
+    const sortedConvs = results.conversationDetails.sort((a, b) => b.thinkingTimeSec - a.thinkingTimeSec).slice(0, 10);
+
+    sortedConvs.forEach((conv, i) => {
+      const title = conv.title.length > 50 ? conv.title.substring(0, 50) + "..." : conv.title;
+      console.log(
+        `  ${(i + 1).toString().padStart(2)}. ${conv.thinkingTimeSec.toFixed(1).padStart(6)}s (${conv.thinkingBlocks} blocks) - ${title}`,
+      );
+    });
+
+    console.log(`\nTOP 10 INDIVIDUAL THINKING BLOCKS:`);
+    const sortedBlocks = results.allThinkingBlocks.sort((a, b) => b.durationSec - a.durationSec).slice(0, 10);
+
+    sortedBlocks.forEach((block, i) => {
+      const title =
+        block.conversationTitle.length > 30
+          ? block.conversationTitle.substring(0, 30) + "..."
+          : block.conversationTitle;
+      const userMsg =
+        block.precedingUserMessage.length > 80
+          ? block.precedingUserMessage.substring(0, 80) + "..."
+          : block.precedingUserMessage;
+      console.log(`  ${(i + 1).toString().padStart(2)}. ${block.durationSec.toFixed(1).padStart(6)}s - ${title}`);
+      console.log(`      User: ${userMsg}`);
+      console.log();
+    });
+  }
+}
+
+async function main() {
+  const filename = process.argv[2] || "conversations.json";
+
+  try {
+    const startTime = process.hrtime.bigint();
+    const results = await analyzeAllConversations(filename);
+    const endTime = process.hrtime.bigint();
+
+    printResults(results);
+
+    // Print execution time
+    const executionTimeMs = Number(endTime - startTime) / 1000000;
+    console.log(`\nExecution time: ${(executionTimeMs / 1000).toFixed(2)} seconds`);
+
+    // Optionally save detailed results to JSON
+    if (process.argv[3] === "--save-details") {
+      const outputFile = "thinking_analysis_results_node.json";
+      await fs.writeFile(outputFile, JSON.stringify(results, null, 2));
+      console.log(`\nDetailed results saved to ${outputFile}`);
+    }
+  } catch (error) {
+    if (error.code === "ENOENT") {
+      console.error(`Error: File '${filename}' not found`);
+      console.error("Usage: node thinktime-cli.js [conversations.json] [--save-details]");
+      process.exit(1);
+    } else if (error instanceof SyntaxError) {
+      console.error(`Error: Invalid JSON in file '${filename}': ${error.message}`);
+      process.exit(1);
+    } else {
+      console.error(`Error: ${error.message}`);
+      process.exit(1);
+    }
+  }
+}
+
+main();

package/thinktime.js

@@ -58,7 +58,7 @@ function findPrecedingUserMessage(mapping, targetNodeId) {
   return "No preceding user message found";
 }
 
-function analyzeConversationThinking(conversation) {
+export function analyzeConversationThinking(conversation) {
   /**
    * Analyze a single conversation for thinking time.
    *
@@ -104,7 +104,7 @@ function analyzeConversationThinking(conversation) {
   return { totalThinkingTime, thinkingBlocks, thinkingDetails };
 }
 
-async function analyzeAllConversations(filename) {
+export async function analyzeAllConversations(filename) {
   /**
    * Analyze all conversations in the JSON file.
    *
@@ -175,105 +175,3 @@ async function analyzeAllConversations(filename) {
 
   return results;
 }
-
-function printResults(results) {
-  /**
-   * Print analysis results in a readable format.
-   */
-  console.log("\n" + "=".repeat(60));
-  console.log("THINKING TIME ANALYSIS RESULTS");
-  console.log("=".repeat(60));
-
-  const totalConvs = results.totalConversations;
-  const thinkingConvs = results.conversationsWithThinking;
-
-  console.log(`Total conversations: ${totalConvs.toLocaleString()}`);
-  console.log(
-    `Conversations with thinking: ${thinkingConvs.toLocaleString()} (${((thinkingConvs / totalConvs) * 100).toFixed(1)}%)`,
-  );
-  console.log(`Conversations without thinking: ${(totalConvs - thinkingConvs).toLocaleString()}`);
-
-  if (thinkingConvs > 0) {
-    console.log(`\nTHINKING TIME STATISTICS:`);
-    console.log(
-      `Total thinking time: ${results.totalThinkingTime.toFixed(1)} seconds (${(results.totalThinkingTime / 60).toFixed(1)} minutes)`,
-    );
-    console.log(`Total thinking blocks: ${results.totalThinkingBlocks.toLocaleString()}`);
-    console.log(
-      `Average thinking time per conversation: ${(results.totalThinkingTime / thinkingConvs).toFixed(1)} seconds`,
-    );
-    console.log(
-      `Average thinking blocks per conversation: ${(results.totalThinkingBlocks / thinkingConvs).toFixed(1)}`,
-    );
-
-    console.log(`\nTHINKING TIME DISTRIBUTION:`);
-    for (const [category, count] of Object.entries(results.thinkingDistribution)) {
-      const percentage = ((count / thinkingConvs) * 100).toFixed(1);
-      console.log(`  ${category}: ${count.toLocaleString()} conversations (${percentage}%)`);
-    }
-
-    console.log(`\nTOP 10 CONVERSATIONS BY THINKING TIME:`);
-    const sortedConvs = results.conversationDetails.sort((a, b) => b.thinkingTimeSec - a.thinkingTimeSec).slice(0, 10);
-
-    sortedConvs.forEach((conv, i) => {
-      const title = conv.title.length > 50 ? conv.title.substring(0, 50) + "..." : conv.title;
-      console.log(
-        `  ${(i + 1).toString().padStart(2)}. ${conv.thinkingTimeSec.toFixed(1).padStart(6)}s (${conv.thinkingBlocks} blocks) - ${title}`,
-      );
-    });
-
-    console.log(`\nTOP 10 INDIVIDUAL THINKING BLOCKS:`);
-    const sortedBlocks = results.allThinkingBlocks.sort((a, b) => b.durationSec - a.durationSec).slice(0, 10);
-
-    sortedBlocks.forEach((block, i) => {
-      const title =
-        block.conversationTitle.length > 30
-          ? block.conversationTitle.substring(0, 30) + "..."
-          : block.conversationTitle;
-      const userMsg =
-        block.precedingUserMessage.length > 80
-          ? block.precedingUserMessage.substring(0, 80) + "..."
-          : block.precedingUserMessage;
-      console.log(`  ${(i + 1).toString().padStart(2)}. ${block.durationSec.toFixed(1).padStart(6)}s - ${title}`);
-      console.log(`      User: ${userMsg}`);
-      console.log();
-    });
-  }
-}
-
-async function main() {
-  const filename = process.argv[2] || "conversations.json";
-
-  try {
-    const startTime = process.hrtime.bigint();
-    const results = await analyzeAllConversations(filename);
-    const endTime = process.hrtime.bigint();
-
-    printResults(results);
-
-    // Print execution time
-    const executionTimeMs = Number(endTime - startTime) / 1000000;
-    console.log(`\nExecution time: ${(executionTimeMs / 1000).toFixed(2)} seconds`);
-
-    // Optionally save detailed results to JSON
-    if (process.argv[3] === "--save-details") {
-      const outputFile = "thinking_analysis_results_node.json";
-      await fs.writeFile(outputFile, JSON.stringify(results, null, 2));
-      console.log(`\nDetailed results saved to ${outputFile}`);
-    }
-  } catch (error) {
-    if (error.code === "ENOENT") {
-      console.error(`Error: File '${filename}' not found`);
-      console.error("Usage: node thinking_time.js [conversations.json] [--save-details]");
-      process.exit(1);
-    } else if (error instanceof SyntaxError) {
-      console.error(`Error: Invalid JSON in file '${filename}': ${error.message}`);
-      process.exit(1);
-    } else {
-      console.error(`Error: ${error.message}`);
-      process.exit(1);
-    }
-  }
-}
-
-main();

package/cli.js

@@ -1,19 +0,0 @@
-#!/usr/bin/env node
-import path from "path";
-import { promises as fs } from "fs";
-import chatgptToMarkdown from "./index.js";
-
-async function run() {
-  const filePath = process.argv[2];
-  if (!filePath) {
-    console.error("Please provide a file path as a command line argument.");
-    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();