Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ehmicky/guess-json-indent
Guess the indentation of a JSON string.
https://github.com/ehmicky/guess-json-indent
algorithm detection heuristic-algorithm heuristics indent indentation javascript json length library newline nodejs parsing serialization size space string tabs typescript whitespace
Last synced: 19 days ago
JSON representation
Guess the indentation of a JSON string.
- Host: GitHub
- URL: https://github.com/ehmicky/guess-json-indent
- Owner: ehmicky
- License: mit
- Created: 2022-08-10T17:27:25.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-14T16:52:57.000Z (2 months ago)
- Last Synced: 2024-10-11T10:17:02.524Z (about 1 month ago)
- Topics: algorithm, detection, heuristic-algorithm, heuristics, indent, indentation, javascript, json, length, library, newline, nodejs, parsing, serialization, size, space, string, tabs, typescript, whitespace
- Language: JavaScript
- Homepage:
- Size: 7.73 MB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/guess-json-indent)
[](https://unpkg.com/guess-json-indent?module)
[](/src/main.d.ts)
[](https://codecov.io/gh/ehmicky/guess-json-indent)
[](https://bundlephobia.com/package/guess-json-indent)
[](https://fosstodon.org/@ehmicky)
[](https://medium.com/@ehmicky)
Guess the indentation of a JSON string.
# Hire me
Please
[reach out](https://www.linkedin.com/feed/update/urn:li:activity:7117265228068716545/)
if you're looking for a Node.js API or CLI engineer (11 years of experience).
Most recently I have been [Netlify Build](https://github.com/netlify/build)'s
and [Netlify Plugins](https://www.netlify.com/products/build/plugins/)'
technical lead for 2.5 years. I am available for full-time remote positions.
# Example
```js
import guessJsonIndent from 'guess-json-indent'
const input = [{ example: true }]
guessJsonIndent(JSON.stringify(input)) // undefined
guessJsonIndent(JSON.stringify(input, undefined, 1)) // 1
guessJsonIndent(JSON.stringify(input, undefined, 2)) // 2
guessJsonIndent(JSON.stringify(input, undefined, 4)) // 4
guessJsonIndent(JSON.stringify(input, undefined, '\t')) // '\t'
guessJsonIndent(JSON.stringify(input, undefined, '\t\t')) // '\t\t'
// Keep the indentation of a JSON string when parsing/serializing it
const jsonString = JSON.stringify(input, undefined, 2)
const indent = guessJsonIndent(jsonString)
const parsedValue = JSON.parse(jsonString)
console.log(JSON.stringify(input, undefined, indent)) // Same as jsonString
```
# Install
```bash
npm install guess-json-indent
```
This package works in both Node.js >=18.18.0 and
[browsers](https://raw.githubusercontent.com/ehmicky/dev-tasks/main/src/browserslist).
This is an ES module. It must be loaded using
[an `import` or `import()` statement](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c),
not `require()`. If TypeScript is used, it must be configured to
[output ES modules](https://www.typescriptlang.org/docs/handbook/esm-node.html),
not CommonJS.
# API
## guessJsonIndent(jsonString)
The return value is the same as the third argument to `JSON.stringify()`:
- `undefined`: none
- integer: number of spaces
- string: tabs
# Benchmarks
This library is very fast thanks to:
- Looking only at the first indented line, which is sufficient in the vast
majority of real-life cases
- Being specific to JSON
The following benchmarks compares it:
- With [`detect-indent`](https://github.com/sindresorhus/detect-indent),
[`detect-json-indent`](https://github.com/mapbox/detect-json-indent) and
[`detect-indentation`](https://github.com/bevry/detect-indentation)
- On a big JSON string (8MB)
```
guess-json-indent: 43ns
detect-json-indent: 60114470ns
detect-indentation: 141975495ns
detect-indent: 198161087ns
```
# Related projects
- [`truncate-json`](https://github.com/ehmicky/truncate-json): Truncate a JSON
string
- [`is-json-value`](https://github.com/ehmicky/is-json-value): Check if a value
is valid JSON
- [`safe-json-value`](https://github.com/ehmicky/safe-json-value): ⛑️ JSON
serialization should never fail
# Support
For any question, _don't hesitate_ to [submit an issue on GitHub](../../issues).
Everyone is welcome regardless of personal background. We enforce a
[Code of conduct](CODE_OF_CONDUCT.md) in order to promote a positive and
inclusive environment.
# Contributing
This project was made with ❤️. The simplest way to give back is by starring and
sharing it online.
If the documentation is unclear or has a typo, please click on the page's `Edit`
button (pencil icon) and suggest a correction.
If you would like to help us fix a bug or add a new feature, please check our
[guidelines](CONTRIBUTING.md). Pull requests are welcome!