Skip to content
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

docs: add homepage #8742

Merged
merged 4 commits into from
Apr 1, 2024
Merged

Conversation

moskalakamil
Copy link
Contributor

@moskalakamil moskalakamil commented Mar 21, 2024

Overview

Added homepage to package.json.

After the merge, the homepage on npmjs.org will be replaced with the official documentation.

screen_of_npmjs.org

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @moskalakamil!

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 Mar 21, 2024

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 07487fd
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/660ad55471161c00088df9c5
😎 Deploy Preview https://deploy-preview-8742--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
Accessibility: 100
Best Practices: 92
SEO: 98
PWA: 80
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

Josh-Cena
Josh-Cena previously approved these changes Mar 24, 2024
@JoshuaKGoldberg JoshuaKGoldberg changed the title feat: add homepage docs: add homepage Mar 25, 2024
Copy link
Member

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

I ... don't think that this will change the actual package.jsons that get published with packages? @typescript-eslint/eslint-plugin, for example, comes from packages/eslint-plugin/package.json. I believe you'll need to make this change in all those nested package.jsons instead.

Someone please yell at me if there's actually Nx magic under the hood I don't know of.

package.json Outdated Show resolved Hide resolved
@JoshuaKGoldberg JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Mar 25, 2024
@moskalakamil
Copy link
Contributor Author

@JoshuaKGoldberg done

@github-actions github-actions bot removed the awaiting response Issues waiting for a reply from the OP or another party label Mar 25, 2024
Copy link
Member

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

LGTM, thanks!

I don't have a personal preference of which ones should point to the root website vs. a /packages/*. If anybody else does then I suppose they can request changes. 😄

@JoshuaKGoldberg JoshuaKGoldberg added the 1 approval One team member has approved this PR; a second should be enough to merge it label Mar 25, 2024
Copy link

codecov bot commented Apr 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.01%. Comparing base (8051c3f) to head (6918fe7).
Report is 2 commits behind head on main.

❗ Current head 6918fe7 differs from pull request most recent head 07487fd. Consider uploading reports for the commit 07487fd to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #8742      +/-   ##
==========================================
- Coverage   88.01%   88.01%   -0.01%     
==========================================
  Files         405      405              
  Lines       14076    14074       -2     
  Branches     4121     4120       -1     
==========================================
- Hits        12389    12387       -2     
  Misses       1382     1382              
  Partials      305      305              
Flag Coverage Δ
unittest 88.01% <ø> (-0.01%) ⬇️

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

see 1 file with indirect coverage changes

@JoshuaKGoldberg JoshuaKGoldberg merged commit ecb6b55 into typescript-eslint:main Apr 1, 2024
55 of 57 checks passed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 10, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
1 approval One team member has approved this PR; a second should be enough to merge it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants