From 29eccd00d29f2a8ac2b9c367a04d3244b5452378 Mon Sep 17 00:00:00 2001 From: Claude Date: Tue, 29 Sep 2026 01:49:47 +0000 Subject: [PATCH] Use the published package name @cap2ui5/cds-plugin, and document the 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 Claude-Session: https://claude.ai/code/session_01NwpbkojNzGmuJrFdbwo5JF --- .github/workflows/check.yml | 2 +- AGENTS.md | 33 +++++++++----- HANDOVER.md | 5 +++ README.md | 2 +- docs/api/app-interface.md | 2 +- docs/examples/external-odata.md | 2 +- docs/examples/hello-world.md | 4 +- docs/examples/list.md | 2 +- docs/examples/selection-screen.md | 2 +- docs/examples/static-xml-view.md | 2 +- docs/guide/ecosystem.md | 16 ++++--- docs/guide/getting-started.md | 60 +++++++++++++++++++------ docs/guide/lifecycle.md | 2 +- docs/guide/migration-from-abap2ui5.md | 2 +- docs/guide/persistence.md | 2 +- docs/guide/project-structure.md | 38 +++++++++++++--- docs/guide/roadmap.md | 2 +- docs/guide/troubleshooting.md | 4 +- docs/guide/user-exit.md | 2 +- docs/guide/what-is-cap2ui5.md | 4 +- docs/guide/where-it-comes-from.md | 2 +- docs/index.md | 2 +- docs/reference/configuration.md | 8 ++-- docs/reference/deployment.md | 10 ++--- scripts/verify-refs.mjs | 65 +++++++++++++++++---------- 25 files changed, 186 insertions(+), 89 deletions(-) diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index fab7aa3..22fa71a 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -30,7 +30,7 @@ jobs: - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 # The documented targets. verify-refs checks every path, class, app id, - # plugin option and `require("cap2ui5")` on this site against real + # plugin option and `require("@cap2ui5/cds-plugin")` on this site against real # checkouts, so without them the run proves only that the site builds — # it skips those checks when a checkout is missing, which is exactly the # silent pass this job exists to prevent. Hence `check:ci` below, which diff --git a/AGENTS.md b/AGENTS.md index 6b0e17d..99d9f32 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -16,9 +16,10 @@ VitePress build. It is also what CI runs, on every pull request - every `?app_start=` names an app something registers with `defineApp`, - every `z2ui5_*` class or interface exists in the abap2UI5 source the hosted runtime is transpiled from, -- every `require("cap2ui5")` or `import { … } from "cap2ui5"` **inside a code - fence** names only what the package really exports (and the port's - `abap2UI5/…` package is reported, in either form), +- every `require("@cap2ui5/cds-plugin")` or `import { … } from + "@cap2ui5/cds-plugin"` **inside a code fence** names only what the package + really exports (and two dead packages are reported, in either form: the + port's `abap2UI5/…` and the plugin's withdrawn old name `cap2ui5`), - every `cds.cap2ui5.