New: the `prefer-reflect` rule (fixes #2939) #2996

keithamus · 2015-07-14T23:23:40Z

This PR adds a rule to warn when the user is using "effectively deprecated" methods - which Reflect.* replaces, as discussed in #2939. Fixes #2939.

As the docs/tests suggest, each section can be disabled - meaning the user can configure this how they need to, for example if they want to use reflect for all but the delete operator, then they can configure it as [2, "delete"].

Let me know if you need anything else from me to merge this.

Oh, also, so close!

nzakas · 2015-07-15T00:50:04Z

tests/lib/rules/prefer-reflect.js

+            ]
+        },
+        {
+            code: "(function(){}).apply(null, 1, 2)",


Apply only takes two arguments.

nzakas · 2015-07-15T00:53:29Z

Overall looks good. I would like to change the options to be more in line with how we've defined exceptions in other rules. I can see two possible options:

prefer-reflect: [2, { exceptions: [ "delete"]}]

prefer-reflect: [2, { delete: false}]

Kinda leaning towards the second, but could be convinced otherwise.

michaelficarra · 2015-07-15T01:59:58Z

@nzakas The second permits a tri-state with different falsey values (false and undefined) meaning different things. That's not a good interface in my opinion.

keithamus · 2015-07-15T07:51:22Z

I went more inline with a ruleset similar to no-restricted-modules. I'm happy to change it to the first example you show though.

keithamus · 2015-07-15T08:04:15Z

Rebased, fixed tests and changed rule options to be {exceptions: [...]} as per @nzakas instruction

keithamus · 2015-07-15T08:49:39Z

io.js travis build seems to be stuck, but I cant stop or restart it: https://travis-ci.org/eslint/eslint/jobs/71037738

keithamus · 2015-07-15T10:58:49Z

Failure is down to travis timing out trying to install iojs:

$ nvm install iojs
                                                                           0.4%
Your test run exceeded 120 minutes. 
One possible solution is to split up your test run.

Force pushed to trigger a new build. Should pass now.

keithamus · 2015-07-15T11:04:30Z

Oops, forgot to update docs in respect to change to using {exceptions:[]} syntax.

Docs updated now. This should be good to go.

nzakas · 2015-07-15T15:10:59Z

lib/rules/prefer-reflect.js

+
+    var exceptions = (context.options[0] || {}).exceptions || [];
+
+    function report(node, existing, substitute) {


Please add JSDoc comments here

keithamus · 2015-07-16T08:58:31Z

Added jsdoc block for report function.

@nzakas is there anything else you'd like me to change?

keithamus · 2015-07-16T09:00:29Z

Fixed lint errors JSDoc.

nzakas · 2015-07-16T18:14:54Z

tests/lib/rules/prefer-reflect.js

+        },
+        {
+            code: "Object.isExtensible({})",
+            args: [2, { exceptions: "apply" }],


Can you use options instead of args?

options: [{exceptions: "apply"}]

You can leave off the initial 2, and any place with args: 2 can just be removed.

keithamus · 2015-07-16T20:31:29Z

All done @nzakas. Anything else?

ilyavolodin · 2015-07-16T20:38:44Z

docs/rules/prefer-reflect.md

+
+If you want to use Reflect methods, but keep using the `delete` keyword, then your config would look like `prefer-reflect: [2, { exceptions: ["delete"]] }`.
+
+These can be combined as much as you like. To make all methods exceptions (thereby rendering this rule useless), use `prefer-reflect: [2, { exceptions: ["apply }", "call]", "defineProperty", "getOwnPropertyDescriptor", "getPrototypeOf", "setPrototypeOf", "isExtensible", "getOwnPropertyNames", "preventExtensions", "delete"]`


I think there's an extra closing brace inside the array and one missing at the end of the line.

ilyavolodin · 2015-07-16T20:39:34Z

LGTM. Btw, awesome documentation!

keithamus · 2015-07-16T20:43:30Z

😄 thanks @ilyavolodin

ilyavolodin · 2015-07-16T20:47:28Z

docs/rules/prefer-reflect.md

+
+The `exceptions` option allows you to pass an array of methods names you'd like to continue to use in the old style.
+
+For example if you wish to use all Reflect methods, except for `Function.prototype.apply` then your config would look like `prefer-reflect: [2, { exceptions: ["apply"]] }`.


Closing square brace is in the wrong place.

nzakas · 2015-07-17T01:59:59Z

Can you rebase?

keithamus · 2015-07-17T08:00:55Z

Rebased @nzakas

ilyavolodin · 2015-07-17T13:47:00Z

Thanks @keithamus for sticking with this!

New: the `prefer-reflect` rule (fixes #2939)

keithamus · 2015-07-17T13:48:08Z

🎉

nzakas reviewed Jul 15, 2015
View reviewed changes

tests/lib/rules/prefer-reflect.js

]

},

{

code: "(function(){}).apply(null, 1, 2)",

Copy link

Member

nzakas Jul 15, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apply only takes two arguments.

nzakas reviewed Jul 15, 2015
View reviewed changes

nzakas reviewed Jul 16, 2015
View reviewed changes

ilyavolodin reviewed Jul 16, 2015
View reviewed changes

New: the prefer-reflect rule (fixes #2939)

bda63db

ilyavolodin added a commit that referenced this pull request Jul 17, 2015

Merge pull request #2996 from keithamus/feature-prefer-reflect

fb33c63

New: the `prefer-reflect` rule (fixes #2939)

ilyavolodin merged commit fb33c63 into eslint:master Jul 17, 2015

keithamus deleted the feature-prefer-reflect branch July 17, 2015 13:48

eslint-deprecated bot locked and limited conversation to collaborators Feb 7, 2018

eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Feb 7, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New: the `prefer-reflect` rule (fixes #2939) #2996

New: the `prefer-reflect` rule (fixes #2939) #2996

keithamus commented Jul 14, 2015

nzakas Jul 15, 2015

nzakas commented Jul 15, 2015

michaelficarra commented Jul 15, 2015

keithamus commented Jul 15, 2015

keithamus commented Jul 15, 2015

keithamus commented Jul 15, 2015

keithamus commented Jul 15, 2015

keithamus commented Jul 15, 2015

nzakas Jul 15, 2015

keithamus commented Jul 16, 2015

keithamus commented Jul 16, 2015

nzakas Jul 16, 2015

keithamus commented Jul 16, 2015

ilyavolodin Jul 16, 2015

ilyavolodin commented Jul 16, 2015

keithamus commented Jul 16, 2015

ilyavolodin Jul 16, 2015

nzakas commented Jul 17, 2015

keithamus commented Jul 17, 2015

ilyavolodin commented Jul 17, 2015

keithamus commented Jul 17, 2015


		var exceptions = (context.options[0] \|\| {}).exceptions \|\| [];

		function report(node, existing, substitute) {


		If you want to use Reflect methods, but keep using the `delete` keyword, then your config would look like `prefer-reflect: [2, { exceptions: ["delete"]] }`.

		These can be combined as much as you like. To make all methods exceptions (thereby rendering this rule useless), use `prefer-reflect: [2, { exceptions: ["apply }", "call]", "defineProperty", "getOwnPropertyDescriptor", "getPrototypeOf", "setPrototypeOf", "isExtensible", "getOwnPropertyNames", "preventExtensions", "delete"]`


		The `exceptions` option allows you to pass an array of methods names you'd like to continue to use in the old style.

		For example if you wish to use all Reflect methods, except for `Function.prototype.apply` then your config would look like `prefer-reflect: [2, { exceptions: ["apply"]] }`.

New: the prefer-reflect rule (fixes #2939) #2996

New: the prefer-reflect rule (fixes #2939) #2996

Conversation

keithamus commented Jul 14, 2015

nzakas Jul 15, 2015

Choose a reason for hiding this comment

nzakas commented Jul 15, 2015

michaelficarra commented Jul 15, 2015

keithamus commented Jul 15, 2015

keithamus commented Jul 15, 2015

keithamus commented Jul 15, 2015

keithamus commented Jul 15, 2015

keithamus commented Jul 15, 2015

nzakas Jul 15, 2015

Choose a reason for hiding this comment

keithamus commented Jul 16, 2015

keithamus commented Jul 16, 2015

nzakas Jul 16, 2015

Choose a reason for hiding this comment

keithamus commented Jul 16, 2015

ilyavolodin Jul 16, 2015

Choose a reason for hiding this comment

ilyavolodin commented Jul 16, 2015

keithamus commented Jul 16, 2015

ilyavolodin Jul 16, 2015

Choose a reason for hiding this comment

nzakas commented Jul 17, 2015

keithamus commented Jul 17, 2015

ilyavolodin commented Jul 17, 2015

keithamus commented Jul 17, 2015

New: the `prefer-reflect` rule (fixes #2939) #2996

New: the `prefer-reflect` rule (fixes #2939) #2996