Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork2.8k
chore(website): add formatting (Prettier) page#5363
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
bradzacher merged 8 commits intotypescript-eslint:mainfromJoshuaKGoldberg:public-prettier-docsJul 22, 2022
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
8 commits Select commitHold shift + click to select a range
4e554e4
chore(website): streamlined Getting Started docs
JoshuaKGoldberg02c4a29
Fix: check-spelling; lint-markdown
JoshuaKGoldberg5afafa1
Fixed remaining typed-linting issues
JoshuaKGoldberg8c8f750
chore: add formatting (Prettier) page to the website
JoshuaKGoldberg79ed79d
nit: first wording
JoshuaKGoldbergd3af9c4
Merge branch 'main'
JoshuaKGoldberga8abe2f
Update docs/linting/troubleshooting/FORMATTING.md
JoshuaKGoldbergaf17ab2
Add dprint to cspell dictionary
JoshuaKGoldbergFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
1 change: 1 addition & 0 deletions.cspell.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -59,6 +59,7 @@ | ||
"declarators", | ||
"destructure", | ||
"destructured", | ||
"dprint", | ||
"errored", | ||
"erroring", | ||
"ESLint", | ||
34 changes: 34 additions & 0 deletionsdocs/linting/troubleshooting/FORMATTING.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
id: formatting | ||
title: What About Formatting? | ||
--- | ||
We strongly recommend against using ESLint for formatting. | ||
We strongly recommend using [Prettier](https://prettier.io), [dprint](https://dprint.dev), or an equivalent instead. | ||
## Formatters vs. Linters | ||
**Formatters** are tools that verify and correct whitespace issues in code, such as spacing and newlines. | ||
Formatters typically run very quickly because they are only concerned with changing whitespace, not code logic or naming. | ||
**Linters** are tools that verify and correct logical and non-whitespace style issues in code, such as naming consistency and bug detection. | ||
Linters often take seconds or more to run because they apply many logical rules to code. | ||
### Problems with Using Linters as Formatters | ||
Linters apply much more work than formatters -- often including potentially multiple rounds of rule fixers. | ||
That generally makes them run orders of magnitude slower. | ||
Additionally, modern formatters such as Prettier are architected in a way that applies formatting to all code regardless of original formatting. | ||
Linters typically run on a rule-by-rule basis, typically resulting in many edge cases and missed coverage in formatting. | ||
## ESLint Core and Formatting | ||
Per [ESLint's 2020 Changes to Rule Policies blog post](https://eslint.org/blog/2020/05/changes-to-rules-policies#what-are-the-changes): | ||
> Stylistic rules are frozen - we won't be adding any more options to stylistic rules. | ||
> We've learned that there's no way to satisfy everyone's personal preferences, and most of the rules already have a lot of difficult-to-understand options. | ||
> Stylistic rules are those related to spacing, conventions, and generally anything that does not highlight an error or a better way to do something. | ||
We support the ESLint team's decision and backing logic to move away from stylistic rules. | ||
With the exception of bug fixes, no new formatting-related pull requests will be accepted into typescript-eslint. |
5 changes: 4 additions & 1 deletionpackages/website/sidebars/sidebar.base.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.