streaming-diff-parser

Streaming parsing for git diffs.

Usage

Using an async iterator

import{parse}from'streaming-diff-parser'// create a readline interface, e.g. from a file or stdinconstinput=readline.createInterface({input: createReadStream(...),})// iterate over results and do whatever you want with themforawait(constoutputofparse(input)){console.log(JSON.stringify(output,null,' '))}

Getting the entire output

import{parseAll,FileDiff}from'streaming-diff-parser'// create a readline interface, e.g. from a file or stdinconstinput=readline.createInterface({input: createReadStream(...),})constresults: FileDiff[]=awaitparseAll(input)

Understanding the Output

This Stack Overflow answer has a nice description of the parts of a git diff. The type definitions and a labeled example are below.

exporttypeChange=|{content: stringtype: 'add'|'remove'lineNumber?: number}|{content: stringtype: 'unchanged'oldLineNumber: numbernewLineNumber: number}exporttypeHunk={header?: stringoldStartLineNumber?: numbernewStartLineNumber?: numberoldLineCount?: numbernewLineCount?: numberchanges: Change[]}exporttypeFileDiff={hunks?: Hunk[]oldFileMode?: stringnewFileMode?: stringsimilarity?: numberoldBlobObjectName?: stringnewBlobObjectName?: stringoldPath: stringnewPath: stringisBinary: booleantype: 'add'|'delete'|'modify'|'rename'|'copy'trailingNewline: 'present'|'missing'|'added'|'removed'}

Comments were added to this diff, starting with #

diff --git a/bar/a.txt b/bar/a.txt # diff --git a/<oldPath> b/<newPath> - start of a new FileDiff
index 257cc56..5716ca5 100644 # index <oldBlobObjectName>..<newBlobObjectName> <old and new fileMode>
--- a/bar/a.txt # a/<oldPath>+++ b/bar/a.txt # b/<newPath>, since neither of these paths are /dev/null, this FileDiff will have type='modify'@@ -1 +1 @@ # beginning of hunk, - @@ -<oldStartLineNumber>,<oldLineCount=1> +<newStartLineNumber>,<newLineCount=1> <header=undefined>
-foo # 'remove' change+bar # 'add' changediff --git a/foo/a.txt b/foo/a.txt # start of a new FileDiff
index 257cc56..3bd1f0e 100644
--- a/foo/a.txt+++ b/foo/a.txt@@ -1 +1,2 @@
foo
+bar

streaming-diff-parser

Streaming parsing for git diffs.

Usage

Using an async iterator

import{parse}from'streaming-diff-parser'// create a readline interface, e.g. from a file or stdinconstinput=readline.createInterface({input: createReadStream(...),})// iterate over results and do whatever you want with themforawait(constoutputofparse(input)){console.log(JSON.stringify(output,null,' '))}

Getting the entire output

import{parseAll,FileDiff}from'streaming-diff-parser'// create a readline interface, e.g. from a file or stdinconstinput=readline.createInterface({input: createReadStream(...),})constresults: FileDiff[]=awaitparseAll(input)

Understanding the Output

This Stack Overflow answer has a nice description of the parts of a git diff. The type definitions and a labeled example are below.

exporttypeChange=|{content: stringtype: 'add'|'remove'lineNumber?: number}|{content: stringtype: 'unchanged'oldLineNumber: numbernewLineNumber: number}exporttypeHunk={header?: stringoldStartLineNumber?: numbernewStartLineNumber?: numberoldLineCount?: numbernewLineCount?: numberchanges: Change[]}exporttypeFileDiff={hunks?: Hunk[]oldFileMode?: stringnewFileMode?: stringsimilarity?: numberoldBlobObjectName?: stringnewBlobObjectName?: stringoldPath: stringnewPath: stringisBinary: booleantype: 'add'|'delete'|'modify'|'rename'|'copy'trailingNewline: 'present'|'missing'|'added'|'removed'}

Comments were added to this diff, starting with #

diff --git a/bar/a.txt b/bar/a.txt # diff --git a/<oldPath> b/<newPath> - start of a new FileDiff
index 257cc56..5716ca5 100644 # index <oldBlobObjectName>..<newBlobObjectName> <old and new fileMode>
--- a/bar/a.txt # a/<oldPath>+++ b/bar/a.txt # b/<newPath>, since neither of these paths are /dev/null, this FileDiff will have type='modify'@@ -1 +1 @@ # beginning of hunk, - @@ -<oldStartLineNumber>,<oldLineCount=1> +<newStartLineNumber>,<newLineCount=1> <header=undefined>
-foo # 'remove' change+bar # 'add' changediff --git a/foo/a.txt b/foo/a.txt # start of a new FileDiff
index 257cc56..3bd1f0e 100644
--- a/foo/a.txt+++ b/foo/a.txt@@ -1 +1,2 @@
foo
+bar

