jsonfixerdev 1.0.0

package/LICENSE.md

@@ -0,0 +1,7 @@
+The ISC License
+
+Copyright (c) 2026
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,118 @@
+# jsonfixer
+
+Repair invalid JSON documents by fixing common syntax issues.
+
+Website: https://jsonfixer.dev
+
+## Install
+
+```
+npm install jsonfixerdev
+```
+
+## Usage
+
+### ES module
+
+```js
+import { jsonfixer } from 'jsonfixerdev'
+
+const input = "{name: 'John'}"
+const fixed = jsonfixer(input)
+console.log(fixed) // '{"name": "John"}'
+```
+
+### CommonJS
+
+```js
+const { jsonfixer } = require('jsonfixerdev')
+
+const input = "{name: 'John'}"
+const fixed = jsonfixer(input)
+console.log(fixed)
+```
+
+### Streaming (Node.js)
+
+```js
+import { createReadStream, createWriteStream } from 'node:fs'
+import { pipeline } from 'node:stream'
+import { jsonfixerTransform } from 'jsonfixerdev/stream'
+
+const inputStream = createReadStream('./data/broken.json')
+const outputStream = createWriteStream('./data/fixed.json')
+
+pipeline(inputStream, jsonfixerTransform(), outputStream, (err) => {
+  if (err) console.error(err)
+  else console.log('done')
+})
+```
+
+## What it fixes
+
+jsonfixer can repair issues such as:
+- Missing quotes around keys
+- Missing commas or closing brackets
+- Single quotes instead of double quotes
+- Trailing commas
+- Comments and JSONP wrappers
+- Escaped JSON strings
+- MongoDB-style wrappers like `NumberLong(2)` and `ISODate(...)`
+- Newline-delimited JSON (converted to a JSON array)
+
+## API
+
+### Regular API
+
+```ts
+// @throws JSONFixerError
+jsonfixer(json: string): string
+```
+
+### Streaming API
+
+```ts
+jsonfixerTransform(options?: { chunkSize?: number, bufferSize?: number }): Transform
+```
+
+- `chunkSize` controls output chunk size (default `65536`).
+- `bufferSize` controls the sliding window size (default `65536`).
+
+## CLI
+
+Install globally:
+
+```
+npm install -g jsonfixerdev
+```
+
+Usage:
+
+```
+jsonfixerdev [filename] {OPTIONS}
+```
+
+Options:
+
+```
+--version, -v       Show application version
+--help,    -h       Show this message
+--output,  -o       Output file
+--overwrite         Overwrite the input file
+--buffer            Buffer size in bytes, for example 64K (default) or 1M
+```
+
+Examples:
+
+```
+jsonfixerdev broken.json                        # Repair a file, output to console
+jsonfixerdev broken.json > fixed.json           # Repair a file, output to file
+jsonfixerdev broken.json --output fixed.json    # Repair a file, output to file
+jsonfixerdev broken.json --overwrite            # Repair a file, replace the file itself
+cat broken.json | jsonfixerdev                  # Repair data from an input stream
+cat broken.json | jsonfixerdev > fixed.json     # Repair data from an input stream, output to file
+```
+
+## License
+
+ISC

package/bin/cli.js

