Add both allowList and disallowList to forbid-*-props

Author: Ell Bradshaw

lib/rules/forbid-component-props.js

@@ -7,6 +7,7 @@
 
 const docsUrl = require('../util/docsUrl');
 const report = require('../util/report');
+const isForbidden = require('../util/isForbidden');
 
 // ------------------------------------------------------------------------------
 // Constants
@@ -54,6 +55,13 @@ module.exports = {
                     type: 'string',
                   },
                 },
+                disallowedFor: {
+                  type: 'array',
+                  uniqueItems: true,
+                  items: {
+                    type: 'string',
+                  },
+                },
                 message: {
                   type: 'string',
                 },
@@ -68,21 +76,19 @@ module.exports = {
   create(context) {
     const configuration = context.options[0] || {};
     const forbid = new Map((configuration.forbid || DEFAULTS).map((value) => {
+      if (value.allowedFor && value.disallowedFor) {
+        throw new Error('Must specify either allowedFor or disallowedFor, not both');
+      }
+
       const propName = typeof value === 'string' ? value : value.propName;
       const options = {
         allowList: typeof value === 'string' ? [] : (value.allowedFor || []),
+        disallowList: typeof value === 'string' ? null : (value.disallowedFor || null),
         message: typeof value === 'string' ? null : value.message,
       };
       return [propName, options];
     }));
 
-    function isForbidden(prop, tagName) {
-      const options = forbid.get(prop);
-      const allowList = options ? options.allowList : undefined;
-      // if the tagName is undefined (`<this.something>`), we assume it's a forbidden element
-      return typeof allowList !== 'undefined' && (typeof tagName === 'undefined' || allowList.indexOf(tagName) === -1);
-    }
-
     return {
       JSXAttribute(node) {
         const parentName = node.parent.name;
@@ -96,7 +102,7 @@ module.exports = {
 
         const prop = node.name.name;
 
-        if (!isForbidden(prop, tag)) {
+        if (!isForbidden(forbid, prop, tag)) {
           return;
         }
 

lib/rules/forbid-dom-props.js

@@ -7,6 +7,7 @@
 
 const docsUrl = require('../util/docsUrl');
 const report = require('../util/report');
+const isForbidden = require('../util/isForbidden');
 
 // ------------------------------------------------------------------------------
 // Constants
@@ -18,21 +19,6 @@ const DEFAULTS = [];
 // Rule Definition
 // ------------------------------------------------------------------------------
 
-/**
- * @param {Map<string, object>} forbidMap // { disallowList: null | string[], message: null | string }
- * @param {string} prop
- * @param {string} tagName
- * @returns {boolean}
- */
-function isForbidden(forbidMap, prop, tagName) {
-  const options = forbidMap.get(prop);
-  return options && (
-    typeof tagName === 'undefined'
-    || !options.disallowList
-    || options.disallowList.indexOf(tagName) !== -1
-  );
-}
-
 const messages = {
   propIsForbidden: 'Prop "{{prop}}" is forbidden on DOM Nodes',
 };
@@ -62,6 +48,13 @@ module.exports = {
                 propName: {
                   type: 'string',
                 },
+                allowedFor: {
+                  type: 'array',
+                  uniqueItems: true,
+                  items: {
+                    type: 'string',
+                  },
+                },
                 disallowedFor: {
                   type: 'array',
                   uniqueItems: true,
@@ -86,8 +79,13 @@ module.exports = {
   create(context) {
     const configuration = context.options[0] || {};
     const forbid = new Map((configuration.forbid || DEFAULTS).map((value) => {
+      if (value.allowedFor && value.disallowedFor) {
+        throw new Error('Must specify either allowedFor or disallowedFor, not both');
+      }
+
       const propName = typeof value === 'string' ? value : value.propName;
       return [propName, {
+        allowList: typeof value === 'string' ? null : (value.allowedFor || null),
         disallowList: typeof value === 'string' ? null : (value.disallowedFor || null),
         message: typeof value === 'string' ? null : value.message,
       }];

lib/util/isForbidden.js

@@ -0,0 +1,30 @@
+'use strict';
+
+/**
+ * @typedef {Object} ForbidOptions
+ * @property {string[]} [allowList]
+ * @property {string[]} [disallowList]
+ * @property {string} [message]
+ */
+
+/**
+ * @param {Map<string, ForbidOptions>} forbidMap
+ * @param {string} prop
+ * @param {string} tagName
+ * @returns {boolean}
+ */
+function isForbidden(forbidMap, prop, tagName) {
+  const options = forbidMap.get(prop);
+  if (!options) { return false; }
+
+  if (options.allowList) {
+    return (typeof tagName === 'undefined') || options.allowList.indexOf(tagName) === -1;
+  }
+  if (options.disallowList) {
+    return (typeof tagName === 'undefined') || options.disallowList.indexOf(tagName) !== -1;
+  }
+
+  return true;
+}
+
+module.exports = isForbidden;