Html Anchor Rewriter Gulp Plugin

This is the simple plugin to re-write anchor elements such as adding new attributes.

Motivation

While developing another gulp plugin (1), I have needed re-writing anchor elements for the SEO. After reading some articles, I decided develop a gulp plugin for re-writing anchor elements.

Challenges

The gulp system has dynamic and usefull plugin system. However, some times finding a plugin will be a challenge and writing a custom plugin is already a challenge.

The gulp suggets a guideline for writing a plugin. This time, I want to follow it (2). In this challenge, I wrote tests for validating plugin and I have used Mocha and Chai.

Installation

npm install --save-dev gulp-html-anchor-rewriter

Usage

const { src, dest } = require("gulp");
const anchorRewriter = require("gulp-html-anchor-rewriter");

exports.default = function () {

    return src("./test/*.html")
        .pipe(anchorRewriter({
            "rel": "nofollow"
        }))
        .pipe(dest("./output"));
};

Options

Without any options plugin throws an exception.

| Name | Type | Description | |---|---|---| | keyword | string, string[] | For searching the anchor element href attribute value. If the href contains the keyword, the anchor will be processed. | | rel | string | For adding rel attribute. | | target | string | For adding target attribute. | | whiteList | boolean | Indicates whether the white-list mode is enabled. |

Testing

For local testing, can be used unit tests.

$> npm install
$> npm test

Support

For supporting me, you can add an issue for bug cases or new feature requests.