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(website): tables from source rules to Biome rules #1583

Merged
merged 7 commits into from
Jan 18, 2024

Conversation

ematipico
Copy link
Member

Summary

This PR creates a new page containing three tables:

  • a table from from ESLint rules to Biome rules
  • a table from typescript-eslint rules to Biome rules
  • a table from ESLint plugin rules to Biome rules

I called this page "Linter sources", but I admit that the title isn't that great, so I would like some suggestion about naming 😄

Test Plan

Check the end result of the webpage

Copy link

netlify bot commented Jan 17, 2024

Deploy Preview for biomejs ready!

Name Link
🔨 Latest commit a4652e3
🔍 Latest deploy log https://app.netlify.com/sites/biomejs/deploys/65a9576d33bcae000787de8b
😎 Deploy Preview https://deploy-preview-1583--biomejs.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: 100 (no change from production)
Accessibility: 97 (no change from production)
Best Practices: 100 (no change from production)
SEO: 93 (no change from production)
PWA: -
View the detailed breakdown and full score reports

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

@ematipico ematipico requested review from a team January 17, 2024 13:50
@github-actions github-actions bot added A-Linter Area: linter A-Tooling Area: internal tools A-Website Area: website labels Jan 17, 2024
Copy link
Contributor

Parser conformance results on

js/262

Test result main count This PR count Difference
Total 49701 49701 0
Passed 48721 48721 0
Failed 980 980 0
Panics 0 0 0
Coverage 98.03% 98.03% 0.00%

jsx/babel

Test result main count This PR count Difference
Total 40 40 0
Passed 37 37 0
Failed 3 3 0
Panics 0 0 0
Coverage 92.50% 92.50% 0.00%

symbols/microsoft

Test result main count This PR count Difference
Total 6322 6322 0
Passed 2036 2036 0
Failed 4286 4286 0
Panics 0 0 0
Coverage 32.20% 32.20% 0.00%

ts/babel

Test result main count This PR count Difference
Total 662 662 0
Passed 592 592 0
Failed 70 70 0
Panics 0 0 0
Coverage 89.43% 89.43% 0.00%

ts/microsoft

Test result main count This PR count Difference
Total 17646 17646 0
Passed 13452 13452 0
Failed 4192 4192 0
Panics 2 2 0
Coverage 76.23% 76.23% 0.00%

@Conaclos
Copy link
Member

Conaclos commented Jan 17, 2024

I called this page "Linter sources", but I admit that the title isn't that great, so I would like some suggestion about naming

ESlint rules? This makes clear that the page is about ESlint correspondance.

What do you think about creating a section for each source instead of grouping plugins in a same table?

We could also add an asterix for the rules Inspired from and adding a note saying that the rule slightly diverge from the original?

Copy link

codspeed-hq bot commented Jan 17, 2024

CodSpeed Performance Report

Merging #1583 will not alter performance

Comparing feat/rules-resource-page (a4652e3) with main (a46230d)

Summary

✅ 93 untouched benchmarks

@ematipico
Copy link
Member Author

ESlint rules? This makes clear that the page is about ESlint correspondence.

That isn't true, because we have clippy rules too. Check the updated tables

@ematipico
Copy link
Member Author

I updated the table with your suggestions. I am not really sure about the footnotes, they add some bloat.

@Conaclos
Copy link
Member

Conaclos commented Jan 18, 2024

We could rename lint rules to rules (this page is already under the linter navigation title, it is clear from the contexts that this refers to lint rules), and linter sources to rule sources.

I think we could remove rules to Biome from all section titles. The table already gives the info about which rule is from Biome.

Also, we should use a single footnote for inspired rule.

@ematipico
Copy link
Member Author

Also, we should use a single footnote for inspired rule.

It doesn't work, I already tried. We can't have multiple carets (numbers next to the word) that point to the same footnote. It's probably how the footnotes in markdown work.

@ematipico
Copy link
Member Author

Check my latest update

@ematipico ematipico merged commit badc93f into main Jan 18, 2024
18 checks passed
@ematipico ematipico deleted the feat/rules-resource-page branch January 18, 2024 16:54
@Conaclos Conaclos added the A-Changelog Area: changelog label Jan 22, 2024
ematipico added a commit to DaniGuardiola/biome that referenced this pull request Jan 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Changelog Area: changelog A-Linter Area: linter A-Tooling Area: internal tools A-Website Area: website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants