feat: introduce forbidUnknowProps

README.md

@@ -16,6 +16,10 @@ yarn add @dhis2/prop-types
 <dd><p>Ensure the prop value is an array with a length between a minimum and maximum.
 If a third <code>propType</code> argument is passed each item in the array needs to be of that prop-type</p>
 </dd>
+<dt><a href="#whitelistProps">whitelistProps(propTypes)</a> ⇒ <code>Object</code></dt>
+<dd><p>Ensure that no other props, apart from the ones in the prop-types definition
+have been passed tot the component</p>
+</dd>
 <dt><a href="#instanceOfComponent">instanceOfComponent(Component)</a> ⇒ <code>Error</code> | <code>null</code></dt>
 <dd><p>Ensure the prop value is an instance of a certain component</p>
 </dd>
@@ -54,6 +58,36 @@ LotsOfLists.propTypes = {
     mandatoryArrayBetweenOneAndTen: arrayWithLength(1,10).isRequired,
 }
 ```
+<a name="whitelistProps"></a>
+
+## whitelistProps(propTypes) ⇒ <code>Object</code>
+Ensure that no other props, apart from the ones in the prop-types definition
+have been passed tot the component
+
+**Kind**: global function  
+**Returns**: <code>Object</code> - Returns a copy of the original prop-types object with an appended
+property `whitelistProps`, which is a prop-types validator that will return an error
+if props have been added that the component that were not in the prop-types object  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| propTypes | <code>object</code> | The prop-types definition of the component |
+
+**Example**  
+```js
+import React from 'react'
+import propTypes from '@dhis2/prop-types'
+
+const MyComponent = ({ score, maxScore }) => <div>{score} out of {maxScore}</div>
+MyComponent.propTypes = propTypes.whitelistProps({
+    score: propTypes.number,
+    maxScore: propTypes.number,
+})
+
+Note: `whitelistProps` is different from the `exact` method form the standard
+prop-types library, because `whitelistProps` is meant to be applied on a full component
+prop-type definition, while `exact` is meant to be a applied on an individual prop-type
+```
 <a name="instanceOfComponent"></a>
 
 ## instanceOfComponent(Component) ⇒ <code>Error</code> \| <code>null</code>

src/forbidUnknownProps.js

@@ -0,0 +1,37 @@
+/**
+ * Ensure that no other props, apart from the ones in the prop-types definition
+ * have been passed tot the component
+ * @param {object} propTypes - The prop-types definition of the component
+ * @return {Object} Returns a copy of the original prop-types object with an appended
+ * property `whitelistProps`, which is a prop-types validator that will return an error
+ * if props have been added that the component that were not in the prop-types object
+ * @example
+ * import React from 'react'
+ * import propTypes from '@dhis2/prop-types'
+ *
+ * const MyComponent = ({ score, maxScore }) => <div>{score} out of {maxScore}</div>
+ * MyComponent.propTypes = propTypes.whitelistProps({
+ *     score: propTypes.number,
+ *     maxScore: propTypes.number,
+ * })
+ *
+ * Note: `whitelistProps` is different from the `exact` method form the standard
+ * prop-types library, because `whitelistProps` is meant to be applied on a full component
+ * prop-type definition, while `exact` is meant to be a applied on an individual prop-type
+ */
+
+const whitelistProps = propTypes => ({
+    ...propTypes,
+    whitelistProps: (props, _, componentName) => {
+        const unknownProps = Object.keys(props).filter(
+            propKey => !propTypes[propKey]
+        )
+        if (unknownProps.length > 0) {
+            const list = unknownProps.join(', ')
+            return new Error(`${componentName}: unknown props found: ${list}`)
+        }
+        return null
+    },
+})
+
+export { whitelistProps }

src/index.js

@@ -1,16 +1,23 @@
 import propTypes from 'prop-types'
 
 import { arrayWithLength } from './arrayWithLength.js'
+import { whitelistProps } from './whitelistProps.js'
 import { instanceOfComponent } from './instanceOfComponent.js'
 import { mutuallyExclusive } from './mutuallyExclusive.js'
 
 const customPropTypes = {
     arrayWithLength,
+    whitelistProps,
     instanceOfComponent,
     mutuallyExclusive,
 }
 
-export { arrayWithLength, instanceOfComponent, mutuallyExclusive }
+export {
+    arrayWithLength,
+    whitelistProps,
+    instanceOfComponent,
+    mutuallyExclusive,
+}
 
 export default {
     ...propTypes,