streaming-diff-parser

Streaming parsing for git diffs.

Usage

Using an async iterator

import{parse}from'streaming-diff-parser'// create a readline interface, e.g. from a file or stdinconstinput=readline.createInterface({input: createReadStream(...),})// iterate over results and do whatever you want with themforawait(constoutputofparse(input)){console.log(JSON.stringify(output,null,' '))}

Getting the entire output

import{parseAll,FileDiff}from'streaming-diff-parser'// create a readline interface, e.g. from a file or stdinconstinput=readline.createInterface({input: createReadStream(...),})constresults: FileDiff[]=awaitparseAll(input)

Understanding the Output

This Stack Overflow answer has a nice description of the parts of a git diff. The type definitions and a labeled example are below.

exporttypeChange=|{content: stringtype: 'add'|'remove'lineNumber?: number}|{content: stringtype: 'unchanged'oldLineNumber: numbernewLineNumber: number}exporttypeHunk={header?: stringoldStartLineNumber?: numbernewStartLineNumber?: numberoldLineCount?: numbernewLineCount?: numberchanges: Change[]}exporttypeFileDiff={hunks?: Hunk[]oldFileMode?: stringnewFileMode?: stringsimilarity?: numberoldBlobObjectName?: stringnewBlobObjectName?: stringoldPath: stringnewPath: stringisBinary: booleantype: 'add'|'delete'|'modify'|'rename'|'copy'trailingNewline: 'present'|'missing'|'added'|'removed'}

Comments were added to this diff, starting with #

diff --git a/bar/a.txt b/bar/a.txt # diff --git a/<oldPath> b/<newPath> - start of a new FileDiff
index 257cc56..5716ca5 100644 # index <oldBlobObjectName>..<newBlobObjectName> <old and new fileMode>
--- a/bar/a.txt # a/<oldPath>+++ b/bar/a.txt # b/<newPath>, since neither of these paths are /dev/null, this FileDiff will have type='modify'@@ -1 +1 @@ # beginning of hunk, - @@ -<oldStartLineNumber>,<oldLineCount=1> +<newStartLineNumber>,<newLineCount=1> <header=undefined>
-foo # 'remove' change+bar # 'add' changediff --git a/foo/a.txt b/foo/a.txt # start of a new FileDiff
index 257cc56..3bd1f0e 100644
--- a/foo/a.txt+++ b/foo/a.txt@@ -1 +1,2 @@
foo
+bar

streaming-diff-parser

Streaming parsing for git diffs.

Usage

Using an async iterator

import{parse}from'streaming-diff-parser'// create a readline interface, e.g. from a file or stdinconstinput=readline.createInterface({input: createReadStream(...),})// iterate over results and do whatever you want with themforawait(constoutputofparse(input)){console.log(JSON.stringify(output,null,' '))}

Getting the entire output

import{parseAll,FileDiff}from'streaming-diff-parser'// create a readline interface, e.g. from a file or stdinconstinput=readline.createInterface({input: createReadStream(...),})constresults: FileDiff[]=awaitparseAll(input)

Understanding the Output

This Stack Overflow answer has a nice description of the parts of a git diff. The type definitions and a labeled example are below.

exporttypeChange=|{content: stringtype: 'add'|'remove'lineNumber?: number}|{content: stringtype: 'unchanged'oldLineNumber: numbernewLineNumber: number}exporttypeHunk={header?: stringoldStartLineNumber?: numbernewStartLineNumber?: numberoldLineCount?: numbernewLineCount?: numberchanges: Change[]}exporttypeFileDiff={hunks?: Hunk[]oldFileMode?: stringnewFileMode?: stringsimilarity?: numberoldBlobObjectName?: stringnewBlobObjectName?: stringoldPath: stringnewPath: stringisBinary: booleantype: 'add'|'delete'|'modify'|'rename'|'copy'trailingNewline: 'present'|'missing'|'added'|'removed'}

Comments were added to this diff, starting with #

