Use the published package name @cap2ui5/cds-plugin, and document @cap2ui5/samples - #30
Conversation
…samples cap2UI5 0.3.0 is published as @cap2ui5/cds-plugin, and the unscoped package cap2ui5 was withdrawn from npm. Every install command, import and dependency line on the site named the withdrawn package, so a reader following the quickstart could no longer install anything. They now name @cap2ui5/cds-plugin; what kept its name (cds.requires.cap2ui5, cds add cap2ui5, npx cap2ui5 abap2js, cap2ui5.Drafts, the cap2ui5 logger) is left as it is, and so are the historical records (ROADMAP.md, the 0.1.0 warning on the views page). 0.3.0 also serves apps a dependency brings, and @cap2ui5/samples is the first such package. The quickstart gains a short section on adding the samples, project-structure explains apps from a package, the ecosystem page lists the new repository and package, and the quickstart tells a project that has the old package how to swap it. verify-refs checked imports, requires and dependency ranges against the name "cap2ui5". It now checks them against @cap2ui5/cds-plugin, and reports the old name the way it reports the port's dead abap2UI5 package, so a stale import cannot pass silently. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NwpbkojNzGmuJrFdbwo5JF
|
Cause: cap2UI5 0.2.0 moved the configuration from No fix exists yet. The fix is the 0.2.0 docs follow-up described in the PR body: point the verifier at Generated by Claude Code |
cap2UI5 0.3.0 (2026-09-29) is published as
@cap2ui5/cds-plugin, and the unscopedcap2ui5was withdrawn from npm. Every install command and import on the site named the withdrawn package. Sources used: cap2UI5/cap2UI5plugin/README.mdandplugin/CHANGELOG.md(0.3.0), and cap2UI5/samplesREADME.md.What changed
Package name →
@cap2ui5/cds-pluginnpm add @cap2ui5/cds-pluginin the quickstart, the home page, what-is, the README and the configuration pageimport … from/require(…)in examples and prose: app-interface, all five examples, getting-started, lifecycle, migration, project-structure, troubleshooting, user-exit, what-is, configuration"@cap2ui5/cds-plugin": "^0.3.0"; project-structure's tree,npm update, andnode_modules/@cap2ui5/cds-plugin/index.cdson the persistence pagecds.requires.cap2ui5/cds.cap2ui5,cds add cap2ui5,npx cap2ui5 abap2js,cap2ui5.Drafts, the[cap2ui5]log lines, ROADMAP.md, and the views page's warning about the 0.1.0 releaseNew content (kept short)
npm rm cap2ui5 && npm add @cap2ui5/cds-plugin, which names stay the same), plus a "The samples" section (npm add -D @cap2ui5/samples, development only)"cap2ui5": { "apps": … }, the peer dependency, how packages are found (dependencies, plus devDependencies outside production), and how name clashes are handled@cap2ui5/samplespackage; configuration'sappsrow links to the new sectionTooling and guidance
scripts/verify-refs.mjsnow checks imports, requires and dependency ranges against@cap2ui5/cds-plugin. It reports the oldcap2ui5name as withdrawn, the same way it reports the port'sabap2UI5package. Before the prose changes it flagged all 15 stale imports and dependency lines on the site.check.ymlis updated.Checks
npm run checkagainst current cap2UI5 main and abap2UI5 main: the VitePress build passes (dead links included). verify-refs reports 6 findings, and every one was already there before this PR.mainhas 7 against the same checkouts; the 7th was the"cap2ui5": "^0.1.0"line, which this PR fixes.checkon main has been red since cap2UI5 0.2.0 (run 41).The 6 come from 0.2.0, which is outside this PR: the configuration moved from
cds.cap2ui5tocds.requires.cap2ui5, andrequiresbecameroles. The verifier still readspackage.json#cds.cap2ui5, which no longer exists, so everycap2ui5.<option>is flagged. CI on this PR will be red for those 6 alone.Not in this PR — needs a follow-up
The site still teaches the 0.1.0 client API:
c.isDisplay,c.view(),c.bind(),c.event(),c.messageBox(). 0.2.0 replaced it withz2ui5_if_clientnames (client.check_on_navigated(),client.view_display(),client._bind()…), and the old names now throw. So the quickstart installs 0.3.0 but its code will not run on it. The same follow-up should cover the configuration pages (cds.requires.cap2ui5,roles, 403 instead of 401) and the verifier's option reader. That is a rewrite of most pages, so it doesn't belong in a rename.Nothing was published to npm.
🤖 Generated with Claude Code
https://claude.ai/code/session_01NwpbkojNzGmuJrFdbwo5JF
Generated by Claude Code