Initial Release v1.0.0

Author: samiahmedsiddiqui

.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+quote_type = single
+trim_trailing_whitespace = true
+insert_final_newline = true

.eslintrc

@@ -0,0 +1,26 @@
+{
+  "root": true,
+  "env": {
+    "es6": true,
+    "node": true,
+    "mocha": true
+  },
+  "extends": [
+    "eslint:recommended"
+  ],
+  "overrides": [
+    {
+      "files": [
+        "*.ts",
+        "*.tsx"
+      ],
+      "parser": "@typescript-eslint/parser",
+      "plugins": [
+        "@typescript-eslint"
+      ],
+      "extends": [
+        "plugin:@typescript-eslint/recommended"
+      ]
+    }
+  ]
+}

.gitattributes

@@ -0,0 +1,14 @@
+# Set the default behavior, in case people don't have `core.autocrlf` set.
+* text=auto
+
+# Declare files that will always have LF line endings on checkout.
+*.ts text eol=lf
+
+# Remove files for archives generated using `git archive`.
+.*                     export-ignore
+appveyor.yml           export-ignore
+package-lock.json      export-ignore
+src                    export-ignore
+test                   export-ignore
+tsconfig.json          export-ignore
+types/index.test-d.ts  export-ignore

.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+node_modules
+npm-debug.log
+yarn-error.log

.travis.yml

@@ -0,0 +1,18 @@
+branches:
+  only:
+    - main
+dist: xenial
+language: node_js
+node_js:
+  - 12
+  - 13
+  - 14
+  - node
+os:
+  - linux
+  - osx
+install:
+  npm install --dev
+script:
+  - npm run lint
+  - npm run test

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 TrunkCode
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,54 @@
+# detect-external-link
+
+[![NPM version][npm-image]][npm-url]
+[![Downloads][downloads-image]][npm-url]
+[![Build Status][travis-image]][travis-url]
+[![AppVeyor Build Status][appveyor-image]][appveyor-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.
+
+## Install
+
+Via `npm`
+
+```bash
+npm install detect-external-link
+```
+
+Via Yarn
+
+```bash
+yarn add detect-external-link
+```
+
+## Usage
+
+```javascript
+const detectExternalLink = require('detect-external-link').default;
+
+const link = 'http://test.example2.com/test/abc/';
+const linkOptions = {
+  'hosts': [
+    'http://example.com',
+    'http://test.example.com'
+  ]
+};
+
+console.log(detectExternalLink(link, linkOptions));
+```
+
+## Parameters
+
+| Attributes |  Type | Required | Default |                 Description                |
+|:----------:|:-----:|:--------:|:-------:|:------------------------------------------:|
+|    hosts   | Array |    Yes   |    []   | Site hostname(s) to detect external links. |
+
+[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
+
+[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

appveyor.yml

@@ -0,0 +1,24 @@
+version: "{build}"
+
+# branches to build
+branches:
+  only:
+    - main
+
+environment:
+  matrix:
+    # node.js
+   - nodejs_version: "12"
+    - nodejs_version: "13"
+    - nodejs_version: "14"
+    - nodejs_version: ""
+
+install:
+  - ps: Install-Product node $env:nodejs_version
+  - npm install --dev
+
+test_script:
+  - npm run lint
+  - npm run test
+
+build: off

index.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+function detectExternalLink(linkToCheck, options) {
+    const configHosts = [];
+    const finalConfig = 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 (configHosts.length === 0 || configHosts.indexOf(linkOrigin) === -1) {
+        isExternal = true;
+    }
+    return isExternal;
+}
+exports.default = detectExternalLink;