Merge branch 'master' of github.com:kpdecker/jsdiff

Author: kpdecker

README.md

@@ -15,56 +15,56 @@ npm install diff --save
 
 ## API
 
-* `JsDiff.diffChars(oldStr, newStr[, options])` - diffs two blocks of text, comparing character by character.
+* `Diff.diffChars(oldStr, newStr[, options])` - diffs two blocks of text, comparing character by character.
 
     Returns a list of change objects (See below).
 
     Options
     * `ignoreCase`: `true` to ignore casing difference. Defaults to `false`.
 
-* `JsDiff.diffWords(oldStr, newStr[, options])` - diffs two blocks of text, comparing word by word, ignoring whitespace.
+* `Diff.diffWords(oldStr, newStr[, options])` - diffs two blocks of text, comparing word by word, ignoring whitespace.
 
     Returns a list of change objects (See below).
 
     Options
     * `ignoreCase`: Same as in `diffChars`.
 
-* `JsDiff.diffWordsWithSpace(oldStr, newStr[, options])` - diffs two blocks of text, comparing word by word, treating whitespace as significant.
+* `Diff.diffWordsWithSpace(oldStr, newStr[, options])` - diffs two blocks of text, comparing word by word, treating whitespace as significant.
 
     Returns a list of change objects (See below).
 
-* `JsDiff.diffLines(oldStr, newStr[, options])` - diffs two blocks of text, comparing line by line.
+* `Diff.diffLines(oldStr, newStr[, options])` - diffs two blocks of text, comparing line by line.
 
     Options
     * `ignoreWhitespace`: `true` to ignore leading and trailing whitespace. This is the same as `diffTrimmedLines`
     * `newlineIsToken`: `true` to treat newline characters as separate tokens.  This allows for changes to the newline structure to occur independently of the line content and to be treated as such. In general this is the more human friendly form of `diffLines` and `diffLines` is better suited for patches and other computer friendly output.
 
     Returns a list of change objects (See below).
 
-* `JsDiff.diffTrimmedLines(oldStr, newStr[, options])` - diffs two blocks of text, comparing line by line, ignoring leading and trailing whitespace.
+* `Diff.diffTrimmedLines(oldStr, newStr[, options])` - diffs two blocks of text, comparing line by line, ignoring leading and trailing whitespace.
 
     Returns a list of change objects (See below).
 
-* `JsDiff.diffSentences(oldStr, newStr[, options])` - diffs two blocks of text, comparing sentence by sentence.
+* `Diff.diffSentences(oldStr, newStr[, options])` - diffs two blocks of text, comparing sentence by sentence.
 
     Returns a list of change objects (See below).
 
-* `JsDiff.diffCss(oldStr, newStr[, options])` - diffs two blocks of text, comparing CSS tokens.
+* `Diff.diffCss(oldStr, newStr[, options])` - diffs two blocks of text, comparing CSS tokens.
 
     Returns a list of change objects (See below).
 
-* `JsDiff.diffJson(oldObj, newObj[, options])` - diffs two JSON objects, comparing the fields defined on each. The order of fields, etc does not matter in this comparison.
+* `Diff.diffJson(oldObj, newObj[, options])` - diffs two JSON objects, comparing the fields defined on each. The order of fields, etc does not matter in this comparison.
 
     Returns a list of change objects (See below).
 
-* `JsDiff.diffArrays(oldArr, newArr[, options])` - diffs two arrays, comparing each item for strict equality (===).
+* `Diff.diffArrays(oldArr, newArr[, options])` - diffs two arrays, comparing each item for strict equality (===).
 
     Options
     * `comparator`: `function(left, right)` for custom equality checks
 
     Returns a list of change objects (See below).
 
-* `JsDiff.createTwoFilesPatch(oldFileName, newFileName, oldStr, newStr, oldHeader, newHeader)` - creates a unified diff patch.
+* `Diff.createTwoFilesPatch(oldFileName, newFileName, oldStr, newStr, oldHeader, newHeader)` - creates a unified diff patch.
 
     Parameters:
     * `oldFileName` : String to be output in the filename section of the patch for the removals
@@ -75,12 +75,12 @@ npm install diff --save
     * `newHeader` : Additional information to include in the new file header
     * `options` : An object with options. Currently, only `context` is supported and describes how many lines of context should be included.
 
-* `JsDiff.createPatch(fileName, oldStr, newStr, oldHeader, newHeader)` - creates a unified diff patch.
+* `Diff.createPatch(fileName, oldStr, newStr, oldHeader, newHeader)` - creates a unified diff patch.
 
-    Just like JsDiff.createTwoFilesPatch, but with oldFileName being equal to newFileName.
+    Just like Diff.createTwoFilesPatch, but with oldFileName being equal to newFileName.
 
 
-* `JsDiff.structuredPatch(oldFileName, newFileName, oldStr, newStr, oldHeader, newHeader, options)` - returns an object with an array of hunk objects.
+* `Diff.structuredPatch(oldFileName, newFileName, oldStr, newStr, oldHeader, newHeader, options)` - returns an object with an array of hunk objects.
 
     This method is similar to createTwoFilesPatch, but returns a data structure
     suitable for further processing. Parameters are the same as createTwoFilesPatch. The data structure returned may look like this:
@@ -96,7 +96,7 @@ npm install diff --save
     }
     ```
 
-* `JsDiff.applyPatch(source, patch[, options])` - applies a unified diff patch.
+* `Diff.applyPatch(source, patch[, options])` - applies a unified diff patch.
 
     Return a string containing new version of provided data. `patch` may be a string diff or the output from the `parsePatch` or `structuredPatch` methods.
 
@@ -105,7 +105,7 @@ npm install diff --save
     - `fuzzFactor`: Number of lines that are allowed to differ before rejecting a patch. Defaults to 0.
     - `compareLine(lineNumber, line, operation, patchContent)`: Callback used to compare to given lines to determine if they should be considered equal when patching. Defaults to strict equality but may be overridden to provide fuzzier comparison. Should return false if the lines should be rejected.
 
-* `JsDiff.applyPatches(patch, options)` - applies one or more patches.
+* `Diff.applyPatches(patch, options)` - applies one or more patches.
 
     This method will iterate over the contents of the patch and apply to data provided through callbacks. The general flow for each patch index is:
 
@@ -114,9 +114,9 @@ npm install diff --save
 
     Once all patches have been applied or an error occurs, the `options.complete(err)` callback is made.
 
-* `JsDiff.parsePatch(diffStr)` - Parses a patch into structured data
+* `Diff.parsePatch(diffStr)` - Parses a patch into structured data
 
-    Return a JSON object representation of the a patch, suitable for use with the `applyPatch` method. This parses to the same structure returned by `JsDiff.structuredPatch`.
+    Return a JSON object representation of the a patch, suitable for use with the `applyPatch` method. This parses to the same structure returned by `Diff.structuredPatch`.
 
 * `convertChangesToXML(changes)` - converts a list of changes to a serialized XML format
 
@@ -138,17 +138,17 @@ Basic example in Node
 
 ```js
 require('colors');
-var jsdiff = require('diff');
+const Diff = require('diff');
 
-var one = 'beep boop';
-var other = 'beep boob blah';
+const one = 'beep boop';
+const other = 'beep boob blah';
 
-var diff = jsdiff.diffChars(one, other);
+const diff = Diff.diffChars(one, other);
 