@@ -0,0 +1,176 @@
+#!/usr/bin/env node
+import { createReadStream, createWriteStream, readFileSync, renameSync } from 'node:fs'
+import { pipeline as pipelineCallback } from 'node:stream'
+import { dirname, join } from 'node:path'
+import { fileURLToPath } from 'node:url'
+import { promisify } from 'node:util'
+import { jsonfixerTransform } from '../lib/esm/stream.js'
+
+const pipeline = promisify(pipelineCallback)
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = dirname(__filename)
+
+function processArgs(args) {
+  const options = {
+    version: false,
+    help: false,
+    overwrite: false,
+    bufferSize: undefined,
+    inputFile: null,
+    outputFile: null
+  }
+
+  // we skip the first two args, since they contain node and the script path
+  let i = 2
+  while (i < args.length) {
+    const arg = args[i]
+
+    switch (arg) {
+      case '-v':
+      case '--version':
+        options.version = true
+        break
+
+      case '-h':
+      case '--help':
+        options.help = true
+        break
+
+      case '--overwrite':
+        options.overwrite = true
+        break
+
+      case '--buffer':
+        i++
+        options.bufferSize = parseSize(args[i])
+        break
+
+      case '-o':
+      case '--output':
+        i++
+        options.outputFile = args[i]
+        break
+
+      default:
+        if (options.inputFile == null) {
+          options.inputFile = arg
+        } else {
+          throw new Error('Unexpected argument "' + arg + '"')
+        }
+    }
+
+    i++
+  }
+
+  return options
+}
+
+async function run(options) {
+  if (options.version) {
+    outputVersion()
+    return
+  }
+
+  if (options.help) {
+    outputHelp()
+    return
+  }
+
+  if (options.overwrite) {
+    if (!options.inputFile) {
+      console.error('Error: cannot use --overwrite: no input file provided')
+      process.exit(1)
+    }
+    if (options.outputFile) {
+      console.error('Error: cannot use --overwrite: there is also an --output provided')
+      process.exit(1)
+    }
+
+    const tempFileSuffix = '.fix-' + new Date().toISOString().replace(/\W/g, '-') + '.json'
+    const tempFile = options.inputFile + tempFileSuffix
+
+    try {
+      const readStream = createReadStream(options.inputFile)
+      const writeStream = createWriteStream(tempFile)
+      await pipeline(
+        readStream,
+        jsonfixerTransform({ bufferSize: options.bufferSize }),
+        writeStream
+      )
+      renameSync(tempFile, options.inputFile)
+    } catch (err) {
+      process.stderr.write(err.toString())
+      process.exit(1)
+    }
+
+    return
+  }
+
+  try {
+    const readStream = options.inputFile ? createReadStream(options.inputFile) : process.stdin
+    const writeStream = options.outputFile ? createWriteStream(options.outputFile) : process.stdout
+    await pipeline(readStream, jsonfixerTransform({ bufferSize: options.bufferSize }), writeStream)
+  } catch (err) {
+    process.stderr.write(err.toString())
+    process.exit(1)
+  }
+}
+
+function outputVersion() {
+  const file = join(__dirname, '../package.json')
+  const pkg = JSON.parse(String(readFileSync(file, 'utf-8')))
+
+  console.log(pkg.version)
+}
+
+function parseSize(size) {
+  const match = size.match(/^(\d+)([KMG]?)$/)
+  if (!match) {
+    throw new Error(`Buffer size "${size}" not recognized. Examples: 65536, 512K, 2M`)
+  }
+
+  const num = parseInt(match[1])
+  const suffix = match[2] // K, M, or G
+
+  switch (suffix) {
+    case 'K':
+      return num * 1024
+    case 'M':
+      return num * 1024 * 1024
+    case 'G':
+      return num * 1024 * 1024 * 1024
+    default:
+      return num
+  }
+}
+
+const help = `
+jsonfixerdev
+
+Repair invalid JSON documents. When a document could not be repaired, the output will be left unchanged.
+
+Usage:
+    jsonfixerdev [filename] {OPTIONS}
+
+Options:
+    --version, -v       Show application version
+    --help,    -h       Show this message
+    --output,  -o       Output file
+    --overwrite         Overwrite the input file
+    --buffer            Buffer size in bytes, for example 64K (default) or 1M
+
+Example usage:
+    jsonfixerdev broken.json                        # Repair a file, output to console
+    jsonfixerdev broken.json > repaired.json        # Repair a file, output to file
+    jsonfixerdev broken.json --output repaired.json # Repair a file, output to file
+    jsonfixerdev broken.json --overwrite            # Repair a file, replace the file itself
+    cat broken.json | jsonfixerdev                  # Repair data from an input stream
+    cat broken.json | jsonfixerdev > repaired.json  # Repair data from an input stream, output to file
+`
+
+function outputHelp() {
+  console.log(help)
+}
+
+const options = processArgs(process.argv)
+await run(options)

