chore: simplify directory structure

Author: rowanmanning

lib/feed-parser.js index.js

@@ -1,12 +1,12 @@
 'use strict';
 
-const { AtomFeed } = require('./feed/atom');
-const { Document } = require('./xml/document');
-const { InvalidFeedError } = require('./errors/invalid-feed');
-const { RssFeed } = require('./feed/rss');
+const { AtomFeed } = require('./lib/feed/atom');
+const { Document } = require('./lib/xml/document');
+const { InvalidFeedError } = require('./lib/errors/invalid-feed');
+const { RssFeed } = require('./lib/feed/rss');
 
 /**
- * @type {{[key: string]: typeof import('./feed/base').Feed}}}
+ * @type {{[key: string]: typeof import('./lib/feed/base').Feed}}}
  */
 const DATA_PROVIDER_BY_ROOT_ELEMENT = {
 	feed: AtomFeed,
@@ -19,7 +19,7 @@ const DATA_PROVIDER_BY_ROOT_ELEMENT = {
  *
  * @param {string} xmlString
  *     A string of XML.
- * @returns {import('./feed/base').Feed}
+ * @returns {import('./lib/feed/base').Feed}
  *     Returns a feed representation of the XML string.
  * @throws {InvalidFeedError}
  *     Throws an invalid feed error if an unrecoverable issue is found with the feed.

package.json

@@ -45,7 +45,7 @@
     "testdouble": "^3.16.5",
     "typescript": "^5.5.2"
   },
-  "main": "lib/feed-parser.js",
+  "main": "index.js",
   "nyc": {
     "reporter": [
       "html",

test/unit/lib/feed-parser.test.js test/unit/index.test.js

@@ -6,23 +6,23 @@ const td = require('testdouble');
 
 td.config({ ignoreWarnings: true });
 
-describe('lib/feed-parser', () => {
+describe('@rowanmanning/feed-parser', () => {
 	let AtomFeed;
 	let Document;
 	let InvalidFeedError;
 	let parseFeed;
 	let RssFeed;
 
 	beforeEach(() => {
-		AtomFeed = td.replace('../../../lib/feed/atom', { AtomFeed: td.constructor() }).AtomFeed;
-		Document = td.replace('../../../lib/xml/document', {
-			Document: require('../mock/lib/xml/document.mock').createMock()
+		AtomFeed = td.replace('../../lib/feed/atom', { AtomFeed: td.constructor() }).AtomFeed;
+		Document = td.replace('../../lib/xml/document', {
+			Document: require('./mock/lib/xml/document.mock').createMock()
 		}).Document;
-		InvalidFeedError = td.replace('../../../lib/errors/invalid-feed', {
+		InvalidFeedError = td.replace('../../lib/errors/invalid-feed', {
 			InvalidFeedError: td.constructor()
 		}).InvalidFeedError;
-		RssFeed = td.replace('../../../lib/feed/rss', { RssFeed: td.constructor() }).RssFeed;
-		parseFeed = require('../../../lib/feed-parser').parseFeed;
+		RssFeed = td.replace('../../lib/feed/rss', { RssFeed: td.constructor() }).RssFeed;
+		parseFeed = require('../..').parseFeed;
 	});
 
 	afterEach(() => td.reset());