@zjy4fun/json-open 0.1.1 → 0.1.9

package/.github/workflows/publish.yml

@@ -18,9 +18,8 @@ jobs:
 
       - uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: 22
           registry-url: 'https://registry.npmjs.org'
-          cache: 'npm'
 
       - run: npm ci
       - run: npm test --if-present
@@ -33,3 +32,5 @@ jobs:
           [ "$TAG_VERSION" = "$PKG_VERSION" ] || (echo "Tag $TAG_VERSION != package.json $PKG_VERSION" && exit 1)
 
       - run: npm publish --access public --provenance
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/README.md

@@ -1,56 +1,59 @@
 # json-open
 
-Open JSON in your browser with a collapsible tree view (supports stdin and inline JSON text).
+Open JSON in your browser as a collapsible tree view.
 
-> A tiny CLI for command-line users: feed JSON, instantly inspect it in a browser with foldable structure.
-
-## Demo
+> A tiny CLI for quickly inspecting JSON from APIs, logs, or inline text.
 
 ![json-open demo](./demo.gif)
 
 ---
 
-## Why this exists
+## Why json-open?
 
-Reading JSON in a terminal is often painful:
+Reading JSON in terminal is often painful:
 
 - Long output is hard to scan
 - Deep nesting is hard to understand quickly
-- Heavy tools feel overkill for quick debugging
+- Full-featured tools can feel heavy for quick checks
 
-`json-open` keeps this simple: **make JSON inspection fast and visual**.
+`json-open` keeps it simple: **pipe JSON in, inspect it visually in seconds**.
 
 ---
 
 ## Features
 
-- ✅ Pipe input: `curl ... | json`
-- ✅ Inline JSON: `json '{"a":1}'`
-- ✅ Collapsible tree view in browser
-- ✅ Expand all / Collapse all buttons
-- ✅ Rendered from local temp file (no remote upload)
-- ✅ Cross-platform browser open (macOS / Linux / Windows)
+- ✅ Read from stdin (pipe)
+- ✅ Read inline JSON text
+- ✅ Open browser automatically (macOS / Linux / Windows)
+- ✅ Collapsible tree view
+- ✅ Expand all / Collapse all
+- ✅ Local temp file rendering (no remote upload)
+- ✅ **Auto-parse serialized JSON strings** (escaped/double-encoded)
+- ✅ **Deep nested JSON string expansion** (auto-unwrap JSON strings inside objects)
 
 ---
 
 ## Installation
 
-### Option A: GitHub Packages (current primary channel)
+### npm (recommended)
+
+```bash
+npm i -g @zjy4fun/json-open
+```
 
-Configure npm for GitHub Packages first:
+After install, use the global command:
 
 ```bash
-echo "@zjy4fun:registry=https://npm.pkg.github.com" >> ~/.npmrc
-echo "//npm.pkg.github.com/:_authToken=YOUR_GITHUB_TOKEN" >> ~/.npmrc
+json --version
 ```
 
-Then install:
+### Run once with npx (no global install)
 
 ```bash
-npm i -g @zjy4fun/json-open
+npx @zjy4fun/json-open '{"hello":"world"}'
 ```
 
-### Option B: Local development install
+### Local development
 
 ```bash
 git clone https://github.com/zjy4fun/json-open.git
@@ -59,11 +62,9 @@ npm install
 npm link
 ```
 
-After that, the `json` command is available globally.
-
 ---
 
-## Quick start
+## Quick Start
 
 ```bash
 # 1) API response
@@ -76,56 +77,71 @@ json '{"hello":"world","list":[1,2,3]}'
 cat response.json | json
 ```
 
-The command opens your browser and shows a JSON tree view.
+The command opens your default browser and shows a structured JSON tree.
 
 ---
 
-## Common use cases
+## CLI Usage
 
-1. **API debugging**  
-   Inspect response shape quickly, especially nested data.
+```bash
+json [inline-json]
+```
 
-2. **Backend/frontend integration checks**  
-   Verify missing fields or type mismatches after API changes.
+Input sources:
 
-3. **Ad-hoc JSON inspection**  
-   Visualize JSON copied from logs, queues, or snapshots.
+- `stdin` (pipe)
+- Inline JSON argument
 
-4. **Team discussion/demo**  
-   Share a clearer structure view when discussing payloads.
+Options:
 
