devkits-json-formatter 1.0.1 → 1.0.4

package/README.md

@@ -1,125 +1,59 @@
-# @devkits/json-formatter
+# devkits-json-formatter
 
-[![Part of DevKits](https://img.shields.io/badge/DevKits-82%2B%20Tools-blue)](https://devkits-tools.surge.sh)
+Format and validate JSON from CLI or stdin. Part of [DevKits Tools](https://devkits-tools.surge.sh).
 
-Format, validate, and minify JSON. Syntax error detection with position info. Zero-dependency JSON utility for developers.
-
-## 🧰 DevKits Pro Tools
-
-This package is part of **DevKits** — 82+ free developer tools. The online JSON Formatter includes schema validation, tree view, and query/filter tools.
-
-**→ [Format JSON with Tree View](https://devkits-tools.surge.sh)**
-
-## Installation
+## Install
 
 ```bash
-npm install @devkits/json-formatter
+npm install -g devkits-json-formatter
 ```
 
-## Usage
-
-```javascript
-const {
-  format,
-  minify,
-  isValid,
-  pretty,
-  countKeys,
-  getSizeInfo,
-  sortKeys,
-  formatSorted
-} = require('@devkits/json-formatter');
-
-const uglyJson = '{"name":"John","age":30,"city":"NYC"}';
-
-// Format JSON with indentation
-const result = format(uglyJson, { indent: 2 });
-// {
-//   success: true,
-//   result: '{\n  "name": "John",\n  "age": 30,\n  "city": "NYC"\n}'
-// }
-
-// Minify JSON
-const min = minify(uglyJson);
-// { success: true, result: '{"name":"John",...}', saved: 15 }
-
-// Validate JSON
-isValid('{"valid": true}');
-// { valid: true }
-
-isValid('{invalid}');
-// { valid: false, error: 'Unexpected token...', position: {line: 1, column: 2} }
-
-// Pretty print an object
-pretty({ name: 'John', age: 30 });
-// '{\n  "name": "John",\n  "age": 30\n}'
-
-// Count keys recursively
-const nested = { a: { b: { c: 1 } }, d: [1, 2, 3] };
-countKeys(nested);
-// 5
-
-// Get size info
-getSizeInfo(uglyJson);
-// { original: 36, minified: 36, saved: 0, keys: 3 }
-
-// Sort keys alphabetically
-const unsorted = { z: 1, a: 2, m: 3 };
-sortKeys(unsorted);
-// { a: 2, m: 3, z: 1 }
-
-// Format with sorted keys
-formatSorted('{"z":1,"a":2}', 2);
-// { success: true, result: '{\n  "a": 2,\n  "z": 1\n}' }
-```
-
-## API
-
-### `format(jsonString, options)`
-Formats JSON with specified indentation (default: 2 spaces).
+[![npm version](https://badge.fury.io/js/devkits-json-formatter.svg)](https://www.npmjs.com/package/devkits-json-formatter)
 
-Returns `{success, result?, error?}`.
-
-### `minify(jsonString)`
-Removes all whitespace from JSON.
-
-Returns `{success, result?, error?, saved?}`.
-
-### `isValid(jsonString)`
-Validates JSON syntax with optional error position.
+## Usage
 
-Returns `{valid, error?, position?}`.
+### Format JSON (pretty print)
 
-### `pretty(obj, indent)`
-Pretty prints a JavaScript object as JSON string.
+```bash
+# From stdin
+echo '{"name":"DevKits","tools":84}' | jsonfmt
 
-### `countKeys(obj)`
-Counts all keys in an object recursively.
+# From file
+jsonfmt package.json
 
-### `getSizeInfo(jsonString)`
-Returns size statistics: original size, minified size, bytes saved, key count.
+# From JSON string
+jsonfmt '{"test":true}'
+```
 
-### `sortKeys(obj)`
-Returns new object with keys sorted alphabetically (recursive).
+### Minify JSON
 
-### `formatSorted(jsonString, indent)`
-Formats JSON with keys sorted alphabetically.
+```bash
+jsonfmt package.json --minify
+jsonfmt '{"test":true}' -m
+```
 
-## See Also
+## 🚀 More Free Tools from DevKits
 
-**Free Online Version:** [DevKits - JSON Formatter](https://devkits-tools.surge.sh)
+This CLI is part of [DevKits](https://devkits-tools.surge.sh?utm_source=npm&utm_medium=readme&utm_campaign=json-formatter) — 82 free developer tools + 20 Pro tools ($9).
 
-### Other DevKits npm Packages
+### Free Tools
+- **JSON Tools**: [Formatter/Validator](https://devkits-tools.surge.sh/tools/json-formatter?utm_source=npm&utm_medium=readme&utm_campaign=json-formatter) | [JSON → CSV/XML/Types](https://devkits-tools.surge.sh/tools/json-to-csv?utm_source=npm&utm_medium=readme&utm_campaign=json-formatter)
+- **Encoding**: [Base64](https://devkits-tools.surge.sh/tools/base64?utm_source=npm&utm_medium=readme&utm_campaign=json-formatter) | [URL Encode/Decode](https://devkits-tools.surge.sh/tools/url-encode?utm_source=npm&utm_medium=readme&utm_campaign=json-formatter)
+- **Crypto**: [Hash Generator](https://devkits-tools.surge.sh/tools/hash-generator?utm_source=npm&utm_medium=readme&utm_campaign=json-formatter) | [JWT Decoder](https://devkits-tools.surge.sh/tools/jwt-decoder?utm_source=npm&utm_medium=readme&utm_campaign=json-formatter)
+- **Color**: [HEX/RGB/HSL Converter](https://devkits-tools.surge.sh/tools/color-converter?utm_source=npm&utm_medium=readme&utm_campaign=json-formatter)
+- **CSS**: [Minifier/Formatter](https://devkits-tools.surge.sh/tools/css-tools?utm_source=npm&utm_medium=readme&utm_campaign=json-formatter)
 
-| Package | Description |
-|---------|-------------|
-| @devkits/base64-tool | Base64 encoding/decoding |
-| @devkits/csv-json-converter | Convert between CSV and JSON |
-| @devkits/markdown-tools | Markdown utilities |
-| @devkits/env-editor | .env file utilities |
+### 👉 Other Products
+- **[Invoicely](https://invoicely-app.surge.sh?utm_source=npm&utm_medium=readme&utm_campaign=json-formatter)** — Free invoice generator (6 templates, PDF export)
+- **[SnapOG](https://snapog.surge.sh?utm_source=npm&utm_medium=readme&utm_campaign=json-formatter)** — Free OG image generator (20+ templates)
 
-**Browse all 82 tools at [DevKits](https://devkits-tools.surge.sh)**
+### 💎 Pro Tools ($9 one-time)
+Unlock 20 Pro tools at [DevKits Pro](https://devkits-tools.surge.sh/pro?utm_source=npm&utm_medium=readme&utm_campaign=json-formatter):
+- SQL → Code (Go/TS/Python/Rust)
+- Advanced Regex with visual groups
+- Mock Data Generator (1000+ rows)
+- And 16 more → [See all Pro tools](https://devkits-tools.surge.sh/pro?utm_source=npm&utm_medium=readme&utm_campaign=json-formatter)
 
 ## License
 
-MIT
+MIT — DevKits Team

package/index.js

@@ -1,177 +1,93 @@
+#!/usr/bin/env node
+
 /**
- * @devkits/json-formatter
+ * @devkits/json-formatter — Format and validate JSON
  *
- * Format, validate, and minify JSON.
- * Works in both Node.js and browser environments.
+ * Usage:
+ *   jsonfmt <file|json> [--minify]
+ *   echo '{"foo":"bar"}' | jsonfmt
+ *   jsonfmt package.json
  */
 
-/**
- * Format JSON string with indentation
- * @param {string} jsonString - JSON string to format
- * @param {Object} options - Format options
- * @param {number} options.indent - Indentation spaces (default: 2)
- * @returns {{success: boolean, result?: string, error?: string}}
- */
-function format(jsonString, options = {}) {
-  const { indent = 2 } = options;
+const fs = require('fs');
 
-  try {
-    const parsed = JSON.parse(jsonString);
-    return {
-      success: true,
-      result: JSON.stringify(parsed, null, indent)
-    };
-  } catch (e) {
-    return {
-      success: false,
-      error: e.message
-    };
-  }
-}
+const PRO_UPGRADE = '\n🚀 Want more? Upgrade to Pro: https://devkits-tools.surge.sh/pro\n   Use code EARLYBIRD-2026 for 20% off\n';
 
-/**
- * Minify JSON (remove all whitespace)
- * @param {string} jsonString - JSON string to minify
- * @returns {{success: boolean, result?: string, error?: string, saved?: number}}
- */
-function minify(jsonString) {
-  try {
-    const parsed = JSON.parse(jsonString);
-    const minified = JSON.stringify(parsed);
-    return {
-      success: true,
-      result: minified,
-      saved: jsonString.length - minified.length
-    };
-  } catch (e) {
-    return {
-      success: false,
-      error: e.message
-    };
-  }
+function showHelp() {
+  console.log(`
+@devkits/json-formatter — Format and validate JSON
+
+Usage:
+  jsonfmt <file|json> [--minify]
+  jsonfmt package.json
+  jsonfmt '{"foo":"bar"}'
+  echo '{"test":true}' | jsonfmt
+
+Options:
+  --minify, -m    Minify JSON (remove whitespace)
+  --help, -h      Show this help
+
+Examples:
+  jsonfmt package.json
+  jsonfmt '{"foo":"bar"}' --minify
+  cat data.json | jsonfmt
+
+Web Version: https://devkits-tools.surge.sh
+Pro Features: https://devkits-tools.surge.sh/pro
+`);
 }
 
-/**
- * Validate JSON syntax
- * @param {string} jsonString - JSON string to validate
- * @returns {{valid: boolean, error?: string, position?: {line: number, column: number}}}
- */
-function isValid(jsonString) {
+function formatJSON(input, minify = false) {
   try {
-    JSON.parse(jsonString);
-    return { valid: true };
-  } catch (e) {
-    // Try to extract position from error message
-    const posMatch = e.message.match(/position\s+(\d+)/i);
-    let position = null;
-
-    if (posMatch) {
-      const pos = parseInt(posMatch[1], 10);
-      const lines = jsonString.substring(0, pos).split('\n');
-      position = {
-        line: lines.length,
-        column: lines[lines.length - 1].length + 1
-      };
+    let jsonData;
+
+    // Check if input is a file path
+    if (fs.existsSync(input)) {
+      input = fs.readFileSync(input, 'utf-8');
     }
 
-    return {
-      valid: false,
-      error: e.message,
-      position
-    };
-  }
-}
+    jsonData = JSON.parse(input);
 
-/**
- * Pretty print a JavaScript object as JSON
- * @param {any} obj - Object to pretty print
- * @param {number} [indent=2] - Indentation spaces
- * @returns {string} Formatted JSON string
- */
-function pretty(obj, indent = 2) {
-  return JSON.stringify(obj, null, indent);
-}
+    if (minify) {
+      console.log(JSON.stringify(jsonData));
+    } else {
+      console.log(JSON.stringify(jsonData, null, 2));
+      console.log(`\n✅ Valid JSON`);
+    }
 
-/**
- * Count keys in a JSON object recursively
- * @param {any} obj - Object to count keys in
- * @returns {number} Total key count
- */
-function countKeys(obj) {
-  if (typeof obj !== 'object' || obj === null) return 0;
-  if (Array.isArray(obj)) {
-    return obj.reduce((n, v) => n + countKeys(v), 0);
+  } catch (err) {
+    console.error(`❌ Invalid JSON: ${err.message}`);
+    process.exit(1);
   }
-  return Object.keys(obj).reduce((n, k) => n + 1 + countKeys(obj[k]), 0);
 }
 
-/**
- * Get JSON size info
- * @param {string} jsonString - JSON string
- * @returns {{original: number, minified?: number, saved?: number, keys?: number}}
- */
-function getSizeInfo(jsonString) {
-  const info = { original: jsonString.length };
-
-  try {
-    const parsed = JSON.parse(jsonString);
-    info.keys = countKeys(parsed);
-
-    const minified = JSON.stringify(parsed);
-    info.minified = minified.length;
-    info.saved = jsonString.length - minified.length;
-  } catch (e) {
-    // Invalid JSON
-  }
+// Main
+const args = process.argv.slice(2);
 
-  return info;
+// Check for help
+if (args.includes('--help') || args.includes('-h')) {
+  showHelp();
+  process.exit(0);
 }
 
-/**
- * Sort object keys alphabetically
- * @param {any} obj - Object to sort
- * @returns {any} Object with sorted keys
- */
-function sortKeys(obj) {
-  if (obj === null || typeof obj !== 'object') return obj;
-  if (Array.isArray(obj)) return obj.map(sortKeys);
-
-  const sorted = {};
-  Object.keys(obj).sort().forEach(key => {
-    sorted[key] = sortKeys(obj[key]);
-  });
-  return sorted;
-}
+const minify = args.includes('--minify') || args.includes('-m');
+const input = args.filter(a => !a.startsWith('-')).join(' ');
 
-/**
- * Format with sorted keys
- * @param {string} jsonString - JSON string
- * @param {number} [indent=2] - Indentation spaces
- * @returns {{success: boolean, result?: string, error?: string}}
- */
-function formatSorted(jsonString, indent = 2) {
+if (!input) {
+  // Read from stdin
   try {
-    const parsed = JSON.parse(jsonString);
-    const sorted = sortKeys(parsed);
-    return {
-      success: true,
-      result: JSON.stringify(sorted, null, indent)
-    };
-  } catch (e) {
-    return {
-      success: false,
-      error: e.message
-    };
+    const stdin = fs.readFileSync(0, 'utf-8').trim();
+    if (!stdin) {
+      showHelp();
+      process.exit(0);
+    }
+    formatJSON(stdin, minify);
+  } catch (err) {
+    console.error('Error reading stdin: ' + err.message);
+    process.exit(1);
   }
+} else {
+  formatJSON(input, minify);
 }
 
-module.exports = {
-  format,
-  minify,
-  isValid,
-  pretty,
-  countKeys,
-  getSizeInfo,
-  sortKeys,
-  formatSorted
-};
+console.log(PRO_UPGRADE);

package/package.json

@@ -1,27 +1,40 @@
 {
   "name": "devkits-json-formatter",
-  "version": "1.0.1",
-  "description": "Format, validate, and minify JSON. Syntax error detection with position info. Zero-dependency JSON utility for developers.",
+  "version": "1.0.4",
+  "description": "Format and validate JSON from CLI or stdin — pretty print, minify, and validate JSON files",
   "main": "index.js",
-  "files": [
-    "index.js",
-    "README.md"
-  ],
+  "bin": {
+    "jsonfmt": "./index.js",
+    "json-formatter": "./index.js"
+  },
+  "scripts": {
+    "test": "node test.js"
+  },
   "keywords": [
     "json",
-    "json-formatter",
-    "json-validator",
-    "json-minifier",
-    "json-beautifier",
-    "json-linter",
-    "developer-tools",
-    "devkits"
+    "formatter",
+    "validator",
+    "cli",
+    "pretty-print",
+    "minify",
+    "developer-tools"
   ],
-  "author": "DevKits Auto <devkits-auto@protonmail.com>",
+  "author": "DevKits Team <devkits-auto@protonmail.com>",
   "license": "MIT",
-  "repository": "",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/devkits/tools"
+  },
+  "homepage": "https://devkits-tools.surge.sh",
   "bugs": {
-    "url": "https://github.com/devkits/devkits/issues"
+    "url": "https://github.com/devkits/tools/issues"
+  },
+  "engines": {
+    "node": ">=14.0.0"
   },
-  "homepage": "https://devkits-tools.surge.sh"
+  "files": [
+    "index.js",
+    "README.md"
+  ],
+  "dependencies": {}
 }