refactor: Improve exports & require statements (#233)

xmldom · Aug 24, 2021 · dc429ae · dc429ae
1 parent 283355a
commit dc429ae
Show file tree

Hide file tree

Showing 19 changed files with 39 additions and 30 deletions.
diff --git a/lib/dom-parser.js b/lib/dom-parser.js
@@ -1,8 +1,15 @@
 var conventions = require("./conventions");
+var dom = require('./dom')
 var entities = require('./entities');
+var sax = require('./sax');
+
+var DOMImplementation = dom.DOMImplementation;
 
 var NAMESPACE = conventions.NAMESPACE;
 
+var ParseError = sax.ParseError;
+var XMLReader = sax.XMLReader;
+
 function DOMParser(options){
 	this.options = options ||{locator:{}};
 }
@@ -246,12 +253,15 @@ function appendElement (hander,node) {
     }
 }//appendChild and setAttributeNS are preformance key
 
-//if(typeof require == 'function'){
-var sax = require('./sax');
-var XMLReader = sax.XMLReader;
-var ParseError = sax.ParseError;
-var DOMImplementation = exports.DOMImplementation = require('./dom').DOMImplementation;
-exports.XMLSerializer = require('./dom').XMLSerializer ;
-exports.DOMParser = DOMParser;
 exports.__DOMHandler = DOMHandler;
-//}
+exports.DOMParser = DOMParser;
+
+/**
+ * @deprecated Import/require from main entry point instead
+ */
+exports.DOMImplementation = dom.DOMImplementation;
+
+/**
+ * @deprecated Import/require from main entry point instead
+ */
+exports.XMLSerializer = dom.XMLSerializer;
diff --git a/lib/index.js b/lib/index.js
@@ -0,0 +1,4 @@
+var dom = require('./dom')
+exports.DOMImplementation = dom.DOMImplementation
+exports.XMLSerializer = dom.XMLSerializer
+exports.DOMParser = require('./dom-parser').DOMParser
diff --git a/package.json b/package.json
@@ -17,7 +17,7 @@
     "type": "git",
     "url": "git://github.com/xmldom/xmldom.git"
   },
