[v3] Move runtime to "dependencies", organize package.json files#4133
Conversation
WalkthroughThis update modifies package configuration files across multiple frontend templates. The Changes
Suggested reviewers
Poem
Tip ⚡💬 Agentic Chat (Pro Plan, General Availability)
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
🪧 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
Documentation and Community
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
v3/internal/templates/react/frontend/package.json (1)
1-11: File Structure and Module Type Declaration.
The overall file structure looks clean, with the"type": "module"declaration correctly set and scripts organized neatly.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
v3/internal/templates/sveltekit-ts/frontend/package-lock.jsonis excluded by!**/package-lock.jsonv3/internal/templates/sveltekit/frontend/package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (20)
v3/internal/templates/lit-ts/frontend/package.json(1 hunks)v3/internal/templates/lit/frontend/package.json(1 hunks)v3/internal/templates/preact-ts/frontend/package.json(1 hunks)v3/internal/templates/preact/frontend/package.json(1 hunks)v3/internal/templates/qwik-ts/frontend/package.json(1 hunks)v3/internal/templates/qwik/frontend/package.json(1 hunks)v3/internal/templates/react-swc-ts/frontend/package.json(2 hunks)v3/internal/templates/react-swc/frontend/package.json(1 hunks)v3/internal/templates/react-ts/frontend/package.json(2 hunks)v3/internal/templates/react/frontend/package.json(1 hunks)v3/internal/templates/solid-ts/frontend/package.json(1 hunks)v3/internal/templates/solid/frontend/package.json(1 hunks)v3/internal/templates/svelte-ts/frontend/package.json(1 hunks)v3/internal/templates/svelte/frontend/package.json(1 hunks)v3/internal/templates/sveltekit-ts/frontend/package.json(2 hunks)v3/internal/templates/sveltekit/frontend/package.json(2 hunks)v3/internal/templates/vanilla-ts/frontend/package.json(1 hunks)v3/internal/templates/vanilla/frontend/package.json(1 hunks)v3/internal/templates/vue-ts/frontend/package.json(1 hunks)v3/internal/templates/vue/frontend/package.json(1 hunks)
🔇 Additional comments (35)
v3/internal/templates/react/frontend/package.json (2)
12-16: Runtime Dependency Placement.
The addition of"@wailsio/runtime": "latest"in thedependenciesblock confirms the runtime requirement, in line with the PR objectives. This change ensures that the package is available during production rather than solely during development.
17-22: DevDependencies Section Verification.
ThedevDependenciessection now only contains build and tooling packages. It no longer includes@wailsio/runtime, which is correctly positioned in the runtime dependencies.v3/internal/templates/qwik-ts/frontend/package.json (3)
1-11: Consistent Package Structure and Script Configuration.
The file retains a tidy structure with scripts defined appropriately. The"type": "module"attribute and version field remain consistent with project conventions.
12-15: Runtime Dependency Placement Confirmed.
Thedependenciessection now includes both"@builder.io/qwik"and"@wailsio/runtime": "latest", aligning with the new runtime classification for the latter.
16-19: DevDependencies Reordering.
ThedevDependenciesblock now follows thedependenciessection, ensuring a clearer separation between production and development packages.v3/internal/templates/vue-ts/frontend/package.json (3)
1-11: Module Configuration and Script Integrity.
The basic configuration—module type, scripts, and version—is maintained correctly. The file reads well and is consistent with the overall template style.
12-15: Runtime Dependency Reclassification.
Adding"@wailsio/runtime": "latest"into thedependenciessection is appropriate. This change correctly reflects its use as a runtime requirement rather than as a development-only dependency.
16-23: Overall Configuration Consistency.
ThedevDependenciessection lists only development tools (e.g.,@vitejs/plugin-vue,typescript,vite, andvue-tsc), which is now distinct from runtime dependencies.v3/internal/templates/qwik/frontend/package.json (3)
1-11: Clean File Layout and Script Definitions.
The file remains well-organized, with a clear"type": "module"declaration and sensible script commands, ensuring consistency across templates.
12-15: Runtime Dependency Update.
The dependency"@wailsio/runtime": "latest"is correctly placed underdependenciesalongside"@builder.io/qwik", promoting uniformity with similar template files updated in this PR.
16-19: DevDependencies Section Order Confirmed.
Moving thedevDependenciesblock to follow thedependenciessection clarifies the separation between production and build tooling packages.v3/internal/templates/react-swc/frontend/package.json (3)
1-11: Validation of Script and Module Configuration.
The file’s module declaration and scripts are maintained as expected. The clear segregation of sections supports the overall organization improvements outlined in the PR.
12-16: Runtime Dependency Reclassification.
The movement of"@wailsio/runtime": "latest"into thedependenciessection ensures that runtime requirements are addressed properly. This change aligns with the project's updated dependency management strategy.
17-22: Correct Grouping of Development Dependencies.
ThedevDependenciescorrectly include only development-related packages (e.g., type definitions and build plugins), with no lingering runtime packages.v3/internal/templates/svelte/frontend/package.json (1)
12-14: Correctly Relocated Dependency for Svelte Template
The move of@wailsio/runtimeinto the"dependencies"section (lines 12-14) is correctly implemented. This ensures the package is present in production environments, and the ordering of keys (with dependencies before devDependencies) remains consistent.v3/internal/templates/react-ts/frontend/package.json (1)
12-16: Proper Dependency Update in React-TS Template
The shift of@wailsio/runtimeto the"dependencies"section (notably at line 13) aligns with the PR objectives. The change is accurate, and the rest of the dependency structure remains well-organized.v3/internal/templates/svelte-ts/frontend/package.json (1)
13-15: Accurate Dependency Reclassification for Svelte-TS Template
Adding@wailsio/runtimewith version"latest"in the"dependencies"section (lines 13-15) is correctly executed. This update maintains consistency with other templates and confirms that the runtime package is classified appropriately.v3/internal/templates/solid/frontend/package.json (1)
12-15: Consistent Update in Solid Template
The solid template now correctly includes@wailsio/runtimein the"dependencies"section (line 13) with the version"latest", while ensuring it is removed from"devDependencies". This update is consistent with the overall changes across templates.v3/internal/templates/lit-ts/frontend/package.json (1)
12-20: Accurate Dependency Adjustment for Lit-TS Template
In this file, the addition of@wailsio/runtimein the"dependencies"section (line 13) and its removal from"devDependencies"are implemented correctly. The overall structure remains organized, aligning with the PR’s objective to clearly distinguish runtime dependencies.v3/internal/templates/vanilla/frontend/package.json (1)
12-14: Reclassify@wailsio/runtimeas a Production Dependency.
The addition of"@wailsio/runtime": "latest"under the"dependencies"section (and its removal fromdevDependencies) correctly reflects its runtime usage per the PR objectives. This change will ensure that the package is bundled in production environments.v3/internal/templates/preact-ts/frontend/package.json (1)
13-13: Properly Moved@wailsio/runtimeto Dependencies.
The inclusion of"@wailsio/runtime": "latest"in the"dependencies"section (with its prior removal fromdevDependencies) is consistent with the intended runtime requirements outlined in the PR.v3/internal/templates/solid-ts/frontend/package.json (1)
12-15: Consistent Dependency Reclassification.
Adding"@wailsio/runtime": "latest"into the"dependencies"section ensures that the runtime package is available in production builds. This aligns well with the overall PR intent across multiple templates.v3/internal/templates/react-swc-ts/frontend/package.json (2)
13-16: Runtime Dependency Reclassification.
Moving"@wailsio/runtime": "latest"to the"dependencies"section appropriately categorizes it as a production dependency, addressing the primary objective of the PR.
22-22: Vite Version Update Confirmation.
The update of the"vite"version indevDependenciesto"^5.0.8"is consistent with changes in other templates and helps maintain uniform tooling across projects.v3/internal/templates/lit/frontend/package.json (1)
12-15: Correct Dependency Adjustment for Runtime.
The addition of"@wailsio/runtime": "latest"to the"dependencies"section confirms its necessity at runtime rather than solely during development, in line with the PR objectives.v3/internal/templates/vue/frontend/package.json (2)
12-15: Correct Runtime Dependency Placement in Vue Template.
The addition of"@wailsio/runtime": "latest"to the"dependencies"section correctly reclassifies it as a runtime dependency rather than a build-only tool. This aligns with the PR objectives.
5-11: Good ES Module Declaration & Script Organization.
The inclusion of"type": "module"and the clear separation of scripts help maintain consistency across templates.v3/internal/templates/preact/frontend/package.json (1)
12-15: Accurate Reclassification for Preact Template.
Moving@wailsio/runtimeinto the"dependencies"section with version"latest"correctly reflects its runtime usage. The rest of the file remains well organized, with scripts and module type clearly defined.v3/internal/templates/sveltekit/frontend/package.json (3)
5-6: ES Module Declaration in SvelteKit Template.
The addition of"type": "module"(line 5) ensures proper module handling and aligns with the overall project conventions.
14-16: Runtime Dependency Version Notice.
The dependency"@wailsio/runtime": "^3.0.0-alpha.28"is added here; however, note that unlike the Vue and Preact templates using"latest", this template specifies an alpha version. Please confirm that the alpha release is intentional for SvelteKit compatibility.
17-23: DevDependencies Organization and Adapter Update.
Moving@sveltejs/adapter-staticinto the"devDependencies"provides a cleaner separation between runtime and build tools. Double-check that this change fits the intended SvelteKit configuration.v3/internal/templates/vanilla-ts/frontend/package.json (1)
12-14: Proper Runtime Dependency Update for Vanilla-TS.
The introduction of the"dependencies"section with"@wailsio/runtime": "latest"appropriately reclassifies the runtime requirement. The rest of the configuration, including"type": "module"and scripts, is consistent and well organized.v3/internal/templates/sveltekit-ts/frontend/package.json (3)
5-6: Consistent ES Module Usage in SvelteKit-TS Template.
Adding"type": "module"ensures that the project leverages ECMAScript modules correctly—this is in line with the modifications seen in other templates.
14-16: Runtime Dependency Version Alert.
The dependency here is set to"@wailsio/runtime": "^3.0.0-alpha.28". As with the SvelteKit (JS) template, please verify if using an alpha version is deliberate or if the overall project should standardize on"latest"for consistency.
17-25: Well-Organized DevDependencies.
The separation of development dependencies (including the adapter moved to devDependencies) is clear and adheres to the intended project organization.
|
Thanks 🙏 Please could you add an entry to the changelog located at |
Head branch was pushed to by a user without write access
|
[v3] Move runtime to "dependencies", organize package.json files
Description
This moves the
@wailsio/runtimepackage to"dependencies"since it is referenced in the code itself, not just build tooling.It also re-arranges things just slightly for consistency (dependencies before devDependencies, etc), removes the
package-lock.jsonfiles from a few templates, and updates version references for the runtime to all be "latest".Fixes #N/A
Type of change
Please select the option that is relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration using
wails doctor.If you checked Linux, please specify the distro and version.
Test Configuration
Please paste the output of
wails doctor. If you are unable to run this command, please describe your environment in as much detail as possible.Checklist:
website/src/pages/changelog.mdxwith details of this PRSummary by CodeRabbit