11# html-differ
22[ ![ Build Status] ( https://github.com/markedjs/html-differ/workflows/CI/badge.svg )] ( https://github.com/markedjs/html-differ/actions )
33[ ![ Install Size] ( https://packagephobia.now.sh/badge?p=@markedjs/html-differ )] ( https://packagephobia.now.sh/result?p=@markedjs/html-differ )
4- [ ![ Dependency Status] ( https://david-dm.org/markedjs/html-differ.svg )] ( https://david-dm.org/markedjs/html-differ )
5- [ ![ devDependency Status] ( https://david-dm.org/markedjs/html-differ/dev-status.svg )] ( https://david-dm.org/markedjs/html-differ?type=dev )
64
7- Compares two HTML.
5+ Compares two HTML strings .
86
97<!-- TOC -->
108- [ The comparison algorithm] ( #the-comparison-algorithm )
@@ -102,8 +100,8 @@ $ npm install @markedjs/html-differ
102100### HtmlDiffer
103101
104102``` js
105- var HtmlDiffer = require ( ' @markedjs/html-differ' ). HtmlDiffer ,
106- htmlDiffer = new HtmlDiffer (options);
103+ import { HtmlDiffer } from ' @markedjs/html-differ' ;
104+ const htmlDiffer = new HtmlDiffer (options);
107105```
108106
109107where ` options ` is an object.
@@ -282,15 +280,15 @@ For example, the following two code samples will be considered to be equivalent:
282280Passing of a preset via the constructor:
283281
284282``` js
285- var HtmlDiffer = require ( ' @markedjs/html-differ' ). HtmlDiffer ,
286- htmlDiffer = new HtmlDiffer (' bem' );
283+ import { HtmlDiffer } from ' @markedjs/html-differ' ;
284+ const htmlDiffer = new HtmlDiffer (' bem' );
287285```
288286
289287Redefinition of a preset via the constructor:
290288
291289``` js
292- var HtmlDiffer = require ( ' @markedjs/html-differ' ). HtmlDiffer ,
293- htmlDiffer = new HtmlDiffer ({ preset: ' bem' , ignoreAttributes: [] });
290+ import { HtmlDiffer } from ' @markedjs/html-differ' ;
291+ const htmlDiffer = new HtmlDiffer ({ preset: ' bem' , ignoreAttributes: [] });
294292```
295293
296294#### Methods
@@ -311,7 +309,7 @@ var HtmlDiffer = require('@markedjs/html-differ').HtmlDiffer,
311309### Logger
312310
313311``` js
314- var logger = require ( ' @markedjs/html-differ/lib/logger' ) ;
312+ import * as logger from ' @markedjs/html-differ/lib/logger' ;
315313```
316314
317315#### Methods
@@ -339,22 +337,22 @@ var logger = require('@markedjs/html-differ/lib/logger');
339337### Example
340338
341339``` js
342- var fs = require ( ' fs' ),
343- HtmlDiffer = require ( ' @markedjs/html-differ' ). HtmlDiffer ,
344- logger = require ( ' @markedjs/html-differ/lib/logger' ) ;
340+ import fs from ' fs' ;
341+ import { HtmlDiffer } from ' @markedjs/html-differ' ;
342+ import * as logger from ' @markedjs/html-differ/lib/logger' ;
345343
346- var html1 = fs .readFileSync (' 1.html' , ' utf-8' ),
347- html2 = fs .readFileSync (' 2.html' , ' utf-8' );
344+ const html1 = fs .readFileSync (' 1.html' , ' utf-8' );
345+ const html2 = fs .readFileSync (' 2.html' , ' utf-8' );
348346
349- var options = {
350- ignoreAttributes: [],
351- compareAttributesAsJSON: [],
352- ignoreWhitespaces: true ,
353- ignoreComments: true ,
354- ignoreEndTags: false
355- };
347+ const options = {
348+ ignoreAttributes: [],
349+ compareAttributesAsJSON: [],
350+ ignoreWhitespaces: true ,
351+ ignoreComments: true ,
352+ ignoreEndTags: false
353+ };
356354
357- var htmlDiffer = new HtmlDiffer (options);
355+ const htmlDiffer = new HtmlDiffer (options);
358356
359357async function run () {
360358 const diff = await htmlDiffer .diffHtml (html1, html2);
@@ -405,11 +403,11 @@ Study the following file `config.json`:
405403
406404``` js
407405{
408- " ignoreAttributes" : [],
409- " compareAttributesAsJSON" : [],
410- " ignoreWhitespaces" : true ,
411- " ignoreComments" : true ,
412- " ignoreEndTags" : false
406+ " ignoreAttributes" : [],
407+ " compareAttributesAsJSON" : [],
408+ " ignoreWhitespaces" : true ,
409+ " ignoreComments" : true ,
410+ " ignoreEndTags" : false
413411}
414412```
415413
0 commit comments