Skip to content

docs: add minimal docs page for type-utils package #9294

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

Conversation

JoshuaKGoldberg
Copy link
Member

PR Checklist

Overview

Adds a quick page for @typescript-eslint/type-utils.

Also fixes up some @example code in builtinSymbolLikes, as discovered by #9293.

Doesn't add more info such as the specific functions exported by it. I'm exploring that as a deeper followup separately.

💖

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

Copy link

netlify bot commented Jun 6, 2024

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 83cfb48
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/667094d85eec5f00084ed3f0
😎 Deploy Preview https://deploy-preview-9294--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: 99 (🟢 up 1 from production)
Accessibility: 100 (no change from production)
Best Practices: 92 (no change from production)
SEO: 90 (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.

Copy link

nx-cloud bot commented Jun 6, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 83cfb48. 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 1 target

Sent with 💌 from NxCloud.

@JoshuaKGoldberg JoshuaKGoldberg requested a review from a team June 6, 2024 15:25
@rubiesonthesky
Copy link
Contributor

rubiesonthesky commented Jun 6, 2024

As a casual reader, I wonder what is the difference between this and ts-api-utils. The answer is probably that this package is meant to be used in another lint plugins.

I saw that readme has this text, perhaps it could be added here too?

Type utilities for working with TypeScript within ESLint rules.

The part about eslint rules is currently missing :)

@JoshuaKGoldberg
Copy link
Member Author

Those are great points, thanks @rubiesonthesky! Added. 🚀

kirkwaiblinger
kirkwaiblinger previously approved these changes Jun 17, 2024
Co-authored-by: Kirk Waiblinger <kirk.waiblinger@gmail.com>
@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 Jun 17, 2024
@JoshuaKGoldberg
Copy link
Member Author

(1 approval in the sense that this is ready to go whenever anybody feels like merging it)

@kirkwaiblinger kirkwaiblinger merged commit 8f08ee5 into typescript-eslint:main Jun 17, 2024
60 of 61 checks passed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 25, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
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
Development

Successfully merging this pull request may close these issues.

Docs: Document @typescript-eslint/type-utils
3 participants