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: mark rules that are frozen on rules index page#11467

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

Conversation

@nayounsang
Copy link
Contributor

@nayounsangnayounsang commentedAug 8, 2025•
edited
Loading

PR Checklist

Overview

  1. markthese rule as frozen
  2. add frozen emoji in rule table on rule index page
frozen emoji
  1. add frozen description on each rule page
frozen block
  1. add frozen explanation on rule index page (Obviously, the frozen property is for contributors, so I'm not sure if the rule index page is the right place. ESLint also has an explanation in its contribution documentation. However, I couldn't find a suitable place in the contribution pages either. I think it could be replaced with the link ofeslint's.)
explain frozen
  1. addfrozen property in meta data of rule.
// packages/utils/src/ts-eslint/Rule.tsexportinterfaceDeprecatedInfo{/**   * The estimated version when the rule is removed (probably the next major   * version). null means the rule is "frozen" (will be available but will not   * be changed).   */availableUntil?:string|null;}

We can determine if something is frozen bydeprecated.availableUntil === null, but I don't like this property, so I add new property:docs.frozen.

  • This interface is necessary foralignment with eslint, butdeprecated andfrozen are different.
  • deprecated can be boolean(truthy) or object(truthy). Additional conditions are needed to distinguish between the two.
  • Type guards (or additional conditions) are required to access object property.
  • availableUntil can be undefined or null. Adding unnecessary comments to bypass the eqeqeq lint rule
  • There are many codes written for these reason, and it is judged that they actually have a negative impact on maintenance.

TODO

  • Check if other rules in eslint are frozen. <- can't find it anymore

@typescript-eslint
Copy link
Contributor

Thanks for the PR,@nayounsang!

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 commentedAug 8, 2025•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

NameLink
🔨 Latest commit526b6a3
🔍 Latest deploy loghttps://app.netlify.com/projects/typescript-eslint/deploys/68bac2395af13a0007c3b419
😎 Deploy Previewhttps://deploy-preview-11467--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: 97 (no change from production)
Accessibility: 97 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (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 project configuration.

@nayounsangnayounsang marked this pull request as draftAugust 8, 2025 08:28
@nx-cloud
Copy link

nx-cloudbot commentedAug 8, 2025•
edited
Loading

View yourCI Pipeline Execution ↗ for commit526b6a3

CommandStatusDurationResult
nx test eslint-plugin --coverage=false✅ Succeeded5m 6sView ↗
nx run-many -t lint✅ Succeeded3m 13sView ↗
nx run-many -t typecheck✅ Succeeded2m 7sView ↗
nx test eslint-plugin-internal --coverage=false✅ Succeeded10sView ↗
nx run types:build✅ Succeeded5sView ↗
nx run integration-tests:test✅ Succeeded3sView ↗
nx test typescript-estree --coverage=false✅ Succeeded2sView ↗
nx run generate-configs✅ Succeeded8sView ↗
Additional runs (27)✅ Succeeded...View ↗

☁️Nx Cloud last updated this comment at2025-09-05 11:11:50 UTC

@codecov
Copy link

codecovbot commentedAug 8, 2025•
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.91%. Comparing base (7319bad) to head (526b6a3).
⚠️ Report is 67 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@##             main   #11467      +/-   ##==========================================+ Coverage   90.88%   90.91%   +0.03%==========================================  Files         505      505                Lines       51125    51160      +35       Branches     8415     8426      +11     ==========================================+ Hits        46463    46513      +50+ Misses       4648     4634      -14+ Partials       14       13       -1
FlagCoverage Δ
unittest90.91% <100.00%> (+0.03%)⬆️

Flags with carried forward coverage won't be shown.Click here to find out more.

Files with missing linesCoverage Δ
...ages/eslint-plugin/src/rules/default-param-last.ts96.82% <100.00%> (+0.05%)⬆️
packages/eslint-plugin/src/rules/dot-notation.ts99.20% <100.00%> (-0.03%)⬇️
...kages/eslint-plugin/src/rules/init-declarations.ts100.00% <100.00%> (ø)
...ackages/eslint-plugin/src/rules/member-ordering.ts99.20% <100.00%> (+<0.01%)⬆️
...kages/eslint-plugin/src/rules/naming-convention.ts97.79% <100.00%> (-0.01%)⬇️
...ckages/eslint-plugin/src/rules/no-magic-numbers.ts98.37% <100.00%> (+<0.01%)⬆️
...es/eslint-plugin/src/rules/prefer-destructuring.ts100.00% <100.00%> (ø)

... and18 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@nayounsangnayounsang marked this pull request as ready for reviewAugust 8, 2025 16:24

##Frozen Rules

When rules are feature complete, they are marked as frozen (indicated with ❄️ in the documentation). This applies to standalone rules that are complete, as well as[extension rules](#extension-rules) whose underlying core ESLint rules are frozen. After that point, we expect users to use[disable comments](https://eslint.org/docs/latest/use/configure/rules#using-configuration-comments-1) when they find an edge case that isn’t covered.
Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

This is slightly different from theESLint's.
I don't quite understand the 80% policy, so I added a line that says the dependent ESLint rule is frozen.
However, my English isn't very good, so I'm not sure if the meaning is natural.

Choose a reason for hiding this comment

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

Agreed, 80% isn't quite the same as our policy. This is perfect 🙂 I wouldn't have picked up on any problems with your English.

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.

Looks great, thanks! There's just one visual bug to fix; nothing else blocking. ✨

}

.ruleNameWrapper {
display: flex;

Choose a reason for hiding this comment

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

[Bug] Putting this new div into block flow is causing extra padding

BeforeAfter
Before screenshot of a few rules table rows showing no vertical space between rule name and descriptionAfter screenshot of a few rules table rows showing about 1rem of vertical space between rule name and description

The flex is good, but it should be inline:

Suggested change
display: flex;
display:inline-flex;

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

imageGreat. I committed.

url?:string;

/**
* Mark this rule as frozen.

Choose a reason for hiding this comment

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

[Docs] Nit: just to make this comment a bit more informative.

Suggested change
*Markthisruleasfrozen.
*Markthisruleasfeature-frozen.

Copy link
ContributorAuthor

Choose a reason for hiding this comment

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

I committed.

@JoshuaKGoldbergJoshuaKGoldberg added the awaiting responseIssues waiting for a reply from the OP or another party labelSep 3, 2025
@github-actionsgithub-actionsbot removed the awaiting responseIssues waiting for a reply from the OP or another party labelSep 5, 2025
JoshuaKGoldberg
JoshuaKGoldberg previously approved these changesSep 5, 2025
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.

Lovely, thanks! 🙌

@JoshuaKGoldbergJoshuaKGoldberg merged commit8154204 intotypescript-eslint:mainSep 8, 2025
61 of 62 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@JoshuaKGoldbergJoshuaKGoldbergJoshuaKGoldberg left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Docs: mark rules that are frozen on rules index page

2 participants

@nayounsang@JoshuaKGoldberg
[8]ページ先頭
©2009-2025 Movatter.jp