diff --git a/bar/a.txt b/bar/a.txt # diff --git a/<oldPath> b/<newPath> - start of a new FileDiff
index 257cc56..5716ca5 100644 # index <oldBlobObjectName>..<newBlobObjectName> <old and new fileMode>
--- a/bar/a.txt # a/<oldPath>+++ b/bar/a.txt # b/<newPath>, since neither of these paths are /dev/null, this FileDiff will have type='modify'@@ -1 +1 @@ # beginning of hunk, - @@ -<oldStartLineNumber>,<oldLineCount=1> +<newStartLineNumber>,<newLineCount=1> <header=undefined>
-foo # 'remove' change+bar # 'add' changediff --git a/foo/a.txt b/foo/a.txt # start of a new FileDiff
index 257cc56..3bd1f0e 100644
--- a/foo/a.txt+++ b/foo/a.txt@@ -1 +1,2 @@
foo
+bar

streaming-diff-parser

Streaming parsing for git diffs.

Usage

Using an async iterator

import{parse}from'streaming-diff-parser'// create a readline interface, e.g. from a file or stdinconstinput=readline.createInterface({input: createReadStream(...),})// iterate over results and do whatever you want with themforawait(constoutputofparse(input)){console.log(JSON.stringify(output,null,' '))}

Getting the entire output

import{parseAll,FileDiff}from'streaming-diff-parser'// create a readline interface, e.g. from a file or stdinconstinput=readline.createInterface({input: createReadStream(...),})constresults: FileDiff[]=awaitparseAll(input)

Understanding the Output

This Stack Overflow answer has a nice description of the parts of a git diff. The type definitions and a labeled example are below.

exporttypeChange=|{content: stringtype: 'add'|'remove'lineNumber?: number}|{content: stringtype: 'unchanged'oldLineNumber: numbernewLineNumber: number}exporttypeHunk={header?: stringoldStartLineNumber?: numbernewStartLineNumber?: numberoldLineCount?: numbernewLineCount?: numberchanges: Change[]}exporttypeFileDiff={hunks?: Hunk[]oldFileMode?: stringnewFileMode?: stringsimilarity?: numberoldBlobObjectName?: stringnewBlobObjectName?: stringoldPath: stringnewPath: stringisBinary: booleantype: 'add'|'delete'|'modify'|'rename'|'copy'trailingNewline: 'present'|'missing'|'added'|'removed'}

Comments were added to this diff, starting with #

diff --git a/bar/a.txt b/bar/a.txt # diff --git a/<oldPath> b/<newPath> - start of a new FileDiff
index 257cc56..5716ca5 100644 # index <oldBlobObjectName>..<newBlobObjectName> <old and new fileMode>
--- a/bar/a.txt # a/<oldPath>+++ b/bar/a.txt # b/<newPath>, since neither of these paths are /dev/null, this FileDiff will have type='modify'@@ -1 +1 @@ # beginning of hunk, - @@ -<oldStartLineNumber>,<oldLineCount=1> +<newStartLineNumber>,<newLineCount=1> <header=undefined>
-foo # 'remove' change+bar # 'add' changediff --git a/foo/a.txt b/foo/a.txt # start of a new FileDiff
index 257cc56..3bd1f0e 100644
--- a/foo/a.txt+++ b/foo/a.txt@@ -1 +1,2 @@
foo
+bar

streaming-diff-parser

Streaming parsing for git diffs.

Usage

Using an async iterator

import{parse}from'streaming-diff-parser'// create a readline interface, e.g. from a file or stdinconstinput=readline.createInterface({input: createReadStream(...),})// iterate over results and do whatever you want with themforawait(constoutputofparse(input)){console.log(JSON.stringify(output,null,' '))}

Getting the entire output

import{parseAll,FileDiff}from'streaming-diff-parser'// create a readline interface, e.g. from a file or stdinconstinput=readline.createInterface({input: createReadStream(...),})constresults: FileDiff[]=awaitparseAll(input)

Understanding the Output

This Stack Overflow answer has a nice description of the parts of a git diff. The type definitions and a labeled example are below.

exporttypeChange=|{content: stringtype: 'add'|'remove'lineNumber?: number}|{content: stringtype: 'unchanged'oldLineNumber: numbernewLineNumber: number}exporttypeHunk={header?: stringoldStartLineNumber?: numbernewStartLineNumber?: numberoldLineCount?: numbernewLineCount?: numberchanges: Change[]}exporttypeFileDiff={hunks?: Hunk[]oldFileMode?: stringnewFileMode?: stringsimilarity?: numberoldBlobObjectName?: stringnewBlobObjectName?: stringoldPath: stringnewPath: stringisBinary: booleantype: 'add'|'delete'|'modify'|'rename'|'copy'trailingNewline: 'present'|'missing'|'added'|'removed'}

