Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update: add fixer for wrap-iife #7196

Merged
merged 2 commits into from Sep 30, 2016

Conversation

not-an-aardvark
Copy link
Member

What is the purpose of this pull request? (put an "X" next to item)

[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[x] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

Please check each item to ensure your pull request is ready:

  • I've read the pull request guide
  • I've included tests for my change
  • I've updated documentation for my change (if appropriate)

What changes did you make? (Give an overview)

This adds a fixer for wrap-iife.

If the IIFE has no surrounding parentheses, the fixer surrounds it with parentheses. The fixer also removes parentheses that are in the wrong place according to the rule option:

/* eslint wrap-iife: [2, "outside"] */

var foo = function() {}();
(function() {})();

// gets fixed to:

var foo = (function() {}());
(function() {}());
/* eslint wrap-iife: [2, "inside"] */

var foo = function() {}();
(function() {}());

// gets fixed to:

var foo = (function() {})();
(function() {})();

Is there anything you'd like reviewers to focus on?

Nothing in particular.

@mention-bot
Copy link

@not-an-aardvark, thanks for your PR! By analyzing the annotation information on this pull request, we identified @vitorbal, @lo1tuma and @ilyavolodin to be potential reviewers

@eslintbot
Copy link

LGTM

Copy link
Member

@mysticatea mysticatea left a comment

Choose a reason for hiding this comment

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

LGTM, thank you!

@mysticatea mysticatea added enhancement This change enhances an existing feature of ESLint rule Relates to ESLint's core rules evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion labels Sep 23, 2016
Copy link
Member

@platinumazure platinumazure left a comment

Choose a reason for hiding this comment

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

Minor tweak about multiline comments, otherwise looks good.

// The outer call expression will always be wrapped at this point.
// Replace the range between the end of the function expression and the end of the call expression.
// for example, in `(function(foo) {}(bar))`, the range `(bar))` should get replaced with `)(bar)`.
// Replace the parens from the outer expression, and parenthesize the function expression.
Copy link
Member

Choose a reason for hiding this comment

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

In our coding conventions, we prefer multi-line comments to be formatted like this:

/*
 * First line of comment here.
 * Second line. Note that each line starts with asterisk aligned with the open-comment asterisk character.
 * Both comment start and end should be on their own line.
 * Comment ends with asterisk of close-comment token aligned with other asterisks.
 */

// The inner function expression will always be wrapped at this point.
// It's only necessary to replace the range between the end of the function expression
// and the call expression. For example, in `(function(foo) {})(bar)`, the range `)(bar)`
// should get replaced with `(bar))`.
Copy link
Member

Choose a reason for hiding this comment

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

Same as above re: multiline comment.

@eslintbot
Copy link

LGTM

@not-an-aardvark
Copy link
Member Author

Added a commit to fix multiline comment style.

@platinumazure
Copy link
Member

Thanks @not-an-aardvark, changes LGTM.

@kaicataldo kaicataldo self-assigned this Sep 29, 2016
@kaicataldo
Copy link
Member

I'll champion this.

@kaicataldo kaicataldo added accepted There is consensus among the team that this change meets the criteria for inclusion and removed evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion labels Sep 29, 2016
@kaicataldo kaicataldo merged commit f8e8fab into eslint:master Sep 30, 2016
@not-an-aardvark not-an-aardvark deleted the wrap-iife-fixer branch September 30, 2016 04:05
@kaicataldo
Copy link
Member

LGTM. Thanks for contributing to ESLint!

@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Feb 6, 2018
@eslint-deprecated 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 6, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion enhancement This change enhances an existing feature of ESLint rule Relates to ESLint's core rules
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants