8000 docs(eslint-plugin): [typedef] deprecate the rule by JoshuaKGoldberg · Pull Request #11202 · typescript-eslint/typescript-eslint · GitHub
[go: up one dir, main page]
Skip to content

docs(eslint-plugin): [typedef] deprecate the rule #11202

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(eslint-plugin): [typedef] deprecate the rule #11202

wants to merge 1 commit into from
+16 −11

Conversation

JoshuaKGoldberg
Copy link
Member
@JoshuaKGoldberg JoshuaKGoldberg commented May 12, 2025 •
edited
Loading

PR Checklist

Overview

At long last! We haven't recommended this rule in years. It's mostly been kept around as a legacy support point. But it's been less and less useful over the years.

Primarily a docs change + addition of meta.deprecated to the rule.

Moves the :::caution note to be the first added content in the rule's docs file, and adds a note to it that the rule is deprecated.

Note that this does include a behavioral change: the rule is no longer in the all configs. Per https://typescript-eslint.io/users/configs#all, the contents of all are not considered semver-stable. This is not a breaking change.

💖

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

@netlify Netlify
Copy link
netlify bot commented May 12, 2025 •
edited
Loading

✅ Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 98d3fdd
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/6821fa84197bfb0008b6d4fc
😎 Deploy Preview https://deploy-preview-11202--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: 98 (🔴 down 1 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (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 your Netlify site configuration.

@nx-cloud Nx Cloud
Copy link
nx-cloud bot commented May 12, 2025 •
edited
Loading

View your CI Pipeline Execution ↗ for commit 98d3fdd.

Command Status Duration Result
nx typecheck ast-spec ✅ Succeeded <1s View ↗
nx run-many --target=build --exclude website --... ✅ Succeeded 5s View ↗
nx run-many --target=clean ✅ Succeeded 11s View ↗

☁️ Nx Cloud last updated this comment at 2025-05-14 12:39:57 UTC

@JoshuaKGoldberg JoshuaKGoldberg changed the title docs(eslint-plugin) [typedef] deprecate the rule docs(eslint-plugin): [typedef] deprecate the rule May 12, 2025
@codecov Codecov
Copy link
codecov bot commented May 12, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.92%. Comparing base (f8db925) to head (98d3fdd).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main   #11202   +/-   ##
=======================================
  Coverage   90.92%   90.92%           
=======================================
  Files         499      499           
  Lines       50845    50847    +2     
  Branches     8384     8384           
=======================================
+ Hits        46231    46233    +2     
  Misses       4599     4599           
  Partials       15       15
Flag Coverage Δ
unittest 90.92% <100.00%> (+<0.01%) ⬆️

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

Files with missing lines Coverage Δ
packages/eslint-plugin/src/configs/eslintrc/all.ts 100.00% <ø> (ø)
packages/eslint-plugin/src/configs/flat/all.ts 100.00% <ø> (ø)
packages/eslint-plugin/src/rules/typedef.ts 99.64% <100.00%> (+<0.01%) ⬆️
🚀 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.

@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as ready for review May 12, 2025 14:25
@JoshuaKGoldberg JoshuaKGoldberg added the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label May 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bradzacher bradzacher bradzacher approved these changes

@kirkwaiblinger kirkwaiblinger kirkwaiblinger approved these changes

Assignees
No one assigned
Labels
1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs: Mark typedef as deprecated / feature frozen
3 participants
@JoshuaKGoldberg @bradzacher @kirkwaiblinger
0