Skip to content

Latest commit

 

History

History
94 lines (70 loc) · 8.58 KB

README.md

File metadata and controls

94 lines (70 loc) · 8.58 KB

json-fixer

NPM

GitHub package version devDependencies Status dependencies Status

GH Downloads GitHub commit activity the past year GitHub contributors Github search hit counter

Build Status codecov.io Code Coverage tested with jest Known Vulnerabilities

GitHub contributions welcome Commitizen friendly

GitHub top language GitHub language count GitHub code size in bytes

BCH compliance Codacy Badge

A JSON file fixer primarly focused to be used in a NodeJS file.

Usage

  • In NodeJS
const jsonFix = require('json-fixer')
const fs = require('fs')

// Get the (potentially malformed) JSON data ready
const jsonContent = fs.readFileSync('config.json', 'utf-8')

const {data, changed} = jsonFix(jsonContent) // Lint (and fix) it

if (changed) {
  // Do something with `data` which is the fixed JSON parsed data from `jsonContent`
  // e.g. `fs.writeFileSync(configPath, JSON.stringify(data, null, 2))`
}
  • In the CLI
    Not supported yet (PR welcome).

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Maximilian Berkmann

💻 📖 🤔 🚧 ⚠️ 🛡️

Semantic Release Bot

📦 📖

all-contributors[bot]

📖

Ben Kucera

💻

Svetozar Mateev

🐛 💻

André Paulo

🐛

Erkin Matkaziev

🐛

Codacy Badger

🚇 📖

GiraffeKey

💻 ⚠️

jonasmaertens

🐛

George Tsotsos

💻

This project follows the all-contributors specification. Contributions of any kind welcome!