-  "main": "lib/dom-parser.js",
+  "main": "lib/index.js",
   "types": "index.d.ts",
   "files": [
     "CHANGELOG.md",

diff --git a/test/dom-parser.test.js b/test/dom-parser.test.js
@@ -1,6 +1,6 @@
 'use strict'
 
-const { DOMParser } = require('../lib/dom-parser')
+const { DOMParser } = require('../lib')
 
 describe('DOMParser', () => {
 	describe('constructor', () => {

diff --git a/test/dom/attr.test.js b/test/dom/attr.test.js
@@ -1,5 +1,5 @@
 'use strict'
-const { DOMParser } = require('../../lib/dom-parser')
+const { DOMParser } = require('../../lib')
 const { DOMException } = require('../../lib/dom')
 
 describe('XML attrs', () => {

diff --git a/test/dom/clone.test.js b/test/dom/clone.test.js
@@ -1,6 +1,6 @@
 'use strict'
 
-const { DOMParser, XMLSerializer } = require('../../lib/dom-parser')
+const { DOMParser, XMLSerializer } = require('../../lib')
 
 describe('XML Namespace Parse', () => {
 	it('can properly set clone', () => {

diff --git a/test/dom/element.test.js b/test/dom/element.test.js
@@ -1,10 +1,6 @@
 'use strict'
 
-const {
-	DOMParser,
-	DOMImplementation,
-	XMLSerializer,
-} = require('../../lib/dom-parser')
+const { DOMParser, DOMImplementation, XMLSerializer } = require('../../lib')
 
 describe('Document', () => {
 	// See: http://jsfiddle.net/bigeasy/ShcXP/1/

diff --git a/test/dom/fragment.test.js b/test/dom/fragment.test.js
@@ -1,6 +1,6 @@
 'use strict'
 
-const { DOMParser } = require('../../lib/dom-parser')
+const { DOMParser } = require('../../lib')
 
 describe('DOM DocumentFragment', () => {
 	// see: http://jsfiddle.net/9Wmh2/1/

diff --git a/test/dom/ns-test.test.js b/test/dom/ns-test.test.js
@@ -1,6 +1,6 @@
 'use strict'
 
-const { DOMParser } = require('../../lib/dom-parser')
+const { DOMParser } = require('../../lib')
 
 // Create a Test Suite
 describe('XML Namespace Parse', () => {

diff --git a/test/dom/serializer.test.js b/test/dom/serializer.test.js
@@ -1,7 +1,6 @@
 'use strict'
 
-const { DOMParser } = require('../../lib/dom-parser')
-const { XMLSerializer } = require('../../lib/dom')
+const { DOMParser, XMLSerializer } = require('../../lib')
 const { MIME_TYPE } = require('../../lib/conventions')
 
 describe('XML Serializer', () => {

diff --git a/test/error/error-handler.test.js b/test/error/error-handler.test.js
@@ -1,6 +1,6 @@
 'use strict'
 
-const { DOMParser } = require('../../lib/dom-parser')
+const { DOMParser } = require('../../lib')
 const { REPORTED } = require('./reported')
 
 describe('custom errorHandler', () => {

diff --git a/test/error/reported-levels.test.js b/test/error/reported-levels.test.js
@@ -3,7 +3,7 @@
 const { LINE_TO_ERROR_INDEX, REPORTED } = require('./reported')
 const { getTestParser } = require('../get-test-parser')
 const { ParseError } = require('../../lib/sax')
-const { DOMParser } = require('../../lib/dom-parser')
+const { DOMParser } = require('../../lib')
 
 describe.each(Object.entries(REPORTED))(
 	'%s',

diff --git a/test/parse/big-file-performance.test.js b/test/parse/big-file-performance.test.js
@@ -1,6 +1,6 @@
 /* eslint strict: off */
 
-const { XMLSerializer, DOMParser } = require('../../lib/dom-parser')
+const { XMLSerializer, DOMParser } = require('../../lib')
 /*
 var DomJS = require('dom-js').DomJS
 try {

diff --git a/test/parse/file.test.js b/test/parse/file.test.js
@@ -2,7 +2,7 @@
 
 const fs = require('fs')
 
-const { DOMParser } = require('../../lib/dom-parser')
+const { DOMParser } = require('../../lib')
 
 describe('from file', () => {
 	it('file-test1.xml', () => {

diff --git a/test/parse/locator.test.js b/test/parse/locator.test.js
@@ -1,6 +1,6 @@
 'use strict'
 
-const { DOMParser } = require('../../lib/dom-parser')
+const { DOMParser } = require('../../lib')
 const { getTestParser } = require('../get-test-parser')
 
 describe('DOMLocator', () => {

diff --git a/test/parse/namespace.test.js b/test/parse/namespace.test.js
@@ -1,6 +1,6 @@
 'use strict'
 
-const { DOMParser } = require('../../lib/dom-parser')
+const { DOMParser } = require('../../lib')
 
 /**
  * Returns an array containing only one occurrence of every sting in `values` (like in a Set).

diff --git a/test/parse/node.test.js b/test/parse/node.test.js
@@ -1,7 +1,7 @@
 'use strict'
 
 const { Node } = require('../../lib/dom')
-const { DOMParser } = require('../../lib/dom-parser')
+const { DOMParser } = require('../../lib')
 
 const expectNeighbours = (first, second, ...nodes) => {
 	expect(first.nextSibling).toStrictEqual(second)

diff --git a/test/parse/parse-element.test.js b/test/parse/parse-element.test.js
@@ -1,7 +1,7 @@
 'use strict'
 
 const { getTestParser } = require('../get-test-parser')
-const { DOMParser } = require('../../lib/dom-parser')
+const { DOMParser } = require('../../lib')
 
 describe('XML Node Parse', () => {
 	describe('no attribute', () => {

diff --git a/test/xss.test.js b/test/xss.test.js
@@ -1,6 +1,6 @@
 'use strict'
 
-const { DOMParser } = require('../lib/dom-parser')
+const { DOMParser } = require('../lib')
 
 const excludeTags = new RegExp(
 	'^(?:' +