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

docs(eslint-plugin): add Deprecating Formatting Rules blog post #8117

Conversation

JoshuaKGoldberg
Copy link
Member

PR Checklist

Overview

Summarizes why we're doing this and links to the ESLint blog post + ESLint Stylistic docs as well.

Also includes a fix to the rule replacements: I'd forgotten ts/ exists as a separate namespace from default/.

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @JoshuaKGoldberg!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!


🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint.

Copy link

netlify bot commented Dec 24, 2023

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit ff4e22f
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/6588b3f31cdab4000969101e
😎 Deploy Preview https://deploy-preview-8117--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 95 (🔴 down 3 from production)
Accessibility: 100 (no change from production)
Best Practices: 92 (no change from production)
SEO: 98 (no change from production)
PWA: 80 (no change from production)
View the detailed breakdown and full score reports

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

Copy link
Member Author

Choose a reason for hiding this comment

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

cc @antfu @typescript-eslint/triage-team - I wish I'd thought to write this post alongside #8072/#8073. Ah well. I've set a reminder to merge this PR in on Monday before our scheduled weekly release. But please do yell at me if anything's off - even if you don't have time till after then. 🙂

Josh-Cena
Josh-Cena previously approved these changes Dec 24, 2023
Copy link
Member

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

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

Content looks great; not sure if the code change should be a separate PR but no strong feelings

Copy link
Member

@auvred auvred left a comment

Choose a reason for hiding this comment

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

Nice post!

I just found a few typos


By the way, maybe this has already been discussed somewhere, but I missed it:
What about no-extra-semi rule? It's classified as suggestion rather than layout, but it's already a part of eslint-stylistic

Shouldn't we deprecate it as well? Because otherwise it will be duplicated in both ts-eslint and eslint-stylistic

@Josh-Cena
Copy link
Member

I asked a while ago privately; I think Brad is in favor of removing it too :)

JoshuaKGoldberg and others added 3 commits December 24, 2023 13:21
Co-authored-by: auvred <61150013+auvred@users.noreply.github.com>
Co-authored-by: auvred <61150013+auvred@users.noreply.github.com>
Co-authored-by: auvred <61150013+auvred@users.noreply.github.com>
@JoshuaKGoldberg
Copy link
Member Author

JoshuaKGoldberg commented Dec 24, 2023

if the code change should be a separate PR

Heh yeah in theory maybe. But it's all going to ship at the same time. And I think this only impacts documentation anyhow.

@JoshuaKGoldberg JoshuaKGoldberg changed the title chore(website): add Deprecating Formatting Rules blog post docs(eslint-plugin): add Deprecating Formatting Rules blog post Dec 24, 2023
@JoshuaKGoldberg JoshuaKGoldberg merged commit b3f87fc into typescript-eslint:main Dec 25, 2023
56 of 57 checks passed
@JoshuaKGoldberg JoshuaKGoldberg deleted the blog-deprecating-formatting-rules branch December 25, 2023 02:43
@antfu
Copy link
Contributor

antfu commented Dec 25, 2023

Thank you! And Merry Christmas to you all!

auvred added a commit to auvred/typescript-eslint that referenced this pull request Dec 29, 2023
…script-eslint#8117)

* chore(website): add Deprecating Formatting Rules blog post

* Apply suggestions from code review

Co-authored-by: auvred <61150013+auvred@users.noreply.github.com>

* Update packages/website/blog/2023-12-25-deprecating-formatting-rules.md

Co-authored-by: auvred <61150013+auvred@users.noreply.github.com>

* Update packages/website/blog/2023-12-25-deprecating-formatting-rules.md

Co-authored-by: auvred <61150013+auvred@users.noreply.github.com>

* Ran format --write

* Add no-extra-semi too

* Generalize formatting notice to @stylistic/ rules

---------

Co-authored-by: auvred <61150013+auvred@users.noreply.github.com>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 2, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Add quick blog post about deprecating formatting rules
4 participants