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: clarify kinds of lint rules in formatting docs #6510

Conversation

JoshuaKGoldberg
Copy link
Member

PR Checklist

Overview

Applies a few changes to make the page more friendly for newcomers:

  • Moves the ESLint Core and Formatting section to the end, so that folks start with the more-relevant explanation of Formatters vs. Linters
  • Adds an explanation of the 2-3 categories of lint rules at the start of ESLint Core and Formatting
  • Elaborates on why you'd want to use eslint-config-prettier, as you don't actually need it unless you enable rules separate from the core/typescript-eslint recommended presets

cc @mattpocock @nzakas for interest 👋

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

@nx-cloud
Copy link

nx-cloud bot commented Feb 21, 2023

☁️ Nx Cloud Report

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

📂 See all runs for this branch


✅ Successfully ran 46 targets

Sent with 💌 from NxCloud.

@netlify
Copy link

netlify bot commented Feb 21, 2023

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 8b8b644
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/63f635727657ce0008facc0a
😎 Deploy Preview https://deploy-preview-6510--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@rubiesonthesky
Copy link
Contributor

I feel weird mentioning semicolons as just formatting, because they can affect runtime behavior. 😅 The decision between using them only where needed and always, is stylistic. Of course this is nit and it may be clear for everyone what is meant here.

@Josh-Cena
Copy link
Member

I feel weird mentioning semicolons as just formatting, because they can affect runtime behavior.

It doesn't change runtime behavior; it changes how the code parses altogether. I guess when we say "change semicolons" it's really implied that we are changing it in a syntactically insignificant way.

bradzacher
bradzacher previously approved these changes Feb 22, 2023
docs/linting/troubleshooting/Formatting.mdx Outdated Show resolved Hide resolved
Co-authored-by: Brad Zacher <brad.zacher@gmail.com>
@bradzacher bradzacher merged commit 3bc8c15 into typescript-eslint:main Mar 1, 2023
@JoshuaKGoldberg JoshuaKGoldberg deleted the formatting-docs-lint-rule-terminology branch March 1, 2023 06:02
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 9, 2023
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: Be more clear in differentiating "formatting" vs "style"
4 participants