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

meta: Fix up peer deps, and keywords in package.json files #32

Merged
merged 3 commits into from
Dec 19, 2023

Conversation

nicholas-codecov
Copy link
Collaborator

Description

Quick updates to the bundler plugins package.json files to add in keywords, as well as peer deps to ensure that we're running with compatible versions of the bundler.

Copy link

@codecov codecov bot left a comment

Choose a reason for hiding this comment

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

The Git diff has changes mainly in the package.json file of three packages: 'rollup-plugin', 'vite-plugin', and 'webpack-plugin'. The changes involve adding keywords and declaring peer dependencies, which are both good practices in managing npm packages. The keywords help in searchability of the packages and peer dependencies ensure that these packages can properly execute and function as expected, given the versions of the dependencies specified. There seems to be no critical or serious issues found during the review.

@@ -4,6 +4,12 @@
"description": "Official Codecov Rollup plugin",
"author": "Codecov",
"license": "MIT",
"keywords": [
Copy link

Choose a reason for hiding this comment

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

Good use of keywords for improving package discoverability.

@@ -50,6 +56,9 @@
"typescript": "^5.3.2",
"unbuild": "^2.0.0"
},
"peerDependencies": {
"rollup": "^3.0 || ^4.0"
Copy link

Choose a reason for hiding this comment

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

The use of semantic versioning (^3.0 || ^4.0) for the 'rollup' peer dependency is good.

@@ -50,6 +56,9 @@
"unbuild": "^2.0.0",
"vite": "5.0.3"
},
Copy link

Choose a reason for hiding this comment

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

Ensure that the dependency 'vite' has backward compatibility with versions 4.0 and 5.0 as specified.

@@ -51,6 +57,9 @@
"typescript": "^5.3.2",
"unbuild": "^2.0.0"
},
Copy link

Choose a reason for hiding this comment

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

Ensure that the peer dependency 'webpack' has backward compatibility with its version 5.0.

Copy link

codecov bot commented Dec 19, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (6a0ba97) 83.52% compared to head (eda1d80) 83.52%.

Additional details and impacted files
Components Coverage Δ
Plugin core 96.33% <ø> (ø)
Rollup plugin 7.35% <ø> (ø)
Vite plugin 7.35% <ø> (ø)
Webpack plugin 33.33% <ø> (ø)

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

@nicholas-codecov nicholas-codecov merged commit 2c1c77a into main Dec 19, 2023
12 checks passed
@nicholas-codecov nicholas-codecov deleted the peer-dep-changes-and-add-keywords branch December 19, 2023 15:35
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.

2 participants