Skip to content

Use the published package name @cap2ui5/cds-plugin, and document @cap2ui5/samples - #30

Merged
oblomov-dev merged 1 commit into
mainfrom
claude/cds-plugin-rename
Sep 29, 2026
Merged

oblomov-dev merged 1 commit into
mainfrom
claude/cds-plugin-rename

Conversation

@oblomov-dev

Copy link
Copy Markdown
Member

cap2UI5 0.3.0 (2026-09-29) is published as @cap2ui5/cds-plugin, and the unscoped cap2ui5 was withdrawn from npm. Every install command and import on the site named the withdrawn package. Sources used: cap2UI5/cap2UI5 plugin/README.md and plugin/CHANGELOG.md (0.3.0), and cap2UI5/samples README.md.

What changed

Package name → @cap2ui5/cds-plugin

  • Install commands: npm add @cap2ui5/cds-plugin in the quickstart, the home page, what-is, the README and the configuration page
  • Every import … from / require(…) in examples and prose: app-interface, all five examples, getting-started, lifecycle, migration, project-structure, troubleshooting, user-exit, what-is, configuration
  • The dependency line on the deployment page is now "@cap2ui5/cds-plugin": "^0.3.0"; project-structure's tree, npm update, and node_modules/@cap2ui5/cds-plugin/index.cds on the persistence page
  • Package facts on ecosystem, project-structure, configuration, deployment, where-it-comes-from and roadmap: 0.3.0, Node ≥ 22, still pins runtime 1.145.0
  • Left as they are: cds.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 release

New content (kept short)

  • Quickstart: an info box for projects that have the old package (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)
  • Project Structure: a new "Apps from a package" section covering "cap2ui5": { "apps": … }, the peer dependency, how packages are found (dependencies, plus devDependencies outside production), and how name clashes are handled
  • Ecosystem: adds the cap2UI5/samples repo and the @cap2ui5/samples package; configuration's apps row links to the new section

Tooling and guidance

  • scripts/verify-refs.mjs now checks imports, requires and dependency ranges against @cap2ui5/cds-plugin. It reports the old cap2ui5 name as withdrawn, the same way it reports the port's abap2UI5 package. Before the prose changes it flagged all 15 stale imports and dependency lines on the site.
  • AGENTS.md ground truth updated (package names and versions, samples repo, which names did not change). HANDOVER.md gets a dated note at the top and its body is unchanged. The comment in check.yml is updated.

Checks

npm run check against 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. main has 7 against the same checkouts; the 7th was the "cap2ui5": "^0.1.0" line, which this PR fixes. check on 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.cap2ui5 to cds.requires.cap2ui5, and requires became roles. The verifier still reads package.json#cds.cap2ui5, which no longer exists, so every cap2ui5.<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 with z2ui5_if_client names (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

…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

Copy link
Copy Markdown
Member Author

check is red, but not because of this PR. verify-refs reports 6 findings, all of the same kind: cap2ui5.apps / cap2ui5.requires / cap2ui5.routes is not a plugin option (package.json#cds.cap2ui5 defines ). They are in troubleshooting.md:61/164/185, user-exit.md:202, configuration.md:57 and deployment.md:120. This PR doesn't touch any of those lines.

Cause: cap2UI5 0.2.0 moved the configuration from cds.cap2ui5 to cds.requires.cap2ui5 and renamed requires to roles. The verifier still reads plugin/package.json#cds.cap2ui5, which no longer exists, so it knows no options at all. main fails the same way (run 41 and later). Against the same checkouts, main has 7 findings; this PR fixes the 7th, the "cap2ui5": "^0.1.0" dependency line.

No fix exists yet. The fix is the 0.2.0 docs follow-up described in the PR body: point the verifier at cds.requires.cap2ui5 and rewrite the configuration prose (roles, 403). I haven't re-run the job: the result is deterministic and reproduces locally with npm run check.


Generated by Claude Code

@oblomov-dev
oblomov-dev merged commit 0a7e461 into main Sep 29, 2026
1 check failed
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