----
+- `-h, --help` Show help
+- `-v, --version` Show version
 
-## Command behavior
+Examples:
 
 ```bash
-json
+json --help
+json --version
+json '{"ok":true}'
 ```
 
-Input source:
+If no input is provided, usage help is printed.
+
+---
 
-- stdin (pipe)
-- inline argument JSON string
+## Serialized JSON String Support
 
-Example:
+`json-open` now automatically handles serialized/escaped JSON strings — a common pain point when working with logs, databases, and APIs.
 
 ```bash
-json '{"ok":true}'
-```
+# Double-encoded JSON string (e.g. from database or API response body)
+json '"{\"name\":\"test\",\"age\":25}"'
+# → auto-detects and parses as { "name": "test", "age": 25 }
 
-If no input is provided, it prints usage help.
+# Nested JSON strings inside objects
+json '{"status":"ok","data":"{\"users\":[{\"id\":1}]}"}'
+# → auto-expands "data" field into a real JSON tree
 
----
+# Multi-level serialization
+json '"\"[1,2,3]\""'
+# → recursively unwraps to [1, 2, 3]
+```
 
-## Release & distribution
+This works for:
+- Escaped JSON from `JSON.stringify()` output
+- Log files with embedded JSON payloads
+- API responses where a field contains a JSON string
+- Database columns storing serialized JSON
 
-Included GitHub Actions workflows:
+---
 
-- `CI`: basic validation flow
-- `Publish to GitHub Packages`: publish to GPR
-- `Publish to npm (Trusted Publishing)`: reserved for npm OIDC flow
+## Common Use Cases
 
-Current primary distribution: **GitHub Packages**.
+- API debugging (inspect response shape quickly)
+- Backend/frontend contract checks
+- Ad-hoc JSON visualization from logs
+- Payload discussion/demo with teammates
+- **Inspecting serialized JSON from databases or message queues**
 
 ---
 
@@ -135,24 +151,18 @@ Issues and PRs are welcome.
 
 ### Good contribution ideas
 
-- Better error diagnostics (e.g. JSON syntax location)
+- Better JSON parse error location hints
 - Theme switch (light/dark)
 - Direct file path support (e.g. `json ./data.json`)
-- Rich interactions (search, highlight, copy JSON path)
+- Search / highlight / copy JSON path
 
-### Local development
+### Local dev
 
 ```bash
 npm install
 npm test
 ```
 
-Before submitting:
-
-- Ensure code runs correctly
-- Ensure README examples still work
-- Keep changes focused and clear
-
 ---
 
 ## License

package/README.zh-CN.md

@@ -107,9 +107,16 @@ json
 - stdin（管道）
 - 命令行参数中的 JSON 字符串
 
+参数选项：
+
+- `-h, --help` 显示帮助
+- `-v, --version` 显示版本
+
 示例：
 
 ```bash
+json --help
+json --version
 json '{"ok":true}'
 ```
 

package/bin/json.js

@@ -1,8 +1,34 @@
 #!/usr/bin/env node
 import fs from 'node:fs/promises'
+import fsSync from 'node:fs'
 import os from 'node:os'
 import path from 'node:path'
 import { spawn } from 'node:child_process'
+import { fileURLToPath } from 'node:url'
+
+function getCliVersion() {
+  try {
+    const currentFile = fileURLToPath(import.meta.url)
+    const packageJsonPath = path.resolve(path.dirname(currentFile), '..', 'package.json')
+    const packageJson = JSON.parse(fsSync.readFileSync(packageJsonPath, 'utf8'))
+    return packageJson.version
+  } catch {
+    return 'unknown'
+  }
+}
+
+function printHelp() {
+  console.log(`json-open
+
+Usage:
+  json <json-string>
+  cat data.json | json
+  curl https://example.com/api | json
+
+Options:
+  -h, --help     Show help
+  -v, --version  Show version`)
+}
 
 function readStdin() {
   return new Promise((resolve, reject) => {
@@ -74,8 +100,11 @@ function valueToHtml(value, key = null) {
   return `<div class=\"line\">${keyHtml}<span>${escapeHtml(String(value))}</span></div>`
 }
 
