Skip to content

docs: add dedicated TypeOrValueSpecifier docs page #9875

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

Conversation

JoshuaKGoldberg
Copy link
Member

PR Checklist

Overview

Adds a dedicated docs page, cross-linked with the generated TypeDocs and each rule options page.

I mentioned everything in the issue except the recommendation to not use this. I think the individual rule options do a more convincing job of advocating for that.

💖

@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 Aug 23, 2024

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 42bc6da
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/66d1b765d19fba00081d1aa3
😎 Deploy Preview https://deploy-preview-9875--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: 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 Aug 23, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 42bc6da. 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 2 targets

Sent with 💌 from NxCloud.

@@ -204,6 +204,10 @@ h6 {
text-decoration: underline;
}

.markdown a:has(code) {
text-underline-offset: 0.25em;
}
Copy link
Member Author

Choose a reason for hiding this comment

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

This was really bugging me...

Before After
Before screenshot of the links in Rule Options Using This Format, with almost no vertical padding above text underlines After screenshot of the links in Rule Options Using This Format, with several pixels of vertical padding above text underlines

Copy link
Member

Choose a reason for hiding this comment

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

Hmm. I really don't have a preference.

Copy link
Member Author

Choose a reason for hiding this comment

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

Copy link
Contributor

@marekdedic marekdedic left a comment

Choose a reason for hiding this comment

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

Thanks, LGTM!

Josh-Cena
Josh-Cena previously approved these changes Aug 27, 2024
Copy link
Member

@Josh-Cena Josh-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 good

@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 Aug 27, 2024
Copy link

codecov bot commented Aug 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.05%. Comparing base (8b1eb00) to head (42bc6da).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #9875   +/-   ##
=======================================
  Coverage   88.05%   88.05%           
=======================================
  Files         407      407           
  Lines       13947    13947           
  Branches     4071     4071           
=======================================
  Hits        12281    12281           
  Misses       1354     1354           
  Partials      312      312           
Flag Coverage Δ
unittest 88.05% <ø> (ø)

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

Files with missing lines Coverage Δ
packages/type-utils/src/TypeOrValueSpecifier.ts 100.00% <ø> (ø)

@JoshuaKGoldberg JoshuaKGoldberg merged commit e5d1ac4 into typescript-eslint:main Aug 30, 2024
53 of 55 checks passed
@JoshuaKGoldberg JoshuaKGoldberg deleted the docs-type-or-value-specifier branch September 2, 2024 23:45
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 10, 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: Add a dedicated docs page for type-utils > TypeOrValueSpecifier
3 participants