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

feat: add allowParensAfterCommentPattern option to no-extra-parens #16561

Merged
merged 8 commits into from Nov 29, 2022

Conversation

snitin315
Copy link
Contributor

@snitin315 snitin315 commented Nov 19, 2022

Prerequisites checklist

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

[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[x] 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)

Resolve #16386

Examples of correct code:

/* eslint no-extra-parens: ["error", "all", { "allowParensAfterCommentPattern": "@type" }] */

const span = /**@type {HTMLSpanElement}*/(event.currentTarget);

if (/** @type {Foo | Bar} */(options).baz) console.log('Lint free');

foo(/** @type {Bar} */ (bar), options, {
    name: "name",
    path: "path",
});

if (foo) {
    /** @type {Bar} */
    (bar).prop = false;
}

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

Open to suggestions for a better name for the option.

@eslint-github-bot eslint-github-bot bot added the triage An ESLint team member will look at this issue soon label Nov 19, 2022
@netlify
Copy link

netlify bot commented Nov 19, 2022

Deploy Preview for docs-eslint canceled.

Name Link
🔨 Latest commit e29b727
🔍 Latest deploy log https://app.netlify.com/sites/docs-eslint/deploys/637f77a141cafb0007d74bda

@eslint-github-bot
Copy link

Hi @snitin315!, thanks for the Pull Request

The first commit message isn't properly formatted. We ask that you update the message to match this format, as we use it to generate changelogs and automate releases.

  • The length of the commit message must be less than or equal to 72

To Fix: You can fix this problem by running git commit --amend, editing your commit message, and then running git push -f to update this pull request.

Read more about contributing to ESLint here

@snitin315 snitin315 force-pushed the feat/allow-comments-before-parens branch from c0de43c to 4a54646 Compare November 19, 2022 11:28
@eslint-github-bot eslint-github-bot bot added the feature This change adds a new feature to ESLint label Nov 19, 2022
@snitin315 snitin315 force-pushed the feat/allow-comments-before-parens branch from 4a54646 to 58dff4d Compare November 20, 2022 10:38
@snitin315 snitin315 changed the title feat: add new allowParensAfterComment option (no-extra-parens) feat: add new allowParensAfterCommentPattern option (no-extra-parens) Nov 20, 2022
@eslint-github-bot
Copy link

Hi @snitin315!, thanks for the Pull Request

The pull request title isn't properly formatted. We ask that you update the message to match this format, as we use it to generate changelogs and automate releases.

  • The length of the commit message must be less than or equal to 72

To Fix: You can fix this problem by clicking 'Edit' next to the pull request title at the top of this page.

Read more about contributing to ESLint here

@snitin315 snitin315 changed the title feat: add new allowParensAfterCommentPattern option (no-extra-parens) feat: add allowParensAfterCommentPattern option (no-extra-parens) Nov 20, 2022
@snitin315 snitin315 marked this pull request as ready for review November 20, 2022 11:03
@mdjermanovic mdjermanovic changed the title feat: add allowParensAfterCommentPattern option (no-extra-parens) feat: add allowParensAfterCommentPattern option to no-extra-parens Nov 21, 2022
@mdjermanovic 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 Nov 21, 2022
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Copy link
Member

@mdjermanovic mdjermanovic left a comment

Choose a reason for hiding this comment

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

Code and docs LGTM, I only have two suggestions about the tests.

tests/lib/rules/no-extra-parens.js Outdated Show resolved Hide resolved
tests/lib/rules/no-extra-parens.js Show resolved Hide resolved
Copy link
Member

@mdjermanovic mdjermanovic left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

I'll leave this open for a few days in case anyone else would like to review it before merging.

@Gstar123456

This comment was marked as spam.

@Gstar123456

This comment was marked as spam.

@Gstar123456

This comment was marked as spam.

@Gstar123456

This comment was marked as spam.

@mdjermanovic mdjermanovic merged commit 49a07c5 into main Nov 29, 2022
@mdjermanovic mdjermanovic deleted the feat/allow-comments-before-parens branch November 29, 2022 11:42
crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this pull request Dec 16, 2022
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | minor | [`8.28.0` -> `8.29.0`](https://renovatebot.com/diffs/npm/eslint/8.28.0/8.29.0) |

---

### Release Notes

<details>
<summary>eslint/eslint</summary>

### [`v8.29.0`](https://github.com/eslint/eslint/releases/tag/v8.29.0)

[Compare Source](eslint/eslint@v8.28.0...v8.29.0)

#### Features

-   [`49a07c5`](eslint/eslint@49a07c5) feat: add `allowParensAfterCommentPattern` option to no-extra-parens ([#&#8203;16561](eslint/eslint#16561)) (Nitin Kumar)
-   [`e6a865d`](eslint/eslint@e6a865d) feat: `prefer-named-capture-group` add suggestions ([#&#8203;16544](eslint/eslint#16544)) (Josh Goldberg)
-   [`a91332b`](eslint/eslint@a91332b) feat: In no-invalid-regexp validate flags also for non-literal patterns ([#&#8203;16583](eslint/eslint#16583)) (trosos)

#### Documentation

-   [`0311d81`](eslint/eslint@0311d81) docs: Configuring Plugins page intro, page tweaks, and rename ([#&#8203;16534](eslint/eslint#16534)) (Ben Perlmutter)
-   [`57089b1`](eslint/eslint@57089b1) docs: add a property assignment example for camelcase rule ([#&#8203;16605](eslint/eslint#16605)) (Milos Djermanovic)
-   [`b6ab030`](eslint/eslint@b6ab030) docs: add docs codeowners ([#&#8203;16601](eslint/eslint#16601)) (Strek)
-   [`6380c87`](eslint/eslint@6380c87) docs: fix sitemap and feed ([#&#8203;16592](eslint/eslint#16592)) (Milos Djermanovic)
-   [`ade621d`](eslint/eslint@ade621d) docs: perf debounce the search query ([#&#8203;16586](eslint/eslint#16586)) (Shanmughapriyan S)
-   [`fbcf3ab`](eslint/eslint@fbcf3ab) docs: fix searchbar clear button ([#&#8203;16585](eslint/eslint#16585)) (Shanmughapriyan S)
-   [`f894035`](eslint/eslint@f894035) docs: HTTPS link to yeoman.io ([#&#8203;16582](eslint/eslint#16582)) (Christian Oliff)
-   [`de12b26`](eslint/eslint@de12b26) docs: Update configuration file pages ([#&#8203;16509](eslint/eslint#16509)) (Ben Perlmutter)
-   [`1ae9f20`](eslint/eslint@1ae9f20) docs: update correct code examples for `no-extra-parens` rule ([#&#8203;16560](eslint/eslint#16560)) (Nitin Kumar)

#### Chores

-   [`7628403`](eslint/eslint@7628403) chore: add discord channel link ([#&#8203;16590](eslint/eslint#16590)) (Amaresh  S M)
-   [`f5808cb`](eslint/eslint@f5808cb) chore: fix rule doc headers check ([#&#8203;16564](eslint/eslint#16564)) (Milos Djermanovic)

</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.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC40Ny4xIiwidXBkYXRlZEluVmVyIjoiMzQuNTQuMiJ9-->

Co-authored-by: cabr2-bot <cabr2.help@gmail.com>
Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1667
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>
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators May 29, 2023
@eslint-github-bot 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 May 29, 2023
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 feature This change adds a new feature to ESLint rule Relates to ESLint's core rules
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: rule no-extra-parens conflict with JSDoc type assertions /**@type {}*/
3 participants