You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit bcb1763
Browse filesBrowse the repository at this point in the historyBrowse files
Replace Yarn 1.x with pnpm 10 as the workspace package manager.
- Add pnpm-workspace.yaml and .npmrc (frozen-lockfile, save-exact,
registry pin, shamefully-hoist)
- Add packageManager field for Corepack support
- Update CI workflows with pnpm/action-setup and dependency caching
- Convert workspace cross-reference from link: to workspace: protocol
- Drop lockfile-lint (pnpm lockfile not vulnerable to URL injection;
.npmrc registry pin provides equivalent protection)
- Replace npm-run-all in root ci script with plain && chain
(npm-run-all2 v5+ delegates to pnpm which chokes on the commitizen
config block in package.json)
- Add pnpmDedupe to Renovate postUpdateOptions
- Update documentation
Copy file name to clipboardExpand all lines: .changeset/README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ We have a quick list of common questions to get you started engaging with this p
12
12
This monorepo replaced Lerna with [Changesets](https://github.com/changesets/changesets) for
13
13
versioning and releases. The flow is:
14
14
15
-
1.**In your PR**, run `yarn changeset` and answer the prompts (which packages, semver level,
15
+
1.**In your PR**, run `pnpm changeset` and answer the prompts (which packages, semver level,
16
16
summary). Commit the generated `.changeset/<random-name>.md` file alongside your code change.
17
17
2. When your PR is merged to `main`, the **Release** workflow opens (or updates) a single
18
18
`Version Packages` PR that aggregates all pending changesets — bumping versions and updating
@@ -23,4 +23,4 @@ versioning and releases. The flow is:
23
23
Private packages (`test-packages/*`, `demos/*`) are skipped automatically by `changeset publish`.
24
24
Only the public packages under `packages/*` are released.
25
25
26
-
If a change does not warrant a release (docs-only, internal tooling, test refactors, etc.) run `yarn changeset:empty` and commit the generated file — it satisfies the required changeset check without producing any package bump.
26
+
If a change does not warrant a release (docs-only, internal tooling, test refactors, etc.) run `pnpm changeset:empty` and commit the generated file — it satisfies the required changeset check without producing any package bump.
# Fails the PR if no changeset describes the change.
44
-
# Add one with `yarn changeset` (or `yarn changeset:empty` for PRs
46
+
# Add one with `pnpm changeset` (or `pnpm changeset:empty` for PRs
45
47
# that don't need a release entry) and commit it.
46
48
# We check `.changesets` (not `.releases`) so that empty changesets
47
49
# — which have 0 package bumps but still document the PR — pass.
48
50
- name: Verify changeset is present
49
51
run: |
50
-
yarn changeset status --since=origin/main --output=/tmp/cs.json
52
+
pnpm changeset status --since=origin/main --output=/tmp/cs.json
51
53
if [ "$(jq '.changesets | length' /tmp/cs.json)" -eq 0 ]; then
52
-
echo "::error::No changeset found on this PR. Run 'yarn changeset' (or 'yarn changeset:empty' for PRs that don't need a release entry) and commit the file."
54
+
echo "::error::No changeset found on this PR. Run 'pnpm changeset' (or 'pnpm changeset:empty' for PRs that don't need a release entry) and commit the file."
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+22-22Lines changed: 22 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,17 +32,17 @@ A reproducible example (a minimal repo or a [TypeScript Hello World](https://git
32
32
### Pre-requisites
33
33
34
34
- A current [Long-Term Support version](https://nodejs.org/en/about/releases/) of Node.js (>= 22; CI tests on 22.x and 24.x).
35
-
-[Yarn 1.x](https://classic.yarnpkg.com/lang/en/docs/install/) — this repo uses yarn classic with workspaces.
35
+
-[pnpm](https://pnpm.io/installation) — this repo uses pnpm workspaces. If you have [Corepack](https://nodejs.org/api/corepack.html) enabled (`corepack enable`), pnpm will be installed automatically from the `packageManager` field in package.json.
36
36
- (optional) [commitizen](https://github.com/commitizen/cz-cli#installing-the-command-line-tool) for managing commit messages.
37
37
38
38
### Initial Setup
39
39
40
40
The initial setup is trivial:
41
41
42
42
- clone this repo
43
-
-`yarn`
43
+
-`pnpm install`
44
44
45
-
The repo's `.yarnrc` enforces `--frozen-lockfile`, exact-version saves (`save-prefix ""`), and a pinned registry — that's intentional supply-chain hardening, please don't loosen it without discussion.
45
+
The repo's `.npmrc` enforces `frozen-lockfile=true`, exact-version saves (`save-exact=true`), and a pinned registry — that's intentional supply-chain hardening, please don't loosen it without discussion.
46
46
47
47
### Repository Layout
48
48
@@ -82,7 +82,7 @@ fix(ts-interface-generator): handle aggregations with cardinality 0..1
82
82
chore: bump root devDependencies
83
83
```
84
84
85
-
The scope is also what `yarn changeset:auto` uses to figure out which packages to bump (see [Releases](#release-process) below). Breaking changes are signalled with a `!` after the type/scope **or** a `BREAKING CHANGE:` footer in the body — either flips the bump to `major`.
85
+
The scope is also what `pnpm changeset:auto` uses to figure out which packages to bump (see [Releases](#release-process) below). Breaking changes are signalled with a `!` after the type/scope **or** a `BREAKING CHANGE:` footer in the body — either flips the bump to `major`.
86
86
87
87
### Formatting
88
88
@@ -93,8 +93,8 @@ However, this does mean that dev flows that do not use a full dev env (e.g editi
93
93
To run it manually:
94
94
95
95
```sh
96
-
yarn format:fix # rewrite files
97
-
yarn format:validate # check, no rewrite (this is what CI runs)
96
+
pnpm format:fix # rewrite files
97
+
pnpm format:validate # check, no rewrite (this is what CI runs)
98
98
```
99
99
100
100
### Compiling
@@ -104,14 +104,14 @@ See the respective sub-packages for instructions (if needed at all).
104
104
To build both publishable packages from the root:
105
105
106
106
```sh
107
-
yarn build
107
+
pnpm run build
108
108
```
109
109
110
-
Per-package work uses yarn's workspace shorthand:
110
+
Per-package work uses pnpm's filter shorthand:
111
111
112
112
```sh
113
-
yarn workspace @ui5/dts-generator build
114
-
yarn workspace @ui5/ts-interface-generator test
113
+
pnpm --filter @ui5/dts-generator run build
114
+
pnpm --filter @ui5/ts-interface-generator runtest
115
115
```
116
116
117
117
### Testing
@@ -121,14 +121,14 @@ yarn workspace @ui5/ts-interface-generator test
121
121
[mocha]: https://mochajs.org/
122
122
[chai]: https://www.chaijs.com
123
123
124
-
- To run the tests, execute `yarn test` in a specific sub-package.
124
+
- To run the tests, execute `pnpm run test` in a specific sub-package.
125
125
- Note that not all sub-packages contain tests.
126
126
127
127
When adding a feature or fixing a bug, **please add or extend a test**. PRs without tests will get a friendly nudge.
128
128
129
129
### Full Build
130
130
131
-
To run the full **C**ontinuous **I**ntegration build run `yarn ci` in either the top-level package or a specific subpackage.
131
+
To run the full **C**ontinuous **I**ntegration build run `pnpm run ci` in either the top-level package or a specific subpackage.
132
132
133
133
## Pull Requests
134
134
@@ -155,13 +155,13 @@ When your PR changes one or more public packages, add a changeset alongside your
|`yarn changeset:auto`|**Recommended for most PRs.** Walks the conventional-commit history on your branch and writes one `.changeset/auto-<sha>.md` per qualifying commit (packages from the commit `scope`, bump from the `type`, summary from the `subject`). Idempotent — safe to re-run. Already-covered commits are skipped, so any hand-written changeset always wins. |
159
-
|`yarn changeset`| Interactive — pick packages, bump type, and write a summary by hand. Use when the auto-derived bump or summary is wrong (e.g. a `chore:` commit that secretly contains a `feat:`). The next `:auto` run will then skip the commit because it's covered. |
160
-
|`yarn changeset:empty`| Docs- or tooling-only PRs that touch no public package. Writes an empty `.changeset/*.md` so the "no changeset detected" hint goes away without producing any CHANGELOG entry. |
158
+
|`pnpm changeset:auto`|**Recommended for most PRs.** Walks the conventional-commit history on your branch and writes one `.changeset/auto-<sha>.md` per qualifying commit (packages from the commit `scope`, bump from the `type`, summary from the `subject`). Idempotent — safe to re-run. Already-covered commits are skipped, so any hand-written changeset always wins. |
159
+
|`pnpm changeset`| Interactive — pick packages, bump type, and write a summary by hand. Use when the auto-derived bump or summary is wrong (e.g. a `chore:` commit that secretly contains a `feat:`). The next `:auto` run will then skip the commit because it's covered. |
160
+
|`pnpm changeset:empty`| Docs- or tooling-only PRs that touch no public package. Writes an empty `.changeset/*.md` so the "no changeset detected" hint goes away without producing any CHANGELOG entry. |
161
161
162
162
Whichever you pick, **commit the resulting `.changeset/*.md` file alongside your code change**.
@@ -173,13 +173,13 @@ How `yarn changeset:auto` chooses the bump:
173
173
174
174
Commits whose only file changes are under `packages/<pkg>/test/` are also skipped — test-only changes don't ship in the published tarball.
175
175
176
-
If a change does not warrant a release at all (CI tweaks, internal tooling, etc.) run `yarn changeset:empty` and commit the generated file — it satisfies the required changeset check without producing any package release.
176
+
If a change does not warrant a release at all (CI tweaks, internal tooling, etc.) run `pnpm changeset:empty` and commit the generated file — it satisfies the required changeset check without producing any package release.
177
177
178
178
### For maintainers — cutting a release
179
179
180
180
The release itself happens entirely on GitHub. You don't need npm credentials or a clean local checkout.
181
181
182
-
1. When a PR with at least one changeset is merged into `main`, the [`Release`](.github/workflows/release.yml) workflow opens (or updates) a single **`Version Packages`** PR. That PR aggregates every pending changeset, bumps the affected `package.json` versions, regenerates each package's `CHANGELOG.md`, and refreshes `yarn.lock`.
182
+
1. When a PR with at least one changeset is merged into `main`, the [`Release`](.github/workflows/release.yml) workflow opens (or updates) a single **`Version Packages`** PR. That PR aggregates every pending changeset, bumps the affected `package.json` versions, regenerates each package's `CHANGELOG.md`, and refreshes `pnpm-lock.yaml`.
183
183
2. Review and merge that **`Version Packages`** PR when you're ready to cut a release.
184
184
3. Merging it triggers the same workflow again, this time on the `publish` path: `changeset publish` runs, the new versions go to npm (with [npm provenance](https://docs.npmjs.com/generating-provenance-statements)), and matching git tags are pushed.
185
185
4. Spot-check the newly published artifacts on [npmjs.com](https://www.npmjs.com/package/@ui5/dts-generator).
@@ -199,10 +199,10 @@ Not currently configured. If we need them, [`changeset pre enter <tag>`](https:/
199
199
To upgrade the version of the dependencies, [`npm-check-updates`](https://github.com/raineorshine/npm-check-updates) is wired up at the root:
200
200
201
201
```sh
202
-
yarn ncu # list outdated packages across the workspace
203
-
yarn ncu-u # apply the bumps to every package.json
204
-
yarn install # refresh yarn.lock
205
-
yarn ci # sanity-check before opening the PR
202
+
pnpm ncu # list outdated packages across the workspace
203
+
pnpm ncu-u # apply the bumps to every package.json
Copy file name to clipboardExpand all lines: README.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,6 +34,10 @@ With Yarn
34
34
35
35
`yarn add @sapui5/types --dev`
36
36
37
+
With pnpm
38
+
39
+
`pnpm add @sapui5/types --save-dev`
40
+
37
41
> **NOTE:** the type definitions define ES6-style module names for the entities. They require the usage of modern JavaScript syntax with ES modules and classes, which requires an additional transformation step that can be run together with the anyway required TypeScript transpilation.
38
42
>
39
43
> Before the type definitions were generated in ES module style, they did declare all APIs with their global names, which are discouraged to be used and will no longer be available in UI5 2.x. The dts-generator still has the capability to generate this legacy "globals" version of the type definitions, for compatibility reasons. These legacy definitions are released as "ts-types" instead of "types", but will no longer be produced for UI5 2.x.
0 commit comments