Merge pull request #780 from remarkablemark/fix/domhandler

fix(index): export domhandler classes

Author: remarkablemark

.size-limit.json

@@ -1,6 +1,6 @@
 [
   {
     "path": "dist/html-react-parser.min.js",
-    "limit": "10.531 KB"
+    "limit": "10.524 KB"
   }
 ]

index.d.ts

@@ -1,22 +1,23 @@
 // TypeScript Version: 4.7
+/* eslint-disable no-undef, no-unused-vars */
 
-import { ParserOptions } from 'htmlparser2';
 import {
   Comment,
-  DomHandlerOptions,
   Element,
   Node,
   ProcessingInstruction,
-  Text
+  Text,
+  type DomHandlerOptions
 } from 'domhandler';
 import htmlToDOM from 'html-dom-parser';
+import { ParserOptions } from 'htmlparser2';
 
 import attributesToProps from './lib/attributes-to-props';
 import domToReact from './lib/dom-to-react';
 
 export { attributesToProps, domToReact, htmlToDOM };
 export type HTMLParser2Options = ParserOptions & DomHandlerOptions;
-export { Comment, Element, Node, ProcessingInstruction, Text };
+export { Comment, Element, ProcessingInstruction, Text };
 export type DOMNode = Comment | Element | Node | ProcessingInstruction | Text;
 
 export interface HTMLReactParserOptions {

index.js

@@ -1,7 +1,9 @@
-var domToReact = require('./lib/dom-to-react');
-var attributesToProps = require('./lib/attributes-to-props');
+var domhandler = require('domhandler');
 var htmlToDOM = require('html-dom-parser');
 
+var attributesToProps = require('./lib/attributes-to-props');
+var domToReact = require('./lib/dom-to-react');
+
 // support backwards compatibility for ES Module
 htmlToDOM =
   /* istanbul ignore next */
@@ -36,7 +38,12 @@ function HTMLReactParser(html, options) {
 HTMLReactParser.domToReact = domToReact;
 HTMLReactParser.htmlToDOM = htmlToDOM;
 HTMLReactParser.attributesToProps = attributesToProps;
-HTMLReactParser.Element = require('domhandler').Element;
+
+// domhandler
+HTMLReactParser.Comment = domhandler.Comment;
+HTMLReactParser.Element = domhandler.Element;
+HTMLReactParser.ProcessingInstruction = domhandler.ProcessingInstruction;
+HTMLReactParser.Text = domhandler.Text;
 
 // support CommonJS and ES Modules
 module.exports = HTMLReactParser;

index.mjs

@@ -3,6 +3,11 @@ import HTMLReactParser from './index.js';
 export var domToReact = HTMLReactParser.domToReact;
 export var htmlToDOM = HTMLReactParser.htmlToDOM;
 export var attributesToProps = HTMLReactParser.attributesToProps;
+
+// domhandler
+export var Comment = HTMLReactParser.Comment;
 export var Element = HTMLReactParser.Element;
+export var ProcessingInstruction = HTMLReactParser.ProcessingInstruction;
+export var Text = HTMLReactParser.Text;
 
 export default HTMLReactParser;

test/index.test.js

@@ -1,4 +1,5 @@
 const React = require('react');
+const domhandler = require('domhandler');
 const parse = require('..');
 const { html, svg } = require('./data');
 const { render } = require('./helpers');
@@ -24,6 +25,16 @@ describe('module', () => {
     expect(parse.attributesToProps).toBe(require('../lib/attributes-to-props'));
     expect(parse.attributesToProps).toBeInstanceOf(Function);
   });
+
+  describe('domhandler', () => {
+    it.each(['Comment', 'Element', 'ProcessingInstruction', 'Text'])(
+      'exports %s',
+      name => {
+        expect(parse[name]).toBeInstanceOf(Function);
+        expect(parse[name]).toBe(domhandler[name]);
+      }
+    );
+  });
 });
 
 describe('HTMLReactParser', () => {

test/integration/index.test.js

@@ -1,26 +1,32 @@
 describe.each([
-  ['unminified', '../../dist/html-react-parser'],
-  ['minified', '../../dist/html-react-parser.min']
+  ['minified', '../../dist/html-react-parser.min'],
+  ['unminified', '../../dist/html-react-parser']
 ])('UMD %s', (_type, path) => {
   const parse = require(path);
 
-  it('exports the parser', () => {
+  it('exports parser', () => {
     expect(parse).toBeInstanceOf(Function);
   });
 
   it('exports default', () => {
     expect(parse.default).toBeInstanceOf(Function);
   });
 
-  it('exports domToReact', () => {
-    expect(parse.domToReact).toBeInstanceOf(Function);
+  describe('internal', () => {
+    it.each(['attributesToProps', 'domToReact', 'htmlToDOM'])(
+      'exports %s',
+      name => {
+        expect(parse[name]).toBeInstanceOf(Function);
+      }
+    );
   });
 
-  it('exports htmlToDOM', () => {
-    expect(parse.htmlToDOM).toBeInstanceOf(Function);
-  });
-
-  it('exports attributesToProps', () => {
-    expect(parse.attributesToProps).toBeInstanceOf(Function);
+  describe('domhandler', () => {
+    it.each(['Comment', 'Element', 'ProcessingInstruction', 'Text'])(
+      'exports %s',
+      name => {
+        expect(parse[name]).toBeInstanceOf(Function);
+      }
+    );
   });
 });

test/module/index.mjs

@@ -1,10 +1,16 @@
 import assert from 'assert';
 import parse, {
+  attributesToProps,
   domToReact,
-  htmlToDOM,
-  attributesToProps
+  htmlToDOM
 } from '../../index.mjs';
+import { Comment, Element, ProcessingInstruction, Text } from '../../index.mjs';
 
 [parse, domToReact, htmlToDOM, attributesToProps].forEach(func => {
   assert.strictEqual(typeof func, 'function');
 });
+
+// domhandler
+[Comment, Element, ProcessingInstruction, Text].forEach(func => {
+  assert.strictEqual(typeof func, 'function');
+});