Skip to content

refactor(cms-base-layer)!: make the package a plain Nuxt layer - #2609

Open
Maciek Kucmus (mkucmus) wants to merge 4 commits into
mainfrom
refactor/GH-2163
Open

refactor(cms-base-layer)!: make the package a plain Nuxt layer#2609
Maciek Kucmus (mkucmus) wants to merge 4 commits into
mainfrom
refactor/GH-2163

Conversation

@mkucmus

Copy link
Copy Markdown
Contributor

Description

Makes @shopware/cms-base-layer a plain Nuxt layer. Closes #2163

  • Removed the dead Nuxt module (src/index.ts, build.config.ts, index.cjs, dist). It registered a component folder that moved to app/ long ago, so it could not work.
  • Dropped the build and dev scripts and the unbuild dev dependency. Nothing is left to bundle.
  • Fixed files (listed helpers and app.config.ts that do not exist) and added an exports map.
  • Deleted the stale components.d.ts and two vitest aliases pointing at missing files.
  • types/imports.d.ts now uses the built @shopware/composables types instead of its sources.
  • Updated README and AGENTS.md to match.

Breaking: the exports map blocks deep imports like @shopware/cms-base-layer/app/components/SwProductCard.vue, and index.cjs/dist are no longer published. Consume the package with extends: ["@shopware/cms-base-layer"].

Type of change

Breaking change (fix or feature that would cause existing functionality to not work as expected)

ToDo's

  • Changeset file provided (major bump)
  • Documentation added/updated

Additional context

Verified: layer tests/lint/typecheck, repo-wide typecheck (68 tasks), vue-demo-store vue-tsc and production build, CI build command, and npm pack diff vs main (only index.cjs leaves the tarball).

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Refactors @shopware/cms-base-layer to reflect its real usage as a plain Nuxt layer (rather than a Nuxt module + build output), tightening the published surface via an exports map and removing dead build artifacts/config.

Changes:

  • Removed the unused Nuxt module entry/build artifacts (src/index.ts, build.config.ts, index.cjs, stale types).
  • Adjusted package publishing metadata (files, exports) and dropped unbuild usage for this package.
  • Updated layer-local type shims and documentation to match layer consumption via extends.

Reviewed changes

Copilot reviewed 10 out of 13 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
pnpm-lock.yaml Removes unbuild from the cms-base-layer importer after dropping the build step.
packages/cms-base-layer/vitest.config.ts Removes vitest aliases that pointed to missing files.
packages/cms-base-layer/types/imports.d.ts Updates #imports shim to re-export built composables types.
packages/cms-base-layer/tsconfig.json Simplifies include/exclude for the layer-only TS program.
packages/cms-base-layer/src/index.ts Deletes the dead Nuxt module implementation.
packages/cms-base-layer/README.md Updates docs to reflect layer auto-import usage and blocked deep imports.
packages/cms-base-layer/package.json Converts package metadata to a plain Nuxt layer (exports, files, scripts/deps cleanup).
packages/cms-base-layer/index.cjs Removes the CommonJS proxy (no longer published/needed).
packages/cms-base-layer/components.d.ts Removes stale global component typings at outdated paths.
packages/cms-base-layer/build.config.ts Removes unbuild configuration now that nothing is bundled.
packages/cms-base-layer/AGENTS.md Updates contributor guidance to reflect “no build step” layer reality.
AGENTS.md Documents that Nuxt layers ship sources as-is and have no build step.
.changeset/tidy-carrots-shake.md Adds a major changeset documenting the breaking packaging/import changes.
Files not reviewed (1)
  • pnpm-lock.yaml: Generated file

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread packages/cms-base-layer/package.json
@vercel

vercel Bot commented Aug 5, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
frontends-starter-template-extended Ready Ready Preview Aug 5, 2026 9:27pm
frontends-vue-starter-template Ready Ready Preview Aug 5, 2026 9:27pm

Request Review

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.

Refactor cms-base-layer to be officially a nuxt layer

2 participants