[New] add linkComponents setting

Author: gbakernet

README.md

@@ -48,6 +48,11 @@ You should also specify settings that will be shared across all the plugin rules
         "forbidExtraProps",
         {"property": "freeze", "object": "Object"},
         {"property": "myFavoriteWrapper"}
+    ],
+    "linkComponents": [
+      // Components used as alternatives to <a> for linking, eg. <Link to={ url } />
+      "Hyperlink",
+      {"name": "Link", "linkAttribute": "to"}
     ]
   }
 }

lib/util/linkComponents.js

@@ -0,0 +1,21 @@
+/**
+ * @fileoverview Utility functions for propWrapperFunctions setting
+ */
+'use strict';
+
+const DEFAULT_LINK_COMPONENTS = ['a'];
+const DEFAULT_LINK_ATTRIBUTE = 'href';
+
+function getLinkComponents(context) {
+  const settings = context.settings || {};
+  return new Map(DEFAULT_LINK_COMPONENTS.concat(settings.linkComponents || []).map(value => {
+    if (typeof value === 'string') {
+      return [value, DEFAULT_LINK_ATTRIBUTE];
+    }
+    return [value.name, value.linkAttribute];
+  }));
+}
+
+module.exports = {
+  getLinkComponents: getLinkComponents
+};

tests/util/linkComponents.js

@@ -0,0 +1,36 @@
+/* eslint-env mocha */
+'use strict';
+
+const assert = require('assert');
+const linkComponentsUtil = require('../../lib/util/linkComponents');
+
+describe('linkComponentsFunctions', () => {
+  describe('getLinkComponents', () => {
+    it('returns a default map of components', () => {
+      const context = {};
+      assert.deepStrictEqual(linkComponentsUtil.getLinkComponents(context), new Map([
+        ['a', 'href']
+      ]));
+    });
+
+    it('returns a map of components', () => {
+      const linkComponents = [
+        'Hyperlink',
+        {
+          name: 'Link',
+          linkAttribute: 'to'
+        }
+      ];
+      const context = {
+        settings: {
+          linkComponents: linkComponents
+        }
+      };
+      assert.deepStrictEqual(linkComponentsUtil.getLinkComponents(context), new Map([
+        ['a', 'href'],
+        ['Hyperlink', 'href'],
+        ['Link', 'to']
+      ]));
+    });
+  });
+});