Initial release to add target and rel on external links

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

CHANGELOG.md

@@ -0,0 +1,5 @@
+# markdown-it-external-link changelog
+
+## 1.0.0 - Aug 24, 2023
+
+- Initial Release

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,56 @@
+# markdown-it-external-link
+
+[![NPM version][npm-image]][npm-url]
+[![Downloads][downloads-image]][npm-url]
+[![AppVeyor Build Status][appveyor-image]][appveyor-url]
+
+[markdown-it](https://www.npmjs.com/package/markdown-it) plugin that adds `target` and `rel` attributes on external links.
+
+## Install
+
+Via `npm`
+
+```bash
+npm install markdown-it-external-link
+```
+
+Via Yarn
+
+```bash
+yarn add markdown-it-external-link
+```
+
+## Usage
+
+```javascript
+const markdownit = require('markdown-it');
+const markdownitExternalLink = require('../index').default;
+const md = markdownit();
+
+const testString = 'This is an [Example](http://example.com) link, [Google](https://google.com) link, [Facebook](https://facebook.com) link, [Test Example](http://test.example.com/) link, [Test2 Example](http://test2.example.com/) link and [Relative](/docs/concept/) link.';
+
+// Mark http://example.com and http://test.example.com as internal domain.
+md.use(markdownitExternalLink, {
+  'hosts': [
+    'http://example.com',
+    'http://test.example.com'
+  ]
+});
+
+console.log(md.render(testString));
+```
+
+## Parameters
+
+|   Attributes   |  Type  | Required |   Default  |                                    Description                                   |
+|:--------------:|:------:|:--------:|:----------:|:--------------------------------------------------------------------------------:|
+|      hosts     |  Array |    Yes   |     []     | Site hostname(s) to detect external links.                                       |
+|     target     | String |    No    |  `_blank`  | Specifies where to open the linked document.                                     |
+|       rel      | String |    No    | `noopener` | Specifies the relationship between the current document and the linked document. |
+
+[npm-image]: https://img.shields.io/npm/v/markdown-it-external-link.svg
+[npm-url]: https://www.npmjs.com/package/markdown-it-external-link
+[downloads-image]: https://img.shields.io/npm/dm/markdown-it-external-link.svg
+
+[appveyor-url]: https://ci.appveyor.com/project/trunkcode/markdown-it-external-link
+[appveyor-image]: https://img.shields.io/appveyor/ci/trunkcode/markdown-it-external-link.svg?label=appveyor

appveyor.yml

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

index.js

@@ -0,0 +1,42 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const detect_external_link_1 = __importDefault(require("detect-external-link"));
+function markdownitExternalLink(md, userConfig) {
+    const defaultConfig = {
+        hosts: [],
+        rel: 'noopener',
+        target: '_blank',
+    };
+    const defaultOpenRender = md.renderer.rules.link_open || function (tokens, idx, options, env, self) {
+        return self.renderToken(tokens, idx, options);
+    };
+    const finalConfig = Object.assign({}, defaultConfig, userConfig);
+    md.renderer.rules.link_open = function (tokens, idx, options, env, self) {
+        if (tokens[idx] && tokens[idx].attrs) {
+            const linkIndex = tokens[idx].attrIndex('href');
+            if (linkIndex in tokens[idx].attrs && tokens[idx].attrs[linkIndex][1]) {
+                if ((0, detect_external_link_1.default)(tokens[idx].attrs[linkIndex][1], finalConfig)) {
+                    const relIndex = tokens[idx].attrIndex('rel');
+                    const targetIndex = tokens[idx].attrIndex('target');
+                    if (targetIndex < 0) {
+                        tokens[idx].attrPush(['target', finalConfig.target]);
+                    }
+                    else {
+                        tokens[idx].attrs[targetIndex][1] = finalConfig.target;
+                    }
+                    if (relIndex < 0) {
+                        tokens[idx].attrPush(['rel', finalConfig.rel]);
+                    }
+                    else {
+                        tokens[idx].attrs[relIndex][1] = finalConfig.rel;
+                    }
+                }
+            }
+        }
+        return defaultOpenRender(tokens, idx, options, env, self);
+    };
+}
+exports.default = markdownitExternalLink;