# whitespace-json

> WhiteSpace JSON - JSON but every character is whitespace. Config files now readable by nobody!! 👍🏻

Latest version **1.1.1** (published 2021-07-18) · ISC license · 0 weekly downloads

## Install

```sh
npm install whitespace-json
pnpm add whitespace-json
yarn add whitespace-json
bun add whitespace-json
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2021-07-18 |
| First published | 2021-07-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 26.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | patrickbrett |
| Keywords | whitespace, json, parse, stringify, wson, encode, config, unreadable, emoji, decode, emojson |

## Links

- npm: https://www.npmjs.com/package/whitespace-json
- Repository: https://github.com/patrickbrett/whitespace-json
- Homepage: https://github.com/patrickbrett/whitespace-json#readme
- Issues: https://github.com/patrickbrett/whitespace-json/issues
- npm.io page: https://npm.io/package/whitespace-json

## Dependencies (1)

- [grapheme-splitter](https://npm.io/package/grapheme-splitter.md) ^1.0.4

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 1.1.1 (latest) — 2021-07-18
- 1.1.0 — 2021-07-18
- 1.0.1 — 2021-07-18
- 1.0.0 — 2021-07-18

## README

# Whitespace JSON

Whitespace JSON - JSON but every character is whitespace. Config files now readable by nobody!! 👍🏻

[![npm version](https://badge.fury.io/js/whitespace-json.svg)](https://npmjs.com/package/whitespace-json)

## Wait, what?

Ever looked at a config file, you know, one like this:

```
{
  "web-app": {
    "servlet": [
      {
        "servlet-name": "cofaxCDS",
        "servlet-class": "org.cofax.cds.CDSServlet",
      }
    ]
  }
}
```

And thought to yourself, wow, that's great and all but I wish this config file looked more like this:

```
 
         	   ​ ​   ⠀ 
                   ⠀ 
 
                 	 
   	     ⠀                                      	             ⠀        
          
       
                             
```

Yeah? Neither have I!

Which is why I made Whitespace JSON - the only (as far as I can tell, nobody else would bother to make this) way to encode your JSON config files so that they *only use whitespace characters*.

The days of pesky, readable JSON files are no more. The possibilities are endless:

* Store your database passwords in a format nobody will bother to read
* Impress your friends with your cool, mysterious configuration files
* Even build your own web server using WSON documents for API calls, and delight your users!

## Wow, sign me up! How do I use this thing?

That's the best part - you shouldn't!

Alright, if you insist - install via NPM:

`npm i whitespace-json`

Then import it like this:

```
const { parse, stringify } = require('whitespace-json');

const thisIsWhitespace = stringify("Don't say I didn't warn you");

const backToNormal = parse(thisIsWhitespace);
```

Oh, did I mention you can also encode your JSON files as emoji? 💯🥳🤪

```
const { parse, stringify } = require('whitespace-json');

const thisIsWhitespace = stringify("Don't say I didn't warn you", { emoji: true });

const backToNormal = parse(thisIsWhitespace, { emoji: true });
```

Looks like this:

```
🙏😘🥺🥺😍😘😍✨🙏😊🥺🥺❤️💕🥺🥺🙏😍😍😭😍👍🙏✨😍✨🥺🥺🥺👍🥺🥺😍😭😍🚗😍
🙏🤣😍🥰😍✨🙏🥺🥺🥺❤️💕🥺🥺😍😭😍🚗😍
🙏🤣😍🥰😍✨🙏🥺🥺😂🙏😍😍😭😍👍🙏✨😍✨🥺🥺🥺👍🥺🥺😍😭🙏🥺🙏🥺😍😭🙏😊🥺🥺❤️💕✨😘🥺🥺😍🥰😍✨🙏🥺😍✨🥺🙏🙏❤️🥺🥺🥺👍🥺🥺😍
😍🚗😍✨🥺🥺✨🍑🙏🍑
```

Godspeed my friend.

---
_Source: https://npm.io/package/whitespace-json · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._