-function toHtml(jsonObj) {
-  const body = valueToHtml(jsonObj)
+function toHtml(jsonObj, deepParsedObj) {
+  const rawBody = valueToHtml(jsonObj)
+  const parsedBody = valueToHtml(deepParsedObj)
+  // 检测是否有差异（有嵌套 JSON 字符串可以展开）
+  const hasDiff = JSON.stringify(jsonObj) !== JSON.stringify(deepParsedObj)
   return `<!doctype html>
 <html lang=\"en\">
 <head>
@@ -104,6 +133,8 @@ function toHtml(jsonObj) {
       margin-bottom: 16px;
       display: flex;
       gap: 8px;
+      align-items: center;
+      flex-wrap: wrap;
     }
     button {
       border: 1px solid #475569;
@@ -116,6 +147,51 @@ function toHtml(jsonObj) {
     button:hover {
       background: #334155;
     }
+    /* 开关样式 */
+    .toggle-wrap {
+      display: flex;
+      align-items: center;
+      gap: 8px;
+      margin-left: auto;
+      font-size: 13px;
+      color: #94a3b8;
+    }
+    .toggle-wrap.hidden { display: none; }
+    .toggle {
+      position: relative;
+      width: 40px;
+      height: 22px;
+      cursor: pointer;
+    }
+    .toggle input {
+      opacity: 0;
+      width: 0;
+      height: 0;
+    }
+    .toggle .slider {
+      position: absolute;
+      inset: 0;
+      background: #334155;
+      border-radius: 22px;
+      transition: background 0.2s;
+    }
+    .toggle .slider::before {
+      content: '';
+      position: absolute;
+      width: 16px;
+      height: 16px;
+      left: 3px;
+      bottom: 3px;
+      background: #e2e8f0;
+      border-radius: 50%;
+      transition: transform 0.2s;
+    }
+    .toggle input:checked + .slider {
+      background: #58a6ff;
+    }
+    .toggle input:checked + .slider::before {
+      transform: translateX(18px);
+    }
     details {
       margin-left: 16px;
     }
@@ -154,17 +230,71 @@ function toHtml(jsonObj) {
   <div class=\"toolbar\">
     <button id=\"expand-all\">Expand all</button>
     <button id=\"collapse-all\">Collapse all</button>
+    <div class=\"toggle-wrap${hasDiff ? '' : ' hidden'}\" title=\"Parse embedded JSON strings inside values\">
+      <span>Parse JSON strings</span>
+      <label class=\"toggle\">
+        <input type=\"checkbox\" id=\"deep-parse-toggle\" />
+        <span class=\"slider\"></span>
+      </label>
+    </div>
   </div>
-  <main>${body}</main>
+  <main id=\"raw-view\">${rawBody}</main>
+  <main id=\"parsed-view\" style=\"display:none\">${parsedBody}</main>
   <script>
-    const details = () => Array.from(document.querySelectorAll('details'))
+    const details = () => Array.from(document.querySelectorAll('main:not([style*=\"display:none\"]) details'))
     document.getElementById('expand-all').addEventListener('click', () => details().forEach((d) => d.open = true))
     document.getElementById('collapse-all').addEventListener('click', () => details().forEach((d) => d.open = false))
+
+    const toggle = document.getElementById('deep-parse-toggle')
+    const rawView = document.getElementById('raw-view')
+    const parsedView = document.getElementById('parsed-view')
+    if (toggle) {
+      toggle.addEventListener('change', () => {
+        if (toggle.checked) {
+          rawView.style.display = 'none'
+          parsedView.style.display = ''
+        } else {
+          rawView.style.display = ''
+          parsedView.style.display = 'none'
+        }
+      })
+    }
   </script>
 </body>
 </html>`
 }
 
+/**
+ * 递归遍历 JSON 对象，尝试将值为 JSON 字符串的字段自动解析为对象
+ * 比如 { "data": "{\"name\":\"test\"}" } → { "data": { "name": "test" } }
+ * 这在 API 响应和日志中非常常见
+ */
+function deepParseJsonStrings(obj) {
+  if (obj === null || obj === undefined) return obj
+  if (Array.isArray(obj)) return obj.map(deepParseJsonStrings)
+  if (typeof obj === 'object') {
+    const result = {}
+    for (const [key, value] of Object.entries(obj)) {
+      result[key] = deepParseJsonStrings(value)
+    }
+    return result
+  }
+  if (typeof obj === 'string') {
+    const trimmed = obj.trim()
+    // 只尝试解析看起来像 JSON 对象或数组的字符串
+    if ((trimmed.startsWith('{') && trimmed.endsWith('}')) ||
+        (trimmed.startsWith('[') && trimmed.endsWith(']'))) {
+      try {
+        const parsed = JSON.parse(trimmed)
+        return deepParseJsonStrings(parsed)
+      } catch {
+        return obj
+      }
+    }
+  }
+  return obj
+}
+
 function openInBrowser(filePath) {
   const platform = process.platform
   const command = platform === 'darwin' ? 'open' : platform === 'win32' ? 'start' : 'xdg-open'
@@ -178,10 +308,22 @@ function openInBrowser(filePath) {
 }
 
 async function main() {
-  const inlineInput = process.argv.slice(2).join(' ').trim()
+  const args = process.argv.slice(2)
+
+  if (args.includes('-h') || args.includes('--help')) {
+    printHelp()
+    process.exit(0)
+  }
+
+  if (args.includes('-v') || args.includes('--version')) {
+    console.log(getCliVersion())
+    process.exit(0)
+  }
+
+  const inlineInput = args.join(' ').trim()
 
   if (!inlineInput && process.stdin.isTTY) {
-    console.error('Usage: curl https://example.com | json\n   or: json "{\"hello\":\"world\"}"')
+    printHelp()
     process.exit(1)
   }
 
@@ -196,11 +338,54 @@ async function main() {
   try {
     parsed = JSON.parse(input)
   } catch {
-    console.error('Input is not valid JSON.')
-    process.exit(1)
+    // 尝试处理 JSON 序列化后的字符串（双重转义）
+    // 比如："{\"name\":\"test\"}" 或 '"{\\\"name\\\":\\\"test\\\"}"'
+    // 这种情况常见于：日志输出、API 响应中嵌套的 JSON 字符串、数据库存储的 JSON
+    try {
+      // 第一步：去掉首尾引号（如果有的话）
+      let cleaned = input.trim()
+      if ((cleaned.startsWith('"') && cleaned.endsWith('"')) ||
+          (cleaned.startsWith("'") && cleaned.endsWith("'"))) {
+        cleaned = cleaned.slice(1, -1)
+      }
+      // 第二步：处理转义字符
+      // 替换 \" → "，\\ → \，\n → 换行，\t → tab
+      cleaned = cleaned
+        .replace(/\\"/g, '"')
+        .replace(/\\\\/g, '\\')
+        .replace(/\\n/g, '\n')
+        .replace(/\\t/g, '\t')
+        .replace(/\\r/g, '\r')
+      parsed = JSON.parse(cleaned)
+      console.log('ℹ️  Detected serialized JSON string, auto-unescaped.')
+    } catch {
+      // 第三步：尝试递归解析（多层序列化的情况）
+      try {
+        let result = input.trim()
+        let depth = 0
+        const maxDepth = 5
+        while (typeof result === 'string' && depth < maxDepth) {
+          result = JSON.parse(result)
+          depth++
+        }
+        if (typeof result === 'object' && result !== null) {
+          parsed = result
+          console.log(`ℹ️  Detected ${depth}-level serialized JSON string, auto-parsed.`)
+        } else {
+          console.error('Input is not valid JSON.')
+          process.exit(1)
+        }
+      } catch {
+        console.error('Input is not valid JSON.')
+        process.exit(1)
+      }
+    }
   }
 
-  const html = toHtml(parsed)
+  // 生成深度解析版本（展开嵌套 JSON 字符串），但默认不启用
+  const deepParsed = deepParseJsonStrings(parsed)
+
+  const html = toHtml(parsed, deepParsed)
   const filePath = path.join(os.tmpdir(), `json-viewer-${Date.now()}.html`)
   await fs.writeFile(filePath, html, 'utf8')
   openInBrowser(filePath)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zjy4fun/json-open",
-  "version": "0.1.1",
+  "version": "0.1.9",
   "description": "Open JSON (stdin or inline text) in a browser with collapsible tree view",
   "type": "module",
   "bin": {
@@ -17,8 +17,12 @@
     "browser",
     "formatter"
   ],
-  "author": "",
+  "author": "zjy4fun",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/zjy4fun/json-open"
+  },
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"