package/package.json

@@ -0,0 +1,95 @@
+{
+  "name": "jsonfixerdev",
+  "version": "1.0.0",
+  "description": "Repair broken JSON documents",
+  "homepage": "https://jsonfixer.dev",
+  "type": "module",
+  "main": "lib/cjs/index.js",
+  "module": "lib/esm/index.js",
+  "browser": "lib/umd/index.min.js",
+  "types": "lib/types/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": "./lib/esm/index.js",
+      "require": "./lib/cjs/index.js",
+      "types": "./lib/types/index.d.ts"
+    },
+    "./stream": {
+      "import": "./lib/esm/stream.js",
+      "require": "./lib/cjs/stream.js",
+      "types": "./lib/types/stream.d.ts"
+    }
+  },
+  "keywords": [
+    "simple",
+    "json",
+    "repair",
+    "fix",
+    "invalid",
+    "stream",
+    "streaming"
+  ],
+  "bin": {
+    "jsonfixerdev": "./bin/cli.js"
+  },
+  "scripts": {
+    "test": "vitest watch src",
+    "test:it": "vitest run src",
+    "build": "npm-run-all build:**",
+    "build:clean": "del-cli lib",
+    "build:esm": "babel src --out-dir lib/esm --extensions \".ts\" --source-maps --config-file ./babel.config.json",
+    "build:cjs": "babel src --out-dir lib/cjs --extensions \".ts\" --source-maps --config-file ./babel-cjs.config.json && cpy tools/cjs lib/cjs --flat",
+    "build:umd": "rollup lib/esm/index.js --format umd --name JSONFixer --sourcemap --output.file lib/umd/jsonfixer.js && cpy tools/cjs/package.json lib/umd --flat",
+    "build:umd:min": "uglifyjs --compress --mangle --source-map --comments --output lib/umd/jsonfixer.min.js -- lib/umd/jsonfixer.js",
+    "build:types": "tsc --project tsconfig-types.json",
+    "build:validate": "vitest run test-lib",
+    "lint": "eslint src/**/*.ts",
+    "format": "npm run lint -- --fix",
+    "benchmark": "npm run build:esm && node tools/benchmark/run.mjs",
+    "build-and-test": "npm run lint && npm run test:it && npm run build",
+    "release": "npm-run-all release:**",
+    "release:build-and-test": "npm run build-and-test",
+    "release:version": "standard-version",
+    "release:push": "git push && git push --tag",
+    "release:publish": "npm publish",
+    "release-dry-run": "npm run build-and-test && standard-version --dry-run",
+    "prepare": "husky install"
+  },
+  "files": [
+    "README.md",
+    "LICENSE.md",
+    "lib"
+  ],
+  "license": "ISC",
+  "devDependencies": {
+    "@babel/cli": "7.23.4",
+    "@babel/core": "7.23.5",
+    "@babel/plugin-transform-typescript": "7.23.5",
+    "@babel/preset-env": "7.23.5",
+    "@babel/preset-typescript": "7.23.3",
+    "@commitlint/cli": "18.4.3",
+    "@commitlint/config-conventional": "18.4.3",
+    "@types/node": "20.10.4",
+    "@typescript-eslint/eslint-plugin": "6.13.2",
+    "@typescript-eslint/parser": "6.13.2",
+    "benchmark": "2.1.4",
+    "cpy-cli": "5.0.0",
+    "del-cli": "5.1.0",
+    "eslint": "8.55.0",
+    "eslint-config-standard": "17.1.0",
+    "eslint-plugin-import": "2.29.0",
+    "eslint-plugin-n": "16.3.1",
+    "eslint-plugin-node": "11.1.0",
+    "eslint-plugin-promise": "6.1.1",
+    "husky": "8.0.3",
+    "npm-run-all": "4.1.5",
+    "prettier": "3.1.0",
+    "rollup": "4.6.1",
+    "standard-version": "9.5.0",
+    "ts-node": "10.9.1",
+    "typescript": "5.3.3",
+    "uglify-js": "3.17.4",
+    "vitest": "1.0.1"
+  }
+}