chore: housekeeping, bump all (dev) deps #384
Conversation
🦋 Changeset detectedLatest commit: 6ba38fd The changes in this PR will be included in the next version bump. This PR includes changesets to release 7 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
Warning Rate limit exceeded@JounQin has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 36 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
WalkthroughThis pull request introduces a series of configuration updates across GitHub workflows, dependency files, and project setup scripts. The changes include pinning specific GitHub Action commit hashes, removing an outdated CodeQL workflow, and adjusting commands in publishing steps. Additionally, various package manager and dependency versions have been updated, TypeScript configurations have been shifted to extend Node16 settings, and new configuration files for deployment and testing have been added. New documentation and a React-based application entry point also appear among the modifications. Changes
Sequence Diagram(s)sequenceDiagram
participant B as Browser
participant R as Router
participant RC as Readme Component
participant CC as Changelog Component
B->>R: Navigate to URL
R-->>B: Route matched
alt Route is for README
R->>RC: Lazy-load Readme
RC-->>B: Render README content
else Route is for Changelog
R->>CC: Lazy-load Changelog
CC-->>B: Render Changelog content
else
R-->>B: Redirect to Home
end
Assessment against linked issues
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
Report too large to display inline |
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. |
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
packages/imagemin/package.json (1)
1-46: 💡 Verification agent❓ Verification inconclusive
Consolidate Type Declarations in package.json
It appears the"types": "./lib/index.d.ts"field now exists both at the root level (line 18) and inside the"exports"object (line 21). Since the intent is to declare the TypeScript definitions solely via the exports, please remove the root-level"types"to avoid duplication and potential ambiguity.
Action Required: Remove Duplicate "types" Field in package.json
- In
packages/imagemin/package.json, the"types": "./lib/index.d.ts"field appears both at the root (line 18) and in the"exports"object (line 21).- Please remove the root-level
"types"entry to consolidate the declaration and avoid any potential ambiguity.
🧹 Nitpick comments (6)
packages/es-modules/tsconfig.json (1)
2-8: Review Module Packaging Configuration.
The"extends"property has been updated to"@1stg/tsconfig/node16", standardizing TypeScript settings across packages. However, note that in this file, only"composite"and"outDir"are specified in"compilerOptions", with no"rootDir"defined. Please verify that omitting"rootDir"is intentional for the es-modules package—if a specific source directory should be designated, adding this option may help avoid potential file inclusion issues during builds.index.html (1)
1-23: HTML Structure is Well-Formed.
The document includes all the necessary meta tags (charset, viewport, and even the legacy X-UA-Compatible) along with a clear HTML structure. If Internet Explorer support is no longer required, consider removing theX-UA-Compatiblemeta tag in future clean-ups.docs/App.tsx (2)
13-23: Consider adding error handling for dynamic importsThe lazy loading of README files doesn't include error handling for cases where a file might not exist for a specified package.
const Readme = () => { const { name } = useParams<{ name: string }>() const Readme = lazy(() => name ? import(`../packages/${name}/README.md`) : import('../README.md'), ) return ( - <Suspense> + <Suspense fallback={<div>Loading...</div>}> <Readme /> </Suspense> ) }Consider also adding error boundaries to handle potential import failures:
import { ErrorBoundary } from 'react-error-boundary' // In your component: return ( <ErrorBoundary fallback={<div>Error loading documentation</div>}> <Suspense fallback={<div>Loading...</div>}> <Readme /> </Suspense> </ErrorBoundary> )
25-37: Consider adding error handling for dynamic importsSimilar to the Readme component, the Changelog component should also include error handling.
const Changelog = () => { const { name } = useParams<{ name: string }>() const Changelog = lazy(() => name ? import(`../packages/${name}/CHANGELOG.md`) : import('../CHANGELOG.md'), ) return ( - <Suspense> + <Suspense fallback={<div>Loading...</div>}> <Changelog /> </Suspense> ) }README.md (2)
21-23: Streamline Sponsors Section:
The sponsors section table layout has been refined for simplicity and clarity. Consider verifying the alignment and spacing for optimal visual consistency across various devices.
27-29: Revise Backers Section:
The backers section formatting has been enhanced to clearly distinguish between the different Open Collective groups. The changes aid readability and visual appeal.🧰 Tools
🪛 LanguageTool
[style] ~29-~29: Using many exclamation marks might seem excessive (in this case: 12 exclamation marks for a text that’s 3256 characters long)
Context: ...----------------------------------- | ||
| [
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
.yarn/releases/yarn-4.8.1.cjsis excluded by!**/.yarn/**yarn.lockis excluded by!**/yarn.lock,!**/*.lock
📒 Files selected for processing (42)
.github/workflows/ci.yml(2 hunks).github/workflows/codeql.yml(0 hunks).github/workflows/pkg-pr-new.yml(1 hunks).github/workflows/pkg-size.yml(1 hunks).github/workflows/release.yml(2 hunks).prettierignore(0 hunks).renovaterc(1 hunks).simple-git-hooks.cjs(0 hunks).simple-git-hooks.js(1 hunks).yarnrc.yml(1 hunks)README.md(3 hunks)auto-imports.d.ts(0 hunks)docs/App.tsx(1 hunks)docs/global.css(1 hunks)docs/index.tsx(1 hunks)eslint.config.js(1 hunks)index.html(1 hunks)package.json(1 hunks)packages/browser/package.json(1 hunks)packages/browser/tsconfig.json(1 hunks)packages/core/package.json(1 hunks)packages/core/tsconfig.json(1 hunks)packages/es-modules/README.md(1 hunks)packages/es-modules/package.json(1 hunks)packages/es-modules/test/test.spec.ts(1 hunks)packages/es-modules/tsconfig.json(1 hunks)packages/imagemin/package.json(1 hunks)packages/rollup/package.json(2 hunks)packages/rollup/src/config.ts(5 hunks)packages/rollup/tsconfig.json(1 hunks)packages/umd-globals/README.md(1 hunks)packages/umd-globals/package.json(1 hunks)packages/umd-globals/test/test.spec.ts(1 hunks)packages/umd-globals/tsconfig.json(1 hunks)packages/utils/package.json(1 hunks)packages/utils/tsconfig.json(1 hunks)test/global.d.ts(1 hunks)test/tsconfig.json(1 hunks)tsconfig.base.json(1 hunks)vercel.json(1 hunks)vite.config.ts(1 hunks)vitest.config.ts(1 hunks)
💤 Files with no reviewable changes (4)
- .prettierignore
- .simple-git-hooks.cjs
- .github/workflows/codeql.yml
- auto-imports.d.ts
🧰 Additional context used
🧬 Code Definitions (1)
docs/index.tsx (1)
docs/App.tsx (1)
App(39-64)
🪛 LanguageTool
README.md
[style] ~29-~29: Using many exclamation marks might seem excessive (in this case: 12 exclamation marks for a text that’s 3256 characters long)
Context: ...----------------------------------- | | 
(EN_EXCESSIVE_EXCLAMATION)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Codacy Static Code Analysis
- GitHub Check: Lint and Test with Node.js 22 on windows-latest
🔇 Additional comments (58)
.simple-git-hooks.js (1)
1-1: Re-export of simple-git-hooks Module:
The new file correctly re-exports the default export from@1stg/simple-git-hooks. This approach streamlines access to the module's functionality and aligns with the dependency update goals.
Please ensure that:
- The dependency
@1stg/simple-git-hooksis declared in yourpackage.jsonand properly installed.- All references previously pointing to
.simple-git-hooks.cjshave been updated to use this new file.packages/umd-globals/tsconfig.json (1)
2-2: TypeScript configuration updated to target Node 16The configuration now extends from
@1stg/tsconfig/node16instead of the previous lib-based configuration. This aligns with modern Node.js development practices and likely enables newer ECMAScript features..renovaterc (1)
1-5: Good addition of Renovate configurationAdding a Renovate configuration that extends from a shared organizational config is a good practice for maintaining consistent dependency management across projects.
.yarnrc.yml (1)
10-10: Yarn version updated to 4.8.1The Yarn path has been updated to reference version 4.8.1, which aligns with the PR objective of updating dependencies.
test/tsconfig.json (1)
1-4: Good addition of test-specific TypeScript configurationAdding a dedicated TypeScript configuration for tests is a good practice. This setup correctly extends the base configuration while targeting test files specifically.
eslint.config.js (1)
10-15: Updated ESLint configuration for modern ReactDisabling the
@eslint-react/jsx-uses-reactrule for TSX files is appropriate when using the modern JSX transform from React 17+, which doesn't require explicitly importing React.vite.config.ts (1)
1-16: Configuration looks good for Vite with React and MDX support.The configuration properly sets up Vite with the necessary plugins for MDX (with GitHub Flavored Markdown support) and React-SWC for improved build performance. The server configuration to automatically open the browser is a nice convenience feature.
vercel.json (1)
1-15: Vercel configuration is properly set up for SPA deployment.The configuration correctly defines:
- Version 2 of the Vercel platform
- Custom alias for the application (pkgr.vercel.app)
- Silent GitHub integration to reduce notification noise
- URL rewrite rules to ensure all routes are handled by the single-page application
This is the standard approach for deploying React SPAs to Vercel.
packages/rollup/src/config.ts (5)
48-48: Import of__importStarfrom tslib looks good.This import is necessary for the dynamic import changes throughout the file to properly handle default exports.
84-85: Consistent usage of__importStarfor nodeResolve plugin.The change from direct use of
nodeResolve({...})to__importStar(nodeResolve).default({...})ensures proper handling of the default export, which is important for compatibility with modern module systems.
107-108: Consistent usage of__importStarfor commonjs plugin.The change from direct use of
commonjs({ sourceMap })to__importStar(commonjs).default({ sourceMap })maintains consistency with the approach used for other plugins.
408-408: Consistent usage of__importStarfor alias plugin.This maintains the same pattern used for other plugins in the file.
439-443: Consistent usage of__importStarfor copy, json, and url plugins.All rollup plugins are now consistently using the
__importStar(...).default()pattern, which improves maintainability and ensures proper handling of default exports across different module systems.test/global.d.ts (1)
1-1: Correctly references Vitest global types.This triple-slash directive properly imports the global type definitions from Vitest, allowing TypeScript to recognize test functions like
describe,it, andexpectwithout explicit imports in test files.packages/rollup/tsconfig.json (1)
2-2: Updated Extends Configuration.
The"extends"property now points to"@1stg/tsconfig/node16", which aligns with the broader project update for Node.js v16 settings. This change appears consistent with related packages.packages/browser/tsconfig.json (1)
2-8: Consistent Update with a Note on Directory Structure.
The"extends"property has been updated to"@1stg/tsconfig/node16", ensuring that the TypeScript configuration now inherits Node16-optimized settings. Note that"rootDir"is set to"."in this file—please verify that this is intentional for the browser package's structure compared to other packages which may use"src".packages/core/tsconfig.json (1)
2-8: Standardized Configuration Update.
The"extends"property is now set to"@1stg/tsconfig/node16", and the compiler options (with"composite": true,"outDir": "lib", and"rootDir": "src") are consistent with the project's updated standards. Ensure that any build scripts or dependent tooling are aligned with these new settings.packages/utils/tsconfig.json (1)
2-8: Updated for Node16 Targets.
This configuration correctly applies the updated"extends"property to"@1stg/tsconfig/node16". The compiler options remain clear and consistent with composite builds, and the exclusion of"lib"and"test"directories is appropriate.docs/global.css (2)
1-5: Dark Mode Styling is Correct.
The media query and the nested rules correctly apply a dark background (#0d1117) when a user prefers a dark color scheme.
7-11: Body Styling is Clear and Consistent.
The body element is styled with a maximum width of 1200px, centered via auto margins, and padded appropriately. Ensure that these values align with your overall layout design.docs/index.tsx (1)
1-12: React Entry Point is Well-Implemented.
The entry file efficiently importscreateRootfromreact-dom/clientand theAppcomponent, applies the relevant class (markdown-body) to the target element, and renders the component. The non-null assertion on thequerySelectoris acceptable provided that the HTML always contains an element with the IDapp.packages/utils/package.json (1)
15-15: Type Declarations Consolidated.
Adding the"types": "./lib/index.d.ts"field ensures that the TypeScript definitions are correctly exposed to consumers of the package. Please verify that the specified path actually points to the correct declaration file.packages/es-modules/package.json (1)
12-12: Consistent Type Definition Usage.
The inclusion of the"types": "./lib/index.d.ts"field at the root of the package.json helps consolidate type information. Ensure that this change is consistently aligned with similar updates in other packages.tsconfig.base.json (1)
1-4: Update to Node16 Base Configuration
The extension has been updated from the older configuration to"@1stg/tsconfig/node16", which should now provide settings better aligned with Node 16. Please verify that the removal of the explicit"compilerOptions": { "target": "ES2020" }does not inadvertently change behaviour in downstream packages.packages/umd-globals/test/test.spec.ts (1)
1-8: Refined Import Path for UMD Globals Test
The import statement has been updated from a generic relative path to explicitly reference'../index.js'. This enhances clarity on the source of the exports. Please ensure that this change is in line with the module resolution strategy in other parts of the project.packages/es-modules/test/test.spec.ts (1)
1-1: Clarify Module Import Resolution
The import forMODULE_DEFINITIONS,alias, andentriesis now explicitly pointing to'../index.js'. This aligns with similar updates elsewhere in the codebase and aids in clarity. Confirm that the change does not affect any consumers of these definitions in downstream tests.packages/umd-globals/README.md (1)
44-51: Consistent Link References in Documentation
The link identifiers have been updated to[1stG.me],[JounQin], and[MIT]for improved consistency and readability. This is a positive change that enhances the clarity of the documentation.packages/browser/package.json (1)
15-15: Added top-level types field for better TypeScript compatibilityThis change adds a top-level
"types"field while maintaining the same field in the"exports"object. This is a good practice that ensures compatibility with both newer TypeScript versions (via exports) and older ones (via top-level types).packages/umd-globals/package.json (1)
12-12: Added top-level types field for better TypeScript compatibilityThis change adds a top-level
"types"field while maintaining the same field in the"exports"object. This is a good practice that ensures compatibility with both newer TypeScript versions (via exports) and older ones (via top-level types).packages/es-modules/README.md (1)
62-64: Improved consistency in markdown reference linksThe capitalization in the reference links has been updated to match their actual usage in the text (line 60), making the documentation more consistent.
packages/core/package.json (1)
15-15: Added top-level types field for better TypeScript compatibilityThis change adds a top-level
"types"field while maintaining the same field in the"exports"object. This is a good practice that ensures compatibility with both newer TypeScript versions (via exports) and older ones (via top-level types).docs/App.tsx (1)
1-64: New documentation site component with React RouterThe new App component creates a documentation site using React Router, allowing navigation between README and CHANGELOG files for different packages. The implementation uses modern React patterns like lazy loading and suspense.
.github/workflows/pkg-pr-new.yml (3)
16-17: Update Checkout Action Reference:
The checkout step now specifies the commit hash11bd71901bbe5b1630ceea73d27597364c9af683. This pinning helps ensure consistent, reproducible builds across workflow runs.
18-19: Update Setup Node.js Action:
The setup-node step is updated to reference commit hashcdca7365b2dadb8aad0a33bc7601856ffabcc48e. This change aligns with other workflows and reinforces action version consistency.
27-28: Enhance Publish Command:
The publish step now includes the--compactflag and explicitly names the step. This improves clarity and may reduce console noise..github/workflows/pkg-size.yml (3)
17-17: Pin Checkout Action Version:
The checkout action is now fixed to commit hash11bd71901bbe5b1630ceea73d27597364c9af683, ensuring stable workflow behavior for the package size report.
19-20: Pin Setup Node.js Action:
By updating the setup-node action to commit hashcdca7365b2dadb8aad0a33bc7601856ffabcc48e, the workflow maintains consistency with other CI configurations.
26-26: Pin Package Size Action Version:
Changingpkg-size/actionto the commit hasha637fb0897b6f14f18e776d8c3dbccb34a1ad27bhelps prevent unexpected variations from future updates..github/workflows/ci.yml (3)
28-29: Pin Checkout Repo Action:
The checkout step now uses commit hash11bd71901bbe5b1630ceea73d27597364c9af683, ensuring reliable retrieval of repository files during CI runs.
30-32: Pin Setup Node.js Action:
The setup-node step is updated with commit hashcdca7365b2dadb8aad0a33bc7601856ffabcc48e, aligning versioning across workflows and promoting consistency.
50-51: Update Codecov Action:
The Codecov step now references commit hash0565863a31f2c772f9f0395002a31e3f06189574, ensuring that code coverage reporting uses a fixed and known version.packages/rollup/package.json (3)
22-24: Expand Peer Dependency Range:
The version constraint for@vitejs/plugin-vue-jsxhas been updated to"^3.0.0 || ^4.0.0". This expansion increases compatibility with projects using either version, which is a welcome improvement.
45-46: Upgrade esbuild Version:
Bumping theesbuilddependency from"^0.25.1"to"^0.25.2"addresses minor version updates that may contain bug fixes or performance improvements.
48-48: Upgrade Rollup Version:
Upgradingrollupfrom"^4.36.0"to"^4.39.0"ensures that the package benefits from the latest non-breaking changes and enhancements.README.md (3)
3-3: Enhance GitHub Actions Badge:
The updated GitHub Actions badge now clearly indicates the workflow status for the master branch, making it more descriptive and useful for users.
6-6: Introduce CodeRabbit PR Reviews Badge:
The new CodeRabbit Pull Request Reviews badge adds transparency regarding PR review status, which helps maintain code quality.
39-41: Update License and Attribution Links:
The references for[1stG.me],[JounQin], and[MIT]have been updated for clarity and accuracy. These improvements ensure correct attribution and licensing information.vitest.config.ts (2)
1-5: Good switch to tsconfigPaths pluginThe replacement of the auto-import plugin with tsconfigPaths is a good change. This will ensure that path aliases defined in tsconfig.json work correctly in tests, improving import consistency across the codebase.
7-13: Improved test configuration with better coverage settingsThe changes to the test configuration are well structured:
- Adding
globals: trueensures Vitest's API (describe, it, expect) is available without imports- Explicitly enabling coverage with the right configuration (include patterns and multiple reporter formats)
This aligns with the removal of the
--coverageflag from the test script in package.json..github/workflows/release.yml (4)
12-15: Security enhancement: Explicit workflow permissionsAdding explicit permissions follows the principle of least privilege and is a GitHub Actions security best practice. The specific permissions added are appropriate for a release workflow that needs to create tags, use OIDC tokens, and manage pull requests.
23-23: Security improvement: Pinned action to specific commit hashPinning the checkout action to a specific commit hash rather than using a floating version tag is a security best practice that prevents potential supply chain attacks.
29-29: Security improvement: Pinned action to specific commit hashPinning the setup-node action to a specific commit hash rather than using a floating version tag is a security best practice that prevents potential supply chain attacks.
52-52: Security enhancement: npm package provenanceEnabling npm provenance by setting
NPM_CONFIG_PROVENANCE: trueimproves the security of published packages by verifying their integrity and origin.package.json (5)
14-14: Package manager version updateUpdating Yarn from 4.7.0 to 4.8.1 brings in the latest improvements and bug fixes.
19-22: Script improvements and new documentation capabilitiesThe changes to the scripts section are well-structured:
- Improved quoting in the
cleanscript to prevent shell expansion issues- Added new scripts for documentation generation using Vite
This is a good enhancement that makes documentation development and builds more accessible.
25-25: Simplified prepare scriptRemoving
patch-packagefrom the prepare script suggests that patched dependencies are no longer needed, which is a positive outcome of the dependency updates.
27-27: Test script alignmentRemoving the
--coverageflag from the test script aligns with the vitest.config.ts changes where coverage is now enabled in the configuration.
32-70: Comprehensive dependency updatesThe dependency updates are extensive and well-organized:
- Updated existing dependencies to newer versions
- Added React, MDX, and web-related dependencies for documentation
- Added vite and related plugins for the new documentation system
These updates align perfectly with the PR objective of updating all dependencies while also enhancing the project's documentation capabilities.
0911283 to
1bec8a1
Compare
@pkgr/browser
@pkgr/core
@pkgr/es-modules
@pkgr/imagemin
@pkgr/rollup
@pkgr/utils
@pkgr/umd-globals
commit: |
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (3)
.github/workflows/vercel.yml (1)
17-18: Checkout Action Version Consistency.
The checkout step usesactions/checkout@v4. Note that in other workflows, a specific commit hash (e.g., in.github/workflows/autofix.yml) is used to ensure consistency and reproducibility. Consider aligning this version with the others if that is a project requirement.docs/App.tsx (2)
39-64: Consider normalizing URL paths for consistency.The route path
/CHANGELOG.mdincludes the file extension while other routes don't. For better URL consistency and future-proofing, consider using just/changeloginstead.- <Route - path="/CHANGELOG.md" - element={<Changelog />} - /> + <Route + path="/changelog" + element={<Changelog />} + />Then update the corresponding links in your application that point to this route.
1-64: Add proper TypeScript type annotations for React components.While the component follows React conventions, adding explicit return types would improve type safety and documentation.
-const Readme = () => { +const Readme: React.FC = () => { -const Changelog = () => { +const Changelog: React.FC = () => { -export const App = () => ( +export const App: React.FC = () => (
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
.yarn/releases/yarn-4.8.1.cjsis excluded by!**/.yarn/**yarn.lockis excluded by!**/yarn.lock,!**/*.lock
📒 Files selected for processing (51)
.github/workflows/autofix.yml(1 hunks).github/workflows/ci.yml(2 hunks).github/workflows/codeql.yml(0 hunks).github/workflows/pkg-pr-new.yml(1 hunks).github/workflows/pkg-size.yml(1 hunks).github/workflows/release.yml(2 hunks).github/workflows/vercel.yml(1 hunks).gitignore(1 hunks).prettierignore(0 hunks).renovaterc(1 hunks).simple-git-hooks.cjs(0 hunks).simple-git-hooks.js(1 hunks).yarnrc.yml(1 hunks)README.md(3 hunks)auto-imports.d.ts(0 hunks)docs/App.tsx(1 hunks)docs/global.css(1 hunks)docs/index.tsx(1 hunks)eslint.config.js(1 hunks)index.html(1 hunks)package.json(1 hunks)packages/browser/index.d.cts(1 hunks)packages/browser/package.json(2 hunks)packages/browser/tsconfig.json(1 hunks)packages/core/package.json(2 hunks)packages/core/tsconfig.json(1 hunks)packages/es-modules/README.md(3 hunks)packages/es-modules/index.d.cts(1 hunks)packages/es-modules/package.json(1 hunks)packages/es-modules/test/test.spec.ts(1 hunks)packages/es-modules/tsconfig.json(1 hunks)packages/imagemin/index.d.cts(1 hunks)packages/imagemin/package.json(2 hunks)packages/imagemin/tsconfig.json(1 hunks)packages/rollup/package.json(3 hunks)packages/rollup/src/config.ts(5 hunks)packages/rollup/tsconfig.json(1 hunks)packages/umd-globals/README.md(3 hunks)packages/umd-globals/index.d.cts(1 hunks)packages/umd-globals/package.json(1 hunks)packages/umd-globals/test/test.spec.ts(1 hunks)packages/umd-globals/tsconfig.json(1 hunks)packages/utils/index.d.cts(1 hunks)packages/utils/package.json(2 hunks)packages/utils/tsconfig.json(1 hunks)test/global.d.ts(1 hunks)test/tsconfig.json(1 hunks)tsconfig.base.json(1 hunks)vercel.json(1 hunks)vite.config.ts(1 hunks)vitest.config.ts(1 hunks)
💤 Files with no reviewable changes (4)
- .prettierignore
- .simple-git-hooks.cjs
- .github/workflows/codeql.yml
- auto-imports.d.ts
✅ Files skipped from review due to trivial changes (1)
- test/global.d.ts
🚧 Files skipped from review as they are similar to previous changes (38)
- packages/imagemin/tsconfig.json
- packages/browser/index.d.cts
- .renovaterc
- .simple-git-hooks.js
- packages/imagemin/index.d.cts
- packages/umd-globals/tsconfig.json
- packages/utils/index.d.cts
- packages/es-modules/index.d.cts
- index.html
- packages/rollup/tsconfig.json
- eslint.config.js
- packages/umd-globals/index.d.cts
- .yarnrc.yml
- vite.config.ts
- packages/es-modules/tsconfig.json
- packages/browser/tsconfig.json
- packages/core/tsconfig.json
- docs/index.tsx
- vercel.json
- packages/utils/tsconfig.json
- tsconfig.base.json
- test/tsconfig.json
- packages/core/package.json
- .github/workflows/pkg-pr-new.yml
- packages/umd-globals/test/test.spec.ts
- vitest.config.ts
- docs/global.css
- packages/es-modules/test/test.spec.ts
- .github/workflows/pkg-size.yml
- packages/utils/package.json
- packages/browser/package.json
- packages/umd-globals/package.json
- packages/imagemin/package.json
- .github/workflows/ci.yml
- .github/workflows/release.yml
- packages/rollup/src/config.ts
- packages/rollup/package.json
- package.json
🧰 Additional context used
🪛 LanguageTool
packages/es-modules/README.md
[style] ~68-~68: Using many exclamation marks might seem excessive (in this case: 8 exclamation marks for a text that’s 2703 characters long)
Context: ...----------------------------------- | |
(EN_EXCESSIVE_EXCLAMATION)
packages/umd-globals/README.md
[style] ~54-~54: Using many exclamation marks might seem excessive (in this case: 8 exclamation marks for a text that’s 2643 characters long)
Context: ...----------------------------------- | |
(EN_EXCESSIVE_EXCLAMATION)
README.md
[style] ~29-~29: Using many exclamation marks might seem excessive (in this case: 12 exclamation marks for a text that’s 3256 characters long)
Context: ...----------------------------------- | |
(EN_EXCESSIVE_EXCLAMATION)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Codacy Static Code Analysis
- GitHub Check: Lint and Test with Node.js 22 on windows-latest
🔇 Additional comments (35)
packages/es-modules/package.json (4)
6-6: Repository URL Format Updated.
The repository field has been updated to use thegit+https://protocol, which is a preferred format for some package managers and improves compatibility.
12-12: Addition of Root-Level Types Field.
The new"types": "./index.d.cts"field ensures that TypeScript definition files are properly referenced at the package root, streamlining type resolution for consumers.
15-26: Restructured Exports Object for Enhanced Module Compatibility.
The"exports"field now nests keys for"import","module-sync", and"require", each with dedicated"types"and"default"fields. This restructuring provides a clearer separation of module formats and type definitions, aligning with similar updates across other packages.
29-29: Updated Files Array to Include TypeScript Declarations.
Including"index.d.cts"in the"files"array ensures that the TypeScript declaration files are published along with the module, fostering better integration with TypeScript projects..gitignore (1)
5-5: Ensure Vercel artifacts remain untracked.
The added entry.vercelcorrectly ignores the Vercel deployment-related directory. This aligns with best practices for deployment configurations..github/workflows/vercel.yml (5)
1-2: Workflow Naming: "Vercel Deploy" is Clear.
The workflow is appropriately named to reflect its purpose.
3-8: Trigger Configuration Verification.
The workflow is set to trigger on pushes to themasterbranch and definespull_request_target: null. Please verify that usingpull_request_target: nullmeets your intended security and trigger behavior for this deployment workflow.
9-12: Concurrency Settings are Well Configured.
The use of a concurrency group based on the workflow name and branch reference, with cancellation of in-progress runs, helps prevent overlapping deployments.
19-25: Branch Check for Deployment.
The conditionif: ${{ github.ref == 'refs/heads/master' }}and the subsequent output settings correctly ensure that deployment steps only execute for the master branch. This logic is sound.
26-34: Deploy Step: Secure and Parameterized Inputs.
The deployment step correctly leveragesamondnet/vercel-action@v25and passes the necessary parameters from secrets and prior step outputs. This approach minimizes exposure of sensitive values while ensuring the proper deployment arguments and conditions are applied..github/workflows/autofix.yml (7)
1-2: Workflow Naming Complying with Security Requirements.
Naming the workflowautofix.ciadheres to the security requirement for using the autofix.ci action.
3-9: PR Trigger Configuration is Appropriate.
The workflow is triggered on pull request events (opened, reopened, synchronized), which is ideal for applying automated code fixes.
10-12: Concurrency Management Is Correct.
The concurrency configuration ensures that only one run per workflow+branch is active, preventing conflicts from simultaneous pull request updates.
18-19: Consistent Dependency Management for Checkout.
Usingactions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683guarantees that the checkout step is pinned to a specific commit, ensuring consistent behavior across workflows.
21-26: Setup Node.js LTS with Caching.
The Node.js environment is correctly set up with caching enabled for Yarn, ensuring that dependency installations are efficient and reproducible.
27-32: Efficient Dependency Installation and Code Formatting.
The steps to install dependencies usingyarn --immutableand to run the build and format commands are straightforward and well-ordered. Please ensure that the scriptsbuildandformatare properly defined in your package configuration.
33-37: Pinned Autofix Action Enhances Stability.
The use of theautofix-ci/action@2891949f3779a1cafafae1523058501de3d4e944withfail-fast: falseproperly manages automated code fixes while allowing the workflow to continue even if some autofix steps fail.README.md (5)
3-3: Improved GitHub Actions Badge
The updated GitHub Actions badge now includes a more descriptive label and branch query (master), enhancing clarity regarding the CI status.
6-6: New CodeRabbit PR Reviews Badge
Adding the "CodeRabbit Pull Request Reviews" badge is a valuable enhancement to signify review status right from the README.
21-23: Well-Formatted Sponsors Table
The sponsors section is clearly laid out in a table format. The structure improves readability and maintains consistency with the presentation across the project.
27-29: Neat Backers Table Presentation
The backers section mirrors the sponsors table structure nicely, providing a uniform look and straightforward navigation for readers.🧰 Tools
🪛 LanguageTool
[style] ~29-~29: Using many exclamation marks might seem excessive (in this case: 12 exclamation marks for a text that’s 3256 characters long)
Context: ...----------------------------------- | |(EN_EXCESSIVE_EXCLAMATION)
39-41: Consistent Link Reference Updates
The updates to the link references for[1stG.me],[JounQin], and[MIT]now use standardized casing, which improves clarity and consistency in the documentation.packages/es-modules/README.md (5)
14-15: Enhanced TOC Navigation
The Table of Contents now includes links for the Sponsors and Backers sections. This addition improves navigation and helps users quickly locate these important sections.
56-57: Sponsor Badge Inclusion
The insertion of a sponsors badge immediately before the Sponsors section serves as an appealing visual cue and reinforces sponsor recognition.
58-63: Clear Sponsors Section
The Sponsors section is presented with a well-structured table of sponsor badges and links. The formatting is consistent and user-friendly.
64-69: Consistent Backers Section
The Backers section uses a table layout similar to the Sponsors section, ensuring a consistent presentation and making it easy for users to identify backer information.🧰 Tools
🪛 LanguageTool
[style] ~68-~68: Using many exclamation marks might seem excessive (in this case: 8 exclamation marks for a text that’s 2703 characters long)
Context: ...----------------------------------- | |(EN_EXCESSIVE_EXCLAMATION)
78-80: Standardized Link References
The updates to the link references (for[1stG.me],[JounQin], and[MIT]) maintain consistent casing and formatting across the documentation, enhancing professionalism and clarity.packages/umd-globals/README.md (5)
14-15: TOC Update for Improved Navigation
Including Sponsors and Backers in the Table of Contents significantly enhances navigation within the document, making these sections easier to locate.
42-42: Sponsor Badge Addition
The added sponsors badge above the Sponsors section is a clear visual indicator of sponsorship and aligns well with similar enhancements in other documentation files.
44-49: Sponsors Table Consistency
The sponsors table is well formatted with clear separation between columns, ensuring that sponsor logos and links are displayed uniformly.
50-55: Uniform Backers Table Layout
The Backers section mirrors the sponsors layout, offering consistency in visual presentation and readability across the documentation.🧰 Tools
🪛 LanguageTool
[style] ~54-~54: Using many exclamation marks might seem excessive (in this case: 8 exclamation marks for a text that’s 2643 characters long)
Context: ...----------------------------------- | |(EN_EXCESSIVE_EXCLAMATION)
64-67: Updated Link References for Consistency
The revised link references (for[1stG.me],[JounQin], and[MIT]) ensure consistency in naming and casing, thereby improving the overall quality of the documentation.docs/App.tsx (3)
1-11: Good use of modern React features and import organization.The code imports necessary React hooks and router components in a clean way. The inclusion of GitHub markdown CSS is appropriate for rendering markdown content.
39-64: Good routing structure with appropriate path handling.The routing structure is well-organized with clear path definitions and appropriate component assignments. The wildcard route at the end properly handles unknown paths.
13-37:❓ Verification inconclusive
Verify markdown loading configuration in your bundler.
The dynamic imports of markdown files assume your bundler (webpack, etc.) is configured to handle
.mdfiles. Ensure you have the appropriate loaders configured (likemarkdown-loader) and that they properly convert markdown to React components.
🏁 Script executed:
#!/bin/bash # Check for markdown loaders or plugins in webpack/bundler config grep -r "markdown\|md" --include="*.js" --include="*.ts" --include="*.json" .Length of output: 1498
Double-check Markdown Loader Configuration in Bundler
The dynamic imports in
docs/App.tsxrely on your bundler to transform Markdown files into React components. We noticed that your project uses the@mdx-js/rollupplugin in your Vite configuration. However, please verify that the plugin (or any alternative loader in your bundler setup) is configured to handle both.mdand.mdxfiles. If the configuration only processes.mdxfiles, you may need to update it (e.g., by adding anextensionsoption) to include.mdfiles as well.
- Confirm that your Vite (or webpack) configuration explicitly supports the
.mdextension.- If needed, adjust the MDX loader settings to ensure Markdown files import correctly.
1bec8a1 to
0d3fd91
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #384 +/- ##
===========================================
- Coverage 100.00% 9.97% -90.03%
===========================================
Files 2 12 +10
Lines 39 421 +382
Branches 14 187 +173
===========================================
+ Hits 39 42 +3
- Misses 0 379 +379 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
b70f8fe to
f6b6a9d
Compare
f6b6a9d to
6ba38fd
Compare
close #383
Summary by CodeRabbit
New Features
Documentation
Chores
.gitignoreto include additional files and directories for better project management.