chore(schematics): document the scrollbar-deprecated-path migration - #1907
Open
lskramarov wants to merge 3 commits into
Open
chore(schematics): document the scrollbar-deprecated-path migration#1907lskramarov wants to merge 3 commits into
lskramarov wants to merge 3 commits into
Conversation
Copilot stopped reviewing on behalf of
lskramarov due to an error
August 17, 2026 14:24
|
Visit the preview URL for this PR (updated for commit a8b1ec1): https://koobiq-next--prs-1907-n7dlo2hv.web.app (expires Thu, 20 Aug 2026 16:37:16 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: c9e37e518febda70d0317d07e8ceb35ac43c534c |
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.
Suppressed comments (1)
packages/schematics/scripts/copy-meta-to-dist.js:97
- The aggregated failure summary says files are "missing", but
failuresalso includes non-missing copy failures fromcopyFileWrapper(e.g. permission/IO errors). This can mislead when debugging CI vs local issues; consider wording that covers both missing files and copy errors.
if (failures.length > 0) {
throw new Error([`${failures.length} file(s) missing from the package:`, ...failures].join('\n '));
}
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
packages/schematics/src/migrations/scrollbar-deprecated-path/was the only migration of 20 without aREADME.md, so it shipped to consumers undocumented while all its siblings ship a guide.The missing file turned out to be more than a documentation gap.
packages/schematics/scripts/copy-meta-to-dist.jscopies each migration's README into the published package, its loop is sequential and rethrows, and the final rejection was swallowed — so the copy step aborted at the first missing file and the build still exited 0. Verified locally: with the README absent,dist/components/schematics/migrations/v20-upgrade/index.jsanddist/components/schematics/utils/messages.jswere never copied, yetyarn run build:schematicsreported success.rimraf packages/schematics/distdoes not cleardist/components, so a stale local build masks the gap while CI publishes the truncated package.List of notable changes:
README.mdfor thescrollbar-deprecated-pathmigration, following the structure of the existing ones — what the schematic rewrites, which specifiers the quote-anchored match deliberately skips, thefixdefault, and a before/after example.@koobiq/components/scrollbarand@koobiq/components/scrollbar/deprecatedshare onlyKbqScrollbarandKbqScrollbarOptions, so most unmigrated imports fail withTS2305, while<kbq-scrollbar>keeps compiling and rendering against the new component and the[kbq-scrollbar]attribute form of the selector quietly matches nothing.copy-meta-to-dist.jsso a copy failure fails the build: the catch now setsprocess.exitCode = 1, failures are collected instead of aborting the loop at the first one, and a missingREADME.md/schema.jsonis reported asNo README.md for the <migration> migrationinstead of a raw ENOENT path.Verified with
yarn run build:schematicson a cleareddist/components(exit 0, all 20 migrations complete), a negative run withalert-signals/README.mdandv20-upgrade/schema.jsonremoved (exit 1, both reported by name, everything else still copied), andnpx jest packages/schematics(21 suites, 275 tests).What should reviewers focus on?
README.mdandschema.jsonshould be hard requirements for every migration directory. All 20 provide both today, so the new check is green, but it does mean a future migration cannot land without its README.