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

Remove lines around comment rule in prettier eslint-plugins #319

Merged
merged 2 commits into from
Feb 1, 2022

Conversation

royleejr
Copy link
Contributor

@royleejr royleejr commented Feb 1, 2022

Description

As said in this PR. We have discussed and decided that the rule lines-around-comment should no longer be enforced upon us because of known typescript issues such as typescript-eslint/typescript-eslint#1150. We believe that we should stay consistent with this rule all across shopify and should remove this rule from the eslint-plugins.

Type of change

  • Patch: Bug (non-breaking change which fixes an issue)
  • eslint-plugin Minor: New feature (non-breaking change which adds functionality)
  • Major: Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist

  • I have added a changelog entry, prefixed by the type of change noted above (Documentation fix and Test update does not need a changelog as we do not publish a new version for these changes)

@royleejr royleejr force-pushed the remove-lines-around-comment-rule-eslint branch from 347657f to 4813849 Compare February 1, 2022 16:56
@royleejr royleejr requested a review from BPScott February 1, 2022 16:57
@royleejr royleejr force-pushed the remove-lines-around-comment-rule-eslint branch from 4813849 to 6855e95 Compare February 1, 2022 17:03
@BPScott
Copy link
Member

BPScott commented Feb 1, 2022

this rule is disabled in eslint-plugin-prettier, which our prettier config extends from, so we don't need to explicitly set this to off ourselves.

Copy link
Member

@BPScott BPScott left a comment

Choose a reason for hiding this comment

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

Code is good, gotta keep the changelog linter happy though

packages/eslint-plugin/CHANGELOG.md Outdated Show resolved Hide resolved
@royleejr royleejr force-pushed the remove-lines-around-comment-rule-eslint branch from 6855e95 to 134745a Compare February 1, 2022 17:25
@royleejr royleejr force-pushed the remove-lines-around-comment-rule-eslint branch from 134745a to d770578 Compare February 1, 2022 17:29
@royleejr royleejr merged commit 1aee40a into main Feb 1, 2022
@royleejr royleejr deleted the remove-lines-around-comment-rule-eslint branch February 1, 2022 20:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants