Include ESM support (#3)

* Include ESM support

* Add missing files and bump to v2.1.0

* rebuild to add missing files

* Bump to v2.0.1

Author: samiahmedsiddiqui

.gitattributes

@@ -7,8 +7,11 @@
 # Remove files for archives generated using `git archive`.
 .*                     export-ignore
 appveyor.yml           export-ignore
+fixup                  export-ignore
 package-lock.json      export-ignore
 src                    export-ignore
 test                   export-ignore
 tsconfig.json          export-ignore
-types/index.test-d.ts  export-ignore
+tsconfig-cjs.json      export-ignore
+tsconfig-esm.json      export-ignore
+types/                 export-ignore

CHANGELOG.md

@@ -1,5 +1,17 @@
 # detect-external-link changelog
 
+## 2.0.1 - Sep 27, 2023
+
+### Bug
+
+- Add missing files
+
+## 2.0.0 - Sep 27, 2023
+
+### Enhancement
+
+- Include ESM support
+
 ## 1.0.2 - Aug 25, 2023
 
 ### Bug

README.md

@@ -2,10 +2,10 @@
 
 [![NPM version][npm-image]][npm-url]
 [![Downloads][downloads-image]][npm-url]
-[![Build Status][travis-image]][travis-url]
 [![AppVeyor Build Status][appveyor-image]][appveyor-url]
+[![Downloads][jsdelivr-image]][jsdelivr-url]
 
-Node.js plugin that analyzes the given link and determines if the URL is internal or external. To ensure accuracy, please include a list of specified hosts that should be marked as internal. This way, the plugin can effectively differentiate between internal and external links based on the provided hosts list.
+JavaScript plugin that analyzes the given link and determines if the URL is internal or external. To ensure accuracy, please include a list of specified hosts that should be marked as internal. This way, the plugin can effectively differentiate between internal and external links based on the provided hosts list.
 
 ## Install
 
@@ -21,10 +21,24 @@ Via Yarn
 yarn add detect-external-link
 ```
 
+For vanilla HTML in modern browsers, import `detect-external-link` from jsDelivr:
+
+```html
+<script type="module">
+import detectExternalLink from 'https://cdn.jsdelivr.net/npm/detect-external-link@2/+esm';
+
+console.log(detectExternalLink('http://test.example2.com/test/abc/', {
+  'hosts': [
+    'http://example.com',
+    'http://test.example.com'
+  ]
+}));
+</script>
+```
 ## Usage
 
 ```javascript
-const detectExternalLink = require('detect-external-link').default;
+import detectExternalLink from '/js/index.js';
 
 const link = 'http://test.example2.com/test/abc/';
 const linkOptions = {
@@ -45,10 +59,10 @@ console.log(detectExternalLink(link, linkOptions));
 
 [npm-image]: https://img.shields.io/npm/v/detect-external-link.svg
 [npm-url]: https://www.npmjs.com/package/detect-external-link
-[downloads-image]: https://img.shields.io/npm/dt/detect-external-link.svg
-
-[travis-image]: https://api.travis-ci.com/trunkcode/detect-external-link.svg?branch=main
-[travis-url]: https://travis-ci.com/trunkcode/detect-external-link
+[downloads-image]: https://img.shields.io/npm/dm/detect-external-link.svg
 
 [appveyor-url]: https://ci.appveyor.com/project/trunkcode/detect-external-link
 [appveyor-image]: https://img.shields.io/appveyor/ci/trunkcode/detect-external-link.svg?label=appveyor
+
+[jsdelivr-image]: https://img.shields.io/jsdelivr/npm/hm/detect-external-link
+[jsdelivr-url]: https://www.jsdelivr.com/package/npm/detect-external-link

dist/cjs/index.d.ts

@@ -0,0 +1,5 @@
+export default function detectExternalLink (linkToCheck: string, options: configOptions): boolean;
+
+export type configOptions = {
+  hosts?: string[];
+};

index.js renamed to dist/cjs/index.js

@@ -0,0 +1,22 @@
+'use strict';
+
+import detectExternalLink from './index';
+
+const multipleHosts = {
+  'hosts': [
+    'http://example.com',
+    'http://test.example.com',
+  ]
+};
+const singleHost = {
+  'hosts': ['http://example.com']
+};
+const testLink = 'https://example.com';
+
+if (singleHost) {
+	console.log(detectExternalLink(testLink, singleHost));
+}
+
+if (multipleHosts) {
+	console.log(detectExternalLink(testLink, multipleHosts));
+}

dist/cjs/index.test-d.ts

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

dist/cjs/package.json

@@ -0,0 +1,5 @@
+export default function detectExternalLink (linkToCheck: string, options: configOptions): boolean;
+
+export type configOptions = {
+  hosts?: string[];
+};

dist/esm/index.d.ts

@@ -0,0 +1,29 @@
+export default function detectExternalLink(linkToCheck, options) {
+    const configHosts = [];
+    const finalConfig = Object.assign({}, options);
+    let isExternal = false;
+    let linkOrigin = '';
+    if (finalConfig.hosts) {
+        let singleHost;
+        for (singleHost of finalConfig.hosts) {
+            if (singleHost.indexOf('http://') === 0 || singleHost.indexOf('https://') === 0) {
+                configHosts.push(new URL(singleHost).hostname);
+            }
+            else {
+                configHosts.push(singleHost);
+            }
+        }
+    }
+    if (linkToCheck.indexOf('http://') === 0 || linkToCheck.indexOf('https://') === 0) {
+        linkOrigin = new URL(linkToCheck).hostname;
+    }
+    else if (linkToCheck.indexOf('//') === 0) {
+        linkOrigin = new URL('https:' + linkToCheck).hostname;
+    }
+    if (linkOrigin) {
+        if (configHosts.length === 0 || configHosts.indexOf(linkOrigin) === -1) {
+            isExternal = true;
+        }
+    }
+    return isExternal;
+}

dist/esm/index.js

@@ -0,0 +1,22 @@
+'use strict';
+
+import detectExternalLink from './index';
+
+const multipleHosts = {
+  'hosts': [
+    'http://example.com',
+    'http://test.example.com',
+  ]
+};
+const singleHost = {
+  'hosts': ['http://example.com']
+};
+const testLink = 'https://example.com';
+
+if (singleHost) {
+	console.log(detectExternalLink(testLink, singleHost));
+}
+
+if (multipleHosts) {
+	console.log(detectExternalLink(testLink, multipleHosts));
+}