# diffparser

> Unified diff parser

Latest version **2.0.1** (published 2018-02-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install diffparser
pnpm add diffparser
yarn add diffparser
bun add diffparser
```

## 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 | 2.0.1 |
| Published | 2018-02-25 |
| First published | 2016-06-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 10.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 12 |
| Author | Felix Gnass |
| Maintainers | fgnass |

## Links

- npm: https://www.npmjs.com/package/diffparser
- Repository: https://github.com/fgnass/diffparser
- Homepage: https://github.com/fgnass/diffparser#readme
- Issues: https://github.com/fgnass/diffparser/issues
- npm.io page: https://npm.io/package/diffparser

## Recent versions

- 2.0.1 (latest) — 2018-02-25
- 2.0.0 — 2017-05-29
- 1.1.0 — 2016-07-06
- 1.0.2 — 2016-06-10
- 1.0.1 — 2016-06-10
- 1.0.0 — 2016-06-10

## README

[![Build Status](https://travis-ci.org/fgnass/diffparser.svg?branch=master)](https://travis-ci.org/fgnass/diffparser)

# Unified diff parser for Node and the browser

This project is a ES2015 version of
https://github.com/sergeyt/parse-diff.

It comes with a full test suite and in addition to line numbers also provides `position` information as required by the [GitHub Comments API](https://developer.github.com/v3/pulls/comments/#create-a-comment).

```js
import parse from 'diffparser';

const diff = `
diff --git a/file b/file
index 123..456 789
--- a/file
+++ b/file
@@ -1,2 +1,2 @@
- line1
+ line2
`;

parse(diff);
```

This will return an array (one entry per file) with the following structure:

```json
[
  {
    "from": "file",
    "to": "file",
    "chunks": [
      {
        "content": "@@ -1,2 +1,2 @@",
        "changes": [
          {
            "type": "del",
            "del": true,
            "oldLine": 1,
            "position": 1,
            "content": "- line1"
          },
          {
            "type": "add",
            "add": true,
            "newLine": 1,
            "position": 2,
            "content": "+ line2"
          }
        ],
        "oldStart": 1,
        "oldLines": 2,
        "newStart": 1,
        "newLines": 2
      }
    ],
    "deletions": 1,
    "additions": 1,
    "index": [
      "123..456",
      "789"
    ]
  }
]
```

## Optional Rename Detection

You can pass `{ findRenames: true }` as option in order to detect renamed files:

```js
const diff = `
diff --git a/bar b/bar
new file mode 100644
index 0000000..4e4b354
--- /dev/null
+++ b/bar
@@ -0,0 +1,2 @@
+this is a
+sample file
diff --git a/foo b/foo
deleted file mode 100644
index 4e4b354..0000000
--- a/foo
+++ /dev/null
@@ -1,2 +0,0 @@
-this is a
-sample file
`;

parse(diff, { findRenames: true });
```

This will return the following array:

```js
[
  {
    "renamed": true,
    "from": "foo",
    "to": "bar"
  }
]
```

# License

MIT

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