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

Fix: no-useless-return autofix removes comments #12292

Merged
merged 1 commit into from Sep 29, 2019

Conversation

@mdjermanovic
Copy link
Member

mdjermanovic commented Sep 19, 2019

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

[X] Bug fix

Tell us about your environment

  • ESLint Version: 6.4.0
  • Node Version: 10.16.0
  • npm Version: 6.9.0

What parser (default, Babel-ESLint, etc.) are you using?

default

Please show your full configuration:

Configuration
module.exports = {
  parserOptions: {
    ecmaVersion: 2015,
  }
};

What did you do? Please include the actual source code causing the issue.

Demo link

/* eslint no-useless-return:error */

function foo() {
  bar();
  return /* comment */;
}

function baz() {
  bar();
  return // comment
  ;
}

What did you expect to happen?

2 errors, but no autofix as it would remove comments.

What actually happened? Please include the actual, raw output from ESLint.

/* eslint no-useless-return:error */

function foo() {
  bar();
  
}

function baz() {
  bar();
  
}

What changes did you make? (Give an overview)

Report errors but don't fix if there are comments inside the return statement's node.

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

I think it's better to manually fix the code in this situation than to auto-remove return and preserve comments.

@eslint eslint bot added the triage label Sep 19, 2019
Copy link
Member

kaicataldo left a comment

LGTM, thanks!

@kaicataldo kaicataldo added bug rule autofix and removed triage labels Sep 19, 2019
@platinumazure platinumazure merged commit 7dc1ea9 into master Sep 29, 2019
16 checks passed
16 checks passed
Verify Files
Details
Test (ubuntu-latest, 8.x)
Details
Test (ubuntu-latest, 10.x)
Details
Test (ubuntu-latest, 12.x)
Details
Test (windows-latest, 12.x)
Details
Test (macOS-latest, 12.x)
Details
Browser Test
Details
commit-message Commit message follows guidelines
Details
continuous-integration Build #20190919.6 succeeded
Details
continuous-integration (Test on Node.js 10 (Linux)) Test on Node.js 10 (Linux) succeeded
Details
continuous-integration (Test on Node.js 12 (Linux)) Test on Node.js 12 (Linux) succeeded
Details
continuous-integration (Test on Node.js 12 (Windows)) Test on Node.js 12 (Windows) succeeded
Details
continuous-integration (Test on Node.js 12 (macOS)) Test on Node.js 12 (macOS) succeeded
Details
continuous-integration (Test on Node.js 8 (Linux)) Test on Node.js 8 (Linux) succeeded
Details
licence/cla Contributor License Agreement is signed.
Details
release-monitor No patch release is pending
Details
@platinumazure platinumazure deleted the nouselessreturn-comments branch Sep 29, 2019
@eslint eslint bot locked and limited conversation to collaborators Mar 29, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants
You can’t perform that action at this time.