Skip to content

feat(require-types): add new rule #958

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

Merged
merged 2 commits into from
Mar 17, 2025
Merged

feat(require-types): add new rule #958

merged 2 commits into from
Mar 17, 2025

Conversation

michaelfaith
Copy link
Collaborator

PR Checklist

Overview

This change adds a new require-types rule.

Closes #816

This change adds a new `require-types` rule.
@michaelfaith michaelfaith marked this pull request as ready for review March 15, 2025 20:53
Copy link

codecov bot commented Mar 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.50%. Comparing base (4208603) to head (42ed2ee).
Report is 11 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #958      +/-   ##
==========================================
+ Coverage   98.77%   99.50%   +0.73%     
==========================================
  Files          21       20       -1     
  Lines        1222     1223       +1     
  Branches      142      142              
==========================================
+ Hits         1207     1217      +10     
+ Misses         15        6       -9     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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

Copy link
Owner

@JoshuaKGoldberg JoshuaKGoldberg 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! Just one suggestion on docs, WDYT?

🚀

Copy link
Owner

Choose a reason for hiding this comment

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

[Non-Actionable] From https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html:

Note that the "typings" field is synonymous with types, and could be used as well.

Confirmed that "types" is the primary one. I don't adding opt-in support for "typings" is required for the base rule. If someone really wants that they can file an issue explaining why. 👍

This change adds a new `require-types` rule.
@michaelfaith michaelfaith merged commit 63305af into main Mar 17, 2025
11 checks passed
@michaelfaith michaelfaith deleted the feat/require-types branch March 17, 2025 21:54
Copy link

🎉 This is included in version v0.29.0 🎉

The release is available on:

Cheers! 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🚀 Feature: Bring in a require-types rule
2 participants