Add support for propTypes wrapped in a function #1253

dustinsoftware · 2017-06-12T22:02:38Z

PropTypes would previously get ignored if wrapped in forbidExtraProps.

ljharb

Thanks!

However, this behavior should be behind an option (array of strings), and that option should include an explicit identifier name for that function - ie, this should not be considered unless forbidExtraProps is in the eslint config.

dustinsoftware · 2017-06-13T00:00:29Z

Is this what you had in mind?

ljharb · 2017-06-13T06:17:43Z

lib/rules/no-unused-prop-types.js

@@ -44,6 +44,9 @@ module.exports = {
        },
        skipShapeProps: {
          type: 'boolean'
+        },
+        extraPropsFunc: {


i think this would be better as an array of unique strings - that way multiples could be provided.

Let's also rename it to "propWrapperFunctions"

dustinsoftware · 2017-06-13T15:34:06Z

Ok, I think it's ready for another pass :)

ljharb

LGTM pending an update to the docs :-)

ljharb · 2017-06-13T16:45:12Z

lib/rules/no-unused-prop-types.js

-          type: 'string'
+        propWrapperFunctions: {
+          type: 'array',
+          items: {


please add uniqueItems: true so that jsonschema enforces uniqueness

ljharb

LGTM!

It'd be nice to rebase this down to a single commit.

dustinsoftware · 2017-06-14T04:41:03Z

👍 rebased. Thanks for the quick feedback.

lencioni · 2017-06-15T18:19:40Z

lib/rules/no-unused-prop-types.js

+        case 'CallExpression':
+          if (
+            configuration.propWrapperFunctions &&
+            configuration.propWrapperFunctions.indexOf(propTypes.callee.name) !== -1 &&


It might be worth converting the propWrapperFunctions to a structure with constant time lookup, like a Set, to keep this path fast.

ljharb · 2017-06-15T23:28:46Z

lib/rules/no-unused-prop-types.js

+        case 'CallExpression':
+          if (
+            configuration.propWrapperFunctions &&
+            configuration.propWrapperFunctions.indexOf(propTypes.callee.name) !== -1 &&


that's a really great point. this should definitely be converted to a Set.

Ok, updated

ljharb

Almost there :-)

ljharb · 2017-06-16T04:18:07Z

lib/rules/no-unused-prop-types.js

@@ -56,6 +63,9 @@ module.exports = {
    var configuration = Object.assign({}, defaults, context.options[0] || {});
    var skipShapeProps = configuration.skipShapeProps;
    var customValidators = configuration.customValidators || [];
+    var propWrapperFunctions = configuration.propWrapperFunctions ?
+      new Set(configuration.propWrapperFunctions) : new Set();


var propWrapperFunctions = new Set(configuration.propWrapperFunctions || []);

Dargh, thanks...should have caught that one

PropTypes would previously get ignored if wrapped in forbidExtraProps.

ljharb · 2017-06-16T07:36:09Z

@dustinsoftware are there other rules that could benefit from this information?

If so, maybe we should move it to "settings", and read from it in multiple rules?

mqklin · 2017-06-22T10:59:18Z

Has it been published?

ljharb · 2017-06-22T16:14:34Z

Nope, not yet.

EvHaus

LGTM

mqklin · 2017-09-28T08:02:15Z

@ljharb @dustinsoftware
still, doesn't work for me :(
repro: https://github.com/mqklin/eslint-proptypes-bug

ljharb · 2017-09-28T12:05:02Z

@mqklin because you haven't explicitly defined it as a propWrapperFunction in your eslintrc.

Please file a new issue if you still have questions instead of commenting on a merged PR.

mqklin · 2017-09-28T12:11:50Z

@ljharb thank you very much! I missed this.

ljharb requested changes Jun 12, 2017

View reviewed changes

ljharb added the enhancement label Jun 12, 2017

ljharb requested changes Jun 13, 2017

View reviewed changes

ljharb approved these changes Jun 14, 2017

View reviewed changes

ljharb requested review from yannickcr, lencioni and EvHaus June 14, 2017 04:24

dustinsoftware force-pushed the forbidExtraProps branch from 4bda7e4 to a71b3a7 Compare June 14, 2017 04:39

ljharb mentioned this pull request Jun 15, 2017

forbidExtraProps incompatible with eslint-plugin-react propType rules? airbnb/prop-types#23

Closed

lencioni approved these changes Jun 15, 2017

View reviewed changes

ljharb requested changes Jun 15, 2017

View reviewed changes

dustinsoftware force-pushed the forbidExtraProps branch 2 times, most recently from 1520791 to 5d05311 Compare June 16, 2017 03:05

ljharb requested changes Jun 16, 2017

View reviewed changes

dustinsoftware force-pushed the forbidExtraProps branch from 5d05311 to 57b974c Compare June 16, 2017 04:23

Add support for propTypes wrapped in a function

5770f29

PropTypes would previously get ignored if wrapped in forbidExtraProps.

dustinsoftware force-pushed the forbidExtraProps branch from 57b974c to 5770f29 Compare June 16, 2017 04:24

ljharb approved these changes Jun 16, 2017

View reviewed changes

ljharb merged commit c568d49 into jsx-eslint:master Jun 16, 2017

flats mentioned this pull request Jun 20, 2017

Most propType rules do not support propTypes wrapped in a function #1266

Closed

EvHaus reviewed Jun 22, 2017

View reviewed changes

ljharb mentioned this pull request Aug 10, 2017

forbid-prop-types: propWrapperFunctions does not follow identifiers #1352

Closed

dependencies bot mentioned this pull request Aug 25, 2017

Update eslint-plugin-react from 7.1.0 to 7.3.0 chauncey-garrett/dotfiles#13

Open

renovate bot mentioned this pull request Feb 2, 2018

Update dependency eslint-plugin-react to v7 JimmyLv/Haiku#34

Open

1 task

This was referenced Oct 25, 2018

Update dependency eslint-plugin-react to v7 efcsydney/efcsydney-roster#502

Merged

Update dependency eslint-plugin-react to v7 CaptainGlac1er/StudentHomeworkProject#38

Open

renovate bot mentioned this pull request Nov 7, 2018

chore(deps): update dependency eslint-plugin-react to v7 vgmtv/rsvg#12

Merged

renovate bot mentioned this pull request Nov 23, 2018

chore(deps): update dependency eslint-plugin-react to v7 JLHwung/tianzige#31

Open

1 task

renovate bot mentioned this pull request Dec 5, 2018

Update dependency eslint-plugin-react to v7 Automattic/jetpack#10827

Closed

1 task

mesosphere-web mentioned this pull request Dec 19, 2018

chore(deps): update dependency eslint-plugin-react to v7 mesosphere/reactjs-components#475

Closed

1 task

This was referenced Jan 8, 2019

Update dependency eslint-plugin-react to v7 SonyaMoisset/Team-Treehouse_Training#8

Closed

Update dependency eslint-plugin-react to v7 - autoclosed amytych/react-escape-outside#10

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for propTypes wrapped in a function #1253

Add support for propTypes wrapped in a function #1253

dustinsoftware commented Jun 12, 2017

ljharb left a comment

dustinsoftware commented Jun 13, 2017

ljharb Jun 13, 2017

dustinsoftware commented Jun 13, 2017

ljharb left a comment

ljharb Jun 13, 2017

ljharb left a comment

dustinsoftware commented Jun 14, 2017

lencioni Jun 15, 2017

ljharb Jun 15, 2017

dustinsoftware Jun 16, 2017

ljharb left a comment

ljharb Jun 16, 2017

dustinsoftware Jun 16, 2017

ljharb commented Jun 16, 2017

mqklin commented Jun 22, 2017

ljharb commented Jun 22, 2017

EvHaus left a comment

mqklin commented Sep 28, 2017 •

edited

ljharb commented Sep 28, 2017

mqklin commented Sep 28, 2017

Add support for propTypes wrapped in a function #1253

Add support for propTypes wrapped in a function #1253

Conversation

dustinsoftware commented Jun 12, 2017

ljharb left a comment

Choose a reason for hiding this comment

dustinsoftware commented Jun 13, 2017

ljharb Jun 13, 2017

Choose a reason for hiding this comment

dustinsoftware commented Jun 13, 2017

ljharb left a comment

Choose a reason for hiding this comment

ljharb Jun 13, 2017

Choose a reason for hiding this comment

ljharb left a comment

Choose a reason for hiding this comment

dustinsoftware commented Jun 14, 2017

lencioni Jun 15, 2017

Choose a reason for hiding this comment

ljharb Jun 15, 2017

Choose a reason for hiding this comment

dustinsoftware Jun 16, 2017

Choose a reason for hiding this comment

ljharb left a comment

Choose a reason for hiding this comment

ljharb Jun 16, 2017

Choose a reason for hiding this comment

dustinsoftware Jun 16, 2017

Choose a reason for hiding this comment

ljharb commented Jun 16, 2017

mqklin commented Jun 22, 2017

ljharb commented Jun 22, 2017

EvHaus left a comment

Choose a reason for hiding this comment

mqklin commented Sep 28, 2017 • edited

ljharb commented Sep 28, 2017

mqklin commented Sep 28, 2017

mqklin commented Sep 28, 2017 •

edited