# babel-plugin-reshow-object-to-json-parse

> [![CircleCI](https://circleci.com/gh/nd-02110114/babel-plugin-object-to-json-parse/tree/master.svg?style=svg)](https://circleci.com/gh/nd-02110114/3dmol-sandbox/tree/master) [![License: MIT](https://img.shields.io/github/license/nd-02110114/babel-plugin-o

Latest version **0.0.9** (published 2020-04-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install babel-plugin-reshow-object-to-json-parse
pnpm add babel-plugin-reshow-object-to-json-parse
yarn add babel-plugin-reshow-object-to-json-parse
bun add babel-plugin-reshow-object-to-json-parse
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.9 |
| Published | 2020-04-05 |
| First published | 2020-04-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 10.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | nd-02110114 |
| Maintainers | hillliu |

## Links

- npm: https://www.npmjs.com/package/babel-plugin-reshow-object-to-json-parse
- npm.io page: https://npm.io/package/babel-plugin-reshow-object-to-json-parse

## Dependencies (2)

- [@babel/core](https://npm.io/package/@babel/core.md) ^7.7.7
- [@babel/types](https://npm.io/package/@babel/types.md) ^7.7.4

## Recent versions

- 0.0.9 (latest) — 2020-04-05

## README

# babel-plugin-object-to-json-parse 🚀

[![CircleCI](https://circleci.com/gh/nd-02110114/babel-plugin-object-to-json-parse/tree/master.svg?style=svg)](https://circleci.com/gh/nd-02110114/3dmol-sandbox/tree/master)
[![License: MIT](https://img.shields.io/github/license/nd-02110114/babel-plugin-object-to-json-parse.svg)](https://opensource.org/licenses/MIT)
[![npm version](https://badge.fury.io/js/babel-plugin-object-to-json-parse.svg)](https://badge.fury.io/js/babel-plugin-object-to-json-parse)


This repository is inspired by [this article](https://v8.dev/blog/cost-of-javascript-2019#json)

> As long as the JSON string is only evaluated once, the JSON.parse approach is much faster compared to the JavaScript object literal, especially for cold loads.

## Object to JSON.parse

This plugin converts from object literal to JSON.parse ([example](https://github.com/nd-02110114/babel-plugin-object-to-json-parse/tree/master/example))

```js
// before
const data = { foo: 42, bar: 1337 };

// after
const data = JSON.parse('{"foo":42,"bar":1337}');
```

## How to use

### Install

```sh
$ npm install babel-plugin-object-to-json-parse -D
or
$ yarn add babel-plugin-object-to-json-parse -D
```

### setup `.babelrc`

```json
{
  "plugins": ["object-to-json-parse"]
}
```


### Options 
#### `minJSONStringSize` (`number`, defaults to `1024`)

The `minJSONStringSize` option will prevent the plugin from replacing an expression if the length of the JSON string given to `JSON.parse` is smaller than `minJSONStringSize`. For example, the following ensures all replacements have a string size of at least 1kb.

```json
{
  "plugins": [
    ["object-to-json-parse", {
      "minJSONStringSize": 1024
    }]
  ]
}
```

## Caution!!
### this plugin may not be production ready
I just made this plugin for my understanding about AST and babel plugin.

### this plugin doesn't support partially JSON expression

I decided not to support partially JSON expression like below.

> Partially JSON expressions such as [notValid, {isValid:true}] ensuring {isValid:true} is transformed.

```
const data = { bar: invalid_object, foo: 'foo' }
↓
const data = { bar: invalid_object, JSON.parse('{"foo": "foo"}')}
```

This is because I think most large objects are not partially JSON expressions. **JSON.parse() is much faster in the case that object is 10 kB or larger. Converting small object to JSON.parse expression is not meaningful.**

### this plugin produces output that only works in modern environments (e.g. Node.js v10+)

I don't care about some backwards compatibilities like [this issue](https://github.com/nd-02110114/babel-plugin-object-to-json-parse/issues/12).

## Development

### Setup

```sh
$ git clone git@github.com:nd-02110114/babel-plugin-object-to-json-parse.git
$ cd babel-plugin-object-to-json-parse
$ yarn install
```

### Tips

```sh
// example
$ yarn build && yarn example

// test
$ yarn test
```

---
_Source: https://npm.io/package/babel-plugin-reshow-object-to-json-parse · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._