Comments were added to this diff, starting with #

diff --git a/bar/a.txt b/bar/a.txt # diff --git a/<oldPath> b/<newPath> - start of a new FileDiff
index 257cc56..5716ca5 100644 # index <oldBlobObjectName>..<newBlobObjectName> <old and new fileMode>
--- a/bar/a.txt # a/<oldPath>+++ b/bar/a.txt # b/<newPath>, since neither of these paths are /dev/null, this FileDiff will have type='modify'@@ -1 +1 @@ # beginning of hunk, - @@ -<oldStartLineNumber>,<oldLineCount=1> +<newStartLineNumber>,<newLineCount=1> <header=undefined>
-foo # 'remove' change+bar # 'add' changediff --git a/foo/a.txt b/foo/a.txt # start of a new FileDiff
index 257cc56..3bd1f0e 100644
--- a/foo/a.txt+++ b/foo/a.txt@@ -1 +1,2 @@
foo
+bar

streaming-diff-parser

Streaming parsing for git diffs.

Usage

Using an async iterator

import{parse}from'streaming-diff-parser'// create a readline interface, e.g. from a file or stdinconstinput=readline.createInterface({input: createReadStream(...),})// iterate over results and do whatever you want with themforawait(constoutputofparse(input)){console.log(JSON.stringify(output,null,' '))}

Getting the entire output

import{parseAll,FileDiff}from'streaming-diff-parser'// create a readline interface, e.g. from a file or stdinconstinput=readline.createInterface({input: createReadStream(...),})constresults: FileDiff[]=awaitparseAll(input)

Understanding the Output

This Stack Overflow answer has a nice description of the parts of a git diff. The type definitions and a labeled example are below.

exporttypeChange=|{content: stringtype: 'add'|'remove'lineNumber?: number}|{content: stringtype: 'unchanged'oldLineNumber: numbernewLineNumber: number}exporttypeHunk={header?: stringoldStartLineNumber?: numbernewStartLineNumber?: numberoldLineCount?: numbernewLineCount?: numberchanges: Change[]}exporttypeFileDiff={hunks?: Hunk[]oldFileMode?: stringnewFileMode?: stringsimilarity?: numberoldBlobObjectName?: stringnewBlobObjectName?: stringoldPath: stringnewPath: stringisBinary: booleantype: 'add'|'delete'|'modify'|'rename'|'copy'trailingNewline: 'present'|'missing'|'added'|'removed'}

Comments were added to this diff, starting with #

diff --git a/bar/a.txt b/bar/a.txt # diff --git a/<oldPath> b/<newPath> - start of a new FileDiff
index 257cc56..5716ca5 100644 # index <oldBlobObjectName>..<newBlobObjectName> <old and new fileMode>
--- a/bar/a.txt # a/<oldPath>+++ b/bar/a.txt # b/<newPath>, since neither of these paths are /dev/null, this FileDiff will have type='modify'@@ -1 +1 @@ # beginning of hunk, - @@ -<oldStartLineNumber>,<oldLineCount=1> +<newStartLineNumber>,<newLineCount=1> <header=undefined>
-foo # 'remove' change+bar # 'add' changediff --git a/foo/a.txt b/foo/a.txt # start of a new FileDiff
index 257cc56..3bd1f0e 100644
--- a/foo/a.txt+++ b/foo/a.txt@@ -1 +1,2 @@
foo
+bar

streaming-diff-parser

Streaming parsing for git diffs.

Usage

Using an async iterator

import{parse}from'streaming-diff-parser'// create a readline interface, e.g. from a file or stdinconstinput=readline.createInterface({input: createReadStream(...),})// iterate over results and do whatever you want with themforawait(constoutputofparse(input)){console.log(JSON.stringify(output,null,' '))}

Getting the entire output

import{parseAll,FileDiff}from'streaming-diff-parser'// create a readline interface, e.g. from a file or stdinconstinput=readline.createInterface({input: createReadStream(...),})constresults: FileDiff[]=awaitparseAll(input)

Understanding the Output

This Stack Overflow answer has a nice description of the parts of a git diff. The type definitions and a labeled example are below.

