8000 docs: reference eslint-stylistic around formatting docs by JoshuaKGoldberg · Pull Request #7733 · typescript-eslint/typescript-eslint · GitHub
[go: up one dir, main page]
Skip to content

docs: reference eslint-stylistic around formatting docs #7733

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Oct 19, 2023
Merged

docs: reference eslint-stylistic around formatting docs #7733

merged 2 commits into from
Oct 19, 2023

Conversation

JoshuaKGoldberg
Copy link
Member

PR Checklist

Overview

Applies a few touchups to the What About Formatting? page:

  • Removes the word strongly to tone down the severity a bit
  • Adds a more explicit mention of typed rules making the performance penalty of re-running linting more severe
    • As I think @Josh-Cena has mentioned previously, much of this docs page really is an ESLint core thing. I want to be clear in it about anything that is different for us.
  • Adds a link to eslint.style, with an explanation of why you'd use it

Also changes the auto-generated admonition on top of formatting rules to point to eslint.style.

cc @antfu - if you have the time, I'd greatly appreciate your review on this. Is this wording accurate and not too harsh still? Is there more reasoning you'd want to add for using eslint.style instead of a dedicated formatter? Is there anywhere else you think we should add something?

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

@netlify
Copy link
netlify bot commented Oct 10, 2023 •
edited
Loading

✅ Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 52cdfb7
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/652efa7cae65980008553171
😎 Deploy Preview https://deploy-preview-7733--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: 99 (🟢 up 4 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.

@nx-cloud
Copy link
nx-cloud bot commented Oct 10, 2023 •
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 52cdfb7. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 19 targets

Sent with 💌 from NxCloud.

@JoshuaKGoldberg JoshuaKGoldberg mentioned this pull request Oct 10, 2023
Closed
antfu
antfu approved these changes Oct 10, 2023
View reviewed changes
Copy link
Contributor
@antfu antfu left a comment

Choose a reason for hiding this comment

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

Looks great! Thanks a lot for the support! (and working on it so quickly!) 💚

@JamesHenry
Copy link
Member

FYI I reran your failed deploy without the cache via the Netlify UI which resolved the issue:
image

@JoshuaKGoldberg JoshuaKGoldberg merged commit 3f64baa into typescript-eslint:main Oct 19, 2023
@JoshuaKGoldberg JoshuaKGoldberg deleted the eslint-stylistic-docs branch October 19, 2023 17:33
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 27, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@antfu antfu antfu approved these changes

@Josh-Cena Josh-Cena Josh-Cena approved these changes

@bradzacher bradzacher Awaiting requested review from bradzacher

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs: Mention eslint-stylistic (eslint.style)
4 participants
@JoshuaKGoldberg @JamesHenry @antfu @Josh-Cena
0