fix: lines-around-comment apply `allowBlockStart` for switch statements by snitin315 · Pull Request #16153 · eslint/eslint

snitin315 · 2022-07-22T03:47:16Z

Prerequisites checklist

I have read the contributing guidelines.

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

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

What changes did you make? (Give an overview)

Fix #16131

/* eslint lines-around-comment: ["error", {
  beforeLineComment: true,
  afterLineComment: true,
  allowBlockStart: true,
  allowBlockEnd: true
}]*/

switch (foo) {
  // this comment is allowed by allowBlockStart: true 
    
  case 1:    
    bar();
    break;
    
  // this comment is allowed by allowBlockEnd: true
}

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

netlify · 2022-07-22T03:47:22Z

✅ Deploy Preview for docs-eslint ready!

Name	Link
🔨 Latest commit	`df449cd`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-eslint/deploys/62dc9e98148ec2000934a59e
😎 Deploy Preview	https://deploy-preview-16153--docs-eslint.netlify.app/rules/lines-around-comment
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

mdjermanovic · 2022-07-23T22:13:15Z

Can you also add switch statements to the list:

eslint/docs/src/rules/lines-around-comment.md

Lines 28 to 29 in e0d072a

    
           * `"allowBlockStart": true` allows comments to appear at the start of block statements, function bodies, classes, and class static blocks 
        
           * `"allowBlockEnd": true` allows comments to appear at the end of block statements, function bodies, classes, and class static blocks

…nes-around-comment)

mdjermanovic

LGTM, thanks!

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | minor | [`8.20.0` -> `8.21.0`](https://renovatebot.com/diffs/npm/eslint/8.20.0/8.21.0) | --- ### Release Notes <details> <summary>eslint/eslint</summary> ### [`v8.21.0`](https://github.com/eslint/eslint/releases/tag/v8.21.0) [Compare Source](eslint/eslint@v8.20.0...v8.21.0) #### Features - [`7b43ea1`](eslint/eslint@7b43ea1) feat: Implement FlatESLint ([#16149](eslint/eslint#16149)) (Nicholas C. Zakas) - [`92bf49a`](eslint/eslint@92bf49a) feat: improve the key width calculation in `key-spacing` rule ([#16154](eslint/eslint#16154)) (Nitin Kumar) - [`c461542`](eslint/eslint@c461542) feat: add new `allowLineSeparatedGroups` option to the `sort-keys` rule ([#16138](eslint/eslint#16138)) (Nitin Kumar) - [`1cdcbca`](eslint/eslint@1cdcbca) feat: add deprecation warnings for legacy API in `RuleTester` ([#16063](eslint/eslint#16063)) (Nitin Kumar) #### Bug Fixes - [`0396775`](eslint/eslint@0396775) fix: lines-around-comment apply `allowBlockStart` for switch statements ([#16153](eslint/eslint#16153)) (Nitin Kumar) #### Documentation - [`2aadc93`](eslint/eslint@2aadc93) docs: add anchors to headings inside docs content ([#16134](eslint/eslint#16134)) (Strek) #### Chores - [`8892511`](eslint/eslint@8892511) chore: Upgrade to Espree 9.3.3 ([#16173](eslint/eslint#16173)) (Brandon Mills) - [`1233bee`](eslint/eslint@1233bee) chore: switch to eslint-plugin-node's maintained fork ([#16150](eslint/eslint#16150)) (唯然) - [`97b95c0`](eslint/eslint@97b95c0) chore: upgrade puppeteer v13 ([#16151](eslint/eslint#16151)) (唯然) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1483 Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>

fix: apply allowBlockStart for switch statements too

1446457

eslint-github-bot Bot added triage An ESLint team member will look at this issue soon bug ESLint is working incorrectly labels Jul 22, 2022

docs: add switch statement examples for lines-around-comment-rule

9347635

mdjermanovic added rule Relates to ESLint's core rules accepted There is consensus among the team that this change meets the criteria for inclusion and removed triage An ESLint team member will look at this issue soon labels Jul 22, 2022

mdjermanovic requested changes Jul 22, 2022

View reviewed changes

Comment thread lib/rules/lines-around-comment.js

fix: check if comment is after the { token

e0d072a

mdjermanovic reviewed Jul 23, 2022

View reviewed changes

Comment thread lib/rules/lines-around-comment.js Outdated

mdjermanovic changed the title ~~fix: apply allowBlockStart for switch statements too~~ fix: lines-around-comment apply allowBlockStart for switch statements Jul 23, 2022

snitin315 added 2 commits July 24, 2022 06:49

fix: check for the correct opening brace

90dead9

docs: add switch statements for allowBlockEnd and allowBlockStart (li…

df449cd

…nes-around-comment)

snitin315 requested a review from mdjermanovic July 24, 2022 10:43

mdjermanovic approved these changes Jul 25, 2022

View reviewed changes

mdjermanovic merged commit 0396775 into main Jul 25, 2022

mdjermanovic deleted the fix/allowBlockStart-lines-around-comment branch July 25, 2022 23:00

sync-by-unito Bot mentioned this pull request Aug 1, 2022

build(deps-dev): bump eslint from 7.32.0 to 8.21.0 numbersprotocol/capture-cam#1868

Closed

sync-by-unito Bot mentioned this pull request Sep 1, 2022

build(deps-dev): bump eslint from 7.32.0 to 8.23.0 numbersprotocol/capture-cam#2013

Closed

eslint-github-bot Bot locked and limited conversation to collaborators Jan 22, 2023

eslint-github-bot Bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Jan 22, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: lines-around-comment apply `allowBlockStart` for switch statements#16153

fix: lines-around-comment apply `allowBlockStart` for switch statements#16153
mdjermanovic merged 5 commits intomainfrom
fix/allowBlockStart-lines-around-comment

snitin315 commented Jul 22, 2022

Uh oh!

netlify Bot commented Jul 22, 2022 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

mdjermanovic commented Jul 23, 2022

Uh oh!

mdjermanovic left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

snitin315 commented Jul 22, 2022

Prerequisites checklist

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

What changes did you make? (Give an overview)

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

Uh oh!

netlify Bot commented Jul 22, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for docs-eslint ready!

Uh oh!

Uh oh!

Uh oh!

mdjermanovic commented Jul 23, 2022

Uh oh!

mdjermanovic left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

netlify Bot commented Jul 22, 2022 •

edited

Loading