-diff.forEach(function(part){
+diff.forEach((part) => {
   // green for additions, red for deletions
   // grey for common parts
-  var color = part.added ? 'green' :
+  const color = part.added ? 'green' :
     part.removed ? 'red' : 'grey';
   process.stderr.write(part.value[color]);
 });
@@ -165,19 +165,19 @@ Basic example in a web page
 <pre id="display"></pre>
 <script src="diff.js"></script>
 <script>
-var one = 'beep boop',
+const one = 'beep boop',
     other = 'beep boob blah',
     color = '',
     span = null;
 
-var diff = JsDiff.diffChars(one, other),
+const diff = Diff.diffChars(one, other),
     display = document.getElementById('display'),
     fragment = document.createDocumentFragment();
 
-diff.forEach(function(part){
+diff.forEach((part) => {
   // green for additions, red for deletions
   // grey for common parts
-  color = part.added ? 'green' :
+  const color = part.added ? 'green' :
     part.removed ? 'red' : 'grey';
   span = document.createElement('span');
   span.style.color = color;

examples/node_example.js

@@ -1,10 +1,10 @@
 require('colors')
-var jsdiff = require('../');
+var Diff = require('../');
 
 var one = 'beep boop';
 var other = 'beep boob blah';
 
-var diff = jsdiff.diffChars(one, other);
+var diff = Diff.diffChars(one, other);
 
 diff.forEach(function(part){
   // green for additions, red for deletions
@@ -14,4 +14,4 @@ diff.forEach(function(part){
   process.stderr.write(part.value[color]);
 });
 
-console.log();
+console.log();

examples/web_example.html

@@ -6,7 +6,7 @@
     color = '',
     span = null;
 
-var diff = JsDiff.diffChars(one, other),
+var diff = Diff.diffChars(one, other),
     display = document.getElementById('display'),
     fragment = document.createDocumentFragment();
 

package.json

@@ -4,6 +4,12 @@
   "description": "A javascript text diff implementation.",
   "keywords": [
     "diff",
+    "jsdiff",
+    "compare",
+    "patch",
+    "text",
+    "json",
+    "css",
     "javascript"
   ],
   "maintainers": [
@@ -24,6 +30,15 @@
   "main": "./lib/index.js",
   "module": "./lib/index.es6.js",
   "browser": "./dist/diff.js",
+  "unpkg": "./dist/diff.js",
+  "exports": {
+    ".": {
+      "import": "./lib/index.mjs",
+      "require": "./lib/index.js"
+    },
+    "./package.json": "./package.json",
+    "./": "./"
+  },
   "scripts": {
     "clean": "rm -rf lib/ dist/",
     "build:node": "yarn babel --out-dir lib  --source-maps=inline src",

rollup.config.js

@@ -8,10 +8,16 @@ export default [
     output: [
       {
         name: 'Diff',
-        file: pkg.browser,
-        format: 'umd'
+        format: 'umd',
+        file: pkg.browser
       },
-      { file: pkg.module, format: 'es' }
+      {
+        format: 'esm',
+        file: pkg.module
+      }, {
+        format: 'esm',
+        file: pkg['exports']['.'].import
+      }
     ],
     plugins: [
       babel({

src/diff/word.js

@@ -32,7 +32,8 @@ wordDiff.equals = function(left, right) {
   return left === right || (this.options.ignoreWhitespace && !reWhitespace.test(left) && !reWhitespace.test(right));
 };
 wordDiff.tokenize = function(value) {
-  let tokens = value.split(/(\s+|[()[\]{}'"]|\b)/);
+  // All whitespace symbols except newline group into one token, each newline - in separate token
+  let tokens = value.split(/([^\S\r\n]+|[()[\]{}'"\r\n]|\b)/);
 
   // Join the boundary splits that we do not consider to be boundaries. This is primarily the extended Latin character set.
   for (let i = 0; i < tokens.length - 1; i++) {

src/patch/create.js

@@ -99,12 +99,10 @@ export function structuredPatch(oldFileName, newFileName, oldStr, newStr, oldHea
   };
 }
 
-export function createTwoFilesPatch(oldFileName, newFileName, oldStr, newStr, oldHeader, newHeader, options) {
-  const diff = structuredPatch(oldFileName, newFileName, oldStr, newStr, oldHeader, newHeader, options);
-
+export function formatPatch(diff) {
   const ret = [];
-  if (oldFileName == newFileName) {
-    ret.push('Index: ' + oldFileName);
+  if (diff.oldFileName == diff.newFileName) {
+    ret.push('Index: ' + diff.oldFileName);
   }
   ret.push('===================================================================');
   ret.push('--- ' + diff.oldFileName + (typeof diff.oldHeader === 'undefined' ? '' : '\t' + diff.oldHeader));
@@ -123,6 +121,10 @@ export function createTwoFilesPatch(oldFileName, newFileName, oldStr, newStr, ol
   return ret.join('\n') + '\n';
 }
 
+export function createTwoFilesPatch(oldFileName, newFileName, oldStr, newStr, oldHeader, newHeader, options) {
+  return formatPatch(structuredPatch(oldFileName, newFileName, oldStr, newStr, oldHeader, newHeader, options));
+}
+
 export function createPatch(fileName, oldStr, newStr, oldHeader, newHeader, options) {
   return createTwoFilesPatch(fileName, fileName, oldStr, newStr, oldHeader, newHeader, options);
 }

style.css

@@ -79,3 +79,9 @@ ins {
 		height: 99%; /* Hide scroll bar in Firefox */
 	}
 }
+
+// for readability, wrap words in results, 
+// in case the original text does not have line breaks
+#result {
+    white-space: pre-wrap;
+}

test/diff/word.js

@@ -209,6 +209,15 @@ describe('WordDiff', function() {
       expect(convertChangesToXML(diffResult)).to.equal('&quot;<ins>word</ins>&quot;');
     });
 
+    it('should threat newline as separate token (issues #180, #211)', function() {
+      // #180
+      const diffResult1 = diffWordsWithSpace('foo\nbar', 'foo\n\n\nbar');
+      expect(convertChangesToXML(diffResult1)).to.equal('foo\n<ins>\n\n</ins>bar');
+      // #211
+      const diffResult2 = diffWordsWithSpace('A\n\nB\n', 'A\nB\n');
+      expect(convertChangesToXML(diffResult2)).to.equal('A\n<del>\n</del>B\n');
+    });
+
     it('should perform async operations', function(done) {
       diffWordsWithSpace('New Value  ', 'New  ValueMoreData ', function(err, diffResult) {
         expect(convertChangesToXML(diffResult)).to.equal('New<ins>  ValueMoreData</ins> <del>Value  </del>');

test/patch/create.js

@@ -1,5 +1,5 @@
 import {diffWords} from '../../lib';
-import {createPatch, createTwoFilesPatch, structuredPatch} from '../../lib/patch/create';
+import {createPatch, createTwoFilesPatch, formatPatch, structuredPatch} from '../../lib/patch/create';
 
 import {expect} from 'chai';
 
@@ -651,4 +651,19 @@ describe('patch/create', function() {
       });
     });
   });
+
+  describe('#formatPatch', function() {
+    it('should generate a patch string from an input diff', function() {
+      const res = formatPatch(structuredPatch(
+        'oldfile', 'newfile',
+        'line2\nline3\nline4\n', 'line2\nline3\nline5',
+        'header1', 'header2'
+      ));
+      expect(res).to.equal(createTwoFilesPatch(
+        'oldfile', 'newfile',
+        'line2\nline3\nline4\n', 'line2\nline3\nline5',
+        'header1', 'header2'
+      ));
+    });
+  });
 });