Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

docs: better rules table (filter rules by extension, etc.)#7666

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
JoshuaKGoldberg merged 21 commits intotypescript-eslint:mainfromZamiell:docs-rule-formatting
Oct 18, 2023
Merged

docs: better rules table (filter rules by extension, etc.)#7666

JoshuaKGoldberg merged 21 commits intotypescript-eslint:mainfromZamiell:docs-rule-formatting
Oct 18, 2023

Conversation

@Zamiell
Copy link
Contributor

@ZamiellZamiell commentedSep 17, 2023
edited
Loading

PR Checklist

Overview

  • This PR changes the docs in the way that Brad discusses in the linked issue.
  • I got rid of all of the existing sidebar categories, since they do not make sense in the context of having a sortable table.
  • I also created a "constants.ts" file to remove some existing DRY violations that I found in the repository.

@typescript-eslint
Copy link
Contributor

Thanks for the PR,@Zamiell!

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 onhttps://opencollective.com/typescript-eslint.

@netlify
Copy link

netlifybot commentedSep 17, 2023
edited
Loading

Deploy Preview fortypescript-eslint ready!

NameLink
🔨 Latest commit49ec745
🔍 Latest deploy loghttps://app.netlify.com/sites/typescript-eslint/deploys/652fe5c840e8a000086cd26c
😎 Deploy Previewhttps://deploy-preview-7666--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: 89 (🔴 down 6 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 yourNetlify site configuration.

@nx-cloud
Copy link

nx-cloudbot commentedSep 17, 2023
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit49ec745. 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 💌 fromNxCloud.

@ZamiellZamiell marked this pull request as ready for reviewSeptember 17, 2023 17:44
Copy link
Member

@JoshuaKGoldbergJoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

Some initial comments, what do you think?

Josh-Cena
Josh-Cena previously approved these changesOct 13, 2023
Copy link
Member

@Josh-CenaJosh-Cena 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 to me, but will wait on@JoshuaKGoldberg

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
@ZamiellZamiell changed the titledocs: better rules table (sort rules by extension, etc.)docs: better rules table (filter rules by extension, etc.)Oct 13, 2023
Josh-Cena
Josh-Cena previously approved these changesOct 13, 2023
Copy link
Member

@JoshuaKGoldbergJoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

Looking great! I'm mostly happy - just suggesting some streamlining to the docs. WDYT? ✨

@JoshuaKGoldbergJoshuaKGoldberg added the awaiting responseIssues waiting for a reply from the OP or another party labelOct 15, 2023
Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>
@Zamiell
Copy link
ContributorAuthor

Looking great! I'm mostly happy - just suggesting some streamlining to the docs. WDYT?

All the feedback should be committed now.

@JoshuaKGoldbergJoshuaKGoldberg removed the awaiting responseIssues waiting for a reply from the OP or another party labelOct 18, 2023
JoshuaKGoldberg
JoshuaKGoldberg previously approved these changesOct 18, 2023
Copy link
Member

@JoshuaKGoldbergJoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

🚀 thanks, this is looking great!


###Config Group (⚙️)

##Extension Rules

Choose a reason for hiding this comment

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

I just realizedhttps://typescript-eslint.io/rules/#extension-rules is probably the only canonical link to an explanation of extension rules out there. So we probably don't want to get rid of the heading. But I've pestered you so much on this PR 😅 I'll just add it in, and if you@Josh-Cena /@Zamiell disagree we can always revert before the release on Monday.

Copy link
ContributorAuthor

@ZamiellZamiellOct 18, 2023
edited
Loading

Choose a reason for hiding this comment

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

do we really need a separate heading though? it is fairly self-explanatory what an extension rule is.
like, for example, considerclass-methods-use-this.
if you go to the page for it, it says:

This rule extends the baseeslint/class-methods-use-this rule. It adds support for ignoring override methods or methods on classes that implement an interface.

After reading this, i am not left wondering, "I have more questions about what an extension rule is, I wonder if there is a more formal definition out there in a dedicated section?"

Choose a reason for hiding this comment

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

I think folks need somewhere to hard-link to. It's similar to ESLint's issue for fixers vs suggestions: even if they're fairly straightforward for many, some folks coming in fresh have a hard time with them. I personally had a hard time both with fixers-vs-suggestionsand what extension rules are.

Choose a reason for hiding this comment

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

Ooh and - pretty soon I think we'll be able to trim down the metadata list down to one sentence per item!

...which just leaves the deeper explanation on extension rules.

@JoshuaKGoldbergJoshuaKGoldberg merged commitee4fe89 intotypescript-eslint:mainOct 18, 2023
@JoshuaKGoldberg
Copy link
Member

Whew, what a PR! Thanks again@Zamiell for iterating it on it with us. Shoutout@rubiesonthesky too!

@Josh-Cena I really liked your feedback and hope I didn't clobber over it in my eagerness to get the PR merged. :3

@ZamiellZamiell deleted the docs-rule-formatting branchOctober 18, 2023 14:42
@Zamiell
Copy link
ContributorAuthor

do we have a plan for mouseover-functionality-indication?

@JoshuaKGoldberg
Copy link
Member

JoshuaKGoldberg commentedOct 18, 2023
edited
Loading

I personally have none. If you want to file & tackle that as a followup issue it could be nice. I'm also wondering if we'd want to rely on a more rich table library that has sorting, filtering, etc. built-in.

Sign up for freeto subscribe to this conversation on GitHub. Already have an account?Sign in.

Reviewers

@JoshuaKGoldbergJoshuaKGoldbergJoshuaKGoldberg left review comments

@Josh-CenaJosh-CenaJosh-Cena left review comments

+1 more reviewer

@rubiesontheskyrubiesontheskyrubiesonthesky left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Docs: Formatting / Deprecated Rules are not clearly delineated in the rule list

4 participants

@Zamiell@JoshuaKGoldberg@rubiesonthesky@Josh-Cena

[8]ページ先頭

©2009-2025 Movatter.jp