# merge-json-file

> Merge a JSON file with a JSON object

Latest version **1.0.1** (published 2020-10-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install merge-json-file
pnpm add merge-json-file
yarn add merge-json-file
bun add merge-json-file
```

## 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.0.1 |
| Published | 2020-10-05 |
| First published | 2020-10-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 7 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Connor White |
| Maintainers | bconnorwhite |
| Keywords | merge, json, file, object, deepmerge, deep, objects, array, arrays, fs-safe, fs |

## Links

- npm: https://www.npmjs.com/package/merge-json-file
- Repository: https://github.com/bconnorwhite/merge-json-file
- Homepage: https://connorwhite.org/github/merge-json-file
- npm.io page: https://npm.io/package/merge-json-file

## Dependencies (4)

- [deepmerge](https://npm.io/package/deepmerge.md) ^4.2.2
- [types-json](https://npm.io/package/types-json.md) ^1.2.2
- [read-json-safe](https://npm.io/package/read-json-safe.md) ^2.0.2
- [write-json-safe](https://npm.io/package/write-json-safe.md) ^2.0.1

## 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.0.1 (latest) — 2020-10-05
- 1.0.0 — 2020-10-05

## README

<div align="center">
  <h1>merge-json-file</h1>
  <a href="https://npmjs.com/package/merge-json-file">
    <img alt="NPM" src="https://img.shields.io/npm/v/merge-json-file.svg">
  </a>
  <a href="https://github.com/bconnorwhite/merge-json-file">
    <img alt="TypeScript" src="https://img.shields.io/github/languages/top/bconnorwhite/merge-json-file.svg">
  </a>
  <a href='https://coveralls.io/github/bconnorwhite/merge-json-file?branch=master'>
    <img alt="Coverage Status" src="https://img.shields.io/coveralls/github/bconnorwhite/merge-json-file.svg?branch=master">
  </a>
  <a href="https://github.com/bconnorwhite/merge-json-file">
    <img alt="GitHub Stars" src="https://img.shields.io/github/stars/bconnorwhite/merge-json-file?label=Stars%20Appreciated%21&style=social">
  </a>
  <a href="https://twitter.com/bconnorwhite">
    <img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/bconnorwhite.svg?label=%40bconnorwhite&style=social">
  </a>
</div>

<br />

> Merge a JSON file with a JSON object.

## Installation

```sh
yarn add merge-json-file
```

```sh
npm install merge-json-file
```

## API

### Usage

#### For existing files:
```ts
import { mergeJSON } from "merge-json-file";

// old-file.json (before):
// {
//  "ok": true
// }
//
mergeJSON("old-file.json", { test: 1 });

// old-file.json (after):
// {
//   "ok": true,
//   "test": 1
// }
//
```

#### For new files:
```ts
import { mergeJSON } from "merge-json-file";

mergeJSON("new-file.json", { test: 1 });

// new-file.json:
// {
//   "test": 1
// }
//

```

### Types
```ts
import { mergeJSON, mergeJSONSync, JSONObject } from "merge-json-file";

function mergeJSON(path: string, object: JSONObject, options?: Options): Promise<boolean>;

function mergeJSONSync(path: string, object: JSONObject, options?: Options): boolean;

type Options = {
  /**
   * Output formatted JSON. Default: `true`
   */
  pretty?: boolean;
  /**
   * Recursively create parent directories if needed. Default: `true`
   */
  recursive?: boolean;
  /**
   * Ensure file ends with a newline. Default: `true`
   */
  appendNewline?: boolean;
}
```

<br />

<h2>Dependencies<img align="right" alt="dependencies" src="https://img.shields.io/david/bconnorwhite/merge-json-file.svg"></h2>

- [deepmerge](https://www.npmjs.com/package/deepmerge): A library for deep (recursive) merging of Javascript objects
- [read-json-safe](https://www.npmjs.com/package/read-json-safe): Read JSON files without try catch
- [write-json-safe](https://www.npmjs.com/package/write-json-safe): Write formatted JSON to a file

<br />

<h2>Dev Dependencies<img align="right" alt="David" src="https://img.shields.io/david/dev/bconnorwhite/merge-json-file.svg"></h2>

- [@bconnorwhite/bob](https://www.npmjs.com/package/@bconnorwhite/bob): undefined
- [@types/mock-fs](https://www.npmjs.com/package/@types/mock-fs): TypeScript definitions for mock-fs
- [mock-fs](https://www.npmjs.com/package/mock-fs): A configurable mock file system.  You know, for testing.

<br />

<h2>License <img align="right" alt="license" src="https://img.shields.io/npm/l/merge-json-file.svg"></h2>

[MIT](https://opensource.org/licenses/MIT)

<br />

## Related Packages

- [fs-safe](https://www.npmjs.com/package/fs-safe): A simple fs wrapper that doesn't throw
- [read-json-safe](https://www.npmjs.com/package/read-json-safe): Read JSON files without try catch
- [write-json-safe](https://www.npmjs.com/package/write-json-safe): Write formatted JSON to a file

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