exporttypeChange=|{content: stringtype: 'add'|'remove'lineNumber?: number}|{content: stringtype: 'unchanged'oldLineNumber: numbernewLineNumber: number}exporttypeHunk={header?: stringoldStartLineNumber?: numbernewStartLineNumber?: numberoldLineCount?: numbernewLineCount?: numberchanges: Change[]}exporttypeFileDiff={hunks?: Hunk[]oldFileMode?: stringnewFileMode?: stringsimilarity?: numberoldBlobObjectName?: stringnewBlobObjectName?: stringoldPath: stringnewPath: stringisBinary: booleantype: 'add'|'delete'|'modify'|'rename'|'copy'trailingNewline: 'present'|'missing'|'added'|'removed'}

Comments were added to this diff, starting with #

diff --git a/bar/a.txt b/bar/a.txt # diff --git a/<oldPath> b/<newPath> - start of a new FileDiff
index 257cc56..5716ca5 100644 # index <oldBlobObjectName>..<newBlobObjectName> <old and new fileMode>
--- a/bar/a.txt # a/<oldPath>+++ b/bar/a.txt # b/<newPath>, since neither of these paths are /dev/null, this FileDiff will have type='modify'@@ -1 +1 @@ # beginning of hunk, - @@ -<oldStartLineNumber>,<oldLineCount=1> +<newStartLineNumber>,<newLineCount=1> <header=undefined>
-foo # 'remove' change+bar # 'add' changediff --git a/foo/a.txt b/foo/a.txt # start of a new FileDiff
index 257cc56..3bd1f0e 100644
--- a/foo/a.txt+++ b/foo/a.txt@@ -1 +1,2 @@
foo
+bar

Name		Name	Last commit message	Last commit date
src		src
.eslintignore		.eslintignore
.eslintrc.cjs		.eslintrc.cjs
.gitignore		.gitignore
.prettierignore		.prettierignore
.prettierrc.json		.prettierrc.json
LICENSE		LICENSE
README.md		README.md
package.json		package.json
tsconfig.json		tsconfig.json
yarn.lock		yarn.lock

Name		Name	Last commit message	Last commit date
src		src
.eslintignore		.eslintignore
.eslintrc.cjs		.eslintrc.cjs
.gitignore		.gitignore
.prettierignore		.prettierignore
.prettierrc.json		.prettierrc.json
LICENSE		LICENSE
README.md		README.md
package.json		package.json
tsconfig.json		tsconfig.json
yarn.lock		yarn.lock

Name		Name	Last commit message	Last commit date
src		src
.eslintignore		.eslintignore
.eslintrc.cjs		.eslintrc.cjs
.gitignore		.gitignore
.prettierignore		.prettierignore
.prettierrc.json		.prettierrc.json
LICENSE		LICENSE
README.md		README.md
package.json		package.json
tsconfig.json		tsconfig.json
yarn.lock		yarn.lock

Name		Name	Last commit message	Last commit date
src		src
.eslintignore		.eslintignore
.eslintrc.cjs		.eslintrc.cjs
.gitignore		.gitignore
.prettierignore		.prettierignore
.prettierrc.json		.prettierrc.json
LICENSE		LICENSE
README.md		README.md
package.json		package.json
tsconfig.json		tsconfig.json
yarn.lock		yarn.lock

Name		Name	Last commit message	Last commit date
src		src
.eslintignore		.eslintignore
.eslintrc.cjs		.eslintrc.cjs
.gitignore		.gitignore
.prettierignore		.prettierignore
.prettierrc.json		.prettierrc.json
LICENSE		LICENSE
README.md		README.md
package.json		package.json
tsconfig.json		tsconfig.json
yarn.lock		yarn.lock

Latest commit

History

Folders and files

Repository files navigation

streaming-diff-parser

Usage

Using an async iterator

Getting the entire output

Understanding the Output

About

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages

Latest commit

History

Folders and files

Repository files navigation

streaming-diff-parser

Usage

Using an async iterator

Getting the entire output

Understanding the Output

About

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages

Latest commit

History

Folders and files

Repository files navigation

streaming-diff-parser

Usage

Using an async iterator

Getting the entire output

Understanding the Output

About

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages

Latest commit

History

Folders and files

Repository files navigation

streaming-diff-parser

Usage

Using an async iterator

Getting the entire output

Understanding the Output

About

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages

Latest commit

History

Folders and files

Repository files navigation

streaming-diff-parser

Usage

Using an async iterator

Getting the entire output